Exchange¶
Template
In iOS, the Exchange payload is designated by specifying com.apple.eas.account as the PayloadType value. This payload configures an Exchange Active Sync account on the device.
In macOS, the Exchange payload is designated by specifying com.apple.ews.account as the PayloadType value. This payload will configure an Exchange Web Services account for Contacts, Mail, Notes, Reminders, and Calendar.
Note
As with VPN and Wi-Fi configurations, it is possible to associate an SCEP credential with an Exchange configuration via the PayloadCertificateUUID key.
Contents
- Exchange
- Summary
- Keys
- Certificate
- CertificateName
- CertificatePassword
- PayloadCertificateUUID
- Host
- MailNumberOfPastDaysToSync
- SSL
- EmailAddress
- UserName
- Password
- PreventMove
- PreventAppSheet
- allowMailDrop
- SMIMEEnabled
- SMIMEEnablePerMessageSwitch
- SMIMESigningCertificateUUID
- SMIMEEncryptionCertificateUUID
- disableMailRecentsSyncing
- CommunicationServiceRules
- Links
Summary¶
| PayloadType: | com.apple.eas.account |
|---|---|
| Supervised Only: | |
| N/A | |
| macOS: | N/A |
| macOS Deprecated: | |
| N/A | |
| iOS: | N/A |
| iOS Deprecated: | N/A |
| Highlander: | N/A |
Keys¶
Certificate¶
Authentication Credential
For accounts that allow authentication via certificate, a p12 identity certificate in NSData blob format DEPRECATED
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| data | N/A | N/A | N/A | N/A | N/A | N/A |
CertificateName¶
Authentication Credential Name
Name or description of the credential for ActiveSync DEPRECATED
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| string | N/A | N/A | N/A | N/A | N/A | N/A |
CertificatePassword¶
Authentication Credential Password
The password necessary for the p12 identity certificate. Use only with encrypted profiles DEPRECATED
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| string | N/A | N/A | N/A | N/A | N/A | N/A |
PayloadCertificateUUID¶
Payload Certificate UUID
UUID of the certificate to use for authentication
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| string | N/A | N/A | ^[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}$ | N/A | N/A | N/A |
Host¶
Exchange ActiveSync Host
The Exchange server host name or IP address
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| string | N/A | always | N/A | N/A | N/A | N/A |
MailNumberOfPastDaysToSync¶
Past Days of Mail to Sync
The number of past days of mail to synchronize
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| integer | 7 | N/A | N/A | N/A | N/A | N/A |
SSL¶
Use SSL
Send all communication through Secure Socket Layer
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| boolean | True | N/A | N/A | N/A | N/A | N/A |
EmailAddress¶
Email Address
The address of the account (e.g. “john@company.com)
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| string | N/A | push | N/A | N/A | N/A | N/A |
UserName¶
User
User for the account. Domain and User must be blank for device to prompt for user
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| string | N/A | push | N/A | N/A | N/A | N/A |
Password¶
Password
The password for the account
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| string | N/A | N/A | N/A | N/A | N/A | N/A |
PreventMove¶
Prevent Move
If set to true, messages may not be moved out of this email account into another account.
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| boolean | N/A | N/A | N/A | N/A | N/A | N/A |
PreventAppSheet¶
Prevent App Sheet
If set to true, this account will not be available for sending mail in third party applications
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| boolean | N/A | N/A | N/A | N/A | N/A | N/A |
allowMailDrop¶
Allow Mail Drop
If set to true, this account is allowed to use Mail Drop.
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| boolean | N/A | N/A | N/A | N/A | N/A | N/A |
SMIMEEnabled¶
S/MIME Enabled
If set to true, this account will support S/MIME
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| boolean | N/A | N/A | N/A | 5.0 | N/A | N/A |
SMIMEEnablePerMessageSwitch¶
S/MIME Enable Per-Message Switch
If set to true, enable the per-message encryption switch. DEPRECATED: Use SMIMEEnableEncryptionPerMessageSwitch
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| boolean | False | N/A | N/A | 8.0 | N/A | N/A |
SMIMESigningCertificateUUID¶
S/MIME Signing Certificate
The PayloadUUID of the identity certificate used to sign messages sent from this account.
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| string | N/A | N/A | ^[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}$ | 5.0 | N/A | N/A |
SMIMEEncryptionCertificateUUID¶
S/MIME Encryption Certificate
The PayloadUUID of the identity certificate used to decrypt messages coming into this account.
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| string | N/A | N/A | ^[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}$ | 5.0 | N/A | N/A |
disableMailRecentsSyncing¶
Disable Mail Recents Syncing
If set to true, this account is excluded from address Recents syncing.
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| boolean | False | N/A | N/A | 6.0 | N/A | N/A |
CommunicationServiceRules¶
Communication Service Rules
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| dictionary | N/A | N/A | N/A | N/A | N/A | N/A |