Skip to main content
Version: 0.16

MtaInboundSession

Configures inbound SMTP session timeouts and transfer limits.

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

Fields​

maxDuration​

Type: Expression · default: {"else":"10m"}

The maximum duration of a session

Available variables: MtaConnectionVariable.

timeout​

Type: Expression · default: {"else":"5m"}

How long to wait for a client to send a command before timing out

Available variables: MtaConnectionVariable.

transferLimit​

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

The maximum number of bytes that can be transferred per session

Available variables: MtaConnectionVariable.

JMAP API​

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

x:MtaInboundSession/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 sysMtaInboundSessionGet permission.

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

x:MtaInboundSession/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 sysMtaInboundSessionUpdate permission.

curl -X POST https://mail.example.com/api \
  -H 'Authorization: Bearer $TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
      "methodCalls": [
        [
          "x:MtaInboundSession/set",
          {
            "update": {
              "singleton": {
                "maxDuration": {
                  "else": "10m"
                }
              }
            }
          },
          "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-inbound-session

Update​

stalwart-cli update mta-inbound-session --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: