The declaration to configure a Mail account.
| Setting | Type | Required | Default | Manual Install | Supported OS |
|---|---|---|---|---|---|
Account Name VisibleName The name that apps show to the user for this mail account. If not present, the system generates a suitable default. | string | optional | — | ✓Yes | iOS (15.0+)macOS (13.0+)visionOS (1.1+) |
User Identity Asset Reference UserIdentityAssetReference The identifier of an asset declaration that contains the user identity for this account. Set the corresponding asset type to `UserIdentity`. | string | optional | — | ✓Yes | iOS (15.0+)macOS (13.0+)visionOS (1.1+) |
Incoming Server Settings IncomingServer The settings for the incoming mail server for this account. 6 subkeys | dictionary | required | — | ✓Yes | iOS (15.0+)macOS (13.0+)visionOS (1.1+) |
└─ Server Type ServerType The mail protocol this account uses. | string | required | — | ✓Yes | iOS (15.0+)macOS (13.0+)visionOS (1.1+) |
└─ Server Host Name HostName The host name for the incoming mail server. | string | required | — | ✓Yes | iOS (15.0+)macOS (13.0+)visionOS (1.1+) |
└─ Server Port Port The port number for the incoming mail server. | integer | optional | — | ✓Yes | iOS (15.0+)macOS (13.0+)visionOS (1.1+) |
└─ Server Authentication Method AuthenticationMethod The authentication method for the incoming mail server. | string | required | — | ✓Yes | iOS (15.0+)macOS (13.0+)visionOS (1.1+) |
└─ Authentication Credentials Asset Reference AuthenticationCredentialsAssetReference The identifier of an asset declaration that contains the credentials for this account to authenticate with an incoming mail server. The corresponding asset must be of type `CredentialUserNameAndPassword`.
If the `AuthenticationMethod` is `None`, this field must be blank. Otherwise, the declaration must contain this field. | string | optional | — | ✓Yes | iOS (15.0+)macOS (13.0+)visionOS (1.1+) |
└─ IMAP Path Prefix IMAPPathPrefix The path prefix for the IMAP server. The system uses this only when `ServerType` is `IMAP`. | string | optional | — | ✓Yes | iOS (15.0+)macOS (13.0+)visionOS (1.1+) |
Outgoing Server Settings OutgoingServer The settings for the outgoing mail server for this account. 4 subkeys | dictionary | required | — | ✓Yes | iOS (15.0+)macOS (13.0+)visionOS (1.1+) |
└─ Server Host Name HostName The host name for the outgoing mail server. | string | required | — | ✓Yes | iOS (15.0+)macOS (13.0+)visionOS (1.1+) |
└─ Server Port Port The port number for the outgoing mail server. | integer | optional | — | ✓Yes | iOS (15.0+)macOS (13.0+)visionOS (1.1+) |
└─ Server Authentication Method AuthenticationMethod The authentication method for the outgoing mail server. | string | required | — | ✓Yes | iOS (15.0+)macOS (13.0+)visionOS (1.1+) |
└─ Authentication Credentials Asset Reference AuthenticationCredentialsAssetReference The identifier of an asset declaration that contains the credentials for this account to authenticate with an outgoing mail server. The corresponding asset must be of type `CredentialUserNameAndPassword`.
If the `AuthenticationMethod` is `None`, this field must be blank. Otherwise, the declaration must contain this field. | string | optional | — | ✓Yes | iOS (15.0+)macOS (13.0+)visionOS (1.1+) |
S/MIME Settings SMIME Settings for S/MIME. 2 subkeys | dictionary | optional | — | ✓Yes | iOS (17.0+) |
└─ S/MIME Signing Settings Signing Settings for S/MIME signing. 4 subkeys | dictionary | optional | — | ✓Yes | iOS (15.0+)macOS (13.0+)visionOS (1.1+) |
└─ └─ Signing Enabled Enabled If `true`, the system enables S/MIME signing. | boolean | required | — | ✓Yes | iOS (15.0+)macOS (13.0+)visionOS (1.1+) |
└─ └─ S/MIME Signing Identity Asset Reference IdentityAssetReference Specifies the identifier of an asset declaration containing the identity required for S/MIME signing of messages sent from this account. | string | optional | — | ✓Yes | iOS (15.0+)macOS (13.0+)visionOS (1.1+) |
└─ └─ Signing User Overrideable UserOverrideable If `true`, the user can turn S/MIME signing on or off in Settings. | boolean | optional | false | ✓Yes | iOS (15.0+)macOS (13.0+)visionOS (1.1+) |
└─ └─ Signing Identity User Overrideable IdentityUserOverrideable If `true`, the user can select an S/MIME signing identity in Settings. | boolean | optional | false | ✓Yes | iOS (15.0+)macOS (13.0+)visionOS (1.1+) |
└─ S/MIME Encryption Settings Encryption Settings for S/MIME encryption. 5 subkeys | dictionary | optional | — | ✓Yes | iOS (15.0+)macOS (13.0+)visionOS (1.1+) |
└─ └─ Encryption By Default Enabled Enabled If `true`, the system enables S/MIME encryption by default, which the user can't override if `PerMessageSwitchEnabled` is `false`. | boolean | required | — | ✓Yes | iOS (15.0+)macOS (13.0+)visionOS (1.1+) |
└─ └─ S/MIME Encryption Identity Asset Reference IdentityAssetReference Specifies the identifier of an asset declaration containing the identity required for S/MIME encryption. 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 their Sent mailbox. | string | optional | — | ✓Yes | iOS (15.0+)macOS (13.0+)visionOS (1.1+) |
└─ └─ Encryption By Default User Overrideable UserOverrideable If `true`, the user can set the default value for S/MIME encryption to on or off in Settings. | boolean | optional | false | ✓Yes | iOS (15.0+)macOS (13.0+)visionOS (1.1+) |
└─ └─ Encryption Identity User Overrideable IdentityUserOverrideable If `true`, the user can select an S/MIME signing identity in Settings. | boolean | optional | false | ✓Yes | iOS (15.0+)macOS (13.0+)visionOS (1.1+) |
└─ └─ Per Message Switch Enabled PerMessageSwitchEnabled If `true`, the system enables the per-message encryption switch in the compose view. | boolean | optional | false | ✓Yes | iOS (15.0+)macOS (13.0+)visionOS (1.1+) |
