Mail::SPF::Mech::All - SPF record C<all> mechanism class


Mail-SPF documentation Contained in the Mail-SPF distribution.

Index


Code Index:

NAME

Top

Mail::SPF::Mech::All - SPF record all mechanism class

DESCRIPTION

Top

An object of class Mail::SPF::Mech::All represents an SPF record mechanism of type all.

Constructors

The following constructors are provided:

new: returns Mail::SPF::Mech::All

Creates a new SPF record all mechanism object.

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

qualifier

See new in Mail::SPF::Mech.

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

Creates a new SPF record all 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 'all'.

name_pattern: returns Regexp

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

Instance methods

The following instance methods are provided:

text
qualifier
name
stringify

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

match($server, $request): returns boolean

Returns true because the all mechanism always matches. See RFC 4408, 5.1, for details.

SEE ALSO

Top

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

http://www.ietf.org/rfc/rfc4408.txt

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

AUTHORS

Top

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


Mail-SPF documentation Contained in the Mail-SPF distribution.
#
# Mail::SPF::Mech::All
# SPF record "all" mechanism class.
#
# (C) 2005-2008 Julian Mehnle <julian@mehnle.net>
#     2005      Shevek <cpan@anarres.org>
# $Id: All.pm 50 2008-08-17 21:28:15Z Julian Mehnle $
#
##############################################################################

package Mail::SPF::Mech::All;

use warnings;
use strict;

use base 'Mail::SPF::Mech';

use constant TRUE   => (0 == 0);
use constant FALSE  => not TRUE;

use constant name           => 'all';
use constant name_pattern   => qr/${\name}/i;

use constant explanation_templates_by_result_code => {
    %{__PACKAGE__->SUPER::explanation_templates_by_result_code},
    pass        => "Sender is authorized by default to use '%{s}' in '%{_scope}' identity",
    fail        => "Sender is not authorized by default to use '%{s}' in '%{_scope}' identity",
    softfail    => "Sender is not authorized by default to use '%{s}' in '%{_scope}' identity, however domain is not currently prepared for false failures",
};

sub parse_params {
    my ($self) = @_;
    # No parameters.
    return;
}

sub match {
    my ($self, $server, $request) = @_;
    return TRUE;
}

TRUE;