.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
. ds C`
. ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
.\}
.\" ========================================================================
.\"
.IX Title "Mail::MtPolicyd::Plugin::DBL 3pm"
.TH Mail::MtPolicyd::Plugin::DBL 3pm "2017-01-13" "perl v5.24.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Mail::MtPolicyd::Plugin::DBL \- mtpolicyd plugin for checking helo,sender domain,rdns against an DBL
.SH "VERSION"
.IX Header "VERSION"
version 2.02
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Will check the sender, helo and reverse_client_name against an domain black list.
.SH "PARAMETERS"
.IX Header "PARAMETERS"
.IP "domain (required)" 4
.IX Item "domain (required)"
The domain of the blacklist to query.
.IP "enabled (default: on)" 4
.IX Item "enabled (default: on)"
Set to 'off' to disable plugin.
.Sp
Possible values: on,off
.IP "uc_enabled (default: empty)" 4
.IX Item "uc_enabled (default: empty)"
If specified the give variable within the session will overwrite the value of 'enabled' if set.
.IP "(uc_)sender_mode (default: reject), (uc_)helo_name_mode (default: passive), (uc_)reverse_client_name_mode (default: reject)" 4
.IX Item "(uc_)sender_mode (default: reject), (uc_)helo_name_mode (default: passive), (uc_)reverse_client_name_mode (default: reject)"
Should the plugin return an reject if the check matches (reject) or
just add an score (passive).
.Sp
Possible values: reject, passive
.IP "sender_score (default: 5)" 4
.IX Item "sender_score (default: 5)"
.PD 0
.IP "helo_name_score (default: 1)" 4
.IX Item "helo_name_score (default: 1)"
.IP "reverse_client_name_score (default: 2.5)" 4
.IX Item "reverse_client_name_score (default: 2.5)"
.PD
Add the given score if check matched.
.IP "score_field (default: score)" 4
.IX Item "score_field (default: score)"
Name of the session variable the score is stored in.
Could be used if multiple scores are needed.
.SH "EXAMPLE"
.IX Header "EXAMPLE"
Only the sender and the reverse_client_name check will cause an
action to be executed (mode).
The helo check will only add an score.
.PP
.Vb 5
\&
\& module = "RBL"
\& #enabled = "on"
\& uc_enabled = "spamhaus"
\& domain="dbl.spamhaus.org"
\&
\& # do not reject based on helo
\& #helo_name_mode=passive
\& #helo_name_score=1
\& #sender_mode=reject
\& #sender_score=5
\& #reverse_client_name_mode=reject
\& #reverse_client_name_score=2.5
\&
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Markus Benning
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is Copyright (c) 2014 by Markus Benning .
.PP
This is free software, licensed under:
.PP
.Vb 1
\& The GNU General Public License, Version 2, June 1991
.Ve