|
NAMEMail::DKIM::DkPolicy - represents a DomainKeys Sender Signing Policy recordVERSIONversion 1.20200907DESCRIPTIONDomainKeys sender signing policies are described in RFC4870(historical). It is a record published in the message sender's (i.e. the person who transmitted the message) DNS that describes how they sign messages.CONSTRUCTORSfetch() - fetch a sender signing policy from DNSmy $policy = Mail::DKIM::DkPolicy->fetch( Protocol => 'dns', Sender => 'joe@example.org', ); The following named arguments are accepted:
Depending on what type of policy is being checked, both the Sender and Author fields may need to be specified. If a DNS error or timeout occurs, an exception is thrown. Otherwise, a policy object of some sort will be returned. If no policy is actually published, then the "default policy" will be returned. To check when this happens, use my $is_default = $policy->is_implied_default_policy; new() - construct a default policy objectmy $policy = Mail::DKIM::DkPolicy->new; parse() - gets a policy object by parsing a stringmy $policy = Mail::DKIM::DkPolicy->parse( String => 'o=~; t=y' ); METHODSapply() - apply the policy to the results of a DKIM verifiermy $result = $policy->apply($dkim_verifier); The caller must provide an instance of Mail::DKIM::Verifier, one which has already been fed the message being verified. Possible results are:
flags() - get or set the flags (t=) tagA vertical-bar separated list of flags.is_implied_default_policy() - is this policy implied?my $is_implied = $policy->is_implied_default_policy; If you fetch the policy for a particular domain, but that domain does not have a policy published, then the "default policy" is in effect. Use this method to detect when that happens. location() - where the policy was fetched fromDomainKeys policies only have per-domain policies, so this will be the domain where the policy was published.If nothing is published for the domain, and the default policy was returned instead, the location will be "undef". note() - get or set the human readable notes (n=) tagHuman readable notes regarding the record. Undef if no notes specified.policy() - get or set the outbound signing policy (o=) tagmy $sp = $policy->policy; Outbound signing policy for the entity. Possible values are:
signall() - true if policy is /-"testing() - checks the testing flagmy $testing = $policy->testing; If nonzero, the testing flag is set on the signing policy, and the verify should not consider a message suspicious based on this policy. AUTHORS
THANKSWork on ensuring that this module passes the ARC test suite was generously sponsored by Valimail (https://www.valimail.com/)COPYRIGHT AND LICENSE
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.6 or, at your option, any later version of Perl 5 you may have available.
Visit the GSP FreeBSD Man Page Interface. |