1Mail::SPF::Mech::IncludUes(e3r)Contributed Perl DocumentMaatiilo:n:SPF::Mech::Include(3)
2
3
4

NAME

6       Mail::SPF::Mech::Include - SPF record "include" mechanism class
7

DESCRIPTION

9       An object of class Mail::SPF::Mech::Include represents an SPF record
10       mechanism of type "include".
11
12   Constructors
13       The following constructors are provided:
14
15       new(%options): returns Mail::SPF::Mech::Include
16           Creates a new SPF record "include" mechanism object.
17
18           %options is a list of key/value pairs representing any of the
19           following options:
20
21           qualifier
22           domain_spec
23               See "new" in Mail::SPF::Mech.
24
25       new_from_string($text, %options): returns Mail::SPF::Mech::Include;
26       throws Mail::SPF::ENothingToParse, Mail::SPF::EInvalidMech
27           Creates a new SPF record "include" mechanism object by parsing the
28           string and any options given.
29
30   Class methods
31       The following class methods are provided:
32
33       default_qualifier
34       qualifier_pattern
35           See "Class methods" in Mail::SPF::Mech.
36
37       name: returns string
38           Returns 'include'.
39
40       name_pattern: returns Regexp
41           Returns a regular expression that matches a mechanism name of
42           'include'.
43
44   Instance methods
45       The following instance methods are provided:
46
47       text
48       qualifier
49       params
50       stringify
51           See "Instance methods" in Mail::SPF::Mech.
52
53       domain_spec: returns Mail::SPF::MacroString
54           Returns the "domain-spec" parameter of the mechanism.
55
56       match($server, $request): returns boolean
57           Performs a recursive SPF check using the given SPF server and
58           request objects and substituting the mechanism's target domain name
59           for the request's authority domain.  The result of the recursive
60           SPF check is translated as follows:
61
62                Recursive result | Effect
63               ------------------+-----------------
64                pass             | return true
65                fail             | return false
66                softfail         | return false
67                neutral          | return false
68                none             | throw PermError
69                permerror        | throw PermError
70                temperror        | throw TempError
71
72           See RFC 4408, 5.2, for the exact algorithm used.
73

SEE ALSO

75       Mail::SPF, Mail::SPF::Record, Mail::SPF::Term, Mail::SPF::Mech
76
77       <http://tools.ietf.org/html/rfc4408>
78
79       For availability, support, and license information, see the README file
80       included with Mail::SPF.
81

AUTHORS

83       Julian Mehnle <julian@mehnle.net>, Shevek <cpan@anarres.org>
84
85
86
87perl v5.36.0                      2023-01-20       Mail::SPF::Mech::Include(3)
Impressum