MtaVirtualQueue

Defines a virtual queue for organizing outbound message delivery.

This object can be configured from the WebUI under Settings › MTA › Outbound › Virtual Queues

Fields

name

Type: String · read-only · max length: 8

Unique identifier for the queue, max 8 characters

description

Type: String?

A short description of the queue, which can be used to identify it in the list of queues

threadsPerNode

Type: UnsignedInt · default: 25 · min: 1

Maximum number of threads to use for delivery on each node in the cluster

JMAP API

The MtaVirtualQueue object is available via the urn:stalwart:jmap capability.

x:MtaVirtualQueue/get

This is a standard Foo/get method as defined in RFC 8620, Section 5.1.

This method requires the sysMtaVirtualQueueGet permission.

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

x:MtaVirtualQueue/set

This is a standard Foo/set method as defined in RFC 8620, Section 5.3.

Supports create, update, and destroy operations in a single call.

Create

This operation requires the sysMtaVirtualQueueCreate permission.

curl -X POST https://mail.example.com/api \
  -H 'Authorization: Bearer $TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
      "methodCalls": [
        [
          "x:MtaVirtualQueue/set",
          {
            "create": {
              "new1": {
                "description": "Example",
                "threadsPerNode": 25
              }
            }
          },
          "c1"
        ]
      ],
      "using": [
        "urn:ietf:params:jmap:core",
        "urn:stalwart:jmap"
      ]
    }'

Update

This operation requires the sysMtaVirtualQueueUpdate permission.

curl -X POST https://mail.example.com/api \
  -H 'Authorization: Bearer $TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
      "methodCalls": [
        [
          "x:MtaVirtualQueue/set",
          {
            "update": {
              "id1": {
                "description": "updated value"
              }
            }
          },
          "c1"
        ]
      ],
      "using": [
        "urn:ietf:params:jmap:core",
        "urn:stalwart:jmap"
      ]
    }'

Destroy

This operation requires the sysMtaVirtualQueueDestroy permission.

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

x:MtaVirtualQueue/query

This is a standard Foo/query method as defined in RFC 8620, Section 5.5.

This method requires the sysMtaVirtualQueueQuery permission.

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

The x:MtaVirtualQueue/query filter argument accepts the following conditions (combinable with AnyOf / AllOf / Not per RFC 8620):

Condition	Kind
name	text

CLI

stalwart-cli wraps the same JMAP calls. See the CLI reference for installation, authentication, and general usage.

Fetch

stalwart-cli get mta-virtual-queue id1

Create

stalwart-cli create mta-virtual-queue \
  --field description=Example \
  --field threadsPerNode=25

Query

stalwart-cli query mta-virtual-queue
stalwart-cli query mta-virtual-queue --where name=example

Update

stalwart-cli update mta-virtual-queue id1 --field description='Updated'

Delete

stalwart-cli delete mta-virtual-queue --ids id1