ReportSettings

Configures inbound report analysis and outbound report settings.

This object can be configured from the WebUI under Settings › MTA › Reports › General

Fields

`inboundReportAddresses`

Type: String[] · default: ["postmaster@*"]

List of addresses (which may include wildcards) from which reports will be intercepted and analyzed

`inboundReportForwarding`

Type: Boolean · default: true

Whether reports should be forwarded to their final recipient after analysis

`outboundReportDomain`

Type: DomainName?

The default domain name used for DSNs and other reports. If left empty, the default domain will be used.

`outboundReportSubmitter`

Type: Expression · default: {"else":"system('hostname')"}

Report submitter address or leave empty to use the default hostname

Available variables: MtaRcptDomainVariable.

JMAP API

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

`x:ReportSettings/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 sysReportSettingsGet permission.

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

`x:ReportSettings/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 sysReportSettingsUpdate permission.

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

Update

stalwart-cli update ReportSettings --field inboundReportAddresses='{"postmaster@*":true}'

Nested types

Expression

A conditional expression with match rules and a default value.

`match`

Type: ExpressionMatch[]

List of conditions and their corresponding results

`else`

Type: String · required

Else condition

ExpressionMatch

A single condition-result pair in an expression.

`if`

Type: String · required

If condition

`then`

Type: String · required

Then clause

Expression references

The following expression contexts are used by fields on this page:

MtaRcptDomainVariable (Variables)