Skip to content

Exchange Payload

This payload can be used to configure a mobile device so it can connect to the company Exchange server.

Please note that an exchange payload can be made “general” and that there is no need for creating a payload for each individual employee.

MANDATORYCONFIGURATIONDESCRIPTIONEXAMPLE
YesAccount NameName for the Exchange ActiveSync/Web Services Account. this is used for the name of the payload.Mail
YesDomain and User nameThis string specifies the user name for this Exchange account. If missing, the devices prompt for it during profile installation.     Format is <domain>\<username> e.g. mydomain.com$LoginName$capasystems$LoginName$
PasswordOptional. The password of the account. Use only with encrypted profiles
YesEmail AddressSpecifies the full email address for the account. The owners (primary user) email address must be injected upon delivery to the device. If not present in the payload, the device prompts for this string during profile installation. In OS X, this key is required.$Email$
YesExchange ActiveSync HostSpecifies the Exchange server hostname (or IP address). In OS X, this key is required.mail.capasystems.com
Use SSLSpecifies whether the Exchange server uses SSL for authentication.
Past days of Mail to SyncThe number of past days of mail to synchronize. (set I days) No limit = 0. (Not documented in Profile Reference)1 Month
ONLY FOR IOS 5 OR NEWER
Allow MoveOptional. Default false. If set to true, messages may not be moved out of this email account into another account. Also prevents forwarding or replying from a different account than the message was originated from.
Use Only in MailOptional. Default false. If set to true, this account will not be available for sending mail in third party applications..
Use S/MIMEOptional. Default false. If set to true, this account supports S/MIME.
ONLY FOR IOS 6 OR NEWER
Disallow Recent Address SyncingIf true, this account is excluded from address Recents syncing. This defaults to false.
WINDOWS PHONE
Sync internalHow often the device will sync with the Exchange server
Sync EmailWhether to synchronize email between the device and the server
Sync CalendarWhether to synchronize the calendar between the device and the server
Sync ContactsWhether to synchronize contacts between the device and the server
Sync TasksWhether to synchronize tasks between the device and the server
ONLY FOR IOS 12 OR NEWER, OR macOS 10,14 OR NEWER
Use OAuthSpecifies whether the connection should use OAuth for authentication. If enabled, a password should not be specified.
USE CERTIFICATE AUTHENTICATION
Use certificate/SCEP authenticationSpecifies whether the connection should use certificate authentication for Exchange.

As a normal bulk deployment doesn’t know the end-users password, it will be empty. On the mobile device, the user will normally be prompted for the password, when the mail client is opened or after the profile is installed. Then the End-user can enter the correct password.

Samsung Knox deviceNative Android device
Native Android devices do not allow Exchange Account profiles.