PayloadKit

Mail

com.apple.mail.managed

The payload that configures a Mail account.

iOSmacOS
macOS 10.7+iOS 4.0+combined

Configuration Keys (37)

KeyTypeTitle
EmailAccountTyperequired

Defines the protocol to use for the account.

Default: "EmailTypeIMAP"

Range: IMAP (EmailTypeIMAP), POP (EmailTypePOP)

stringAccount Type
EmailAccountDescription

A user-visible description of the email account, shown in the Mail and Settings applications.

stringAccount Description
IncomingMailServerIMAPPathPrefix

The path prefix for the IMAP mail server.

stringPath Prefix
EmailAccountName

The full user name for the account. The system displays this name in sent messages.

stringUser Display Name
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.

stringEmail Address
IdentificationUUID

The UUID of the Identification Payload to use as the source for the user email and username values.

stringIdentificationUUID
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.

Default: false

booleanAllow user to move messages from this account
disableMailRecentsSyncing

If 'true', the system excludes this account from Recent Addresses syncing.

Default: false

booleanAllow recent addresses to be synced
allowMailDrop

If 'true', the system enables this account to use Mail Drop.

Default: false

booleanAllow Mail Drop
PreventAppSheet

If 'true', the system prevents this account from sending mail in any app other than the Apple Mail app.

Default: false

booleanUse Only In Mail
SMIMEEnabled

If 'true', the system enables S/MIME encryption. The system ignores this key in iOS 10.0 and later.

Default: false

booleanS/MIME Enabled
SMIMESigningEnabled

If 'true', the system enables S/MIME signing for this account.

Default: false

booleanS/MIME Signing Enabled
SMIMESigningCertificateUUID

The payload UUID of the identity certificate used to sign messages sent from this account.

stringS/MIME Signing Certificate
SMIMEEncryptionEnabled

If 'true', the system enables S/MIME encryption for this account.

Default: false

booleanS/MIME Encryption Enabled
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.

stringS/MIME Encryption Certificate
SMIMEEnablePerMessageSwitch

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

booleanS/MIME Enable Per-Message Switch
SMIMESigningUserOverrideable

If 'true', the user can turn S/MIME signing on or off in Settings.

Default: false

booleanEnable S/MIME toggle
SMIMESigningCertificateUUIDUserOverrideable

If 'true', the user can select the signing identity.

Default: false

booleanEnable user to select the signing identity
SMIMEEncryptByDefault

If 'true', the system enables S/MIME encryption by default.

Default: false

booleanEnable S/MIME by default
SMIMEEncryptByDefaultUserOverrideable

If 'true', the user can turn encryption by default on/off, and encryption is on.

Default: false

booleanEnable user to toggle S/MIME by default
SMIMEEncryptionCertificateUUIDUserOverrideable

If 'true', the user can select the S/MIME encryption identity, and encryption is on.

Default: false

booleanEnable user to select the signing identity and encryption is enabled
SMIMEEnableEncryptionPerMessageSwitch

If 'true', the system displays the per-message encryption switch in the Mail Compose UI.

Default: false

booleanEnable per-message encryption switch
PFC_SegmentedControl_0required
string
IncomingMailServerHostNamerequired

The incoming mail server host name.

stringIncoming Mail Server Hostname
IncomingMailServerPortNumber

The incoming mail server port number. If not set, the system uses the default port for a given protocol.

Default: 993

Range: 0 – 65535

integerIncoming Mail Server Port
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.

stringIncoming Mail Server Username
IncomingMailServerAuthenticationrequired

The authentication scheme for incoming mail.

Default: "EmailAuthPassword"

Range: None (EmailAuthNone), Password (EmailAuthPassword), MD5 Challenge-Response (EmailAuthCRAMMD5), NTLM (EmailAuthNTLM), HTTP MD5 Digest (EmailAuthHTTPMD5)

stringIncoming Mail Server Authentification Type
IncomingPassword

The password for the incoming mail server. Only use this in encrypted profiles.

stringIncoming Mail Server Password
IncomingMailServerUseSSL

If 'true', the system enables SSL for authentication on the incoming mail server.

Default: false

booleanIncoming Mail Server Use SSL
OutgoingMailServerHostNamerequired

The outgoing mail server host name.

stringOutgoing Mail Server Hostname
OutgoingMailServerPortNumber

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

integerOutgoing Mail Server Port
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.

stringOutgoing Mail Server Username
OutgoingMailServerAuthenticationrequired

The authentication scheme for outgoing mail.

Default: "EmailAuthPassword"

Range: None (EmailAuthNone), Password (EmailAuthPassword), MD5 Challenge-Response (EmailAuthCRAMMD5), NTLM (EmailAuthNTLM), HTTP MD5 Digest (EmailAuthHTTPMD5)

stringOutgoing Mail Server Authentication Type
OutgoingPassword

The password for the outgoing mail server. Only use this in encrypted profiles.

stringOutgoing Mail Server Password
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.

Default: false

booleanOutgoing Password Same As Incoming
OutgoingMailServerUseSSL

If 'true', the system enables SSL authentication on the outgoing mail server.

Default: false

booleanOutgoing Mail Server Use SSL
VPNUUID

The VPNUUID of the per-app VPN the account uses for network communication. Available in iOS 14 and later.

stringVPNUUID