TaskManager

Configures how background tasks are retried after transient failures.

This object can be configured from the WebUI under Settings › Task Manager

Fields

strategy

Type: TaskRetryStrategy · required

Strategy used to compute the delay before a task that failed with a transient error is retried

alertAfter

Type: UnsignedInt · default: 5 · min: 1

Number of failed attempts after which a task is reported as stalled; stalled tasks keep retrying with the configured strategy

JMAP API

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

x:TaskManager/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 sysTaskManagerGet permission.

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

x:TaskManager/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 sysTaskManagerUpdate permission.

curl -X POST https://mail.example.com/jmap/ \
  -H 'Authorization: Bearer $TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
      "methodCalls": [
        [
          "x:TaskManager/set",
          {
            "update": {
              "singleton": {
                "strategy": {
                  "@type": "ExponentialBackoff"
                }
              }
            }
          },
          "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 TaskManager

Update

stalwart-cli update TaskManager --field strategy='{"@type":"ExponentialBackoff"}'

Nested types

TaskRetryStrategy

Retry strategy for failed tasks.

• ExponentialBackoff: Exponential backoff. Carries the fields of TaskRetryStrategyBackoff.
• FixedDelay: Fixed delay. Carries the fields of TaskRetryStrategyFixed.

TaskRetryStrategyBackoff

Exponential backoff retry strategy settings.

factor

Type: Float · default: 2.0 · min: 1

Backoff factor for calculating retry delays

initialDelay

Type: Duration · default: 60000

Initial delay before retrying a failed task

maxDelay

Type: Duration · default: 21600000

Maximum delay between retry attempts

jitter

Type: Boolean · default: true

Whether to apply jitter to the retry delay to avoid thundering herd problem

TaskRetryStrategyFixed

Fixed delay retry strategy settings.

delay

Type: Duration · default: 300000

Fixed delay before retrying a failed task