Version: 0.16

Directory

Defines an external directory for account authentication and lookups.

This object can be configured from the WebUI under Settings › Authentication › Directories

Fields

Directory is a multi-variant object: each instance has an @type discriminator selecting one of the variants below, and each variant carries its own set of fields.

`@type: "Ldap"`

LDAP Directory

`description`

Type: String · required

Short description of this directory

`url`

Type: Uri · default: "ldap://localhost:389"

URL of the LDAP server

`timeout`

Type: Duration · default: "30s"

Connection timeout to the server

`allowInvalidCerts`

Type: Boolean · default: false

Allow invalid TLS certificates when connecting to the server

`useTls`

Type: Boolean · default: false

Use TLS to connect to the remote server

`baseDn`

Type: String · required

The base distinguished name (DN) from where searches should begin

`bindDn`

Type: String?

The distinguished name of the account that the server will bind as to connect to the LDAP directory

`bindSecret`

Type: SecretKeyOptional · required

The password or secret for the bind DN account

`bindAuthentication`

Type: Boolean · default: true

Whether to use bind authentication. When enabled, the server will use the filterLogin to search for the user account and then attempt to bind as that account using the provided password. When disabled, the server will use the bind DN and secret to connect to the LDAP server and obtain the secret from the account entry using the attrSecret attribute.

`filterLogin`

Type: String · default: "(&(objectClass=inetOrgPerson)(mail=?))"

Searches for user accounts by e-mail address during authentication

`filterMailbox`

Type: String · default: "(|(&(objectClass=inetOrgPerson)(|(mail=?)(mailAlias=?)))(&(objectClass=groupOfNames)(|(mail=?)(mailAlias=?))))"

Searches for users or groups matching a recipient e-mail address or alias

`filterMemberOf`

Type: String? · default: "(&(objectClass=groupOfNames)(member=?))"

Searches for groups that an account is member of. Use when the group membership is not provided in the account entry. The ? in the filter will be replaced with the account DN.

`attrClass`

Type: String[] · default: ["objectClass"]

LDAP attribute for the user's account type, if missing defaults to individual.

`attrDescription`

Type: String[] · default: ["description"]

LDAP attributes used to store the user's description

`attrEmail`

Type: String[] · default: ["mail"]

LDAP attribute for the user's primary email address

`attrEmailAlias`

Type: String[] · default: ["mailAlias"]

LDAP attribute for the user's email alias(es)

`attrMemberOf`

Type: String[] · default: ["memberOf"]

LDAP attributes for the groups that a user belongs to. Used when filterMemberOf is not configured or when the group membership is also provided in the account entry.

`attrSecret`

Type: String[] · default: ["userPassword"]

LDAP attribute for the user's password hash. This setting is required when binding as a service user. When using bind authentication, configure the secret-changed attribute instead.

`attrSecretChanged`

Type: String[] · default: ["pwdChangeTime"]

LDAP attribute that provides a password change hash or a timestamp indicating when the password was last changed. When using bind authentication, this attribute is used to determine when to invalidate OAuth tokens.

`groupClass`

Type: String · default: "groupOfNames"

LDAP object class used to identify group entries

`poolMaxConnections`

Type: UnsignedInt · default: 10 · max: 8192

Maximum number of connections that can be maintained simultaneously in the connection pool

`poolTimeoutCreate`

Type: Duration · default: "30s"

Maximum amount of time that the connection pool will wait for a new connection to be created

`poolTimeoutRecycle`

Type: Duration · default: "30s"

Maximum amount of time that the connection pool manager will wait for a connection to be recycled

`poolTimeoutWait`

Type: Duration · default: "30s"

Maximum amount of time that the connection pool will wait for a connection to become available

`memberTenantId`

Type: Id<Tenant>? · enterprise

Identifier for the tenant this directory belongs to

`@type: "Sql"`

SQL Database

`description`

Type: String · required

Short description of this directory

`store`

Type: SqlAuthStore · required

Storage backend where accounts and groups are stored

`columnEmail`

Type: String · default: "name"

Column name for e-mail address. Optional, you can use instead a query to obtain the account's addresses.

`columnSecret`

Type: String · default: "secret"

Column name for the account password.

`columnClass`

Type: String? · default: "type"

Column name for account type

`columnDescription`

Type: String? · default: "description"

Column name for account full name or description

`queryLogin`

Type: String · default: "SELECT name, secret, description, type FROM accounts WHERE name = $1"

Query to obtain the account details by login e-mail address.

`queryRecipient`

Type: String · default: "SELECT name, secret, description, type FROM accounts WHERE name = $1 AND active = true"

Query to obtain the account details by recipient e-mail address or alias.

`queryMemberOf`

Type: String? · default: "SELECT member_of FROM group_members WHERE name = $1"

Query to obtain the groups an account is member of.

`queryEmailAliases`

Type: String? · default: "SELECT address FROM emails WHERE name = $1"

Query to obtain the e-mail aliases of an account.

`memberTenantId`

Type: Id<Tenant>? · enterprise

Identifier for the tenant this directory belongs to

`@type: "Oidc"`

OpenID Connect

`description`

Type: String · required

Short description of this directory

`issuerUrl`

Type: Uri · required

The base URL of the OpenID Connect provider (e.g. https://sso.example.com/realms/myrealm). Stalwart will use this URL to automatically discover the provider's endpoints, including the token validation and user info endpoints.

`requireAudience`

Type: String? · default: "stalwart"

If set, Stalwart will reject any token whose aud (audience) claim does not include this value. Set this to the client ID or resource identifier registered for Stalwart in your identity provider to ensure tokens issued for other applications are not accepted.

`requireScopes`

Type: String[] · default: ["openid","email"]

If set, Stalwart will reject any token that does not include all of the specified scopes. Useful for ensuring that only tokens explicitly granted access to the mail server are accepted.

`claimUsername`

Type: String · default: "preferred_username"

The claim name used to retrieve the user's login name from the token or user info response. Common values are preferred_username, email, or sub depending on your provider's configuration. If the claim value is not an email address and usernameDomain is set, the domain will be appended automatically (e.g. john becomes [email protected]). If the claim value already contains an @, it is used as-is. If the claim value is not an email address and no usernameDomain is configured, Stalwart will fall back to the email claim. If neither yields a valid email address, authentication will be rejected.

`usernameDomain`

Type: String?

The domain name to append to the username when the value of claimUsername does not contain an @ symbol (e.g. setting this to example.com will turn john into [email protected]). If not set, Stalwart will fall back to the email claim when the username claim does not contain a valid email address.

`claimName`

Type: String? · default: "name"

The claim name used to retrieve the user's display name from the token or user info response. Common values are name or display_name. If not set, the display name will not be populated.

`claimGroups`

Type: String?

The claim name used to retrieve the user's group memberships from the token or user info response. Common values are groups or roles depending on your provider's configuration. If not set, group information will not be populated. Note that some providers omit group claims from the token to keep its size small and only return them via the user info endpoint, if group information is missing, ensure your provider is configured to include it.

`memberTenantId`

Type: Id<Tenant>? · enterprise

Identifier for the tenant this directory belongs to

JMAP API

The Directory object is available via the urn:stalwart:jmap capability.

`x:Directory/get`

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

This method requires the sysDirectoryGet permission.

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

`x:Directory/set`

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

Supports create, update, and destroy operations in a single call.

Create

This operation requires the sysDirectoryCreate permission.

curl -X POST https://mail.example.com/api \
  -H 'Authorization: Bearer $TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
      "methodCalls": [
        [
          "x:Directory/set",
          {
            "create": {
              "new1": {
                "@type": "Ldap",
                "allowInvalidCerts": false,
                "attrClass": [
                  "objectClass"
                ],
                "attrDescription": [
                  "description"
                ],
                "attrEmail": [
                  "mail"
                ],
                "attrEmailAlias": [
                  "mailAlias"
                ],
                "attrMemberOf": [
                  "memberOf"
                ],
                "attrSecret": [
                  "userPassword"
                ],
                "attrSecretChanged": [
                  "pwdChangeTime"
                ],
                "baseDn": "Example",
                "bindAuthentication": true,
                "bindDn": "Example",
                "bindSecret": {
                  "@type": "None"
                },
                "description": "Example",
                "filterLogin": "(&(objectClass=inetOrgPerson)(mail=?))",
                "filterMailbox": "(|(&(objectClass=inetOrgPerson)(|(mail=?)(mailAlias=?)))(&(objectClass=groupOfNames)(|(mail=?)(mailAlias=?))))",
                "filterMemberOf": "(&(objectClass=groupOfNames)(member=?))",
                "groupClass": "groupOfNames",
                "memberTenantId": "<Tenant id>",
                "poolMaxConnections": 10,
                "poolTimeoutCreate": "30s",
                "poolTimeoutRecycle": "30s",
                "poolTimeoutWait": "30s",
                "timeout": "30s",
                "url": "ldap://localhost:389",
                "useTls": false
              }
            }
          },
          "c1"
        ]
      ],
      "using": [
        "urn:ietf:params:jmap:core",
        "urn:stalwart:jmap"
      ]
    }'

Update

This operation requires the sysDirectoryUpdate permission.

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

Destroy

This operation requires the sysDirectoryDestroy permission.

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

`x:Directory/query`

This is a standard Foo/query method as defined in RFC 8620, Section 5.5.

This method requires the sysDirectoryQuery permission.

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

The x:Directory/query filter argument accepts the following conditions (combinable with AnyOf / AllOf / Not per RFC 8620):

Condition	Kind
`memberTenantId`	id of Tenant

CLI

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

Fetch

stalwart-cli get directory id1

Create

stalwart-cli create directory/ldap \
  --field description=Example \
  --field url=ldap://localhost:389 \
  --field timeout=30s \
  --field allowInvalidCerts=false \
  --field useTls=false \
  --field baseDn=Example \
  --field bindDn=Example \
  --field 'bindSecret={"@type":"None"}' \
  --field bindAuthentication=true \
  --field filterLogin=(&(objectClass=inetOrgPerson)(mail=?)) \
  --field filterMailbox=(|(&(objectClass=inetOrgPerson)(|(mail=?)(mailAlias=?)))(&(objectClass=groupOfNames)(|(mail=?)(mailAlias=?)))) \
  --field filterMemberOf=(&(objectClass=groupOfNames)(member=?)) \
  --field 'attrClass=["objectClass"]' \
  --field 'attrDescription=["description"]' \
  --field 'attrEmail=["mail"]' \
  --field 'attrEmailAlias=["mailAlias"]' \
  --field 'attrMemberOf=["memberOf"]' \
  --field 'attrSecret=["userPassword"]' \
  --field 'attrSecretChanged=["pwdChangeTime"]' \
  --field groupClass=groupOfNames \
  --field poolMaxConnections=10 \
  --field poolTimeoutCreate=30s \
  --field poolTimeoutRecycle=30s \
  --field poolTimeoutWait=30s \
  --field 'memberTenantId=<Tenant id>'

Query

stalwart-cli query directory
stalwart-cli query directory --where memberTenantId=id1

Update

stalwart-cli update directory id1 --field description='Updated'

Delete

stalwart-cli delete directory --ids id1

Nested types

SecretKeyOptional

An optional secret value, or none.

None: No secret. No additional fields.
Value: Secret value. Carries the fields of SecretKeyValue.
EnvironmentVariable: Secret read from environment variable. Carries the fields of SecretKeyEnvironmentVariable.
File: Secret read from file. Carries the fields of SecretKeyFile.

SecretKeyValue

A secret value provided directly.

`secret`

Type: String · required · secret

Password or secret value

SecretKeyEnvironmentVariable

A secret value read from an environment variable.

`variableName`

Type: String · required

Environment variable name to read the secret from

SecretKeyFile

A secret value read from a file.

`filePath`

Type: String · required

File path to read the secret from

SqlAuthStore

Defines the SQL database used to store account and group information for SQL directories.

Default: Use data store (SQL only). No additional fields.
PostgreSql: PostgreSQL. Carries the fields of PostgreSqlStore.
MySql: mySQL. Carries the fields of MySqlStore.
Sqlite: SQLite. Carries the fields of SqliteStore.

PostgreSqlStore

PostgreSQL data store.

`timeout`

Type: Duration? · default: "15s"

Connection timeout to the database

`useTls`

Type: Boolean · default: false

Use TLS to connect to the store

`allowInvalidCerts`

Type: Boolean · default: false

Allow invalid TLS certificates when connecting to the store

`poolMaxConnections`

Type: UnsignedInt? · default: 10 · max: 8192 · min: 1

Maximum number of connections to the store

`poolRecyclingMethod`

Type: PostgreSqlRecyclingMethod · default: "fast"

Method to use when recycling connections in the pool

`readReplicas`

Type: PostgreSqlSettings[] · enterprise

List of read replicas for the store

`host`

Type: HostName · required

Hostname of the database server

`port`

Type: UnsignedInt · default: 5432 · max: 65535 · min: 1

Port of the database server

`database`

Type: String · default: "stalwart"

Name of the database

`authUsername`

Type: String? · default: "stalwart"

Username to connect to the store

`authSecret`

Type: SecretKeyOptional · required

Password to connect to the store

`options`

Type: String?

Additional connection options

PostgreSqlSettings

PostgreSQL connection settings.

`host`

Type: HostName · required

Hostname of the database server

`port`

Type: UnsignedInt · default: 5432 · max: 65535 · min: 1

Port of the database server

`database`

Type: String · default: "stalwart"

Name of the database

`authUsername`

Type: String? · default: "stalwart"

Username to connect to the store

`authSecret`

Type: SecretKeyOptional · required

Password to connect to the store

`options`

Type: String?

Additional connection options

MySqlStore

MySQL data store.

`timeout`

Type: Duration? · default: "15s"

Connection timeout to the database

`useTls`

Type: Boolean · default: false

Use TLS to connect to the store

`allowInvalidCerts`

Type: Boolean · default: false

Allow invalid TLS certificates when connecting to the store

`maxAllowedPacket`

Type: UnsignedInt? · max: 1073741824 · min: 1024

Maximum size of a packet in bytes

`poolMaxConnections`

Type: UnsignedInt? · default: 10 · max: 8192 · min: 1

Maximum number of connections to the store

`poolMinConnections`

Type: UnsignedInt? · default: 5 · max: 8192 · min: 1

Minimum number of connections to the store

`readReplicas`

Type: MySqlSettings[] · enterprise

List of read replicas for the store

`host`

Type: HostName · required

Hostname of the database server

`port`

Type: UnsignedInt · default: 3306 · max: 65535 · min: 1

Port of the database server

`database`

Type: String · default: "stalwart"

Name of the database

`authUsername`

Type: String? · default: "stalwart"

Username to connect to the store

`authSecret`

Type: SecretKeyOptional · required

Password to connect to the store

MySqlSettings

MySQL connection settings.

`host`

Type: HostName · required

Hostname of the database server

`port`

Type: UnsignedInt · default: 3306 · max: 65535 · min: 1

Port of the database server

`database`

Type: String · default: "stalwart"

Name of the database

`authUsername`

Type: String? · default: "stalwart"

Username to connect to the store

`authSecret`

Type: SecretKeyOptional · required

Password to connect to the store

SqliteStore

SQLite embedded data store.

`path`

Type: String · required

Path to the SQLite data directory

`poolWorkers`

Type: UnsignedInt? · max: 64 · min: 1

Number of worker threads to use for the store, defaults to the number of cores

`poolMaxConnections`

Type: UnsignedInt · default: 10 · max: 8192 · min: 1

Maximum number of connections to the store

Enums

PostgreSqlRecyclingMethod

Value	Label
`fast`	Fast recycling method
`verified`	Verified recycling method
`clean`	Clean recycling method

Fields​

@type: "Ldap"​

description​

url​

timeout​

allowInvalidCerts​

useTls​

baseDn​

bindDn​

bindSecret​

bindAuthentication​

filterLogin​

filterMailbox​

filterMemberOf​

attrClass​

attrDescription​

attrEmail​

attrEmailAlias​

attrMemberOf​

attrSecret​

attrSecretChanged​

groupClass​

poolMaxConnections​

poolTimeoutCreate​

poolTimeoutRecycle​

poolTimeoutWait​

memberTenantId​

@type: "Sql"​

description​

store​

columnEmail​

columnSecret​

columnClass​

columnDescription​

queryLogin​

queryRecipient​

queryMemberOf​

queryEmailAliases​

memberTenantId​

@type: "Oidc"​

description​

issuerUrl​

requireAudience​

requireScopes​

claimUsername​

usernameDomain​

claimName​

claimGroups​

memberTenantId​

JMAP API​

x:Directory/get​

x:Directory/set​

Create​

Update​

Destroy​

x:Directory/query​

CLI​

Fetch​

Create​

Query​

Update​

Delete​

Nested types​

SecretKeyOptional​

SecretKeyValue​

secret​

SecretKeyEnvironmentVariable​

variableName​

SecretKeyFile​

filePath​

SqlAuthStore​

PostgreSqlStore​

timeout​

useTls​

allowInvalidCerts​

poolMaxConnections​

poolRecyclingMethod​

readReplicas​

host​

port​

Fields

`@type: "Ldap"`

`description`

`url`

`timeout`

`allowInvalidCerts`

`useTls`

`baseDn`

`bindDn`

`bindSecret`

`bindAuthentication`

`filterLogin`

`filterMailbox`

`filterMemberOf`

`attrClass`

`attrDescription`

`attrEmail`

`attrEmailAlias`

`attrMemberOf`

`attrSecret`

`attrSecretChanged`

`groupClass`

`poolMaxConnections`

`poolTimeoutCreate`

`poolTimeoutRecycle`

`poolTimeoutWait`

`memberTenantId`

`@type: "Sql"`

`description`

`store`

`columnEmail`

`columnSecret`

`columnClass`

`columnDescription`

`queryLogin`

`queryRecipient`

`queryMemberOf`

`queryEmailAliases`

`memberTenantId`

`@type: "Oidc"`

`description`

`issuerUrl`

`requireAudience`

`requireScopes`

`claimUsername`

`usernameDomain`

`claimName`

`claimGroups`

`memberTenantId`

JMAP API

`x:Directory/get`

`x:Directory/set`

Create

Update

Destroy

`x:Directory/query`

CLI

Fetch

Create

Query

Update

Delete

Nested types

SecretKeyOptional

SecretKeyValue

`secret`

SecretKeyEnvironmentVariable

`variableName`

SecretKeyFile

`filePath`

SqlAuthStore

PostgreSqlStore

`timeout`

`useTls`

`allowInvalidCerts`

`poolMaxConnections`

`poolRecyclingMethod`

`readReplicas`

`host`

`port`