Skip to main content
Version: 0.16

MtaStageRcpt

Configures RCPT TO stage processing and recipient validation.

This object can be configured from the WebUI under Settings › MTA › Session › RCPT TO Stage

Fields​

maxFailures​

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

Maximum number of recipient errors before the session is disconnected

Available variables: MtaMailFromVariable.

waitOnFail​

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

Amount of time to wait after a recipient error

Available variables: MtaMailFromVariable.

maxRecipients​

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

Maximum number of recipients per message

Available variables: MtaMailFromVariable.

allowRelaying​

Type: Expression · default: {"else":"!is_empty(authenticated_as)"}

Whether to allow relaying for non-local domains

Available variables: MtaRcptToVariable.

rewrite​

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

Expression to rewrite the recipient address

Available variables: MtaRcptToVariable.

script​

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

Which Sieve script to run after the client sends a RCPT command

Available variables: MtaRcptToVariable.

JMAP API​

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

x:MtaStageRcpt/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 sysMtaStageRcptGet permission.

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

x:MtaStageRcpt/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 sysMtaStageRcptUpdate permission.

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

Update​

stalwart-cli update mta-stage-rcpt --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: