PostQF

^{Copyright © 2022,2024 Ralph Seichter}

PostQF is a user-friendly Postfix queue data filter which operates on data produced by postqueue -j. See the manual page's subsection titled "JSON object format" for details. PostQF offers convenient features for analysis and and cleanup of Postfix mail queues.

I have used the all-purpose JSON manipulation utility "jq" before, but found it inconvenient for everyday Postfix administration tasks. "jq" offers great flexibility and handles all sorts of JSON input, but it comes at the cost of complexity. PostQF is an alternative specifically tailored for easier access to Postfix queues.

To facilitate the use of Unix-like pipelines, PostQF usually reads from stdin and writes to stdout. Using command line arguments, you can override this behaviour and define one or more input files and/or an output file. Depending on the context, a horizontal dash - represents either stdin or stdout. See the command line usage description below.

Example usage

Find all messages in the deferred queue where the delay reason contains the string connection timed out.

postqueue -j | postqf -q deferred -d 'connection timed out'

Find all messages in the active or hold queues which have at least one recipient in the example.com or example.org domains, and write the matching JSON records into the file /tmp/output.

postqueue -j | postqf -q 'active|hold' -r '@example\.(com|org)$' -o /tmp/output

Find all messages all queues for which the sender address is [email protected] or [email protected], and pipe the queue IDs to postsuper in order to place the matching messages on hold.

postqueue -j | postqf -s '^(alice|bob)@gmail\.com$' -i | postsuper -h -

Print the number of messages which arrived during the last 30 minutes.

postqueue -j | postqf -a 30m | wc -l

The next example assumes a directory /tmp/data with several files, each containing JSON output produced at some previous time. The command pipes all queue IDs which have ever been in the hold queue into the file idlist, relying on BASH wildcard expansion to generate a list of input files.

postqf -i -q hold /tmp/data/*.json > idlist

Count unique recipient address domains for deferred messages and print a sorted list:

postqueue -j | postqf -q deferred --rdom

Filters

Queue entries can be easily filtered by

• Arrival time
• Delay reason
• Queue name
• Recipient address
• Sender address

and combinations thereof, using regular expressions. Anchoring is optional, meaning that plain text is treated as a substring pattern.

Time based filters

Arrival time filters do not use regular expressions, but support the following formats instead:

1. ISO 8601 time strings.
2. Unix time (the number of seconds since January 1, 1970). This is the representation of arrival time returned in JSON-format Postfix queue data.
3. Time difference, expressed as one or more digits followed by a single "unit" character s, m, h, or d. These units designate seconds, minutes, hours and days. The resulting timestamp will be in the past, as in "now minus the difference".

Please keep in mind that formats 1 and 2 are used for fixed timestamps, while format 3 represents time differences against the time of running PostQF. When format 3 is used with static input data (say, JSON data you saved to disk sevaral days ago) the results may vary as time progresses. When in doubt, use absolute time formats.

The command line option -a X means "message arrived after time X", and -b Y means "message arrived before time Y". The filter string can have any of the supported formats, and you can mix them freely. Here are some examples of valid command line arguments:

• -a 2022-01-23T08:30 -b 2022-01-23T17:45 January 23, 2022 between 08:30 and 17:45.
• -a 1642923000 -b 1642956300 The same time interval, specified in Unix time.
• -a 90m Less than 90 minutes ago.
• -b 36h More than 36 hours ago.

Custom output

In addition to filtering JSON input and producing JSON output in the process, PostQF can also generate a number of simple reports to answer some of the most frequently asked questions about message queue content. The following data can be shown in reports:

• Delay reason
• Recipient address
• Recipient domain
• Sender address
• Sender domain

Another type of custom output is a list of raw message IDs associated with the filter criteria. ID lists can be piped to utilities like postsuper. Please note that only one type of report or custom output can be generated at a time, and that the necessary command line options are therefore mutually exclusive.

Command line usage

postqf [-h] [-d REGEX] [-q REGEX] [-r REGEX] [-s REGEX] [-a TS] [-b TS] [-o OUTFILE]
       [--id | --rcpt | --rdom | --reason | --sdom | --sender] [FILE [FILE ...]]

Positional arguments:
  FILE        Input file. Use a dash "-" for standard input.

Optional arguments:
  -h, --help  show this help message and exit
  -o OUTFILE  Output file. Use a dash "-" for standard output.

Regular expression filters:
  -d REGEX    Delay reason filter.
  -q REGEX    Queue name filter.
  -r REGEX    Recipient address filter.
  -s REGEX    Sender address filter.

Arrival time filters:
  -a TS       Message arrived after TS.
  -b TS       Message arrived before TS.

Custom output (mutually exclusive):
  --id, -i    ID output only.
  --rcpt      Recipient address report.
  --rdom      Recipient domain report.
  --reason    Delay reason report.
  --sdom      Sender domain report.
  --sender    Sender address report.

Installation

The only installation requirement is Python version 3.7 or newer. PostQF is distributed via PyPI.org and can be installed using either pip or pip3, depending on your Python distribution.

I also provide an installer script. It will download the latest PostQF release into the current directory, and generate an executable launcher. When in doubt, choose this method. Note that you do not need to install PostQF as 'root', and I recommend using an unprivileged user account.

# Method 1: Official installation script.
mkdir /path/to/somedir
cd /path/to/somedir
# Download and run the install script. If successful, it will print a message
# similar to "You can now launch PostQF using /path/to/somedir/postqf".
curl -fL https://github.com/rseichter/postqf/raw/master/scripts/install.sh | bash

# Method 2: Python virtual environment.
mkdir /path/to/somedir
cd /path/to/somedir
python3 -m venv venv
venv/bin/pip install postqf

The pip installation process also adds a launcher executable like venv/bin/postqf. You might want to modify your PATH environment variable for easy access.

Contact

The project is hosted on GitHub in the rseichter/postqf repository. If you have suggestions or run into any problems, please check the discussions section first. There is also an issue tracker available, and the build configuration file contains a contact email address.