PayloadKit

Exchange Web Services

com.apple.ews.account

The payload that configures an Exchange Web Services accounts.

macOS 10.7+
Apple schemacombined

macOS: user channel only

Configuration Keys (17)

Showing 17 of 17 keys

KeyTypeDescriptionDefaultRange
UserNamestring

Account user name

stringThe user name for this Exchange account. Required for noninteractive installation, such as through MDM. If missing, the system prompts the user for it during interactive profile installation.

Depends on: IdentificationUUID not set

Default: —Range: —

Account email address

stringThe full email address for the account. If the email address string isn't present in the payload, the device prompts for it during profile installation.

Depends on: IdentificationUUID not set

Default: —Range: —
Passwordstring

Account password

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

IdentificationUUID

stringThe UUID of the Identification Payload to use as the source for user values.Default: —Range: —
Hoststring

Internal Exchange Host

stringThe Exchange server host name or IP address. Ignored if using OAuth.Default: —Range: —
Portinteger

Internal Exchange Host Port

integerThe server port number.Default: —Range: 0 – 65535
Pathstring

Internal server path

stringThe server path.Default: —Range: —
SSLboolean

Use SSL for Internal Exchange Host

booleanIf 'true', the system enables SSL.Default: trueRange: —

External Exchange Host

stringThe external server address.Default: —Range: —

External Exchange Host Port

integerThe external server port number.Default: —Range: 0 – 65535

External server path

stringThe external server path.Default: —Range: —

Use SSL for External Exchange Host

booleanIf 'true', the system enables SSL for connections to the external server.Default: trueRange: —
OAuthboolean

Use OAuth

macOS 10.14+

booleanIf 'true', the system enables OAuth for authentication. Don't specify a password if 'OAuth' is 'true'.Default: falseRange: —

URL for OAuth sign-in

macOS 10.14+

stringThe URL to load into a web view for authentication through OAuth when autodiscovery isn't used. This setting requires a 'Host' value.Default: —Range: —

Payload certificate UUID

macOS 10.12+

stringThe UUID of the certificate payload within the same profile to use for the identity credential. Supported on macOS 10.12 or later.Default: —Range: —
stringThe UUID of the certificate payload within the same profile to use for the identity credential. Supported on macOS 10.11 or later. On macOS 10.12 or later use the PayloadCertificateUUID.Default: —Range: —

Allow mail drop

macOS 10.12+

booleanIf 'true', the system enables Mail Drop.Default: falseRange: —