.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Mail::SpamAssassin::Plugin::SPF 3"
.TH Mail::SpamAssassin::Plugin::SPF 3 2024-09-01 "perl v5.40.0" "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::SpamAssassin::Plugin::SPF \- perform SPF verification tests
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  loadplugin     Mail::SpamAssassin::Plugin::SPF
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This plugin checks a message against Sender Policy Framework (SPF)
records published by the domain owners in DNS to fight email address
forgery and make it easier to identify spams.
.PP
It's recommended to use MTA filter (pypolicyd-spf / spf-engine etc), so this
plugin can reuse the Received-SPF and/or Authentication-Results header results as is.
Otherwise throughput could suffer, DNS lookups done by this plugin are not
asynchronous.
Those headers will also help when SpamAssassin is not able to correctly detect EnvelopeFrom.
.SH "USER SETTINGS"
.IX Header "USER SETTINGS"
.IP "welcomelist_from_spf user@example.com" 4
.IX Item "welcomelist_from_spf user@example.com"
Previously whitelist_from_spf which will work interchangeably until 4.1.
.Sp
Works similarly to welcomelist_from, except that in addition to matching a
sender address, a check against the domain's SPF record must pass.  The
first parameter is an address to welcomelist, and the second is a string to
match the relay's rDNS.
.Sp
Just like welcomelist_from, multiple addresses per line, separated by
spaces, are OK.  Multiple \f(CW\*(C`welcomelist_from_spf\*(C'\fR lines are also OK.
.Sp
The headers checked for welcomelist_from_spf addresses are the same headers
used for SPF checks (Envelope-From, Return-Path, X\-Envelope-From, etc).
.Sp
Since this welcomelist requires an SPF check to be made, network tests must be
enabled. It is also required that your trust path be correctly configured.
See the section on \f(CW\*(C`trusted_networks\*(C'\fR for more info on trust paths.
.Sp
e.g.
.Sp
.Vb 2
\&  welcomelist_from_spf joe@example.com fred@example.com
\&  welcomelist_from_spf *@example.com
.Ve
.IP "def_welcomelist_from_spf user@example.com" 4
.IX Item "def_welcomelist_from_spf user@example.com"
Previously def_whitelist_from_spf which will work interchangeably until 4.1.
.Sp
Same as \f(CW\*(C`welcomelist_from_spf\*(C'\fR, but used for the default welcomelist entries
in the SpamAssassin distribution.  The welcomelist score is lower, because
these are often targets for spammer spoofing.
.IP "unwelcomelist_from_spf user@example.com" 4
.IX Item "unwelcomelist_from_spf user@example.com"
Previously unwhitelist_from_spf which will work interchangeably until 4.1.
.Sp
Used to remove a \f(CW\*(C`welcomelist_from_spf\*(C'\fR or \f(CW\*(C`def_welcomelist_from_spf\*(C'\fR entry. 
The specified email address has to match exactly the address previously used.
.Sp
Useful for removing undesired default entries from a distributed configuration
by a local or site-specific configuration or by \f(CW\*(C`user_prefs\*(C'\fR.
.SH "ADMINISTRATOR SETTINGS"
.IX Header "ADMINISTRATOR SETTINGS"
.IP "spf_timeout n		(default: 5)" 4
.IX Item "spf_timeout n (default: 5)"
How many seconds to wait for an SPF query to complete, before scanning
continues without the SPF result. A numeric value is optionally suffixed
by a time unit (s, m, h, d, w, indicating seconds (default), minutes, hours,
days, weeks).
.IP "ignore_received_spf_header (0|1)	(default: 0)" 4
.IX Item "ignore_received_spf_header (0|1) (default: 0)"
By default, to avoid unnecessary DNS lookups, the plugin will try to use the
SPF results found in any \f(CW\*(C`Received\-SPF\*(C'\fR headers it finds in the message that
could only have been added by an internal relay.
.Sp
Set this option to 1 to ignore any \f(CW\*(C`Received\-SPF\*(C'\fR headers present and to have
the plugin perform the SPF check itself.
.Sp
Note that unless the plugin finds an \f(CW\*(C`identity=helo\*(C'\fR, or some unsupported
identity, it will assume that the result is a mfrom SPF check result.  The
only identities supported are \f(CW\*(C`mfrom\*(C'\fR, \f(CW\*(C`mailfrom\*(C'\fR and \f(CW\*(C`helo\*(C'\fR.
.IP "use_newest_received_spf_header (0|1)	(default: 0)" 4
.IX Item "use_newest_received_spf_header (0|1) (default: 0)"
By default, when using \f(CW\*(C`Received\-SPF\*(C'\fR headers, the plugin will attempt to use
the oldest (bottom most) \f(CW\*(C`Received\-SPF\*(C'\fR headers, that were added by internal
relays, that it can parse results from since they are the most likely to be
accurate.  This is done so that if you have an incoming mail setup where one
of your primary MXes doesn't know about a secondary MX (or your MXes don't
know about some sort of forwarding relay that SA considers trusted+internal)
but SA is aware of the actual domain boundary (internal_networks setting) SA
will use the results that are most accurate.
.Sp
Use this option to start with the newest (top most) \f(CW\*(C`Received\-SPF\*(C'\fR headers,
working downwards until results are successfully parsed.
.IP has_check_for_spf_errors 4
.IX Item "has_check_for_spf_errors"
Adds capability check for "if \fBcan()\fR" for check_for_spf_permerror, check_for_spf_temperror, check_for_spf_helo_permerror and check_for_spf_helo_permerror
.IP has_check_spf_skipped_noenvfrom 4
.IX Item "has_check_spf_skipped_noenvfrom"
Adds capability check for "if \fBcan()\fR" for check_spf_skipped_noenvfrom
.RS 4
.IP check_spf_skipped_noenvfrom 4
.IX Item "check_spf_skipped_noenvfrom"
Checks if SPF checks have been skipped because EnvelopeFrom cannot be determined.
.RE
.RS 4
.RE