E-mail Account¶
An email payload creates an email account on the device.
Contents
- E-mail Account
- Summary
- Keys
- EmailAccountDescription
- EmailAccountType
- EmailAccountName
- EmailAddress
- disableMailRecentsSyncing
- allowMailDrop
- PreventMove
- PreventAppSheet
- SMIMEEnabled
- SMIMEEnablePerMessageSwitch
- SMIMESigningCertificateUUID
- SMIMEEncryptionCertificateUUID
- IncomingMailServerAuthentication
- IncomingMailServerHostName
- IncomingMailServerIMAPPathPrefix
- IncomingMailServerPortNumber
- IncomingMailServerUseSSL
- IncomingMailServerUsername
- IncomingPassword
- OutgoingPassword
- OutgoingPasswordSameAsIncomingPassword
- OutgoingMailServerAuthentication
- OutgoingMailServerHostName
- OutgoingMailServerPortNumber
- OutgoingMailServerUseSSL
- OutgoingMailServerUsername
- Links
Summary¶
| PayloadType: | com.apple.mail.managed |
|---|---|
| Supervised Only: | |
| N/A | |
| macOS: | N/A |
| macOS Deprecated: | |
| N/A | |
| iOS: | N/A |
| iOS Deprecated: | N/A |
| Highlander: | N/A |
Keys¶
EmailAccountDescription¶
Account Description
The display name of the account (e.g. “Company Mail Account”)
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| string | N/A | always | N/A | N/A | N/A | N/A |
EmailAccountType¶
Account Type
The protocol for accessing the email account
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| string | EmailTypeIMAP | always | N/A | N/A | N/A | N/A |
Valid Choices¶
- EmailTypeIMAP
- EmailTypePOP
EmailAccountName¶
Account Name
The display name of the user (e.g. “John Appleseed”)
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| string | N/A | 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 |
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 |
allowMailDrop¶
Allow Mail Drop
If set to true, this account is allowed to use Mail Drop.
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| boolean | False | N/A | N/A | 9.2 | 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 | False | N/A | N/A | 5.0 | 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 | False | N/A | N/A | 5.0 | 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 | False | 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.
| 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 |
IncomingMailServerAuthentication¶
Incoming Mail Server Authentification
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
IncomingMailServerHostName¶
Mail Server
Hostname or IP Address
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| string | N/A | always | 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 |
IncomingMailServerPortNumber¶
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 |
IncomingMailServerUseSSL¶
Use SSL
Retrieve incoming mail through Secure Socket Layer
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| boolean | True | always | N/A | N/A | N/A | N/A |
IncomingMailServerUsername¶
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 |
IncomingPassword¶
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 |
OutgoingPassword¶
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 |
OutgoingMailServerAuthentication¶
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¶
- EmailAuthPassword
- EmailAuthNone
- EmailAuthCRAMMD5
- EmailAuthNTLM
- EmailAuthHTTPMD5
OutgoingMailServerHostName¶
Mail Server
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¶
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 |
OutgoingMailServerUseSSL¶
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 |
OutgoingMailServerUsername¶
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 |