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

CONSTRUCTORS

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

METHODS

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

BUGS

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

AUTHOR

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

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