Mail::SPF::v2::Record (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::v2::Record.3pm".)

NAME

Mail::SPF::v2::Record - Sender ID ("spf2.0") record class

SYNOPSIS

See Mail::SPF::Record.

DESCRIPTION

An object of class Mail::SPF::v2::Record represents a Sender ("spf2.0") record.

Constructors

The following constructors are provided:

new(%options): returns Mail::SPF::v2::Record

Creates a new Sender

ID

(``spf2.0'') record object.

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

text

terms

global_mods

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

scopes

Required. See ``new'' in Mail::SPF::Record. The 'mfrom' and 'pra' scopes are supported. There is no default.

new_from_string($text, %options): returns Mail::SPF::v2::Record; throws Mail::SPF::ENothingToParse, Mail::SPF::EInvalidRecordVersion, Mail::SPF::ESyntaxError

Creates a new Sender

ID

(``spf2.0'') record object by parsing the string and any options given.

Class methods

The following class methods are provided:

version_tag_pattern: returns Regexp

Returns a regular expression that matches a version tag of 'spf2.0/' plus a comma-separated list of any of the 'mfrom' and 'pra' scopes. The following are valid version tags:

    spf2.0/mfrom
    spf2.0/pra
    spf2.0/mfrom,pra
    spf2.0/pra,mfrom

default_qualifier

results_by_qualifier

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

Instance methods

The following instance methods are provided:

text

scopes

terms

global_mods

global_mod

stringify

eval

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

version_tag: returns string

Returns 'spf2.0/' plus a comma-separated list of the scopes of the record. See ``version_tag_pattern'' for a list of possible return values.

SEE ALSO

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

<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>