/ 
Mail-DMARC-0.20130514
River stage one • 2 direct dependents • 3 total dependents
/ Mail::DMARC::Result::Evaluated

NAME

Mail::DMARC::Result::Evaluated - the results of applying a DMARC policy

VERSION

version 0.20130514

OVERVIEW

An evaluated DMARC result looks like the following data structure:

result       => 'pass',   # pass, fail
disposition  => 'none',   # reject, quarantine, none
reason       => {
    type     => '',       # forwarded, sampled_out, trusted_forwarder,
    comment  => '',       #   mailing_list, local_policy, other
},
dkim         => 'pass',   # pass, fail
dkim_align   => 'strict', # strict, relaxed
spf          => 'pass',   # pass, fail
spf_align    => 'strict', # strict, relaxed

The reason is optional and may not be present.

The dkim_align and spf_align fields will only be present if the corresponding test value equals pass.

METHODS

result

Whether the message passed the DMARC test. Possible values are: pass, fail.

In order to pass, at least one of the defined authentication alignments must pass. At present (2013 Draft) the defined alignments are DKIM and SPF. The alignment list is expected to grow.

disposition

When the DMARC result is not pass, disposition is the results of applying DMARC policy to a message. Generally this is the same as the header_from domains published DMARC policy. When it is not, the reason SHOULD be specified.

dkim

Whether the message passed or failed DKIM alignment. In order to pass the DMARC DKIM alignment test, a DKIM signature that matches the RFC5322.From domain must be present. An unsigned messsage, a message with an invalid signature, or signatures that don't match the RFC5322.From field are all considered failures.

dkim_align

If the message passed the DKIM alignment test, this indicates whether the alignment was strict or relaxed.

spf

Whether the message passed or failed SPF alignment. To pass SPF alignment, the RFC5321.MailFrom domain must match the RFC5322.From field.

spf_align

If the message passed the SPF alignment test, this indicates whether the alignment was strict or relaxed.

reason

If the applied policy differs from the sites published policy, the evaluated policy should contain a reason and optionally a comment.

An evaluated DMARC result reason has two attributes, type, and comment.

reason => {   
    type =>  '',   
    comment => '',
},

type

The following reason types are defined and valid:

forwarded
sampled_out
trusted_forwarder
mailing_list
local_policy
other

comment

Comment is a free form text field.

AUTHORS

  • Matt Simerson <msimerson@cpan.org>

  • Davide Migliavacca <shari@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2013 by The Network People, Inc..

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.