mail::dkim(3) [centos man page]

Mail::DKIM(3)						User Contributed Perl Documentation					     Mail::DKIM(3)

NAME

       Mail::DKIM - Signs/verifies Internet mail with DKIM/DomainKey signatures

SYNOPSIS

	 # verify a message
	 use Mail::DKIM::Verifier;

	 # create a verifier object
	 my $dkim = Mail::DKIM::Verifier->new();

	 # read an email from stdin, pass it into the verifier
	 while (<STDIN>)
	 {
	     # remove local line terminators
	     chomp;
	     s/15$//;

	     # use SMTP line terminators
	     $dkim->PRINT("$_1512");
	 }
	 $dkim->CLOSE;

	 # what is the result of the verify?
	 my $result = $dkim->result;

DESCRIPTION

       This module implements the various components of the DKIM and DomainKeys message-signing and verifying standards for Internet mail.  It
       currently tries to implement these specifications:

       RFC4871, for DKIM
       RFC4870, for DomainKeys

       The module uses an object-oriented interface. You use one of two different classes, depending on whether you are signing or verifying a
       message. To sign, use the Mail::DKIM::Signer class. To verify, use the Mail::DKIM::Verifier class. Simple, eh?

SEE ALSO

       Mail::DKIM::Signer, Mail::DKIM::Verifier

       http://dkimproxy.sourceforge.net/

KNOWN BUGS

       Problems passing `make test' seem to usually point at a faulty DNS configuration on your machine, or something weird about your OpenSSL
       libraries.

       The "author signing policy" component is still under construction. The author signing policy is supposed to identify the practice of the
       message author, so you could for example reject a message from an author who claims they always sign their messages. See
       Mail::DKIM::Policy.

AUTHOR

       Jason Long, <jlong@messiah.edu>

COPYRIGHT AND LICENSE

       Copyright (C) 2006-2007, 2009 by Messiah College

       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.

perl v5.16.3							    2010-11-14							     Mail::DKIM(3)

Mail::DKIM::Policy(3)					User Contributed Perl Documentation				     Mail::DKIM::Policy(3)

NAME

       Mail::DKIM::Policy - abstract base class for originator "signing" policies

SYNOPSIS

	 # get all policies that apply to a verified message
	 foreach my $policy ($dkim->policies)
	 {

	     # the name of this policy
	     my $name = $policy->name;

	     # the location in DNS where this policy was found
	     my $location = $policy->location;

	     # apply this policy to the message being verified
	     my $result = $policy->apply($dkim);

	 }

DESCRIPTION

       Between the various versions of the DomainKeys/DKIM standards, several different forms of sender "signing" policies have been defined.  In
       order for the Mail::DKIM library to support these different policies, it uses several different subclasses. All subclasses support this
       general interface, so that a program using Mail::DKIM can support any and all policies found for a message.

METHODS

       These methods are supported by all classes implementing the Mail::DKIM::Policy interface.

   apply()
       Apply the policy to the results of a DKIM verifier.

	 my $result = $policy->apply($dkim_verifier);

       The caller must provide an instance of Mail::DKIM::Verifier, one which has already been fed the message being verified.

       Possible results are:

       accept
	   The message is approved by the sender signing policy.

       reject
	   The message is rejected by the sender signing policy.

       neutral
	   The message is neither approved nor rejected by the sender signing policy. It can be considered suspicious.

   as_string()
       The policy as a string.

       Note that the string returned by this method will not necessarily have the tags ordered the same as the text record found in DNS.

   is_implied_default_policy()
       Is this policy implied?

	 my $is_implied = $policy->is_implied_default_policy;

       If you fetch the policy for a particular domain, but that domain does not have a policy published, then the "default policy" is in effect.
       Use this method to detect when that happens.

   location()
       Where the policy was fetched from.

       This is generally a domain name, the domain name where the policy was published.

       If nothing is published for the domain, and the default policy was returned instead, the location will be "undef".

   name()
       Identify what type of policy this is.

       This currently returns strings like "sender", "author", and "ADSP".  It is subject to change in the next version of Mail::DKIM.

SEE ALSO

       Mail::DKIM::DkPolicy - for RFC4870(historical) DomainKeys sender signing policies

       Mail::DKIM::DkimPolicy - for early draft DKIM sender signing policies

       Mail::DKIM::AuthorDomainPolicy - for Author Domain Signing Practices (ADSP)

AUTHOR

       Jason Long, <jlong@messiah.edu>

COPYRIGHT AND LICENSE

       Copyright (C) 2006-2009 by Messiah College

       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.

perl v5.12.1							    2010-01-23						     Mail::DKIM::Policy(3)