3.3. Suspend configuration

This file holds all static suspends that should be enforced when the system starts. By default, smtpd loads it from /etc/halon/smtpd-suspend.yaml. It is described by, and can be validated with, the smtpd-suspend.schema.json. A suspend is a rule that prevents a message from being picked up from the active queue. This file can be reloaded using the halonctl queue suspend reload command. The overall concepts of suspends are documented in active queue suspension.

3.3.1. Suspend directives

The suspend directive is an array of rules. Each item in the array represents one suspend. If any of the suspends match, by any field combination it will be in effect for a specific queued message. From a performance perspective it’s beneficial to use string and *.domain over regex patterns.

Note

All fields are optional, meaning if an empty array item is found, everything is suspended.

suspends:
  - {}

suspends[].tenantid

Supported types are string, /regex/ or a @list of those.

suspends[].jobid

Supported types are string, /regex/ or a @list of those.

suspends[].transportid

Supported types are string, /regex/ or a @list of those.

suspends[].localip

Supported types are ipv4, ipv4network, ipv6, ipv6network or @list of those.

suspends[].grouping

Supported types are string, /regex/ or a @list of those.

suspends[].remoteip

Supported types are ipv4, ipv4network, ipv6, ipv6network or @list of those.

suspends[].remotemx

Supported types are domain, *.domain, /regex/ or a @list of those.

suspends[].recipientdomain

Supported types are domain, *.example.com, /regex/ or a @list of those.

suspends[].tag

A tag (max 32 characters) defining the rule.

suspends[].properties{}

Supported values are string, number or a boolean.