Contents

ExchangeActiveSync

The payload that configures Exchange ActiveSync accounts.

Declaration

object ExchangeActiveSync

Properties

NameTypeDescription
allowMailDropboolean

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

Certificatedata

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

CertificateNamestring

The name or description of the certificate.

CertificatePasswordstring

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

CommunicationServiceRulesExchangeActiveSync.CommunicationServiceRules

The communication service handler rules for this account.

disableMailRecentsSyncingboolean

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

EmailAddressstring

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

EnableCalendarsboolean

If false, the system disables the Calendars service for this account. The user can reenable Calendars service in Settings unless EnableCalendarsUserOverridable is false.

EnableCalendarsUserOverridableboolean

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

EnableContactsboolean

If false, the system disables the Contacts service for this account. The user can reenable Contacts service in Settings unless EnableContactsUserOverridable is false.

EnableContactsUserOverridableboolean

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

EnableMailboolean

If false, the system disables the Mail service for this account. The user can reenable Mail service in Settings unless EnableMailUserOverridable is false.

EnableMailUserOverridableboolean

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

EnableNotesboolean

If false, the system disables the Notes service for this account. The user can reenable Notes service in Settings unless EnableNotesUserOverridable is false.

EnableNotesUserOverridableboolean

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

EnableRemindersboolean

If false, the system disables the Reminders service for this account. The user can reenable Reminders service in Settings unless EnableRemindersUserOverridable is false.

EnableRemindersUserOverridableboolean

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

HeaderMagicstring

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

Hoststring

The Exchange server host name or IP address.

MailNumberOfPastDaysToSyncinteger

The number of days in the past to sync mail on the device.

For no limit, use the value 0.

OAuthboolean

If true, enables OAuth for authentication. If enabled, don’t specify a password.

Available only in iOS 12.0 and above.

OAuthSignInURLstring

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.

OAuthTokenRequestURLstring

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

OverridePreviousPasswordboolean

If true, the system overrides the previous user/EAS password with the new EAS password in the payload. Available in iOS 14 and later.

Passwordstring

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

PayloadCertificateUUIDstring

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.

PreventAppSheetboolean

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

PreventMoveboolean

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.

SMIMEEnabledboolean

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

SMIMEEnableEncryptionPerMessageSwitchboolean

If true, the system displays the per-message encryption switch in the Mail Compose UI. Available in iOS 12.0 and later.

SMIMEEnablePerMessageSwitchboolean

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

Available in iOS 8.0 and later. As of iOS 12.0, this key is deprecated. Use SMIMEEnableEncryptionPerMessageSwitch instead.

SMIMEEncryptByDefaultboolean

If true, the system enables S/MIME encryption by default. If SMIMEEnableEncryptionPerMessageSwitch is false, the user can’t change this default. Available in iOS 12.0 and later.

SMIMEEncryptByDefaultUserOverrideableboolean

If true, the system enables encryption by default and the user can’t change it. Available in iOS 12.0 and later.

SMIMEEncryptionCertificateUUIDstring

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.

SMIMEEncryptionCertificateUUIDUserOverrideableboolean

If true, the user can select the S/MIME encryption identity, and encryption is on.Available in iOS 12.0 and later.

SMIMEEncryptionEnabledboolean

If true, the system enables S/MIME encryption for this account. Available in iOS 10.0 and later. As of iOS 12.0, this key is deprecated. Use SMIMEEncryptByDefault instead.

SMIMESigningCertificateUUIDstring

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

SMIMESigningCertificateUUIDUserOverrideableboolean

If true, the user can select the signing identity. Available in iOS 12.0 and later.

SMIMESigningEnabledboolean

If true, the system enables S/MIME signing for this account. Available in iOS 10.0 and later.

SMIMESigningUserOverrideableboolean

If true, the user can turn S/MIME signing on or off in Settings. Available in iOS 12.0 and later.

SSLboolean

If true, the system enables SSL for authentication.

UserNamestring

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

VPNUUIDstring

The VPNUUID of the per-app VPN the account uses for network communication. Available in iOS 14 and later.

Discussion

Specify com.apple.eas.account as the payload type.

Profile availability

Device channel

iOS, visionOS

User channel

Shared iPad

Allow manual install

iOS, visionOS

Requires supervision

NA

Requires user-approved MDM

NA

Allowed in user enrollment

iOS, visionOS

Allow multiple payloads

iOS, Shared iPad, visionOS

Profile example

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <key>PayloadContent</key>
    <array>
        <dict>
            <key>EmailAddress</key>
            <string>juanchavez4@companyemail.com</string>
            <key>EnableCalendars</key>
            <true/>
            <key>EnableCalendarsUserOverridable</key>
            <true/>
            <key>EnableContacts</key>
            <true/>
            <key>EnableContactsUserOverridable</key>
            <true/>
            <key>EnableMail</key>
            <true/>
            <key>EnableMailUserOverridable</key>
            <true/>
            <key>EnableNotes</key>
            <true/>
            <key>EnableNotesUserOverridable</key>
            <true/>
            <key>EnableReminders</key>
            <true/>
            <key>EnableRemindersUserOverridable</key>
            <true/>
            <key>Host</key>
            <string>host.companyemail.com</string>
            <key>MailNumberOfPastDaysToSync</key>
            <integer>7</integer>
            <key>OAuth</key>
            <false/>
            <key>OverridePreviousPassword</key>
            <false/>
            <key>SMIMEEnabled</key>
            <false/>
            <key>SMIMEEncryptionEnabled</key>
            <false/>
            <key>SMIMESigningEnabled</key>
            <false/>
            <key>SSL</key>
            <true/>
            <key>UserName</key>
            <string>juanchavez4@companyemail.com</string>
            <key>disableMailRecentsSyncing</key>
            <false/>
            <key>PayloadIdentifier</key>
            <string>com.example.myeaspayload</string>
            <key>PayloadType</key>
            <string>com.apple.eas.account</string>
            <key>PayloadUUID</key>
            <string>de789252-dcf2-42e7-91c8-0ab9f50aafc5</string>
            <key>PayloadVersion</key>
            <integer>1</integer>
        </dict>
    </array>
    <key>PayloadDisplayName</key>
    <string>Exchange Active Sync</string>
    <key>PayloadIdentifier</key>
    <string>com.example.myprofile</string>
    <key>PayloadType</key>
    <string>Configuration</string>
    <key>PayloadUUID</key>
    <string>b8fd6fd7-a55e-4eb1-96af-d9c4d8562e38'</string>
    <key>PayloadVersion</key>
    <integer>1</integer>
</dict>
</plist>

Topics

Objects

See Also

Mail