NAME

pmx-qdigest.conf - Configuration options for pmx-qdigest, pmx-qdigest-expire and pmx-qdigest-approve


SYNOPSIS

/opt/pmx6/etc/pmx-qdigest.conf


DESCRIPTION

approve_addr
The generated email will come with a Reply-To header that points to this address. The address should be configured to invoke the pmx-qdigest-approve script.

approve_tmpl
When pmx-qdigest-approve fails to process an end-user approval request, it uses the approve_tmpl template file to construct a response message. If a full path is not specified, pmx-qdigest-approve searches the etc directory, then the etc/templates/<language> directory for this template. The language-specific path used in this search is taken from the language setting in pmx.conf.

consolidate
The type of consolidation to perform when constructing digest messages. Known values are none (do not consolidate digests) and merged (digests are consolidated into a single message according to the notifications map). The default is none for backwards compatibility.

centralized
The centralized setting is used to create digests from quarantines on multiple servers. The default is false. To enable centralized digests, set this option to true.

<digest>
The digest section contains the definitions of each type of digest to generate. For example, the default 'spam-only' digest generates a list of messages quarantined for the reason 'spam' for each user belonging to the list specified in the 'members' setting.
expire
How long to wait between mailing the digest and deleting the entry in the digest directory.

<digest_config_name>
Each digest section specifies what kind of quarantined messages to report, and which users should receive summaries.
template
The name of the template file used to generate the digest. If a full path is not specified, pmx-qdigest searches the etc directory, then the etc/templates/<language> directory for this template. The language-specific path used in this search is taken from the language setting in pmx.conf.

<reason>
When a message is added to the quarantine, a the policy action attaches a 'reason' to the message. For example, 'spam' and 'virus' are default reason codes. This reason code is used to determine which messages should be included in the digest. For example, enter 'spam' in this section to include messages quarantined for the reason 'spam'. You may enter multiple reason codes.

</reason>
members
Messages are generated for the users in the specified list.

</spam-only>
</digest>
<approve>
Each approve section specifies the type of quarantined messages to approve for users. If a reason doesn't specify an action, it inherits the default action.
action
The supported actions are 'approve' (release the message to the user) and 'deny' (refuse to release the message).

<virus>
action
The supported actions are 'approve' (release the message to the user) and 'deny' (refuse to release the message).

weight
Each section can also have a weight. Weight is used when an email was quarantined for more than one reason. The rule with the highest weight for each message takes priority. By default, the weight is '0'.

</virus>
</approve>


SEE ALSO

See also the pmx-qdigest manpage, the pmx-qdigest-expire manpage and the pmx-qdigest-approve manpage.


=head1 COPYRIGHT

Copyright (C) 2000-2008 Sophos Group. All rights reserved. Sophos and PureMessage are trademarks of Sophos Plc and Sophos Group.