Skip to main content
Version: 0.16

TlsReportSettings

Configures TLS aggregate report generation.

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

Fields​

contactInfo​

Type: Expression · default: {"else":"false"}

Contact information to be included in the report

Available variables: MtaQueueHostVariable.

fromAddress​

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

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

Available variables: MtaQueueHostVariable.

fromName​

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

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

Available variables: MtaQueueHostVariable.

maxReportSize​

Type: Expression · default: {"else":"5242880"}

Maximum size of the TLS aggregate report in bytes

Available variables: MtaQueueHostVariable.

orgName​

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

Name of the organization to be included in the report

Available variables: MtaQueueHostVariable.

sendFrequency​

Type: Expression · default: {"else":"daily"}

Frequency at which the TLS aggregate reports will be sent. The options are hourly, daily, weekly, or never to disable reporting

Available variables: MtaQueueHostVariable.

Available constants: MtaAggregateConstant.

dkimSignDomain​

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

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

Available variables: MtaQueueHostVariable.

subject​

Type: Expression · default: {"else":"'TLS Aggregate Report'"}

Subject name that will be used in the TLS aggregate report email

Available variables: MtaQueueHostVariable.

JMAP API​

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

x:TlsReportSettings/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 sysTlsReportSettingsGet permission.

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

x:TlsReportSettings/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 sysTlsReportSettingsUpdate permission.

curl -X POST https://mail.example.com/api \
  -H 'Authorization: Bearer $TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
      "methodCalls": [
        [
          "x:TlsReportSettings/set",
          {
            "update": {
              "singleton": {
                "contactInfo": {
                  "else": "false"
                }
              }
            }
          },
          "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 tls-report-settings

Update​

stalwart-cli update tls-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: