Email Payload¶
Template
An email payload creates an email account on the device.
| PayloadType: | com.apple.mail.managed |
|---|---|
| Supervised Only: | |
| N/A | |
| macOS: | N/A |
| macOS Deprecated: | |
| N/A | |
| iOS: | N/A |
| iOS Deprecated: | N/A |
| Highlander: | False |
Contents
- Email Payload
- Keys
- Incoming Server Settings
- Outgoing Server Settings
- S/MIME Signing and Encryption
- SMIMEEnabled
- SMIMESigningEnabled
- SMIMESigningCertificateUUID
- SMIMEEncryptionEnabled
- SMIMEEncryptionCertificateUUID
- SMIMEEnablePerMessageSwitch
- SMIMESigningUserOverrideable
- SMIMESigningCertificateUUIDUserOverrideable
- SMIMEEncryptByDefault
- SMIMEEncryptByDefaultUserOverrideable
- SMIMEEncryptionCertificateUUIDUserOverrideable
- SMIMEEnableEncryptionPerMessageSwitch
| Name | Type | Title | Description | Required |
|---|---|---|---|---|
| EmailAccountType | string | Account Type | The protocol for accessing the account | always |
| EmailAccountDescription | string | Account Description | The display name of the account (e.g. “Company Mail Account”) | n/a |
| IncomingMailServerIMAPPathPrefix | string | Path Prefix | Path prefix for IMAP mail server | n/a |
| EmailAccountName | string | User Display Name | The display name of the user (e.g. “John Appleseed”) | push |
| EmailAddress | string | Email Address | The address of the account (e.g. “john@company.com”) | push |
| PreventMove | boolean | Allow user to move messages from this account | Messages can be moved out of this account into another. | n/a |
| disableMailRecentsSyncing | boolean | Allow recent addresses to be synced | Include this account in recent address syncing | n/a |
| allowMailDrop | boolean | Allow Mail Drop | Allow Mail Drop for this account | n/a |
| PreventAppSheet | boolean | Use Only In Mail | Send outgoing mail from this account only from Mail app | n/a |
| SMIMEEnabled | boolean | S/MIME Enabled | If set to true, this account will support S/MIME | n/a |
| SMIMESigningEnabled | boolean | Enable S/MIME Signing | Support S/MIME signing for this account | n/a |
| SMIMESigningCertificateUUID | string | S/MIME Signing Certificate | The PayloadUUID of the identity certificate used to sign messages sent from this account. | n/a |
| SMIMEEncryptionEnabled | boolean | Enable S/MIME Encryption | Support S/MIME encryption from this account | n/a |
| SMIMEEncryptionCertificateUUID | string | S/MIME Encryption Certificate | The PayloadUUID of the identity certificate used to decrypt messages coming into this account. | n/a |
| SMIMEEnablePerMessageSwitch | boolean | Enable per-message encryption switch | Allow the user to choose whether to encrypt each message | n/a |
| SMIMESigningUserOverrideable | boolean | Enable S/MIME toggle | Allow the user to toggle S/MIME signing on or off in Settings. | n/a |
| SMIMESigningCertificateUUIDUserOverrideable | boolean | Enable user to select the signing identity | Allow the user to select the signing identity. | n/a |
| SMIMEEncryptByDefault | boolean | Enable S/MIME by default. | If SMIMEEnableEncryptionPerMessageSwitch is false, this default cannot be changed by the user. | n/a |
| SMIMEEncryptByDefaultUserOverrideable | boolean | Enable user to toggle S/MIME by default. | Allow the user to toggle the encryption by default setting. | n/a |
| SMIMEEncryptionCertificateUUIDUserOverrideable | boolean | Enable user to select the signing identity and encryption is enabled | Allow the user to select the signing identity and encryption is enabled. | n/a |
| SMIMEEnableEncryptionPerMessageSwitch | boolean | Enable per-message encryption switch | Allow the user toggle encrytion in the compose view and encryption is enabled. | n/a |
| PFC_SegmentedControl_0 | string | n/a | n/a | always |
| IncomingMailServerHostName | string | Incoming Mail Server Hostname | Hostname or IP Address for incoming mail | always |
| IncomingMailServerPortNumber | integer | Incoming Mail Server Port | Port number for incoming mail | n/a |
| IncomingMailServerUsername | string | Incoming Mail Server Username | The username used to connect to the server for incoming mail | push |
| IncomingMailServerAuthentication | string | Incoming Mail Server Authentification Type | The authentication method for the incoming mail server | always |
| IncomingPassword | string | Incoming Mail Server Password | The password for the incoming mail server | n/a |
| IncomingMailServerUseSSL | boolean | Incoming Mail Server Use SSL | Retrieve incoming mail through Secure Socket Layer | n/a |
| OutgoingMailServerHostName | string | Outgoing Mail Server Hostname | Hostname or IP address for outgoing mail | always |
| OutgoingMailServerPortNumber | integer | Outgoing Mail Server Port | The port number for outgoing mail | n/a |
| OutgoingMailServerUsername | string | Outgoing Mail Server Username | The username used to connect to the server for outgoing mail | push |
| OutgoingMailServerAuthentication | string | Outgoing Mail Server Authentication Type | The authentication method for the outgoing mail server | always |
| OutgoingPassword | string | Outgoing Mail Server Password | The password for the outgoing mail server | n/a |
| OutgoingPasswordSameAsIncomingPassword | boolean | Outgoing Password Same As Incoming | SMTP authentication uses the same password as POP/IMAP | n/a |
| OutgoingMailServerUseSSL | boolean | Outgoing Mail Server Use SSL | Send outgoing mail through Secure Socket Layer | n/a |
Keys¶
EmailAccountType¶
Account Type
The protocol for accessing the account
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| string | EmailTypeIMAP | always | N/A | N/A | N/A | N/A |
Valid Choices¶
- EmailTypeIMAP
- EmailTypePOP
EmailAccountDescription¶
Account Description
The display name of the account (e.g. “Company Mail Account”)
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| string | N/A | N/A | N/A | N/A | N/A | N/A |
IncomingMailServerIMAPPathPrefix¶
Path Prefix
Path prefix for IMAP mail server
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| string | N/A | N/A | N/A | N/A | N/A | N/A |
EmailAccountName¶
User Display Name
The display name of the user (e.g. “John Appleseed”)
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| string | N/A | push | 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 |
PreventMove¶
Allow user to move messages from this account
Messages can be moved out of this account into another.
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| boolean | False | N/A | N/A | 5.0 | N/A | N/A |
disableMailRecentsSyncing¶
Allow recent addresses to be synced
Include this account in recent address syncing
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| boolean | False | N/A | N/A | 6.0 | N/A | N/A |
allowMailDrop¶
Allow Mail Drop
Allow Mail Drop for this account
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| boolean | False | N/A | N/A | 9.2 | N/A | N/A |
PreventAppSheet¶
Use Only In Mail
Send outgoing mail from this account only from Mail app
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| boolean | N/A | N/A | N/A | 5.0 | N/A | N/A |
Incoming Server Settings¶
IncomingMailServerHostName¶
Incoming Mail Server Hostname
Hostname or IP Address for incoming mail
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| string | N/A | always | N/A | N/A | N/A | N/A |
IncomingMailServerPortNumber¶
Incoming Mail Server Port
Port number for incoming mail
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| integer | 993 | N/A | N/A | N/A | N/A | N/A |
IncomingMailServerUsername¶
Incoming Mail Server Username
The username used to connect to the server for incoming mail
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| string | N/A | push | N/A | N/A | N/A | N/A |
IncomingMailServerAuthentication¶
Incoming Mail Server Authentification Type
The authentication method for the incoming mail server
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| string | EmailAuthPassword | always | N/A | N/A | N/A | N/A |
Valid Choices¶
- EmailAuthNone
- EmailAuthPassword
- EmailAuthCRAMMD5
- EmailAuthNTLM
- EmailAuthHTTPMD5
IncomingPassword¶
Incoming Mail Server Password
The password for the incoming mail server
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| string | N/A | N/A | N/A | N/A | N/A | N/A |
IncomingMailServerUseSSL¶
Incoming Mail Server Use SSL
Retrieve incoming mail through Secure Socket Layer
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| boolean | True | N/A | N/A | N/A | N/A | N/A |
Outgoing Server Settings¶
OutgoingMailServerHostName¶
Outgoing Mail Server Hostname
Hostname or IP address for outgoing mail
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| string | N/A | always | N/A | N/A | N/A | N/A |
OutgoingMailServerPortNumber¶
Outgoing Mail Server Port
The port number for outgoing mail
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| integer | 587 | N/A | N/A | N/A | N/A | N/A |
OutgoingMailServerUsername¶
Outgoing Mail Server Username
The username used to connect to the server for outgoing mail
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| string | N/A | push | N/A | N/A | N/A | N/A |
OutgoingMailServerAuthentication¶
Outgoing Mail Server Authentication Type
The authentication method for the outgoing mail server
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| string | EmailAuthPassword | always | N/A | N/A | N/A | N/A |
Valid Choices¶
- EmailAuthNone
- EmailAuthPassword
- EmailAuthCRAMMD5
- EmailAuthNTLM
- EmailAuthHTTPMD5
OutgoingPassword¶
Outgoing Mail Server Password
The password for the outgoing mail server
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| string | N/A | N/A | N/A | N/A | N/A | N/A |
OutgoingPasswordSameAsIncomingPassword¶
Outgoing Password Same As Incoming
SMTP authentication uses the same password as POP/IMAP
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| boolean | False | N/A | N/A | N/A | N/A | N/A |
OutgoingMailServerUseSSL¶
Outgoing Mail Server Use SSL
Send outgoing mail through Secure Socket Layer
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| boolean | True | N/A | N/A | N/A | N/A | N/A |
S/MIME Signing and Encryption¶
SMIMEEnabled¶
S/MIME Enabled
If set to true, this account will support S/MIME
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| boolean | False | N/A | N/A | 5.0 | N/A | N/A |
SMIMESigningEnabled¶
Enable S/MIME Signing
Support S/MIME signing for this account
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| boolean | False | N/A | N/A | 10.3 | 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 |
SMIMEEncryptionEnabled¶
Enable S/MIME Encryption
Support S/MIME encryption from this account
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| boolean | False | N/A | N/A | 10.3 | 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 |
SMIMEEnablePerMessageSwitch¶
Enable per-message encryption switch
Allow the user to choose whether to encrypt each message
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| boolean | False | N/A | N/A | 8.0 | N/A | N/A |
SMIMESigningUserOverrideable¶
Enable S/MIME toggle
Allow the user to toggle S/MIME signing on or off in Settings.
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| boolean | False | N/A | N/A | 12.0 | N/A | N/A |
SMIMESigningCertificateUUIDUserOverrideable¶
Enable user to select the signing identity
Allow the user to select the signing identity.
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| boolean | False | N/A | N/A | 12.0 | N/A | N/A |
SMIMEEncryptByDefault¶
Enable S/MIME by default.
If SMIMEEnableEncryptionPerMessageSwitch is false, this default cannot be changed by the user.
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| boolean | False | N/A | N/A | 12.0 | N/A | N/A |
SMIMEEncryptByDefaultUserOverrideable¶
Enable user to toggle S/MIME by default.
Allow the user to toggle the encryption by default setting.
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| boolean | False | N/A | N/A | 12.0 | N/A | N/A |
SMIMEEncryptionCertificateUUIDUserOverrideable¶
Enable user to select the signing identity and encryption is enabled
Allow the user to select the signing identity and encryption is enabled.
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| boolean | False | N/A | N/A | 12.0 | N/A | N/A |
SMIMEEnableEncryptionPerMessageSwitch¶
Enable per-message encryption switch
Allow the user toggle encrytion in the compose view and encryption is enabled.
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| boolean | False | N/A | N/A | 12.0 | N/A | N/A |