.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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::SPF::Mod::Exp 3pm"
.TH Mail::SPF::Mod::Exp 3pm 2023-07-25 "perl v5.38.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::SPF::Mod::Exp \- SPF record "exp" modifier class
.SH DESCRIPTION
.IX Header "DESCRIPTION"
An object of class \fBMail::SPF::Mod::Exp\fR represents an SPF record modifier of
type \f(CW\*(C`exp\*(C'\fR.
.SS Constructors
.IX Subsection "Constructors"
The following constructors are provided:
.IP "\fBnew(%options)\fR: returns \fIMail::SPF::Mod::Exp\fR" 4
.IX Item "new(%options): returns Mail::SPF::Mod::Exp"
Creates a new SPF record \f(CW\*(C`exp\*(C'\fR modifier object.
.Sp
\&\f(CW%options\fR is a list of key/value pairs representing any of the following
options:
.RS 4
.IP \fBdomain_spec\fR 4
.IX Item "domain_spec"
See "new" in Mail::SPF::Mod.
.RE
.RS 4
.RE
.ie n .IP "\fBnew_from_string($text, \fR\fB%options\fR\fB)\fR: returns \fIMail::SPF::Mod::Exp\fR; throws \fIMail::SPF::ENothingToParse\fR, \fIMail::SPF::EInvalidMod\fR" 4
.el .IP "\fBnew_from_string($text, \fR\f(CB%options\fR\fB)\fR: returns \fIMail::SPF::Mod::Exp\fR; throws \fIMail::SPF::ENothingToParse\fR, \fIMail::SPF::EInvalidMod\fR" 4
.IX Item "new_from_string($text, %options): returns Mail::SPF::Mod::Exp; throws Mail::SPF::ENothingToParse, Mail::SPF::EInvalidMod"
Creates a new SPF record \f(CW\*(C`exp\*(C'\fR modifier object by parsing the string and
any options given.
.SS "Class methods"
.IX Subsection "Class methods"
The following class methods are provided:
.IP "\fBname\fR: returns \fIstring\fR" 4
.IX Item "name: returns string"
Returns \fB'exp'\fR.
.IP "\fBname_pattern\fR: returns \fIRegexp\fR" 4
.IX Item "name_pattern: returns Regexp"
Returns a regular expression that matches a modifier name of \fB'exp'\fR.
.IP "\fBprecedence\fR: returns \fIreal\fR" 4
.IX Item "precedence: returns real"
Returns a precedence value of \fB0.2\fR.  See "precedence" in Mail::SPF::Mod.
.SS "Instance methods"
.IX Subsection "Instance methods"
The following instance methods are provided:
.IP \fBparams\fR 4
.IX Item "params"
See "params" in Mail::SPF::Mod.
.IP "\fBdomain_spec\fR: returns \fIMail::SPF::MacroString\fR" 4
.IX Item "domain_spec: returns Mail::SPF::MacroString"
Returns the \f(CW\*(C`domain\-spec\*(C'\fR parameter of the modifier.
.ie n .IP "\fBprocess($server, \fR\fB$request\fR\fB, \fR\fB$result\fR\fB)\fR" 4
.el .IP "\fBprocess($server, \fR\f(CB$request\fR\fB, \fR\f(CB$result\fR\fB)\fR" 4
.IX Item "process($server, $request, $result)"
If the given SPF result is a \f(CW\*(C`fail\*(C'\fR result, retrieves the authority domain's
explanation string from the modifier's target domain and attaches it to the SPF
result.  If an error occurs during the retrieval of the explanation string,
does nothing, as if the modifier was not present.  See RFC 4408, 6.2, for
details.
.PP
See Mail::SPF::Mod for other supported instance methods.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Mail::SPF, Mail::SPF::Mod, Mail::SPF::Term, Mail::SPF::Record
.PP
<http://tools.ietf.org/html/rfc4408>
.PP
For availability, support, and license information, see the README file
included with Mail::SPF.
.SH AUTHORS
.IX Header "AUTHORS"
Julian Mehnle <julian@mehnle.net>, Shevek <cpan@anarres.org>