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)

Showing 43 of 43 keys

KeyTypeDescriptionDefaultRange
UserNamestring

User

stringThis user name for this Exchange account. Required for noninteractive installations like MDM in iOS.Default: —Range: —

Email address

stringThe full email address for the account. If not present in the payload, the device prompts for this string during profile installation.Default: —Range: —
Passwordstring

Password

stringThe password of the account. Use only with encrypted profiles.Default: —Range: —

Override previous password

iOS 14.0+

booleanIf 'true', the system overrides the previous user/EAS password with the new EAS password in the payload.Default: falseRange: —
Hoststring

Exchange ActiveSync host

required
stringThe Exchange server host name or IP address.Default: —Range: —
SSLboolean

Use SSL

booleanIf 'true', the system enables SSL for authentication.Default: falseRange: —
OAuthboolean

Use OAuth

iOS 12.0+

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

Authentication credential

iOS 7.0+

dataThe '.p12' identity certificate in NSData blob format, for accounts that allow authentication via certificate.Default: —Range: —

Authentication credential name

iOS 7.0+

stringThe name or description of the certificate.Default: —Range: —

Authentication credential password

stringThe password necessary for the '.p12' identity certificate. Used with mandatory encryption of profiles.Default: —Range: —

Prevent move

iOS 5.0+

booleanIf '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: falseRange: —

Prevent app sheet

iOS 5.0+

booleanIf 'true', prevents this account from sending mail in any app other than the Apple Mail app.Default: falseRange: —

Payload certificate UUID

stringThe 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.Default: —Range: —

S/MIME enabled

iOS 5.0+ · deprecated 10.0 · not on visionOS

deprecated
booleanIf 'true', the system enables S/MIME encryption. In iOS 10.0 and later, this key is ignored. Use 'SMIMESigningEnabled' instead.Default: falseRange: —

S/MIME signing enabled

iOS 10.3+

booleanIf 'true', the system enables S/MIME signing for this account.Default: falseRange: —

S/MIME signing certificate

iOS 5.0+

stringThe UUID of the identity certificate used to sign messages sent from this account.Default: —Range: —

S/MIME encryption enabled

iOS 10.3+ · deprecated 12.0 · not on visionOS

deprecated
booleanIf 'true', the system enables S/MIME encryption for this account. This key is deprecated. Use 'SMIMEEncryptByDefault' instead.Default: falseRange: —

S/MIME encryption certificate

iOS 5.0+

stringThe 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.Default: —Range: —

S/MIME enable per-message switch

iOS 8.0+ · deprecated 12.0 · not on visionOS

deprecated
booleanIf 'true', the system displays the per-message encryption switch in the Mail Compose UI. This key is deprecated. Use 'SMIMEEnableEncryptionPerMessageSwitch' instead.Default: falseRange: —

Allow user to toggle S/MIME Signing

iOS 12.0+

booleanIf 'true', the user can turn S/MIME signing on or off in Settings.Default: falseRange: —

Allow user to select S/MIME Identity

iOS 12.0+

booleanIf 'true', the user can select the signing identity.Default: falseRange: —

Enable S/MIME Encryption

iOS 12.0+

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

Allow user to select S/MIME Encryption

iOS 12.0+

booleanIf 'true', the system enables encryption by default and the user can't change it.Default: falseRange: —

Allow user to select S/MIME Encryption Certificate

iOS 12.0+

booleanIf 'true', the user can select the S/MIME encryption identity, and encryption is on.Default: falseRange: —

Allow user to select S/MIME Encryption per message

iOS 12.0+

booleanIf 'true', the system displays the per-message encryption switch in the Mail Compose UI.Default: falseRange: —

Enabled Services - Calendars

iOS 13.0+

booleanIf '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: trueRange: —

Enabled Services - Contacts

iOS 13.0+

booleanIf '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: trueRange: —
EnableMailboolean

Enabled Services - Mail

iOS 13.0+

booleanIf '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: trueRange: —

Enabled Services - Notes

iOS 13.0+

booleanIf '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: trueRange: —

Enabled Services - Reminders

iOS 13.0+

booleanIf '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: trueRange: —

Account Modification - Calendars

iOS 13.0+

booleanIf 'false', the system prevents the user from changing the state of the Calendars service for this account in Settings.Default: trueRange: —

Account Modification - Contacts

iOS 13.0+

booleanIf 'false', the system prevents the user from changing the state of the Contacts service for this account in Settings.Default: trueRange: —

Account Modification - Mail

iOS 13.0+

booleanIf 'false', the system prevents the user from changing the state of the Mail service for this account in Settings.Default: trueRange: —

Account Modification - Notes

iOS 13.0+

booleanIf 'false', prevents the user from changing the state of the Notes service for this account in Settings.Default: trueRange: —

Account Modification - Reminders

iOS 13.0+

booleanIf 'false', the system prevents the user from changing the state of the Reminders service for this account in Settings.Default: trueRange: —

Disable mail recents syncing

booleanIf 'true', the system excludes this account from Recent Addresses syncing.Default: falseRange: —

Past days of mail to sync

integerThe number of days in the past to sync mail on the device. For no limit, use the value '0'.Default: 7Range: No Limit (0), 1 (1), 3 (3), 7 (7), 14 (14), 31 (31)

Communication service rules

iOS 10.0+

dictThe communication service handler rules for this account.Default: —Range: —

Default service handlers

iOS 10.0+

dictThe default handlers to use for contacts from this account.Default: —Range: —
AudioCallstring

App for audio calls

iOS 10.0+

stringThe bundle identifier of the default application to use for audio calls made to contacts from this account.Default: —Range: —
VPNUUIDstring

VPNUUID

iOS 14.0+

stringThe VPNUUID of the per-app VPN the account uses for network communication.Default: —Range: —

iOS · deprecated 7.0 · not on visionOS

deprecated
stringThe value of the 'X-Apple-Config-Magic' header in each EAS HTTP request.Default: —Range: —

Allow mail drop

iOS 9.2+

booleanIf 'true', the system enables this account to use Mail Drop.Default: falseRange: —

iOS 13.0+

stringThe 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.Default: —Range: —

iOS 13.0+

stringThe URL that this account should use for token requests through OAuth. Ignored unless 'OAuth' is 'true'.Default: —Range: —