1Mail::DKIM::DkimPolicy(U3s)er Contributed Perl DocumentatMiaoinl::DKIM::DkimPolicy(3)
2
3
4

NAME

6       Mail::DKIM::DkimPolicy - represents a DKIM Sender Signing Practices
7       record
8

DESCRIPTION

10       The Sender Signing Practices (SSP) record can be published by any
11       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
15       _policy._domainkey.DOMAIN where DOMAIN is the domain of the message's
16       "From" address.
17
18       This record format has been superceded by ADSP. See
19       Mail::DKIM::AuthorDomainPolicy for information about ADSP.  It is
20       implemented here because at one time it appeared this is what would be
21       standardized by the IETF. It will be removed from Mail::DKIM at some
22       point in the future.  The last version of the SSP specification can be
23       found at http://tools.ietf.org/html/draft-ietf-dkim-ssp-02
24       <http://tools.ietf.org/html/draft-ietf-dkim-ssp-02>.
25

CONSTRUCTORS

27   fetch()
28       Lookup a DKIM signing practices record.
29
30         my $policy = Mail::DKIM::DkimPolicy->fetch(
31                   Protocol => "dns",
32                   Author => 'jsmith@example.org',
33                 );
34
35   new()
36       Construct a default policy object.
37
38         my $policy = Mail::DKIM::DkimPolicy->new;
39

METHODS

41   apply()
42       Apply the policy to the results of a DKIM verifier.
43
44         my $result = $policy->apply($dkim_verifier);
45
46       The caller must provide an instance of Mail::DKIM::Verifier, one which
47       has already been fed the message being verified.
48
49       Possible results are:
50
51       accept
52           The message is approved by the sender signing policy.
53
54       reject
55           The message is rejected by the sender signing policy.  It can be
56           considered very suspicious.
57
58       neutral
59           The message is neither approved nor rejected by the sender signing
60           policy. It can be considered somewhat suspicious.
61
62   flags()
63       Get or set the flags (t=) tag.
64
65       A colon-separated list of flags. Flag values are:
66
67       y   The entity is testing signing practices, and the Verifier SHOULD
68           NOT consider a message suspicious based on the record.
69
70       s   The signing practices apply only to the named domain, and not to
71           subdomains.
72
73   is_implied_default_policy()
74       Is this policy implied?
75
76         my $is_implied = $policy->is_implied_default_policy;
77
78       If you fetch the policy for a particular domain, but that domain does
79       not have a policy published, then the "default policy" is in effect.
80       Use this method to detect when that happens.
81
82   location()
83       Where the policy was fetched from.
84
85       If the policy is domain-wide, this will be domain where the policy was
86       published.
87
88       If the policy is user-specific, TBD.
89
90       If nothing is published for the domain, and the default policy was
91       returned instead, the location will be "undef".
92
93   policy()
94       Get or set the outbound signing policy (dkim=) tag.
95
96         my $sp = $policy->policy;
97
98       Outbound signing policy for the entity. Possible values are:
99
100       "unknown"
101           The default. The entity may sign some or all email.
102
103       "all"
104           All mail from the entity is signed.  (The DKIM signature can use
105           any domain, not necessarily matching the From: address.)
106
107       "strict"
108           All mail from the entity is signed with Originator signatures.
109           (The DKIM signature uses a domain matching the From: address.)
110
111   signall()
112       True if policy is "all".
113
114   signall_strict()
115       True if policy is "strict".
116
117   testing()
118       Checks the testing flag.
119
120         my $testing = $policy->testing;
121
122       If nonzero, the testing flag is set on the signing policy, and the
123       verify should not consider a message suspicious based on this policy.
124

BUGS

126       ยท   If a sender signing policy is not found for a given domain, the
127           fetch() method should search the parent domains, according to
128           section 4 of the dkim-ssp Internet Draft.
129

AUTHOR

131       Jason Long, <jlong@messiah.edu>
132

134       Copyright (C) 2006-2007 by Messiah College
135
136       This library is free software; you can redistribute it and/or modify it
137       under the same terms as Perl itself, either Perl version 5.8.6 or, at
138       your option, any later version of Perl 5 you may have available.
139
140
141
142perl v5.12.2                      2009-07-09         Mail::DKIM::DkimPolicy(3)
Impressum