Skip to content

ReadyQueueStateSnapshot

Info

This page was generated by extracting information from a JSON Schema data file for the API. It may be missing some information, or otherwise suggest approximate or placeholder values based on information in the schema file; this is due to limitations on how that data is extracted from the underlying Rust code and into the JSON Schema, and then again from there and into these docs.

Snapshot of the operational state of a ready queue.

Since: Dev Builds Only

The functionality described in this section requires a dev build of KumoMTA. You can obtain a dev build by following the instructions in the Installation section.

This is an object value, with the following properties:

  • connection_count - required integer.

  • connection_limited - optional nullable QueueState.

  • connection_rate_throttled - optional nullable QueueState.

  • ready_count - required integer.

  • suspended - optional nullable SuspendReadyQueueV1ListEntry.

  • watchdog_threshold - required string. Effective progress watchdog timeout for this queue, honoring the per-egress-path config or the protocol-derived default.

Examples

{
  "connection_count": 42,
  "connection_limited": {
    "context": "TooManyLeases for queue",
    "since": "1990-12-31T23:59:60Z"
  },
  "connection_rate_throttled": {
    "context": "TooManyLeases for queue",
    "since": "1990-12-31T23:59:60Z"
  },
  "ready_count": 42,
  "suspended": {
    "duration": "string",
    "expires": "1990-12-31T23:59:60Z",
    "id": "9511a32e-66f8-42aa-b151-ccb176df47d9",
    "name": "source_name->(alt1|alt2|alt3|alt4)?.gmail-smtp-in.l.google.com@smtp_client",
    "reason": "pause while working on resolving a block with the destination postmaster"
  },
  "watchdog_threshold": "string"
}