.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.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.  \*(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-
.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" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Mail::DKIM::SignerPolicy 3"
.TH Mail::DKIM::SignerPolicy 3 "2012-11-28" "perl v5.16.3" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Mail::DKIM::SignerPolicy \- determines signing parameters for a message
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
A \*(L"signer policy\*(R" is an object, class, or function used by
Mail::DKIM::Signer to determine what signatures to add to the
current message. To take advantage of signer policies, create your
own Perl class that extends the Mail::DKIM::SignerPolicy class.
The only method you need to implement is the \fIapply()\fR method.
.PP
The \fIapply()\fR method takes as a parameter the Mail::DKIM::Signer object.
Using this object, it can determine some properties of the message (e.g.
what the From: address or Sender: address is). Then it sets various
signer properties as desired. The \fIapply()\fR method should
return a nonzero value if the message should be signed. If a false value
is returned, then the message is \*(L"skipped\*(R" (i.e. not signed).
.PP
Here is an example of a policy that always returns the same values:
.PP
.Vb 2
\&  package MySignerPolicy;
\&  use base "Mail::DKIM::SignerPolicy";
\&
\&  sub apply
\&  {
\&      my $self = shift;
\&      my $signer = shift;
\&  
\&      $signer\->algorithm("rsa\-sha1");
\&      $signer\->method("relaxed");
\&      $signer\->domain("example.org");
\&      $signer\->selector("selector1");
\&      $signer\->key_file("private.key");
\&  
\&      return 1;
\&  }
.Ve
.PP
To use this policy, simply specify the name of the class as the Policy
parameter...
.PP
.Vb 3
\&  my $dkim = Mail::DKIM::Signer\->new(
\&                  Policy => "MySignerPolicy",
\&             );
.Ve
.SH "ADVANCED"
.IX Header "ADVANCED"
You can also have the policy actually build the signature for the Signer
to use. To do this, call the signer's \fIadd_signature()\fR method from within
your \fIapply()\fR callback. E.g.,
.PP
.Vb 4
\&  sub apply
\&  {
\&      my $self = shift;
\&      my $signer = shift;
\&  
\&      $signer\->add_signature(
\&              new Mail::DKIM::Signature(
\&                  Algorithm => $signer\->algorithm,
\&                  Method => $signer\->method,
\&                  Headers => $signer\->headers,
\&                  Domain => $signer\->domain,
\&                  Selector => $signer\->selector,
\&              ));
\&      return;
\&  }
.Ve
.PP
Again, if you do not want any signatures, return zero or undef. If you
use \fIadd_signature()\fR to create a signature, the default signature will
not be created, even if you return nonzero.
.SH "AUTHOR"
.IX Header "AUTHOR"
Jason Long, <jlong@messiah.edu>
.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.