From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

JMEHNLE / Mail-SPF-2.000_002 / lib / Mail / SPF / Mech / PTR.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
—
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
—
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
—
104
105
106
107
108
109
110
111
112
113
114
115
116
—
117
118
119
120
121
122
123
124
125
126
127
128
129
—
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
—
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168

              
#
# Mail::SPF::Mech::PTR
# SPF record "ptr" mechanism class.
#
# (C) 2005-2006 Julian Mehnle <julian@mehnle.net>
#     2005      Shevek <cpan@anarres.org>
# $Id: PTR.pm 22 2006-11-15 03:31:28Z Julian Mehnle $
#
##############################################################################
package Mail::SPF::Mech::PTR;
=head1 NAME
Mail::SPF::Mech::PTR - SPF record C<ptr> mechanism class
=cut
use warnings;
use strict;
use base 'Mail::SPF::Mech';
use Mail::SPF::Util;
use NetAddr::IP;
use constant TRUE   => (0 == 0);
use constant FALSE  => not TRUE;
use constant name           => 'ptr';
use constant name_pattern   => qr/${\name}/i;
=head1 DESCRIPTION
An object of class B<Mail::SPF::Mech::PTR> represents an SPF record mechanism
of type C<ptr>.
=head2 Constructors
The following constructors are provided:
=over
=item B<new(%options)>: returns I<Mail::SPF::Mech::PTR>
Creates a new SPF record C<ptr> mechanism object.
%options is a list of key/value pairs representing any of the following
options:
=over
=item B<qualifier>
=item B<domain_spec>
See L<Mail::SPF::Mech/new>.
=back
=item B<new_from_string($text)>: returns I<Mail::SPF::Mech::PTR>;
throws I<Mail::SPF::ENothingToParse>, I<Mail::SPF::EInvalidMech>
Creates a new SPF record C<ptr> mechanism object by parsing the given string.
=back
=head2 Class methods
The following class methods are provided:
=over
=item B<default_qualifier>
=item B<qualifier_pattern>
See L<Mail::SPF::Mech/Class methods>.
=item B<name>: returns I<string>
Returns B<'ptr'>.
=item B<name_pattern>: returns I<Regexp>
Returns a regular expression that matches a mechanism name of B<'ptr'>.
=back
=head2 Instance methods
The following instance methods are provided:
=over
=cut
sub parse_params {
    my ($self) = @_;
    $self->parse_domain_spec();
    return;
}
=item B<text>
=item B<qualifier>
=item B<params>
=cut
sub params {
    my ($self) = @_;
    return defined($self->{domain_spec}) ? ':' . $self->{domain_spec} : undef;
}
=item B<stringify>
See L<Mail::SPF::Mech/Instance methods>.
=item B<domain_spec>: returns I<Mail::SPF::MacroString>
Returns the C<domain-spec> parameter of the mechanism.
=cut
# Make read-only accessor:
__PACKAGE__->make_accessor('domain_spec', TRUE);
=item B<match($server, $request)>: returns I<boolean>
Checks whether the mechanism's target domain name, or a sub-domain thereof, is
a "valid" domain name for the given request's IP address (see
L<Mail::SPF::Request/ip_address>), and returns B<true> if it does, or B<false>
otherwise.  See L<Mail::SPF::Util/valid_domain_for_ip_address> for how domains
are validated.  See RFC 4408, 5.5, for the description of an equivalent
algorithm.
=cut
sub match {
    my ($self, $server, $request) = @_;
    $server->count_dns_interactive_term($request);
    return
        Mail::SPF::Util->valid_domain_for_ip_address(
            $server, $request->ip_address, $self->domain($server, $request))
        ? TRUE : FALSE;
}
=back
=head1 SEE ALSO
L<Mail::SPF>, L<Mail::SPF::Record>, L<Mail::SPF::Term>, L<Mail::SPF::Mech>
L<RFC 4408|http://www.ietf.org/rfc/rfc4408.txt>
For availability, support, and license information, see the README file
included with Mail::SPF.
=head1 AUTHORS
Julian Mehnle <julian@mehnle.net>, Shevek <cpan@anarres.org>
=cut
TRUE;