The payload that configures a Mail account.
| Setting | Type | Required | Default | Manual Install | Supported OS |
|---|---|---|---|---|---|
Account Description EmailAccountDescription A user-visible description of the email account, shown in the Mail and Settings applications. | string | optional | — | ✓Yes | iOS (4.0+)macOS (10.7+)visionOS (1.1+) |
Account Name EmailAccountName The full user name for the account. The system displays this name in sent messages. | string | optional | — | ✓Yes | iOS (4.0+)macOS (10.7+)visionOS (1.1+) |
Account Type EmailAccountType Defines the protocol to use for the account. | string | required | — | ✓Yes | iOS (4.0+)macOS (10.7+)visionOS (1.1+) |
Email Address EmailAddress The full email address for the account. If this string isn't present in the payload, the device prompts the user for this string during interactive profile installation in Settings or System Preferences. | string | optional | — | ✓Yes | iOS (4.0+)macOS (10.7+)visionOS (1.1+) |
Incoming Mail Server Authentication IncomingMailServerAuthentication The authentication scheme for incoming mail. | string | required | — | ✓Yes | iOS (4.0+)macOS (10.7+)visionOS (1.1+) |
Mail Server IncomingMailServerHostName The incoming mail server host name. | string | required | — | ✓Yes | iOS (4.0+)macOS (10.7+)visionOS (1.1+) |
Port IncomingMailServerPortNumber The incoming mail server port number. If not set, the system uses the default port for a given protocol. | integer | optional | — | ✓Yes | iOS (4.0+)macOS (10.7+)visionOS (1.1+) |
Use SSL IncomingMailServerUseSSL If `true`, the system enables SSL for authentication on the incoming mail server. | boolean | optional | false | ✓Yes | iOS (4.0+)macOS (10.7+)visionOS (1.1+) |
Username IncomingMailServerUsername The user name for the email account, usually the same as the email address up to the "@" character. If not set and the account requires authentication for incoming email, the device prompts the user for this string during interactive profile installation in Settings or System Preferences. | string | optional | — | ✓Yes | iOS (4.0+)macOS (10.7+)visionOS (1.1+) |
Password IncomingPassword The password for the incoming mail server. Only use this in encrypted profiles. | string | optional | — | ✓Yes | iOS (4.0+)macOS (10.7+)visionOS (1.1+) |
Password OutgoingPassword The password for the outgoing mail server. Only use this in encrypted profiles. | string | optional | — | ✓Yes | iOS (4.0+)macOS (10.7+)visionOS (1.1+) |
Outgoing Password Same As Incoming OutgoingPasswordSameAsIncomingPassword If `true`, the system prompts the user only once for the password, which it uses for both outgoing and incoming mail.
This setting is only supported by interactive profile installations. Not supported by non-interactive installations, such as MDM on iOS. | boolean | optional | false | ✓Yes | iOS (4.0+)macOS (10.7+)visionOS (1.1+) |
Authentication Type OutgoingMailServerAuthentication The authentication scheme for outgoing mail. | string | required | — | ✓Yes | iOS (4.0+)macOS (10.7+)visionOS (1.1+) |
Mail Server OutgoingMailServerHostName The outgoing mail server host name. | string | required | — | ✓Yes | iOS (4.0+)macOS (10.7+)visionOS (1.1+) |
Port OutgoingMailServerPortNumber The outgoing mail server port number. If not set, the system uses ports 25, 587, and 465, in that order. | integer | optional | — | ✓Yes | iOS (4.0+)macOS (10.7+)visionOS (1.1+) |
Use SSL OutgoingMailServerUseSSL If `true`, the system enables SSL authentication on the outgoing mail server. | boolean | optional | false | ✓Yes | iOS (4.0+)macOS (10.7+)visionOS (1.1+) |
Username OutgoingMailServerUsername The user name for the email account, usually the same as the email address up to the "@" character. If not set and the account requires authentication for outgoing email, the device prompts the user for this string during interactive profile installation in Settings or System Preferences. | string | optional | — | ✓Yes | iOS (4.0+)macOS (10.7+)visionOS (1.1+) |
Prevent Move PreventMove If `true`, the system prevents moving messages out of this email account and into another account. It also prevents forwarding or replying from an account other than the recipient of the message. | boolean | optional | false | ✓Yes | iOS (5.0+) |
Prevent App Sheet PreventAppSheet If `true`, the system prevents this account from sending mail in any app other than the Apple Mail app. | boolean | optional | false | ✓Yes | iOS (5.0+) |
S/MIME Enabled SMIMEEnabled If `true`, the system enables S/MIME encryption. The system ignores this key in iOS 10.0 and later. | boolean | optional | false | ✓Yes | iOS (5.0+) |
S/MIME Signing Enabled SMIMESigningEnabled If `true`, the system enables S/MIME signing for this account. | boolean | optional | false | ✓Yes | iOS (10.0+) |
S/MIME Signing Certificate SMIMESigningCertificateUUID The payload UUID of the identity certificate used to sign messages sent from this account. | string | optional | — | ✓Yes | iOS (5.0+) |
S/MIME Encryption Enabled SMIMEEncryptionEnabled If `true`, the system enables S/MIME encryption for this account. | boolean | optional | false | ✓Yes | iOS (10.0+) |
S/MIME Encryption Certificate SMIMEEncryptionCertificateUUID The UUID of the identity certificate used to decrypt messages sent to this account. The system attaches the public certificate to outgoing mail to allow the user to receive encrypted mail. When the user sends encrypted mail, the system uses the public certificate to encrypt the copy of the mail in their Sent mailbox. | string | optional | — | ✓Yes | iOS (5.0+) |
S/MIME Enable Per-Message Switch SMIMEEnablePerMessageSwitch Deprecated (iOS 10.0) If `true`, the system displays the per-message encryption switch in the Mail Compose UI. Deprecated in iOS 12.0. Use `SMIMEEnableEncryptionPerMessageSwitch` instead. | boolean | optional | false | ✓Yes | iOS (8.0 - 10.0) |
Disable Mail Recents Syncing disableMailRecentsSyncing If `true`, the system excludes this account from Recent Addresses syncing. | boolean | optional | false | ✓Yes | iOS (6.0+) |
Allow Mail Drop allowMailDrop If `true`, the system enables this account to use Mail Drop. | boolean | optional | false | ✓Yes | iOS (9.2+)macOS (10.12+) |
Path Prefix IncomingMailServerIMAPPathPrefix The path prefix for the IMAP mail server. | string | optional | — | ✓Yes | iOS (4.0+)macOS (10.7+)visionOS (1.1+) |
SMIMESigningUserOverrideable SMIMESigningUserOverrideable If `true`, the user can turn S/MIME signing on or off in Settings. | boolean | optional | false | ✓Yes | iOS (12.0+) |
SMIMESigningCertificateUUIDUserOverrideable SMIMESigningCertificateUUIDUserOverrideable If `true`, the user can select the signing identity. | boolean | optional | false | ✓Yes | iOS (12.0+) |
SMIMEEncryptByDefault SMIMEEncryptByDefault If `true`, the system enables S/MIME encryption by default. | boolean | optional | false | ✓Yes | iOS (12.0+) |
SMIMEEncryptByDefaultUserOverrideable SMIMEEncryptByDefaultUserOverrideable If `true`, the user can turn encryption by default on/off, and encryption is on. | boolean | optional | false | ✓Yes | iOS (12.0+) |
SMIMEEncryptionCertificateUUIDUserOverrideable SMIMEEncryptionCertificateUUIDUserOverrideable If `true`, the user can select the S/MIME encryption identity, and encryption is on. | boolean | optional | false | ✓Yes | iOS (12.0+) |
SMIMEEnableEncryptionPerMessageSwitch SMIMEEnableEncryptionPerMessageSwitch If `true`, the system displays the per-message encryption switch in the Mail Compose UI. | boolean | optional | false | ✓Yes | iOS (12.0+) |
VPNUUID VPNUUID The VPNUUID of the per-app VPN the account uses for network communication. Available in iOS 14 and later. | string | optional | — | ✓Yes | iOS (14.0+) |
