[pmg-docs.git] / pmgqm.adoc

[[chapter_pmgqm]]
ifdef::manvolnum[]
pmgqm(1)
========
:pmg-toplevel:

NAME
----

pmgqm - Quarantine Management Toolkit


SYNOPSIS
--------

include::pmgqm.1-synopsis.adoc[]


DESCRIPTION
-----------
endif::manvolnum[]
ifndef::manvolnum[]
pmgqm - Quarantine Management Toolkit
=====================================
:pmg-toplevel:
endif::manvolnum[]

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)`.

ifdef::manvolnum[]
include::pmg-copyright.adoc[]
endif::manvolnum[]
Commit	Line	Data
	1	[[chapter_pmgqm]]
	2	ifdef::manvolnum[]
	3	pmgqm(1)
	4	========
	5	:pmg-toplevel:
	6
	7	NAME
	8	----
	9
	10	pmgqm - Quarantine Management Toolkit
	11
	12
	13	SYNOPSIS
	14	--------
	15
	16	include::pmgqm.1-synopsis.adoc[]
	17
	18
	19	DESCRIPTION
	20	-----------
	21	endif::manvolnum[]
	22	ifndef::manvolnum[]
	23	pmgqm - Quarantine Management Toolkit
	24	=====================================
	25	:pmg-toplevel:
	26	endif::manvolnum[]
	27
	28	Toolkit to manage spam and virus quarantine, and send spam report mails.
	29
	30	The possible timespans are `week`, `yesterday`, and `today`. The default
	31	pmgspamreport.service is run at 00:05 every day and calls the `pmgqm` command
	32	with the `--timespan yesterday` parameter.
	33	This will send a spam report if at least one new spam mail was moved to the
	34	quarantine since the beginning of the previous day.
	35
	36	The service can be edited, for example, to change the timespan to `today` or
	37	`week`, with the following command:
	38	----
	39	systemctl edit pmgspamreport.service
	40	----
	41
	42	The timer can be edited with the command below:
	43	----
	44	systemctl edit pmgspamreport.timer
	45	----
	46
	47	Note that adding another `OnCalendar` event will cause the report to be sent in
	48	addition to the default time. If you want to prevent the default email at
	49	00:05, you must first reset the original `OnCalendar` setting, For example, to
	50	send the emails only at 06:00 you would enter the following lines when
	51	editing the timer unit:
	52
	53	----
	54	[Timer]
	55	OnCalendar=
	56	OnCalendar=06:00
	57	----
	58
	59	For details see the systemd man pages: `systemd.unit(5)`, `systemd.timer(5)`.
	60
	61	ifdef::manvolnum[]
	62	include::pmg-copyright.adoc[]
	63	endif::manvolnum[]
	64