1Mail::DKIM::AuthorDomaiUnsPeorliCcoyn(t3r)ibuted Perl DoMcauimle:n:tDaKtIiMo:n:AuthorDomainPolicy(3)
2
3
4

NAME

6       Mail::DKIM::AuthorDomainPolicy - represents an Author Domain Signing
7       Practices (ADSP) record
8

DESCRIPTION

10       The Author Domain Signing Policies (ADSP) record can be published by
11       any domain to help a receiver know what to do when it encounters an
12       unsigned message claiming to originate from that domain.
13
14       The record is published as a DNS TXT record at _adsp._domainkey.DOMAIN
15       where DOMAIN is the domain of the message's "From" address.
16
17       More details about this record can be found by reading the
18       specification itself at <http://tools.ietf.org/html/rfc5617>.
19

CONSTRUCTORS

21   fetch()
22       Lookup an ADSP record in DNS.
23
24         my $policy = Mail::DKIM::AuthorDomainPolicy->fetch(
25                   Protocol => "dns",
26                   Author => 'jsmith@example.org',
27                 );
28
29       If the ADSP record is found and appears to be valid, an object
30       containing that record's information will be constructed and returned.
31       If the ADSP record is blank or simply does not exist, an object
32       representing the default policy will be returned instead.  (See also
33       "is_implied_default_policy()".)  If a DNS error occurs (e.g. SERVFAIL
34       or time-out), this method will "die".
35
36   new()
37       Construct a default policy object.
38
39         my $policy = Mail::DKIM::AuthorDomainPolicy->new;
40

METHODS

42   apply()
43       Apply the policy to the results of a DKIM verifier.
44
45         my $result = $policy->apply($dkim_verifier);
46
47       The caller must provide an instance of Mail::DKIM::Verifier, one which
48       has already been fed the message being verified.
49
50       Possible results are:
51
52       accept
53           The message is approved by the sender signing policy.
54
55       reject
56           The message is rejected by the sender signing policy.  It can be
57           considered very suspicious.
58
59       neutral
60           The message is neither approved nor rejected by the sender signing
61           policy. It can be considered somewhat suspicious.
62
63   is_implied_default_policy()
64       Tells whether this policy implied.
65
66         my $is_implied = $policy->is_implied_default_policy;
67
68       If you fetch the policy for a particular domain, but that domain does
69       not have a policy published, then the "default policy" is in effect.
70       Use this method to detect when that happens.
71
72   location()
73       Tells where the policy was fetched from.
74
75       If the policy is domain-wide, this will be domain where the policy was
76       published.
77
78       If the policy is user-specific, TBD.
79
80       If nothing is published for the domain, and the default policy was
81       returned instead, the location will be "undef".
82
83   policy()
84       Get or set the outbound signing policy (dkim=) tag.
85
86         my $sp = $policy->policy;
87
88       Outbound signing policy for the entity. Possible values are:
89
90       "unknown"
91           The default. The entity may sign some or all email.
92
93       "all"
94           All mail from the domain is expected to be signed, using a valid
95           Author signature, but the author does not suggest discarding mail
96           without a valid signature.
97
98       "discardable"
99           All mail from the domain is expected to be signed, using a valid
100           Author signature, and the author is so confident that non-signed
101           mail claiming to be from this domain can be automatically discarded
102           by the recipient's mail server.
103
104       "NXDOMAIN"
105           The domain is out of scope, i.e., the domain does not exist in the
106           DNS.
107
108   signall()
109       True if policy is "all".
110
111   signall_discardable()
112       True if policy is "strict".
113

BUGS

115       ยท   Section 4.3 of the specification says to perform a query on the
116           domain itself just to see if it exists. This class is not currently
117           doing that, i.e. it might report NXDOMAIN because
118           _adsp._domainkey.example.org is nonexistent, but it should not be
119           treated the same as example.org being nonexistent.
120

AUTHOR

122       Jason Long, <jlong@messiah.edu>
123

125       Copyright (C) 2006-2009 by Messiah College
126
127       This library is free software; you can redistribute it and/or modify it
128       under the same terms as Perl itself, either Perl version 5.8.6 or, at
129       your option, any later version of Perl 5 you may have available.
130
131
132
133perl v5.10.1                      2009-09-03 Mail::DKIM::AuthorDomainPolicy(3)
Impressum