.\" 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::SPF 3pm"
.TH Mail::MtPolicyd::Plugin::SPF 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::SPF \- mtpolicyd plugin to apply SPF checks
.SH "VERSION"
.IX Header "VERSION"
version 2.02
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This plugin applies Sender Policy Framework(\s-1SPF\s0) checks.
.PP
Checks are implemented using the Mail::SPF perl module.
.PP
Actions based on the \s-1SPF\s0 result can be applied for:
.IP "pass (pass_mode, default: passive)" 4
.IX Item "pass (pass_mode, default: passive)"
.PD 0
.IP "softfail (softfail_mode, default: passive)" 4
.IX Item "softfail (softfail_mode, default: passive)"
.IP "fail (fail_mode, default: reject)" 4
.IX Item "fail (fail_mode, default: reject)"
.PD
.PP
For status 'neutral' no action or score is applied.
.SH "PARAMETERS"
.IX Header "PARAMETERS"
.IP "(uc_)enabled (default: on)" 4
.IX Item "(uc_)enabled (default: on)"
Enable/disable the plugin.
.IP "(uc_)pass_mode (default: passive)" 4
.IX Item "(uc_)pass_mode (default: passive)"
How to behave if the \s-1SPF\s0 checks passed successfully:
.RS 4
.IP "passive" 4
.IX Item "passive"
Just apply score. Do not return an action.
.IP "accept, dunno" 4
.IX Item "accept, dunno"
Will return an 'dunno' action.
.RE
.RS 4
.RE
.IP "pass_score (default: empty)" 4
.IX Item "pass_score (default: empty)"
Score to apply when the sender has been successfully checked against \s-1SPF.\s0
.IP "(uc_)softfail_mode (default: passive)" 4
.IX Item "(uc_)softfail_mode (default: passive)"
How to behave if the \s-1SPF\s0 checks returned a softfail status.
.RS 4
.IP "passive" 4
.IX Item "passive"
Just apply score. Do not return an action.
.IP "accept, dunno" 4
.IX Item "accept, dunno"
Will return an 'dunno' action.
.IP "reject" 4
.IX Item "reject"
Return an reject action.
.RE
.RS 4
.RE
.IP "softfail_score (default: empty)" 4
.IX Item "softfail_score (default: empty)"
Score to apply when the \s-1SPF\s0 check returns an softfail status.
.IP "(uc_)fail_mode (default: reject)" 4
.IX Item "(uc_)fail_mode (default: reject)"
.RS 4
.PD 0
.IP "reject" 4
.IX Item "reject"
.PD
Return an reject action.
.IP "passive" 4
.IX Item "passive"
Just apply score and do not return an action.
.RE
.RS 4
.RE
.IP "reject_message (default: )" 4
.IX Item "reject_message (default: )"
If fail_mode is set to 'reject' this message is used in the reject.
.Sp
The following pattern will be replaced in the string:
.RS 4
.ie n .IP "%LOCAL_EXPL%" 4
.el .IP "\f(CW%LOCAL_EXPL\fR%" 4
.IX Item "%LOCAL_EXPL%"
Will be replaced with a (local) explanation of the check result.
.ie n .IP "%AUTH_EXPL%" 4
.el .IP "\f(CW%AUTH_EXPL\fR%" 4
.IX Item "%AUTH_EXPL%"
Will be replaced with a \s-1URL\s0 to the explanation of the result.
.Sp
This \s-1URL\s0 could be configured with 'default_authority_explanation'.
.RE
.RS 4
.RE
.IP "fail_score (default: empty)" 4
.IX Item "fail_score (default: empty)"
Score to apply if the sender failed the \s-1SPF\s0 checks.
.IP "default_authority_explanation (default: See http://www.%{d}/why/id=%{S};ip=%{I};r=%{R})" 4
.IX Item "default_authority_explanation (default: See http://www.%{d}/why/id=%{S};ip=%{I};r=%{R})"
String to return as an \s-1URL\s0 pointing to an explanation of the \s-1SPF\s0 check result.
.Sp
See Mail::SPF::Server for details.
.IP "hostname (default: empty)" 4
.IX Item "hostname (default: empty)"
An hostname to show in the default_authority_explanation as generating server.
.IP "whitelist (default: '')" 4
.IX Item "whitelist (default: '')"
A comma separated list of \s-1IP\s0 addresses to skip.
.ie n .IP "check_helo (default: ""on"")" 4
.el .IP "check_helo (default: ``on'')" 4
.IX Item "check_helo (default: on)"
Set to 'off' to disable \s-1SPF\s0 check on helo.
.SH "EXAMPLE"
.IX Header "EXAMPLE"
.Vb 7
\&  <Plugin spf>
\&    module = "SPF"
\&    pass_mode = passive
\&    pass_score = \-10
\&    fail_mode = reject
\&    #fail_score = 10
\&  </Plugin>
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Mail::SPF, OpenSPF "" in www.openspf.org, \s-1RFC 7209 \s0<https://tools.ietf.org/html/rfc7208>
.SH "AUTHOR"
.IX Header "AUTHOR"
Markus Benning <ich@markusbenning.de>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is Copyright (c) 2014 by Markus Benning <ich@markusbenning.de>.
.PP
This is free software, licensed under:
.PP
.Vb 1
\&  The GNU General Public License, Version 2, June 1991
.Ve