Mail::DKIM::AuthorDomainPolicy(3) | User Contributed Perl Documentation | Mail::DKIM::AuthorDomainPolicy(3) |
Mail::DKIM::AuthorDomainPolicy - represents an Author Domain Signing Practices (ADSP) record
The Author Domain Signing Policies (ADSP) record can be published by any domain to help a receiver know what to do when it encounters an unsigned message claiming to originate from that domain.
The record is published as a DNS TXT record at _adsp._domainkey.DOMAIN where DOMAIN is the domain of the message's "From" address.
More details about this record can be found by reading the specification itself at <http://tools.ietf.org/html/rfc5617>.
Lookup an ADSP record in DNS.
my $policy = Mail::DKIM::AuthorDomainPolicy->fetch( Protocol => 'dns', Author => 'jsmith@example.org', );
If the ADSP record is found and appears to be valid, an object containing that record's information will be constructed and returned. If the ADSP record is blank or simply does not exist, an object representing the default policy will be returned instead. (See also "is_implied_default_policy()".) If a DNS error occurs (e.g. SERVFAIL or time-out), this method will "die".
Construct a default policy object.
my $policy = Mail::DKIM::AuthorDomainPolicy->new;
Construct an ADSP record from a string.
my $policy = Mail::DKIM::AuthorDomainPolicy->parse( String => 'dkim=all', Domain => 'aaa.example', );
Apply the policy to the results of a DKIM verifier.
my $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:
Note: in the future, these values may become:
none - no ADSP record is published
pass - a passing signature is present
fail - ADSP record is "all" and no passing signature is found
discard - ADSP record is "discardable" and no passing signature is
found
nxdomain - the DNS domain does not exist
temperror - transient error occurred
permerror - non-transient error occurred
Tells whether 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.
Tells where the policy was fetched from.
If the policy is domain-wide, this will be domain where the policy was published.
If the policy is user-specific, TBD.
If nothing is published for the domain, and the default policy was returned instead, the location will be "undef".
Get or set the outbound signing policy (dkim=) tag.
my $sp = $policy->policy;
Outbound signing policy for the entity. Possible values are:
True if policy is "all".
True if policy is "strict".
Jason Long, <jlong@messiah.edu>
Copyright (C) 2006-2009 by Messiah College
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.
2019-11-13 | perl v5.34.0 |