MtaSts

Configures the MTA-STS policy for the server.

This object can be configured from the WebUI under Settings › MTA › Inbound › MTA-STS

Fields

maxAge

Type: Duration · default: "7d"

Maximum time to cache the MTA-STS policy

mode

Type: PolicyEnforcement · default: "testing"

Whether to enforce, test, or disable the MTA-STS policy

mxHosts

Type: String[]

Override the allowed MX hosts for the MTA-STS policy domain. If empty, the MX hosts are determined from the system settings

JMAP API

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

x:MtaSts/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 sysMtaStsGet permission.

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

x:MtaSts/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 sysMtaStsUpdate permission.

curl -X POST https://mail.example.com/api \
  -H 'Authorization: Bearer $TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
      "methodCalls": [
        [
          "x:MtaSts/set",
          {
            "update": {
              "singleton": {
                "maxAge": "7d"
              }
            }
          },
          "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 mta-sts

Update

stalwart-cli update mta-sts --field description='Updated'

Enums

PolicyEnforcement

Value	Label
enforce	Enforce
testing	Testing
disable	Disabled