Mail::SPF::Mech::PTR (3)

Leading comments

Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)

Standard preamble:
========================================================================

(The comments found at the beginning of the groff file "man3/Mail::SPF::Mech::PTR.3pm".)

NAME

Mail::SPF::Mech::PTR - SPF record "ptr" mechanism class

DESCRIPTION

An object of class Mail::SPF::Mech::PTR represents an record mechanism of type "ptr".

Constructors

The following constructors are provided:

new(%options): returns Mail::SPF::Mech::PTR

Creates a new

SPF

record "ptr" mechanism object.

%options is a list of key/value pairs representing any of the following options:

qualifier

domain_spec

See ``new'' in Mail::SPF::Mech.

new_from_string($text, %options): returns Mail::SPF::Mech::PTR; throws Mail::SPF::ENothingToParse, Mail::SPF::EInvalidMech

Creates a new

SPF

record "ptr" mechanism object by parsing the string and any options given.

Class methods

The following class methods are provided:

default_qualifier

qualifier_pattern

See ``Class methods'' in Mail::SPF::Mech.

name: returns string

Returns 'ptr'.

name_pattern: returns Regexp

Returns a regular expression that matches a mechanism name of 'ptr'.

Instance methods

The following instance methods are provided:

text

qualifier

params

stringify

See ``Instance methods'' in Mail::SPF::Mech.

domain_spec: returns Mail::SPF::MacroString

Returns the "domain-spec" parameter of the mechanism.

match($server, $request): returns 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 ``ip_address'' in Mail::SPF::Request), and returns true if it does, or false otherwise. See ``valid_domain_for_ip_address'' in Mail::SPF::Util for how domains are validated. See

RFC 4408, 5.5,

for the description of an equivalent algorithm.

SEE ALSO

Mail::SPF, Mail::SPF::Record, Mail::SPF::Term, Mail::SPF::Mech

<tools.ietf.org/html/rfc4408>

For availability, support, and license information, see the

file included with Mail::SPF.

AUTHORS

Julian Mehnle <julian@mehnle.net>, Shevek <cpan@anarres.org>