Skip to main content
Version: 0.16

DkimReportSettings

Configures DKIM authentication failure report generation.

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

Fields​

fromAddress​

Type: Expression · default: {"else":"'noreply-dkim@' + system('domain')"}

Email address that will be used in the From header of the DKIM report email

Available variables: MtaRcptToVariable.

fromName​

Type: Expression · default: {"else":"'Report Subsystem'"}

Name that will be used in the From header of the DKIM report email

Available variables: MtaRcptToVariable.

sendFrequency​

Type: Expression · default: {"else":"[1, 1d]"}

Rate at which DKIM reports will be sent to a given email address. When this rate is exceeded, no further DKIM failure reports will be sent to that address

Available variables: MtaRcptToVariable.

dkimSignDomain​

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

Which domain's DKIM signatures to use when signing the DKIM report

Available variables: MtaRcptToVariable.

subject​

Type: Expression · default: {"else":"'DKIM Authentication Failure Report'"}

Subject name that will be used in the DKIM report email

Available variables: MtaRcptToVariable.

JMAP API​

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

x:DkimReportSettings/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 sysDkimReportSettingsGet permission.

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

x:DkimReportSettings/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 sysDkimReportSettingsUpdate permission.

curl -X POST https://mail.example.com/api \
  -H 'Authorization: Bearer $TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
      "methodCalls": [
        [
          "x:DkimReportSettings/set",
          {
            "update": {
              "singleton": {
                "fromAddress": {
                  "else": "'noreply-dkim@' + system('domain')"
                }
              }
            }
          },
          "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 dkim-report-settings

Update​

stalwart-cli update dkim-report-settings --field description='Updated'

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: