AccountMail
The declaration to configure a Mail account.
Declaration
object AccountMailProperties
| Name | Type | Description |
|---|---|---|
IncomingServer Required | AccountMailIncomingServerObject | The settings for the incoming mail server for this account. |
OutgoingServer Required | AccountMailOutgoingServerObject | The settings for the outgoing mail server for this account. |
SMIME | AccountMailSMIMEObject | Settings for S/MIME. Available: iOS 17+ | iPadOS 17+ | visionOS 1.1+ |
UserIdentityAssetReference | string | The identifier of an asset declaration that contains the user identity for this account. Set the corresponding asset type to |
VisibleName | string | The name that apps show to the user for this mail account. If not present, the system generates a suitable default. |
Discussion
Specify com.apple.configuration.account.mail as the declaration type.
Configuration availability
Allowed in supervised enrollment | iOS, macOS, Shared iPad, visionOS |
Allowed in device enrollment | iOS, Shared iPad, visionOS |
Allowed in user enrollment | iOS, macOS, Shared iPad, visionOS |
Allowed in local enrollment | iOS, macOS, Shared iPad, visionOS |
Allowed in system scope | iOS, visionOS |
Allowed in user scope | macOS, Shared iPad |
Apply | Multiple configurations are applied separately |
Configuration example
This configuration sets up an IMAP email account with SMTP outgoing mail.
{
"Type": "com.apple.configuration.account.mail",
"Identifier": "EB13EE2B-5D63-4EBA-810F-5B81D07F5017",
"ServerToken": "E180CA9A-F089-4FA3-BBDF-94CC159C4AE8",
"Payload": {
"VisibleName": "Work Mail",
"UserIdentityAssetReference": "CB3E6C7F-2318-437B-8A9E-D50C69376DE4",
"IncomingServer": {
"ServerType": "IMAP",
"HostName": "imap.example.com",
"AuthenticationMethod": "Password",
"AuthenticationCredentialsAssetReference": "64BF8F5C-8CFD-40AA-9082-A0B594D4E100"
},
"OutgoingServer": {
"HostName": "smtp.example.com",
"AuthenticationMethod": "Password",
"AuthenticationCredentialsAssetReference": "64BF8F5C-8CFD-40AA-9082-A0B594D4E100"
}
}
}