DispatcherPhase

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.

Phase of a dispatcher task within 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.

Can be one of the following shapes of data:

Option 1

This type is an enum with the following allowed values:

• "Starting"

Option 2

This is an object value, with the following properties:

• AcquiringLease - required object.

Option 3

This type is an enum with the following allowed values:

• "Idle"

Option 4

This is an object value, with the following properties:

• AccumulatingBatch - required object.

Option 5

This type is an enum with the following allowed values:

• "ConnectionRateThrottled"

Option 6

This type is an enum with the following allowed values:

• "MessageRateThrottled"

Option 7

This type is an enum with the following allowed values:

• "AttemptingConnection"

Option 8

This type is an enum with the following allowed values:

• "DeliveringMessage"

Option 9

This type is an enum with the following allowed values:

• "Closing"

Examples

"AttemptingConnection"

"Closing"

"ConnectionRateThrottled"

"DeliveringMessage"

"Idle"

"MessageRateThrottled"

"Starting"

{
  "AccumulatingBatch": {
    "have": 42,
    "want": 42
  }
}

{
  "AcquiringLease": {
    "label": "string"
  }
}