apple_device-management/mdm/profiles/com.apple.mail.managed.yaml

title: Mail
description: The payload that configures a Mail account.
payload:
  payloadtype: com.apple.mail.managed
  supportedOS:
    iOS:
      introduced: '4.0'
      multiple: true
      supervised: false
      allowmanualinstall: true
      sharedipad:
        mode: allowed
        devicechannel: false
        userchannel: true
      userenrollment:
        mode: allowed
    macOS:
      introduced: '10.7'
      multiple: true
      devicechannel: false
      userchannel: true
      supervised: false
      requiresdep: false
      userapprovedmdm: false
      allowmanualinstall: true
      userenrollment:
        mode: allowed
    tvOS:
      introduced: n/a
    visionOS:
      introduced: '1.1'
      multiple: true
      supervised: false
      allowmanualinstall: true
      userenrollment:
        mode: allowed
    watchOS:
      introduced: n/a
  content: An email payload creates an email account on the device.
payloadkeys:
- key: EmailAccountDescription
  title: Account description
  type: <string>
  presence: optional
  content: A user-visible description of the email account, shown in the Mail and
    Settings applications.
- key: EmailAccountName
  title: Account name
  type: <string>
  presence: optional
  content: The full user name for the account. The system displays this name in sent
    messages.
- key: EmailAccountType
  title: Account type
  type: <string>
  presence: required
  rangelist:
  - EmailTypeIMAP
  - EmailTypePOP
  content: Defines the protocol to use for the account.
- key: EmailAddress
  title: Email address
  type: <string>
  presence: optional
  content: 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.
- key: IncomingMailServerAuthentication
  title: Incoming mail server authentication
  type: <string>
  presence: required
  rangelist:
  - EmailAuthNone
  - EmailAuthPassword
  - EmailAuthCRAMMD5
  - EmailAuthNTLM
  - EmailAuthHTTPMD5
  content: The authentication scheme for incoming mail.
- key: IncomingMailServerHostName
  title: Mail server
  type: <string>
  presence: required
  content: The incoming mail server host name.
- key: IncomingMailServerPortNumber
  title: Port
  type: <integer>
  presence: optional
  content: The incoming mail server port number. If not set, the system uses the default
    port for a given protocol.
- key: IncomingMailServerUseSSL
  title: Use SSL
  type: <boolean>
  presence: optional
  default: false
  content: If `true`, the system enables SSL for authentication on the incoming mail
    server.
- key: IncomingMailServerUsername
  title: Username
  type: <string>
  presence: optional
  content: 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.
- key: IncomingPassword
  title: Password
  type: <string>
  presence: optional
  content: The password for the incoming mail server. Only use this in encrypted profiles.
- key: OutgoingPassword
  title: Password
  type: <string>
  presence: optional
  content: The password for the outgoing mail server. Only use this in encrypted profiles.
- key: OutgoingPasswordSameAsIncomingPassword
  title: Outgoing password same as incoming
  type: <boolean>
  presence: optional
  default: false
  content: |-
    If `true`, the system prompts the user only once for the password, which it uses for both outgoing and incoming mail.

    This setting supports only interactive profile installations. Non-interactive installations, such as MDM on iOS, don't support this setting.
- key: OutgoingMailServerAuthentication
  title: Authentication type
  type: <string>
  presence: required
  rangelist:
  - EmailAuthNone
  - EmailAuthPassword
  - EmailAuthCRAMMD5
  - EmailAuthNTLM
  - EmailAuthHTTPMD5
  content: The authentication scheme for outgoing mail.
- key: OutgoingMailServerHostName
  title: Mail server
  type: <string>
  presence: required
  content: The outgoing mail server host name.
- key: OutgoingMailServerPortNumber
  title: Port
  type: <integer>
  presence: optional
  content: The outgoing mail server port number. If not set, the system uses ports
    25, 587, and 465, in that order.
- key: OutgoingMailServerUseSSL
  title: Use SSL
  type: <boolean>
  presence: optional
  default: false
  content: If `true`, the system enables SSL authentication on the outgoing mail server.
- key: OutgoingMailServerUsername
  title: Username
  type: <string>
  presence: optional
  content: 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.
- key: PreventMove
  title: Prevent move
  supportedOS:
    iOS:
      introduced: '5.0'
    macOS:
      introduced: n/a
  type: <boolean>
  presence: optional
  default: false
  content: 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.
- key: PreventAppSheet
  title: Prevent app sheet
  supportedOS:
    iOS:
      introduced: '5.0'
    macOS:
      introduced: n/a
  type: <boolean>
  presence: optional
  default: false
  content: If `true`, the system prevents this account from sending mail in any app
    other than the Apple Mail app.
- key: SMIMEEnabled
  title: S/MIME enabled
  supportedOS:
    iOS:
      introduced: '5.0'
    macOS:
      introduced: n/a
  type: <boolean>
  presence: optional
  default: false
  content: If `true`, the system enables S/MIME encryption. The system ignores this
    key in iOS 10.0 and later.
- key: SMIMESigningEnabled
  title: S/MIME signing enabled
  supportedOS:
    iOS:
      introduced: '10.0'
    macOS:
      introduced: n/a
  type: <boolean>
  presence: optional
  default: false
  content: If `true`, the system enables S/MIME signing for this account.
- key: SMIMESigningCertificateUUID
  title: S/MIME signing certificate
  supportedOS:
    iOS:
      introduced: '5.0'
    macOS:
      introduced: n/a
  type: <string>
  presence: optional
  format: ^[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-[0-9A-Za-z]{4}-[0-9A-Za-z]{4}-[0-9A-Za-z]{12}$
  content: The payload UUID of the identity certificate used to sign messages sent
    from this account.
- key: SMIMEEncryptionEnabled
  title: S/MIME encryption enabled
  supportedOS:
    iOS:
      introduced: '10.0'
    macOS:
      introduced: n/a
  type: <boolean>
  presence: optional
  default: false
  content: If `true`, the system enables S/MIME encryption for this account.
- key: SMIMEEncryptionCertificateUUID
  title: S/MIME encryption certificate
  supportedOS:
    iOS:
      introduced: '5.0'
    macOS:
      introduced: n/a
  type: <string>
  presence: optional
  format: ^[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-[0-9A-Za-z]{4}-[0-9A-Za-z]{4}-[0-9A-Za-z]{12}$
  content: 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.
- key: SMIMEEnablePerMessageSwitch
  title: S/MIME enable per-message switch
  supportedOS:
    iOS:
      introduced: '8.0'
      deprecated: '10.0'
    macOS:
      introduced: n/a
    visionOS:
      introduced: n/a
  type: <boolean>
  presence: optional
  default: false
  content: If `true`, the system displays the per-message encryption switch in the
    Mail Compose UI. Deprecated in iOS 12.0. Use `SMIMEEnableEncryptionPerMessageSwitch`
    instead.
- key: disableMailRecentsSyncing
  title: Disable mail recents syncing
  supportedOS:
    iOS:
      introduced: '6.0'
  type: <boolean>
  presence: optional
  default: false
  content: If `true`, the system excludes this account from Recent Addresses syncing.
- key: allowMailDrop
  title: Allow mail drop
  supportedOS:
    iOS:
      introduced: '9.2'
    macOS:
      introduced: '10.12'
  type: <boolean>
  presence: optional
  default: false
  content: If `true`, the system enables this account to use Mail Drop.
- key: IncomingMailServerIMAPPathPrefix
  title: Path prefix
  type: <string>
  presence: optional
  content: The path prefix for the IMAP mail server.
- key: SMIMESigningUserOverrideable
  supportedOS:
    iOS:
      introduced: '12.0'
    macOS:
      introduced: n/a
  type: <boolean>
  presence: optional
  default: false
  content: If `true`, the user can turn S/MIME signing on or off in Settings.
- key: SMIMESigningCertificateUUIDUserOverrideable
  supportedOS:
    iOS:
      introduced: '12.0'
    macOS:
      introduced: n/a
  type: <boolean>
  presence: optional
  default: false
  content: If `true`, the user can select the signing identity.
- key: SMIMEEncryptByDefault
  supportedOS:
    iOS:
      introduced: '12.0'
    macOS:
      introduced: n/a
  type: <boolean>
  presence: optional
  default: false
  content: If `true`, the system enables S/MIME encryption by default.
- key: SMIMEEncryptByDefaultUserOverrideable
  supportedOS:
    iOS:
      introduced: '12.0'
    macOS:
      introduced: n/a
  type: <boolean>
  presence: optional
  default: false
  content: If `true`, the user can turn encryption by default on/off, and encryption
    is on.
- key: SMIMEEncryptionCertificateUUIDUserOverrideable
  supportedOS:
    iOS:
      introduced: '12.0'
    macOS:
      introduced: n/a
  type: <boolean>
  presence: optional
  default: false
  content: If `true`, the user can select the S/MIME encryption identity, and encryption
    is on.
- key: SMIMEEnableEncryptionPerMessageSwitch
  supportedOS:
    iOS:
      introduced: '12.0'
    macOS:
      introduced: n/a
  type: <boolean>
  presence: optional
  default: false
  content: If `true`, the system displays the per-message encryption switch in the
    Mail Compose UI.
- key: VPNUUID
  title: VPNUUID
  supportedOS:
    iOS:
      introduced: '14.0'
    macOS:
      introduced: n/a
  type: <string>
  presence: optional
  content: The VPNUUID of the per-app VPN the account uses for network communication.
examples:
- title: Profile example
  files:
  - file: examples/mdm/profiles/com.apple.mail.managed/example1.plist