PayloadKit

Exchange ActiveSync

com.apple.eas.account

The payload that configures Exchange ActiveSync accounts.

iOS 4.0+visionOS 1.1+
Apple schemacombined

Configuration Keys (43)

KeyTypeTitle
UserName

This user name for this Exchange account. Required for noninteractive installations like MDM in iOS.

stringUser
EmailAddress

The full email address for the account. If not present in the payload, the device prompts for this string during profile installation.

stringEmail address
Password

The password of the account. Use only with encrypted profiles.

stringPassword
OverridePreviousPassword

iOS 14.0+

If 'true', the system overrides the previous user/EAS password with the new EAS password in the payload.

Default: false

booleanOverride previous password
Hostrequired

The Exchange server host name or IP address.

stringExchange ActiveSync host
SSL

If 'true', the system enables SSL for authentication.

Default: false

booleanUse SSL
OAuth

iOS 12.0+

If 'true', enables OAuth for authentication. If enabled, don't specify a password. Available only in iOS 12.0 and above.

Default: false

booleanUse OAuth
Certificate

iOS 7.0+

The '.p12' identity certificate in NSData blob format, for accounts that allow authentication via certificate.

dataAuthentication credential
CertificateName

iOS 7.0+

The name or description of the certificate.

stringAuthentication credential name
CertificatePassword

The password necessary for the '.p12' identity certificate. Used with mandatory encryption of profiles.

stringAuthentication credential password
PreventMove

iOS 5.0+

If 'true', the system prevents moving messages from out of this email account into another account. This setting also prevents forwarding or replying from an account other than the recipient of the message.

Default: false

booleanPrevent move
PreventAppSheet

iOS 5.0+

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

Default: false

booleanPrevent app sheet
PayloadCertificateUUID

The UUID of the certificate payload within the same profile to use for the identity credential. If this field is present, the Certificate field isn't used.

stringPayload certificate UUID
SMIMEEnableddeprecated

iOS 5.0+ · deprecated 10.0 · not on visionOS

If 'true', the system enables S/MIME encryption. In iOS 10.0 and later, this key is ignored. Use 'SMIMESigningEnabled' instead.

Default: false

booleanS/MIME enabled
SMIMESigningEnabled

iOS 10.3+

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

Default: false

booleanS/MIME signing enabled
SMIMESigningCertificateUUID

iOS 5.0+

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

stringS/MIME signing certificate
SMIMEEncryptionEnableddeprecated

iOS 10.3+ · deprecated 12.0 · not on visionOS

If 'true', the system enables S/MIME encryption for this account. This key is deprecated. Use 'SMIMEEncryptByDefault' instead.

Default: false

booleanS/MIME encryption enabled
SMIMEEncryptionCertificateUUID

iOS 5.0+

The payload 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 the user's Sent mailbox.

stringS/MIME encryption certificate
SMIMEEnablePerMessageSwitchdeprecated

iOS 8.0+ · deprecated 12.0 · not on visionOS

If 'true', the system displays the per-message encryption switch in the Mail Compose UI. This key is deprecated. Use 'SMIMEEnableEncryptionPerMessageSwitch' instead.

Default: false

booleanS/MIME enable per-message switch
SMIMESigningUserOverrideable

iOS 12.0+

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

Default: false

booleanAllow user to toggle S/MIME Signing
SMIMESigningCertificateUUIDUserOverrideable

iOS 12.0+

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

Default: false

booleanAllow user to select S/MIME Identity
SMIMEEncryptByDefault

iOS 12.0+

If 'true', the system enables S/MIME encryption by default. If 'SMIMEEnableEncryptionPerMessageSwitch' is 'false', the user can't change this default.

Default: false

booleanEnable S/MIME Encryption
SMIMEEncryptByDefaultUserOverrideable

iOS 12.0+

If 'true', the system enables encryption by default and the user can't change it.

Default: false

booleanAllow user to select S/MIME Encryption
SMIMEEncryptionCertificateUUIDUserOverrideable

iOS 12.0+

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

Default: false

booleanAllow user to select S/MIME Encryption Certificate
SMIMEEnableEncryptionPerMessageSwitch

iOS 12.0+

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

Default: false

booleanAllow user to select S/MIME Encryption per message
EnableCalendars

iOS 13.0+

If 'false', the system disables the Calendars service for this account. The user can reenable Calendars service in Settings unless 'EnableCalendarsUserOverridable' is 'false'. Note: At least of the following fields needs to be 'true': 'EnableMail', 'EnableContacts', 'EnableCalendars', 'EnableReminders', and 'EnableNotes'.

Default: true

booleanEnabled Services - Calendars
EnableContacts

iOS 13.0+

If 'false', the system disables the Contacts service for this account. The user can reenable Contacts service in Settings unless 'EnableContactsUserOverridable' is 'false'. Note: At least of the following fields needs to be 'true': 'EnableMail', 'EnableContacts', 'EnableCalendars', 'EnableReminders', and 'EnableNotes'.

Default: true

booleanEnabled Services - Contacts
EnableMail

iOS 13.0+

If 'false', the system disables the Mail service for this account. The user can reenable Mail service in Settings unless 'EnableMailUserOverridable' is 'false'. Note: At least of the following fields needs to be 'true': 'EnableMail', 'EnableContacts', 'EnableCalendars', 'EnableReminders', and 'EnableNotes'.

Default: true

booleanEnabled Services - Mail
EnableNotes

iOS 13.0+

If 'false', the system disables the Notes service for this account. The user can reenable Notes service in Settings unless 'EnableNotesUserOverridable' is 'false'. Note: At least of the following fields needs to be 'true': 'EnableMail', 'EnableContacts', 'EnableCalendars', 'EnableReminders', and 'EnableNotes'.

Default: true

booleanEnabled Services - Notes
EnableReminders

iOS 13.0+

If 'false', the system disables the Reminders service for this account. The user can reenable Reminders service in Settings unless 'EnableRemindersUserOverridable' is 'false'. Note: At least of the following fields needs to be 'true': 'EnableMail', 'EnableContacts', 'EnableCalendars', 'EnableReminders', and 'EnableNotes'.

Default: true

booleanEnabled Services - Reminders
EnableCalendarsUserOverridable

iOS 13.0+

If 'false', the system prevents the user from changing the state of the Calendars service for this account in Settings.

Default: true

booleanAccount Modification - Calendars
EnableContactsUserOverridable

iOS 13.0+

If 'false', the system prevents the user from changing the state of the Contacts service for this account in Settings.

Default: true

booleanAccount Modification - Contacts
EnableMailUserOverridable

iOS 13.0+

If 'false', the system prevents the user from changing the state of the Mail service for this account in Settings.

Default: true

booleanAccount Modification - Mail
EnableNotesUserOverridable

iOS 13.0+

If 'false', prevents the user from changing the state of the Notes service for this account in Settings.

Default: true

booleanAccount Modification - Notes
EnableRemindersUserOverridable

iOS 13.0+

If 'false', the system prevents the user from changing the state of the Reminders service for this account in Settings.

Default: true

booleanAccount Modification - Reminders
disableMailRecentsSyncing

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

Default: false

booleanDisable mail recents syncing
MailNumberOfPastDaysToSync

The number of days in the past to sync mail on the device. For no limit, use the value '0'.

Default: 7

Range: No Limit (0), 1 (1), 3 (3), 7 (7), 14 (14), 31 (31)

integerPast days of mail to sync
CommunicationServiceRules

iOS 10.0+

The communication service handler rules for this account.

dictCommunication service rules
DefaultServiceHandlers

iOS 10.0+

The default handlers to use for contacts from this account.

dictDefault service handlers
AudioCall

iOS 10.0+

The bundle identifier of the default application to use for audio calls made to contacts from this account.

stringApp for audio calls
VPNUUID

iOS 14.0+

The VPNUUID of the per-app VPN the account uses for network communication.

stringVPNUUID
HeaderMagicdeprecated

iOS · deprecated 7.0 · not on visionOS

The value of the 'X-Apple-Config-Magic' header in each EAS HTTP request.

string—
allowMailDrop

iOS 9.2+

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

Default: false

booleanAllow mail drop
OAuthSignInURL

iOS 13.0+

The URL that this account should use for signing in through OAuth. Ignored unless 'OAuth' is 'true'. If you specify this URL, auto-discovery isn't used for this account, so you need to also specify a host.

string—
OAuthTokenRequestURL

iOS 13.0+

The URL that this account should use for token requests through OAuth. Ignored unless 'OAuth' is 'true'.

string—