unixdev.net


Switch to SpeakEasy.net DSL

The Modular Manual Browser

Home Page
Manual: (Debian-5.0)
Page:
Section:
Apropos / Subsearch:
optional field

Mail::SPF::Result(3pm)User Contributed Perl DocumentatioMail::SPF::Result(3pm)



NAME
       Mail::SPF::Result - SPF result class

SYNOPSIS
       For the general usage of Mail::SPF::Result objects in code that calls
       Mail::SPF, see Mail::SPF.  For the detailed interface of
       Mail::SPF::Result and its derivatives, see below.

       Throwing results

           package Mail::SPF::Foo;
           use Error ':try';
           use Mail::SPF::Result;

           sub foo {
               if (...) {
                   throw Mail::SPF::Result::Pass($server, $request);
               }
               else {
                   throw Mail::SPF::Result::PermError($server, $request, 'Invalid foo');
               }
           }

       Catching results

           package Mail::SPF::Bar;
           use Error ':try';
           use Mail::SPF::Foo;

           try {
               Mail::SPF::Foo->foo();
           }
           catch Mail::SPF::Result with {
               my ($result) = @_;
               ...
           };

       Using results

           my $result_code     = $result->code;
           my $request         = $result->request;
           my $local_exp       = $result->local_explanation;
           my $authority_exp   = $result->authority_explanation
               if $result->can('authority_explanation');
           my $spf_header      = $result->received_spf_header;

DESCRIPTION
       An object of class Mail::SPF::Result represents the result of an SPF
       request.

       There is usually no need to construct an SPF result object directly
       using the "new" constructor.  Instead, use the "throw" class method to
       signal to the calling code that a definite SPF result has been deter-
       mined.  In other words, use Mail::SPF::Result and its derivatives just
       like exceptions.  See Error or "eval" in perlfunc for how to handle
       exceptions in Perl.

       Constructor

       The following constructor is provided:

       new($server, $request): returns Mail::SPF::Result
       new($server, $request, $text): returns Mail::SPF::Result
           Creates a new SPF result object and associates the given
           Mail::SPF::Server and Mail::SPF::Request objects with it.  An
           optional result text may be specified.

       Class methods

       The following class methods are provided:

       throw($server, $request): throws Mail::SPF::Result
       throw($server, $request, $text): throws Mail::SPF::Result
           Throws a new SPF result object, associating the given
           Mail::SPF::Server and Mail::SPF::Request objects with it.  An
           optional result text may be specified.

       name: returns string
           Returns the trailing part of the name of the Mail::SPF::Result::*
           class on which it is invoked.  For example, returns "NeutralByDe-
           fault" if invoked on Mail::SPF::Result::NeutralByDefault.  This
           method may also be used as an instance method.

       code: returns string
           Returns the result code ("pass", "fail", "softfail", "neutral",
           "none", "error", "permerror", "permerror") of the
           Mail::SPF::Result::* class on which it is invoked.  This method may
           also be used as an instance method.

       class_by_code($code): returns class
           Maps the given result code to the corresponding
           Mail::SPF::Result::* class.  If an unknown result code was speci-
           fied, returns undef.

       is_code($code): returns boolean
           If the class (or object) on which this method is invoked represents
           the given result code (or a derivative code), returns true.
           Returns false otherwise.  This method may also be used as an
           instance method.

           For example, "Mail::SPF::Result::Pass->is_code('pass')" returns
           true.

       Instance methods

       The following instance methods are provided:

       throw: throws Mail::SPF::Result
       throw($server, $request): throws Mail::SPF::Result
       throw($server, $request, $text): throws Mail::SPF::Result
           Re-throws an existing SPF result object.  If Mail::SPF::Server and
           Mail::SPF::Request objects are specified, associates them with the
           result object, replacing the prior server and request objects.  If
           a result text is specified as well, overrides the prior result
           text.

       code: returns string
           Returns the result code of the result object.

       server: returns Mail::SPF::Server
           Returns the Mail::SPF server object that produced the result at
           hand.

       request: returns Mail::SPF::Request
           Returns the SPF request that led to the result at hand.

       text: returns string
           Returns the text message of the result object.

       stringify: returns string
           Returns the result's name and text message formatted as a string.
           You can simply use a Mail::SPF::Result object as a string for the
           same effect, see "OVERLOADING".

       local_explanation: returns string; throws Mail::SPF::EDNSError,
       Mail::SPF::EInvalidMacroString
           Returns a locally generated explanation for the result.

           The local explanation is prefixed with the authority domain whose
           sender policy is responsible for the result.  If the responsible
           sender policy referred to another domain's policy (using the
           "include" mechanism or the "redirect" modifier), that other domain
           which is directly responsible for the result is also included in
           the local explanation's head.  For example:

               example.com: <local-explanation>

           The authority domain "example.com"'s sender policy is directly
           responsible for the result.

               example.com ... other.example.org: <local-explanation>

           The authority domain "example.com" (directly or indirectly)
           referred to the domain "other.example.org", whose sender policy
           then led to the result.

       received_spf_header: returns string
           Returns a string containing an appropriate "Received-SPF" header
           field for the result object.  The header field is not line-wrapped
           and contains no trailing newline character.

OVERLOADING
       If a Mail::SPF::Result object is used as a string, the "stringify"
       method is used to convert the object into a string.

RESULT CLASSES
       The following result classes are provided:

       Mail::SPF::Result::Pass
       Mail::SPF::Result::Fail
           The following additional instance method is provided:

           authority_explanation: returns string; throws Mail::SPF::EDNSError,
           Mail::SPF::EInvalidMacroString
               Returns the authority domain's explanation for the result.  Be
               aware that the authority domain may be a malicious party and
               thus the authority explanation should not be trusted blindly.
               See RFC 4408, 10.5, for a detailed discussion of this issue.

       Mail::SPF::Result::SoftFail
       Mail::SPF::Result::Neutral
       Mail::SPF::Result::NeutralByDefault
           This is a special-case of the "neutral" result that is thrown as a
           default when "falling off" the end of the record during evaluation.
           See RFC 4408, 4.7.

       Mail::SPF::Result::None
       Mail::SPF::Result::Error
           The following sub-classes of Mail::SPF::Result::Error are provided:

           Mail::SPF::Result::PermError
           Mail::SPF::Result::TempError

SEE ALSO
       Mail::SPF, Mail::SPF::Server, Error, "eval" in perlfunc

       <http://www.ietf.org/rfc/rfc4408.txt>;

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

AUTHORS
       Julian Mehnle <julianATmehnle.net>



perl v5.8.8                       2007-10-07            Mail::SPF::Result(3pm)