IndexQueueStatus

Represents the processing state of a search index queue.

This object can be configured from the WebUI under Management › Tasks › Index Queue

Fields

index

Type: IndexType · server-set

Search index the queue belongs to

partition

Type: UnsignedInt · server-set · default: 0

Account or telemetry bucket the queued documents belong to

queuedUpdates

Type: UnsignedInt · server-set · default: 0

Number of documents awaiting indexing

queuedDeletions

Type: UnsignedInt · server-set · default: 0

Number of documents awaiting deletion from the index

status

Type: IndexStatus · default: {"@type":"Running"}

Current processing state of the queue

JMAP API

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

x:IndexQueueStatus/get

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

This method requires the sysIndexQueueStatusGet permission.

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

x:IndexQueueStatus/set

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

Supports the update operation only.

This method requires the sysIndexQueueStatusUpdate permission.

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

x:IndexQueueStatus/query

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

This method requires the sysIndexQueueStatusQuery permission.

curl -X POST https://mail.example.com/jmap/ \
  -H 'Authorization: Bearer $TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
      "methodCalls": [
        [
          "x:IndexQueueStatus/query",
          {
            "filter": {}
          },
          "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 IndexQueueStatus id1

Query

stalwart-cli query IndexQueueStatus

Update

stalwart-cli update IndexQueueStatus id1 --field status='{"@type":"Running"}'

Nested types

IndexStatus

Processing state of a search index queue.

• Running: Queue is being processed normally. No additional fields.
• Failed: Last indexing attempt failed. Carries the fields of IndexStatusFailed.

IndexStatusFailed

Details of the last failed indexing attempt.

reason

Type: Text · required

Error reported by the last indexing attempt

nextRetry

Type: UTCDateTime · required

Date and time when indexing will be retried

Enums

IndexType

Value	Label
telemetry	Telemetry
email	Email
calendar	Calendar
contacts	Contacts
file	File