Skip to main content
Version: 0.16

AccountSettings

Configures default account settings for locale and encryption.

This object can be configured from the WebUI under Account › Settings

Fields​

description​

Type: String?

Description of the account

locale​

Type: Locale · default: "en_US"

Preferred locale for the account

timeZone​

Type: TimeZone?

Preferred time zone for the account

encryptionAtRest​

Type: EncryptionAtRest · required

Encryption-at-rest settings for the account

JMAP API​

The AccountSettings singleton is available via the urn:stalwart:jmap capability.

x:AccountSettings/get​

This is a standard Foo/get method as defined in RFC 8620, Section 5.1.

For singletons, the ids argument should be the literal singleton (or null to return the single instance).

This method requires the sysAccountSettingsGet permission.

curl -X POST https://mail.example.com/api \
  -H 'Authorization: Bearer $TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
      "methodCalls": [
        [
          "x:AccountSettings/get",
          {
            "ids": [
              "singleton"
            ]
          },
          "c1"
        ]
      ],
      "using": [
        "urn:ietf:params:jmap:core",
        "urn:stalwart:jmap"
      ]
    }'

x:AccountSettings/set​

This is a standard Foo/set method as defined in RFC 8620, Section 5.3.

For singletons, only the update argument with id singleton is accepted; create and destroy arguments are rejected.

This method requires the sysAccountSettingsUpdate permission.

curl -X POST https://mail.example.com/api \
  -H 'Authorization: Bearer $TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
      "methodCalls": [
        [
          "x:AccountSettings/set",
          {
            "update": {
              "singleton": {
                "description": "updated value"
              }
            }
          },
          "c1"
        ]
      ],
      "using": [
        "urn:ietf:params:jmap:core",
        "urn:stalwart:jmap"
      ]
    }'

CLI​

stalwart-cli wraps the same JMAP calls. See the CLI reference for installation, authentication, and general usage.

Fetch​

stalwart-cli get account-settings

Update​

stalwart-cli update account-settings --field description='Updated'

Nested types​

EncryptionAtRest​

Encryption-at-rest algorithm selection.

EncryptionSettings​

Encryption-at-rest settings for an account.

publicKey​

Type: Id<PublicKey> · required

Public key used for encrypting emails

encryptOnAppend​

Type: Boolean · default: false

Whether to encrypt emails when they are appended to mailboxes

allowSpamTraining​

Type: Boolean · default: false

Whether to allow training the spam classifier with plaintext emails before encryption