.\" -*- 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::Mech::Exists 3pm"
.TH Mail::SPF::Mech::Exists 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::Mech::Exists \- SPF record "exists" mechanism class
.SH DESCRIPTION
.IX Header "DESCRIPTION"
An object of class \fBMail::SPF::Mech::Exists\fR represents an SPF record
mechanism of type \f(CW\*(C`exists\*(C'\fR.
.SS Constructors
.IX Subsection "Constructors"
The following constructors are provided:
.IP "\fBnew(%options)\fR: returns \fIMail::SPF::Mech::Exists\fR" 4
.IX Item "new(%options): returns Mail::SPF::Mech::Exists"
Creates a new SPF record \f(CW\*(C`exists\*(C'\fR mechanism object.
.Sp
\&\f(CW%options\fR is a list of key/value pairs representing any of the following
options:
.RS 4
.IP \fBqualifier\fR 4
.IX Item "qualifier"
.PD 0
.IP \fBdomain_spec\fR 4
.IX Item "domain_spec"
.PD
See "new" in Mail::SPF::Mech.
.RE
.RS 4
.RE
.ie n .IP "\fBnew_from_string($text, \fR\fB%options\fR\fB)\fR: returns \fIMail::SPF::Mech::Exists\fR; throws \fIMail::SPF::ENothingToParse\fR, \fIMail::SPF::EInvalidMech\fR" 4
.el .IP "\fBnew_from_string($text, \fR\f(CB%options\fR\fB)\fR: returns \fIMail::SPF::Mech::Exists\fR; throws \fIMail::SPF::ENothingToParse\fR, \fIMail::SPF::EInvalidMech\fR" 4
.IX Item "new_from_string($text, %options): returns Mail::SPF::Mech::Exists; throws Mail::SPF::ENothingToParse, Mail::SPF::EInvalidMech"
Creates a new SPF record \f(CW\*(C`exists\*(C'\fR mechanism object by parsing the string and
any options given.
.SS "Class methods"
.IX Subsection "Class methods"
The following class methods are provided:
.IP \fBdefault_qualifier\fR 4
.IX Item "default_qualifier"
.PD 0
.IP \fBqualifier_pattern\fR 4
.IX Item "qualifier_pattern"
.PD
See "Class methods" in Mail::SPF::Mech.
.IP "\fBname\fR: returns \fIstring\fR" 4
.IX Item "name: returns string"
Returns \fB'exists'\fR.
.IP "\fBname_pattern\fR: returns \fIRegexp\fR" 4
.IX Item "name_pattern: returns Regexp"
Returns a regular expression that matches a mechanism name of \fB'exists'\fR.
.SS "Instance methods"
.IX Subsection "Instance methods"
The following instance methods are provided:
.IP \fBtext\fR 4
.IX Item "text"
.PD 0
.IP \fBqualifier\fR 4
.IX Item "qualifier"
.IP \fBparams\fR 4
.IX Item "params"
.IP \fBstringify\fR 4
.IX Item "stringify"
.PD
See "Instance methods" in Mail::SPF::Mech.
.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 mechanism.
.ie n .IP "\fBmatch($server, \fR\fB$request\fR\fB)\fR: returns \fIboolean\fR" 4
.el .IP "\fBmatch($server, \fR\f(CB$request\fR\fB)\fR: returns \fIboolean\fR" 4
.IX Item "match($server, $request): returns boolean"
Checks whether a DNS \f(CW\*(C`A\*(C'\fR record exists for the mechanism's target domain name,
and returns \fBtrue\fR if one does, or \fBfalse\fR otherwise.  See RFC 4408, 5.7, for
details.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Mail::SPF, Mail::SPF::Record, Mail::SPF::Term, Mail::SPF::Mech
.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>