NAME

Mail::SPF::Mod::Redirect - SPF record redirect modifier class

VERSION

version 3.20240923

DESCRIPTION

An object of class Mail::SPF::Mod::Redirect represents an SPF record modifier of type redirect.

Constructors

The following constructors are provided:

new(%options): returns Mail::SPF::Mod::Redirect

Creates a new SPF record redirect modifier object.

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

domain_spec

See "new" in Mail::SPF::Mod.

new_from_string($text, %options): returns Mail::SPF::Mod::Redirect; throws Mail::SPF::ENothingToParse, Mail::SPF::EInvalidMod

Creates a new SPF record redirect modifier object by parsing the string and any options given.

Class methods

The following class methods are provided:

name: returns string

Returns 'redirect'.

name_pattern: returns Regexp

Returns a regular expression that matches a modifier name of 'redirect'.

precedence: returns real

Returns a precedence value of 0.8. See "precedence" in Mail::SPF::Mod.

Instance methods

The following instance methods are provided:

params

See "params" in Mail::SPF::Mod.

domain_spec: returns Mail::SPF::MacroString

Returns the domain-spec parameter of the modifier.

process($server, $request, $result): throws Mail::SPF::Result

If no mechanism matched during the evaluation of the current SPF record, performs a recursive SPF check using the given SPF server and request objects and substituting the modifier's target domain name for the request's authority domain. The result of the recursive SPF check is then thrown as the result of the current record's evaluation. However, if the target domain has no acceptable SPF record, a permerror result is thrown. See RFC 4408, 6.1, for details.

See Mail::SPF::Mod for other supported instance methods.

SEE ALSO

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

http://tools.ietf.org/html/rfc4408

For availability, support, and license information, see the README file included with Mail::SPF.

AUTHORS

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