Contents

Mail

The payload that configures a Mail account.

Declaration

object Mail

Properties

NameTypeDescription
allowMailDropboolean

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

disableMailRecentsSyncingboolean

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

EmailAccountDescriptionstring

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

EmailAccountNamestring

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

EmailAccountType Requiredstring

Defines the protocol to use for the account.

EmailAddressstring

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.

IncomingMailServerAuthentication Requiredstring

The authentication scheme for incoming mail.

IncomingMailServerHostName Requiredstring

The incoming mail server host name.

IncomingMailServerIMAPPathPrefixstring

The path prefix for the IMAP mail server.

IncomingMailServerPortNumberinteger

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

IncomingMailServerUsernamestring

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.

IncomingMailServerUseSSLboolean

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

IncomingPasswordstring

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

OutgoingMailServerAuthentication Requiredstring

The authentication scheme for outgoing mail.

OutgoingMailServerHostName Requiredstring

The outgoing mail server host name.

OutgoingMailServerPortNumberinteger

The outgoing mail server port number. If not set, the system uses ports 25, 587, and 465, in that order.

OutgoingMailServerUsernamestring

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.

OutgoingMailServerUseSSLboolean

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

OutgoingPasswordstring

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

OutgoingPasswordSameAsIncomingPasswordboolean

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.

PreventAppSheetboolean

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

PreventMoveboolean

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.

SMIMEEnabledboolean

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

SMIMEEnableEncryptionPerMessageSwitchboolean

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

SMIMEEnablePerMessageSwitchboolean

If true, the system displays the per-message encryption switch in the Mail Compose UI. Deprecated in iOS 12.0. Use SMIMEEnableEncryptionPerMessageSwitch instead.

SMIMEEncryptByDefaultboolean

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

SMIMEEncryptByDefaultUserOverrideableboolean

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

SMIMEEncryptionCertificateUUIDstring

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.

SMIMEEncryptionCertificateUUIDUserOverrideableboolean

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

SMIMEEncryptionEnabledboolean

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

SMIMESigningCertificateUUIDstring

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

SMIMESigningCertificateUUIDUserOverrideableboolean

If true, the user can select the signing identity.

SMIMESigningEnabledboolean

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

SMIMESigningUserOverrideableboolean

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

VPNUUIDstring

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

Discussion

Specify com.apple.mail.managed as the payload type.

Profile availability

Device channel

iOS, visionOS

User channel

macOS, Shared iPad

Allow manual install

iOS, macOS, visionOS

Requires supervision

NA

Requires user-approved MDM

NA

Allowed in user enrollment

iOS, macOS, visionOS

Allow multiple payloads

iOS, macOS, Shared iPad, visionOS

Profile example

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <key>PayloadContent</key>
    <array>
        <dict>
            <key>EmailAccountDescription</key>
            <string>Company Mail Account</string>
            <key>EmailAccountName</key>
            <string>Juan Chavez</string>
            <key>EmailAccountType</key>
            <string>EmailTypeIMAP</string>
            <key>EmailAddress</key>
            <string>juanchavez4@example.com</string>
            <key>IncomingMailServerAuthentication</key>
            <string>EmailAuthPassword</string>
            <key>IncomingMailServerHostName</key>
            <string>imap.example.com</string>
            <key>IncomingMailServerPortNumber</key>
            <integer>993</integer>
            <key>IncomingMailServerUseSSL</key>
            <true/>
            <key>IncomingMailServerUsername</key>
            <string>juanchavez4@example.com</string>
            <key>IncomingPassword</key>
            <string>Password123</string>
            <key>OutgoingMailServerAuthentication</key>
            <string>EmailAuthPassword</string>
            <key>OutgoingMailServerHostName</key>
            <string>smtp.example.com</string>
            <key>OutgoingMailServerPortNumber</key>
            <integer>587</integer>
            <key>OutgoingMailServerUseSSL</key>
            <true/>
            <key>OutgoingMailServerUsername</key>
            <string>juanchavez4@example.com</string>
            <key>OutgoingPassword</key>
            <string>Password123</string>
            <key>OutgoingPasswordSameAsIncomingPassword</key>
            <false/>
            <key>SMIMEEnablePerMessageSwitch</key>
            <false/>
            <key>SMIMEEnabled</key>
            <false/>
            <key>SMIMEEncryptionEnabled</key>
            <false/>
            <key>SMIMESigningEnabled</key>
            <false/>
            <key>allowMailDrop</key>
            <false/>
            <key>disableMailRecentsSyncing</key>
            <false/>
            <key>PayloadIdentifier</key>
            <string>com.example.mymailpayload</string>
            <key>PayloadType</key>
            <string>com.apple.mail.managed</string>
            <key>PayloadUUID</key>
            <string>d6379d8d-9e05-4d99-80bc-0865f1fe0aca</string>
            <key>PayloadVersion</key>
            <integer>1</integer>
        </dict>
    </array>
    <key>PayloadDisplayName</key>
    <string>Mail</string>
    <key>PayloadIdentifier</key>
    <string>com.example.myprofile</string>
    <key>PayloadType</key>
    <string>Configuration</string>
    <key>PayloadUUID</key>
    <string>8e1961d8-898e-4d79-986f-c7a61af4103c</string>
    <key>PayloadVersion</key>
    <integer>1</integer>
</dict>
</plist>

See Also

Mail