pmgqm(1)

NAME

pmgqm - Quarantine Management Toolkit

SYNOPSIS

pmgqm <COMMAND> [ARGS] [OPTIONS]

pmgqm help [OPTIONS]

Get help about specified command.

--extra-args <array>: Shows help for a specific command
--verbose <boolean>: Verbose output format.

pmgqm purge [OPTIONS]

Cleanup Quarantine database. Remove entries older than configured quarantine lifetime.

--check <boolean> (default = 0): Only search for quarantine files older than configured quarantine lifetime. Just print found files, but do not remove them.

pmgqm send [OPTIONS]

Generate and send spam report emails.

--debug <boolean> (default = 0): Debug mode. Print raw email to stdout instead of sending them.
--receiver (?:[^\s\\@]+\@[^\s\/\\@]+): Generate report for a single email address. If not specified, generate reports for all users.
--redirect (?:[^\s\\@]+\@[^\s\/\\@]+): Redirect spam report email to this address.
--style <custom | short | verbose>: Spam report style. Default value is read from spam quarantine configuration.
--timespan <today | week | yesterday> (default = today): Select time span.

pmgqm status [OPTIONS]

Print quarantine status (mails per user) for specified time span.

--timespan <today | week | yesterday> (default = today): Select time span.

DESCRIPTION

Toolkit to manage spam and virus quarantine, and send spam report mails.

The possible timespans are week, yesterday, and today. The default pmgspamreport.service is run at 00:05 every day and calls the pmgqm command with the --timespan yesterday parameter. This will send a spam report if at least one new spam mail was moved to the quarantine since the beginning of the previous day.

The service can be edited, for example, to change the timespan to today or week, with the following command:

systemctl edit pmgspamreport.service

The timer can be edited with the command below:

systemctl edit pmgspamreport.timer

Note that adding another OnCalendar event will cause the report to be sent in addition to the default time. If you want to prevent the default email at 00:05, you must first reset the original OnCalendar setting, For example, to send the emails only at 06:00 you would enter the following lines when editing the timer unit:

[Timer]
OnCalendar=
OnCalendar=06:00

For details see the systemd man pages: systemd.unit(5), systemd.timer(5).

Copyright and Disclaimer

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/