| Current File : //usr/local/share/man/man1/spfquery.1 |
.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.30)
.\"
.\" 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 turned on, 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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "SPFQUERY 1"
.TH SPFQUERY 1 "2006-01-23" "perl v5.20.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"
spfquery \- checks if an IP address is an SPF\-authorized SMTP sender for a
domain
.SH "VERSION"
.IX Header "VERSION"
2.3
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBspfquery\fR \fB\-\-mail\-from\fR|\fB\-m\fR|\fB\-\-sender\fR|\fB\-s\fR \fIemail-address\fR|\fIdomain\fR
\&\fB\-\-helo\fR|\fB\-h\fR \fIhostname\fR \fB\-\-ip\fR|\fB\-i\fR \fIip-address\fR [\fI\s-1OPTIONS\s0\fR]
.PP
\&\fBspfquery\fR \fB\-\-helo\fR|\fB\-h\fR \fIhostname\fR \fB\-\-ip\fR|\fB\-i\fR \fIip-address\fR [\fI\s-1OPTIONS\s0\fR]
.PP
\&\fBspfquery\fR \fB\-\-file\fR|\fB\-f\fR \fIfilename\fR|\fB\-\fR [\fI\s-1OPTIONS\s0\fR]
.PP
\&\fBspfquery\fR \fB\-\-version\fR|\fB\-V\fR
.PP
\&\fBspfquery\fR \fB\-\-help\fR
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBspfquery\fR performs Sender Policy Framework (\s-1SPF\s0) authorization checks based
on the command-line arguments or data given in a file or on standard input.
For information on \s-1SPF\s0 see <http://www.openspf.org>.
.PP
The \fB\-\-mail\-from\fR form checks if the given \fIip-address\fR is an authorized \s-1SMTP\s0
sender for the given envelope sender \fIdomain\fR or \fIemail-address\fR and \f(CW\*(C`HELO\*(C'\fR
\&\fIhostname\fR (so-called \f(CW\*(C`MAIL FROM\*(C'\fR check). If a \fIdomain\fR is given,
\&\f(CW\*(C`postmaster\*(C'\fR will be substituted for the localpart.
.PP
The \fB\-\-helo\fR form checks if the given \fIip-address\fR is an authorized \s-1SMTP\s0
sender for the given \f(CW\*(C`HELO\*(C'\fR \fIhostname\fR (so-called \f(CW\*(C`HELO\*(C'\fR check).
.PP
The \fB\-\-file\fR form reads "\fIip-address\fR \fIsender-address\fR \fIhelo-hostname\fR"
tuples from the file with the specified \fIfilename\fR, or from standard input if
\&\fIfilename\fR is \fB\-\fR.
.PP
The \fB\-\-version\fR form prints version information of spfquery. The \fB\-\-help\fR
form prints usage information for spfquery.
.SH "OPTIONS"
.IX Header "OPTIONS"
The \fB\-\-mail\-from\fR, \fB\-\-helo\fR, and \fB\-\-file\fR forms optionally take any of the
following additional \fI\s-1OPTIONS\s0\fR:
.IP "\fB\-\-debug\fR" 4
.IX Item "--debug"
Print out debug information.
.IP "\fB\-\-default\-explanation\fR \fIstring\fR" 4
.IX Item "--default-explanation string"
Use the specified \fIstring\fR as the default explanation if the \s-1SPF\s0 record does
not specify an explanation string itself.
.IP "\fB\-\-guess\fR \fIspf-terms\fR" 4
.IX Item "--guess spf-terms"
Use \fIspf-terms\fR as a default record if no \s-1SPF\s0 record is found. \fBThis is a
non-standard feature.\fR
.IP "\fB\-\-keep\-comments\fR" 4
.IX Item "--keep-comments"
.PD 0
.IP "\fB\-\-no\-keep\-comments\fR" 4
.IX Item "--no-keep-comments"
.PD
Do (not) print any comments found when reading from a file or from standard
input.
.IP "\fB\-\-local\fR \fIspf-terms\fR" 4
.IX Item "--local spf-terms"
Process \fIspf-terms\fR as local policy before resorting to a default result
(the implicit or explicit \f(CW\*(C`all\*(C'\fR mechanism at the end of the domain's \s-1SPF\s0
record). For example, this could be used for white-listing one's secondary
MXes: \f(CW\*(C`mx:mydomain.example.org\*(C'\fR.
.IP "\fB\-\-max\-lookup\-count\fR \fIn\fR" 4
.IX Item "--max-lookup-count n"
Perform a maximum of \fIn\fR \s-1SPF\s0 record lookups. Defaults to \fB10\fR.
.IP "\fB\-\-name\fR \fIhostname\fR" 4
.IX Item "--name hostname"
Use \fIhostname\fR as the hostname of the local system instead of auto-detecting
it.
.IP "\fB\-\-override\fR \fIdomain\fR\fB=\fR\fIspf-record\fR" 4
.IX Item "--override domain=spf-record"
.PD 0
.IP "\fB\-\-fallback\fR \fIdomain\fR\fB=\fR\fIspf-record\fR" 4
.IX Item "--fallback domain=spf-record"
.PD
Set overrides and fallbacks. Each option can be specified multiple times. For
example: \f(CW\*(C`\-\-override example.org=\*(Aqv=spf1 \-all\*(Aq \-\-override
\&\*(Aq*.example.net\*(Aq=\*(Aqv=spf1 a mx \-all\*(Aq \-\-fallback example.com=\*(Aqv=spf1 \-all\*(Aq\*(C'\fR.
\&\fBThis is a non-standard feature.\fR
.IP "\fB\-\-rcpt\-to\fR \fIemail-addresses\fR" 4
.IX Item "--rcpt-to email-addresses"
Automatically allow the secondary MXes of the comma-separated list of
\&\fIemail-addresses\fR.
.IP "\fB\-\-sanitize\fR" 4
.IX Item "--sanitize"
.PD 0
.IP "\fB\-\-no\-sanitize\fR" 4
.IX Item "--no-sanitize"
.PD
Do (not) sanitize the output by condensing consecutive white-space into a
single space and replacing non-printable characters with question marks.
Enabled by default.
.IP "\fB\-\-trusted\fR" 4
.IX Item "--trusted"
.PD 0
.IP "\fB\-\-no\-trusted\fR" 4
.IX Item "--no-trusted"
.PD
Do (not) perform \f(CW\*(C`trusted\-forwarder.org\*(C'\fR accreditation checking. Disabled by
default. \fBThis is a non-standard feature.\fR
.SH "RESULT CODES"
.IX Header "RESULT CODES"
.IP "\fBpass\fR" 10
.IX Item "pass"
The specified \s-1IP\s0 address is an authorized mailer for the sender domain/address.
.IP "\fBfail\fR" 10
.IX Item "fail"
The specified \s-1IP\s0 address is not an authorized mailer for the sender
domain/address.
.IP "\fBsoftfail\fR" 10
.IX Item "softfail"
The specified \s-1IP\s0 address is not an authorized mailer for the sender
domain/address, however the domain is still in the process of transitioning to
\&\s-1SPF.\s0
.IP "\fBneutral\fR" 10
.IX Item "neutral"
The sender domain makes no assertion about the status of the \s-1IP\s0 address.
.IP "\fBunknown\fR" 10
.IX Item "unknown"
The sender domain has a syntax error in its \s-1SPF\s0 record.
.IP "\fBerror\fR" 10
.IX Item "error"
A temporary \s-1DNS\s0 error occurred while resolving the sender policy. Try again
later.
.IP "\fBnone\fR" 10
.IX Item "none"
There is no \s-1SPF\s0 record for the sender domain.
.SH "EXIT CODES"
.IX Header "EXIT CODES"
.IP "\fB0\fR" 4
.IX Item "0"
pass
.IP "\fB1\fR" 4
.IX Item "1"
fail
.IP "\fB2\fR" 4
.IX Item "2"
softfail
.IP "\fB3\fR" 4
.IX Item "3"
neutral
.IP "\fB4\fR" 4
.IX Item "4"
unknown
.IP "\fB5\fR" 4
.IX Item "5"
error
.IP "\fB6\fR" 4
.IX Item "6"
none
.SH "EXAMPLES"
.IX Header "EXAMPLES"
.Vb 3
\& spfquery \-i 11.22.33.44 \-m user@example.com \-h spammer.example.net
\& spfquery \-f test_data
\& echo "127.0.0.1 user@example.com helohost.example.com" | spfquery \-f \-
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Mail::SPF::Query, spfd
.SH "AUTHORS"
.IX Header "AUTHORS"
This version of \fBspfquery\fR was written by Wayne Schlitt <wayne@midwestcs.com>.
.PP
This man-page was written by Julian Mehnle <julian@mehnle.net>, based on a
man-page written by S. Zachariah Sprackett for an older version of \fBspfquery\fR.