com.apple.mail.managed
The payload that configures a Mail account.
macOS: user channel only
Configuration Keys (37)
Showing 37 of 37 keys
| Key | Type | Description | Default | Range |
|---|---|---|---|---|
| string | Defines the protocol to use for the account. | Default: "EmailTypeIMAP" | Range: IMAP (EmailTypeIMAP), POP (EmailTypePOP) | |
EmailAccountDescriptionstringAccount description | string | A user-visible description of the email account, shown in the Mail and Settings applications. | Default: — | Range: — |
Incoming Mail Server IMAP Path Prefix | string | The path prefix for the IMAP mail server. | Default: — | Range: — |
EmailAccountNamestringUser Display Name | string | The full user name for the account. The system displays this name in sent messages. | Default: — | Range: — |
EmailAddressstringEmail address | string | 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. | Default: — | Range: — |
IdentificationUUIDstringIdentificationUUID | string | The UUID of the Identification Payload to use as the source for the user email and username values. | Default: — | Range: — |
| boolean | 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. | Default: false | Range: — | |
| boolean | If 'true', the system excludes this account from Recent Addresses syncing. | Default: false | Range: — | |
| boolean | If 'true', the system enables this account to use Mail Drop. | Default: false | Range: — | |
| boolean | If 'true', the system prevents this account from sending mail in any app other than the Apple Mail app. | Default: false | Range: — | |
| boolean | If 'true', the system enables S/MIME encryption. The system ignores this key in iOS 10.0 and later. | Default: false | Range: — | |
| boolean | If 'true', the system enables S/MIME signing for this account. | Default: false | Range: — | |
| string | The payload UUID of the identity certificate used to sign messages sent from this account. | Default: — | Range: — | |
| boolean | If 'true', the system enables S/MIME encryption for this account. | Default: false | Range: — | |
| string | 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. | Default: — | Range: — | |
SMIMEEnablePerMessageSwitchbooleanS/MIME enable per-message switch iOS 8.0+ · deprecated 10.0 · not on macOS, visionOS deprecated | boolean | If 'true', the system displays the per-message encryption switch in the Mail Compose UI. Deprecated in iOS 12.0. Use 'SMIMEEnableEncryptionPerMessageSwitch' instead. | Default: false | Range: — |
| boolean | If 'true', the user can turn S/MIME signing on or off in Settings. | Default: false | Range: — | |
Enable user to select the signing identity iOS 12.0+ · not on macOS | boolean | If 'true', the user can select the signing identity. | Default: false | Range: — |
| boolean | If 'true', the system enables S/MIME encryption by default. | Default: false | Range: — | |
Enable user to toggle S/MIME by default iOS 12.0+ · not on macOS | boolean | If 'true', the user can turn encryption by default on/off, and encryption is on. | Default: false | Range: — |
Enable user to select the signing identity and encryption is enabled iOS 12.0+ · not on macOS | boolean | If 'true', the user can select the S/MIME encryption identity, and encryption is on. | Default: false | Range: — |
Enable per-message encryption switch iOS 12.0+ · not on macOS | boolean | If 'true', the system displays the per-message encryption switch in the Mail Compose UI. | Default: false | Range: — |
PFC_SegmentedControl_0stringrequired | string | — | Default: — | Range: — |
| string | The incoming mail server host name. | Default: — | Range: — | |
IncomingMailServerPortNumberintegerIncoming Mail Server Port | integer | The incoming mail server port number. If not set, the system uses the default port for a given protocol. | Default: 993 | Range: 0 – 65535 |
Incoming Mail Server Username | string | 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. | Default: — | Range: — |
| string | The authentication scheme for incoming mail. | Default: "EmailAuthPassword" | Range: None (EmailAuthNone), Password (EmailAuthPassword), MD5 Challenge-Response (EmailAuthCRAMMD5), NTLM (EmailAuthNTLM), HTTP MD5 Digest (EmailAuthHTTPMD5) | |
IncomingPasswordstringIncoming Mail Server Password | string | The password for the incoming mail server. Only use this in encrypted profiles. | Default: — | Range: — |
IncomingMailServerUseSSLbooleanIncoming Mail Server Use SSL | boolean | If 'true', the system enables SSL for authentication on the incoming mail server. | Default: false | Range: — |
| string | The outgoing mail server host name. | Default: — | Range: — | |
OutgoingMailServerPortNumberintegerOutgoing Mail Server Port | integer | The outgoing mail server port number. If not set, the system uses ports 25, 587, and 465, in that order. | Default: 587 | Range: 0 – 65535 |
Outgoing Mail Server Username | string | 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. | Default: — | Range: — |
| string | The authentication scheme for outgoing mail. | Default: "EmailAuthPassword" | Range: None (EmailAuthNone), Password (EmailAuthPassword), MD5 Challenge-Response (EmailAuthCRAMMD5), NTLM (EmailAuthNTLM), HTTP MD5 Digest (EmailAuthHTTPMD5) | |
OutgoingPasswordstringOutgoing Mail Server Password | string | The password for the outgoing mail server. Only use this in encrypted profiles. | Default: — | Range: — |
Outgoing password same as incoming | boolean | 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. | Default: false | Range: — |
OutgoingMailServerUseSSLbooleanOutgoing Mail Server Use SSL | boolean | If 'true', the system enables SSL authentication on the outgoing mail server. | Default: false | Range: — |
| string | The VPNUUID of the per-app VPN the account uses for network communication. | Default: — | Range: — |