.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" 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 "Mail::SPF::Record 3"
.TH Mail::SPF::Record 3 "2016-08-24" "perl v5.16.3" "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::SPF::Record \- Abstract base class for SPF records
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.SS "Creating a record from a string"
.IX Subsection "Creating a record from a string"
.Vb 1
\&    use Mail::SPF::v1::Record;
\&
\&    my $record = Mail::SPF::v1::Record\->new_from_string("v=spf1 a mx \-all");
.Ve
.SS "Creating a record synthetically"
.IX Subsection "Creating a record synthetically"
.Vb 1
\&    use Mail::SPF::v2::Record;
\&
\&    my $record = Mail::SPF::v2::Record\->new(
\&        scopes      => [\*(Aqmfrom\*(Aq, \*(Aqpra\*(Aq],
\&        terms       => [
\&            Mail::SPF::Mech::A\->new(),
\&            Mail::SPF::Mech::MX\->new(),
\&            Mail::SPF::Mech::All\->new(qualifier => \*(Aq\-\*(Aq)
\&        ],
\&        global_mods => [
\&            Mail::SPF::Mod::Exp\->new(domain_spec => \*(Aqspf\-exp.example.com\*(Aq)
\&        ]
\&    );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBMail::SPF::Record\fR is an abstract base class for \s-1SPF\s0 records.  It cannot be
instantiated directly.  Create an instance of a concrete sub-class instead.
.SS "Constructor"
.IX Subsection "Constructor"
The following constructors are provided:
.IP "\fBnew(%options)\fR: returns \fIMail::SPF::Record\fR" 4
.IX Item "new(%options): returns Mail::SPF::Record"
Creates a new \s-1SPF\s0 record object.
.Sp
\&\f(CW%options\fR is a list of key/value pairs representing any of the following
options:
.RS 4
.IP "\fBtext\fR" 4
.IX Item "text"
A \fIstring\fR denoting the unparsed text of the record.
.IP "\fBscopes\fR" 4
.IX Item "scopes"
A reference to an \fIarray\fR of \fIstring\fRs denoting the scopes that are covered
by the record (see the description of the \f(CW\*(C`scope\*(C'\fR option of
Mail::SPF::Request's \f(CW\*(C`new\*(C'\fR constructor).
.IP "\fBterms\fR" 4
.IX Item "terms"
A reference to an \fIarray\fR of \fIMail::SPF::Term\fR (i.e. \fIMail::SPF::Mech\fR or
\&\fIMail::SPF::Mod\fR) objects that make up the record.  \fIMail::SPF::GlobalMod\fR
objects must not be included here, but should be specified using the
\&\f(CW\*(C`global_mods\*(C'\fR option instead.
.IP "\fBglobal_mods\fR" 4
.IX Item "global_mods"
A reference to an \fIarray\fR of \fIMail::SPF::GlobalMod\fR objects that are global
modifiers of the record.
.RE
.RS 4
.RE
.ie n .IP "\fBnew_from_string($text, \fB%options\fB)\fR: returns \fIMail::SPF::Record\fR; throws \fIMail::SPF::ENothingToParse\fR, \fIMail::SPF::EInvalidRecordVersion\fR, \fIMail::SPF::ESyntaxError\fR" 4
.el .IP "\fBnew_from_string($text, \f(CB%options\fB)\fR: returns \fIMail::SPF::Record\fR; throws \fIMail::SPF::ENothingToParse\fR, \fIMail::SPF::EInvalidRecordVersion\fR, \fIMail::SPF::ESyntaxError\fR" 4
.IX Item "new_from_string($text, %options): returns Mail::SPF::Record; throws Mail::SPF::ENothingToParse, Mail::SPF::EInvalidRecordVersion, Mail::SPF::ESyntaxError"
Creates a new \s-1SPF\s0 record object by parsing the string and any options given.
.SS "Class methods"
.IX Subsection "Class methods"
The following class methods are provided:
.IP "\fBversion_tag_pattern\fR: returns \fIRegexp\fR" 4
.IX Item "version_tag_pattern: returns Regexp"
\&\fIAbstract\fR.  Returns a regular expression that matches a legal version tag.
.Sp
This method is abstract and must be implemented by sub-classes of
Mail::SPF::Record.
.IP "\fBdefault_qualifier\fR: returns \fIstring\fR" 4
.IX Item "default_qualifier: returns string"
Returns the default qualifier, i.e. \fB'+'\fR.
.IP "\fBresults_by_qualifier\fR: returns \fIhash\fR of \fIstring\fR" 4
.IX Item "results_by_qualifier: returns hash of string"
Returns a reference to a hash that maps qualifiers to result codes as follows:
.Sp
.Vb 6
\&     Qualifier | Result code
\&    \-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-
\&         +     | pass
\&         \-     | fail
\&         ~     | softfail
\&         ?     | neutral
.Ve
.SS "Instance methods"
.IX Subsection "Instance methods"
The following instance methods are provided:
.IP "\fBtext\fR: returns \fIstring\fR; throws \fIMail::SPF::ENoUnparsedText\fR" 4
.IX Item "text: returns string; throws Mail::SPF::ENoUnparsedText"
Returns the unparsed text of the record.  Throws a \fIMail::SPF::ENoUnparsedText\fR
exception if the record was created synthetically instead of being parsed, and
no text was provided.
.IP "\fBversion_tag\fR: returns \fIstring\fR" 4
.IX Item "version_tag: returns string"
\&\fIAbstract\fR.  Returns the version tag of the record.
.Sp
This method is abstract and must be implemented by sub-classes of
Mail::SPF::Record.
.IP "\fBscopes\fR: returns \fIlist\fR of \fIstring\fR" 4
.IX Item "scopes: returns list of string"
Returns a list of the scopes that are covered by the record.  See the
description of the \*(L"new\*(R" constructor's \f(CW\*(C`scopes\*(C'\fR option.
.IP "\fBterms\fR: returns \fIlist\fR of \fIMail::SPF::Term\fR" 4
.IX Item "terms: returns list of Mail::SPF::Term"
Returns a list of the terms that make up the record, excluding any global
modifiers, which are returned by the \f(CW\*(C`global_mods\*(C'\fR method.  See the
description of the \*(L"new\*(R" constructor's \f(CW\*(C`terms\*(C'\fR option.
.IP "\fBglobal_mods\fR: returns \fIlist\fR of \fIMail::SPF::GlobalMod\fR" 4
.IX Item "global_mods: returns list of Mail::SPF::GlobalMod"
Returns a list of the global modifiers of the record, ordered ascending by
modifier precedence.  See the description of the \*(L"new\*(R" constructor's
\&\f(CW\*(C`global_mods\*(C'\fR option.
.IP "\fBglobal_mod($mod_name)\fR: returns \fIMail::SPF::GlobalMod\fR" 4
.IX Item "global_mod($mod_name): returns Mail::SPF::GlobalMod"
Returns the global modifier of the given name if it is present in the record.
Returns \fBundef\fR otherwise.  Use this method if you wish to retrieve a specific
global modifier as opposed to getting all of them.
.IP "\fBstringify\fR: returns \fIstring\fR" 4
.IX Item "stringify: returns string"
Returns the record's version tag and terms (including the global modifiers)
formatted as a string.  You can simply use a Mail::SPF::Record object as a
string for the same effect, see \*(L"\s-1OVERLOADING\*(R"\s0.
.ie n .IP "\fBeval($server, \fB$request\fB)\fR: throws \fIMail::SPF::Result\fR" 4
.el .IP "\fBeval($server, \f(CB$request\fB)\fR: throws \fIMail::SPF::Result\fR" 4
.IX Item "eval($server, $request): throws Mail::SPF::Result"
Evaluates the \s-1SPF\s0 record in the context of the request parameters represented
by the given \fIMail::SPF::Request\fR object.  The given \fIMail::SPF::Server\fR
object is used for performing \s-1DNS\s0 look-ups.  Throws a \fIMail::SPF::Result\fR
object matching the outcome of the evaluation; see Mail::SPF::Result.  See
\&\s-1RFC 4408, 4.6\s0 and 4.7, for the exact algorithm used.
.SH "OVERLOADING"
.IX Header "OVERLOADING"
If a Mail::SPF::Record object is used as a \fIstring\fR, the \f(CW\*(C`stringify\*(C'\fR method
is used to convert the object into a string.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Mail::SPF, Mail::SPF::v1::Record, Mail::SPF::v2::Record,
Mail::SPF::Term, Mail::SPF::Mech, Mail::SPF::Mod
.PP
<http://tools.ietf.org/html/rfc4408>
.PP
For availability, support, and license information, see the \s-1README\s0 file
included with Mail::SPF.
.SH "AUTHORS"
.IX Header "AUTHORS"
Julian Mehnle <julian@mehnle.net>, Shevek <cpan@anarres.org>