.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3 .\" .\" Standard preamble: .\" ======================================================================== .de Sh \" Subsection heading .br .if t .Sp .ne 5 .PP \fB\\$1\fR .PP .. .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. | will give a .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' .\" expand to `' in nroff, nothing in troff, for use with C<>. .tr \(*W-|\(bv\*(Tr .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .\" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .hy 0 .if n .na .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Mail::DKIM::DkimPolicy 3" .TH Mail::DKIM::DkimPolicy 3 "2007-10-04" "perl v5.8.7" "User Contributed Perl Documentation" .SH "NAME" Mail::DKIM::DkimPolicy \- represents a DKIM Sender Signing Practices record .SH "CONSTRUCTORS" .IX Header "CONSTRUCTORS" .Sh "\fIfetch()\fP \- lookup a \s-1DKIM\s0 signing practices record" .IX Subsection "fetch() - lookup a DKIM signing practices record" .Vb 4 \& my $policy = Mail::DKIM::DkimPolicy->fetch( \& Protocol => "dns", \& Author => 'jsmith@example.org', \& ); .Ve .Sh "\fInew()\fP \- construct a default policy object" .IX Subsection "new() - construct a default policy object" .Vb 1 \& my $policy = Mail::DKIM::DkimPolicy->new; .Ve .SH "METHODS" .IX Header "METHODS" .Sh "\fIapply()\fP \- apply the policy to the results of a \s-1DKIM\s0 verifier" .IX Subsection "apply() - apply the policy to the results of a DKIM verifier" .Vb 1 \& my $result = $policy->apply($dkim_verifier); .Ve .PP The caller must provide an instance of Mail::DKIM::Verifier, one which has already been fed the message being verified. .PP Possible results are: .IP "accept" 4 .IX Item "accept" The message is approved by the sender signing policy. .IP "reject" 4 .IX Item "reject" The message is rejected by the sender signing policy. It can be considered very suspicious. .IP "neutral" 4 .IX Item "neutral" The message is neither approved nor rejected by the sender signing policy. It can be considered somewhat suspicious. .Sh "\fIflags()\fP \- get or set the flags (t=) tag" .IX Subsection "flags() - get or set the flags (t=) tag" A colon-separated list of flags. Flag values are: .IP "y" 4 .IX Item "y" The entity is testing signing practices, and the Verifier \&\s-1SHOULD\s0 \s-1NOT\s0 consider a message suspicious based on the record. .IP "s" 4 .IX Item "s" The signing practices apply only to the named domain, and not to subdomains. .Sh "\fIis_implied_default_policy()\fP \- is this policy implied?" .IX Subsection "is_implied_default_policy() - is this policy implied?" .Vb 1 \& my $is_implied = $policy->is_implied_default_policy; .Ve .PP If you fetch the policy for a particular domain, but that domain does not have a policy published, then the \*(L"default policy\*(R" is in effect. Use this method to detect when that happens. .Sh "\fIlocation()\fP \- where the policy was fetched from" .IX Subsection "location() - where the policy was fetched from" If the policy is domain\-wide, this will be domain where the policy was published. .PP If the policy is user\-specific, \s-1TBD\s0. .PP If nothing is published for the domain, and the default policy was returned instead, the location will be \f(CW\*(C`undef\*(C'\fR. .Sh "\fIpolicy()\fP \- get or set the outbound signing policy (dkim=) tag" .IX Subsection "policy() - get or set the outbound signing policy (dkim=) tag" .Vb 1 \& my $sp = $policy->policy; .Ve .PP Outbound signing policy for the entity. Possible values are: .ie n .IP """unknown""" 4 .el .IP "\f(CWunknown\fR" 4 .IX Item "unknown" The default. The entity may sign some or all email. .ie n .IP """all""" 4 .el .IP "\f(CWall\fR" 4 .IX Item "all" All mail from the entity is signed. (The \s-1DKIM\s0 signature can use any domain, not necessarily matching the From: address.) .ie n .IP """strict""" 4 .el .IP "\f(CWstrict\fR" 4 .IX Item "strict" All mail from the entity is signed with Originator signatures. (The \s-1DKIM\s0 signature uses a domain matching the From: address.) .ie n .Sh "\fIsignall()\fP \- true if policy is ""all""" .el .Sh "\fIsignall()\fP \- true if policy is ``all''" .IX Subsection "signall() - true if policy is all" .ie n .Sh "\fIsignall_strict()\fP \- true if policy is ""strict""" .el .Sh "\fIsignall_strict()\fP \- true if policy is ``strict''" .IX Subsection "signall_strict() - true if policy is strict" .Sh "\fItesting()\fP \- checks the testing flag" .IX Subsection "testing() - checks the testing flag" .Vb 1 \& my $testing = $policy->testing; .Ve .PP If nonzero, the testing flag is set on the signing policy, and the verify should not consider a message suspicious based on this policy. .SH "BUGS" .IX Header "BUGS" .IP "\(bu" 4 If a sender signing policy is not found for a given domain, the \&\fIfetch()\fR method should search the parent domains, according to section 4 of the dkim-ssp Internet Draft. .SH "AUTHOR" .IX Header "AUTHOR" Jason Long, .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" Copyright (C) 2006\-2007 by Messiah College .PP 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.