--- title: Mail framework: devicemanagement role: symbol role_heading: Device Management Profile path: devicemanagement/mail --- # Mail The payload that configures a Mail account. ## Declaration ```data object Mail ``` ## Properties allowMailDrop: If true, the system enables this account to use Mail Drop. Available: iOS 9.2+ | iPadOS 9.2+ | macOS 10.12+ | visionOS 1.1+ disableMailRecentsSyncing: If true, the system excludes this account from Recent Addresses syncing. Available: iOS 6+ | iPadOS 6+ | macOS 10.7+ | visionOS 1.1+ EmailAccountDescription: A user-visible description of the email account, shown in the Mail and Settings applications. EmailAccountName: The full user name for the account. The system displays this name in sent messages. EmailAccountType: Defines the protocol to use for the account. 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. IncomingMailServerAuthentication: The authentication scheme for incoming mail. IncomingMailServerHostName: The incoming mail server host name. IncomingMailServerIMAPPathPrefix: The path prefix for the IMAP mail server. IncomingMailServerPortNumber: The incoming mail server port number. If not set, the system uses the default port for a given protocol. 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. IncomingMailServerUseSSL: If true, the system enables SSL for authentication on the incoming mail server. IncomingPassword: The password for the incoming mail server. Only use this in encrypted profiles. OutgoingMailServerAuthentication: The authentication scheme for outgoing mail. OutgoingMailServerHostName: The outgoing mail server host name. OutgoingMailServerPortNumber: The outgoing mail server port number. If not set, the system uses ports 25, 587, and 465, in that order. 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. OutgoingMailServerUseSSL: If true, the system enables SSL authentication on the outgoing mail server. OutgoingPassword: The password for the outgoing mail server. Only use this in encrypted profiles. 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. PreventAppSheet: If true, the system prevents this account from sending mail in any app other than the Apple Mail app. Available: iOS 5+ | iPadOS 5+ | visionOS 1.1+ 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. Available: iOS 5+ | iPadOS 5+ | visionOS 1.1+ SMIMEEnabled: If true, the system enables S/MIME encryption. The system ignores this key in iOS 10.0 and later. Available: iOS 5+ | iPadOS 5+ | visionOS 1.1+ SMIMEEnableEncryptionPerMessageSwitch: If true, the system displays the per-message encryption switch in the Mail Compose UI. Available: iOS 12+ | iPadOS 12+ | visionOS 1.1+ SMIMEEnablePerMessageSwitch: If true, the system displays the per-message encryption switch in the Mail Compose UI. Deprecated in iOS 12.0. Use SMIMEEnableEncryptionPerMessageSwitch instead. Available: iOS 8+ | iPadOS 8+ Deprecated: iOS 10+ | iPadOS 10+ SMIMEEncryptByDefault: If true, the system enables S/MIME encryption by default. Available: iOS 12+ | iPadOS 12+ | visionOS 1.1+ SMIMEEncryptByDefaultUserOverrideable: If true, the user can turn encryption by default on/off, and encryption is on. Available: iOS 12+ | iPadOS 12+ | visionOS 1.1+ 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. Available: iOS 5+ | iPadOS 5+ | visionOS 1.1+ SMIMEEncryptionCertificateUUIDUserOverrideable: If true, the user can select the S/MIME encryption identity, and encryption is on. Available: iOS 12+ | iPadOS 12+ | visionOS 1.1+ SMIMEEncryptionEnabled: If true, the system enables S/MIME encryption for this account. Available: iOS 10+ | iPadOS 10+ | visionOS 1.1+ SMIMESigningCertificateUUID: The payload UUID of the identity certificate used to sign messages sent from this account. Available: iOS 5+ | iPadOS 5+ | visionOS 1.1+ SMIMESigningCertificateUUIDUserOverrideable: If true, the user can select the signing identity. Available: iOS 12+ | iPadOS 12+ | visionOS 1.1+ SMIMESigningEnabled: If true, the system enables S/MIME signing for this account. Available: iOS 10+ | iPadOS 10+ | visionOS 1.1+ SMIMESigningUserOverrideable: If true, the user can turn S/MIME signing on or off in Settings. Available: iOS 12+ | iPadOS 12+ | visionOS 1.1+ VPNUUID: The VPNUUID of the per-app VPN the account uses for network communication. Available: iOS 14+ | iPadOS 14+ | visionOS 1.1+ ## Discussion Discussion Specify com.apple.mail.managed as the payload type. Profile availability | | | | | | | | Profile example PayloadContent EmailAccountDescription Company Mail Account EmailAccountName Juan Chavez EmailAccountType EmailTypeIMAP EmailAddress juanchavez4@example.com IncomingMailServerAuthentication EmailAuthPassword IncomingMailServerHostName imap.example.com IncomingMailServerPortNumber 993 IncomingMailServerUseSSL IncomingMailServerUsername juanchavez4@example.com IncomingPassword Password123 OutgoingMailServerAuthentication EmailAuthPassword OutgoingMailServerHostName smtp.example.com OutgoingMailServerPortNumber 587 OutgoingMailServerUseSSL OutgoingMailServerUsername juanchavez4@example.com OutgoingPassword Password123 OutgoingPasswordSameAsIncomingPassword SMIMEEnablePerMessageSwitch SMIMEEnabled SMIMEEncryptionEnabled SMIMESigningEnabled allowMailDrop disableMailRecentsSyncing PayloadIdentifier com.example.mymailpayload PayloadType com.apple.mail.managed PayloadUUID d6379d8d-9e05-4d99-80bc-0865f1fe0aca PayloadVersion 1 PayloadDisplayName Mail PayloadIdentifier com.example.myprofile PayloadType Configuration PayloadUUID 8e1961d8-898e-4d79-986f-c7a61af4103c PayloadVersion 1 ## See Also ### Mail - [ExchangeActiveSync](devicemanagement/exchangeactivesync.md) - [ExchangeWebServices](devicemanagement/exchangewebservices.md)