.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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 >0, 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::MIMEDefang::DKIM 3"
.TH Mail::MIMEDefang::DKIM 3 2024-03-20 3.4.1 "Mail::MIMEDefang::DKIM 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::MIMEDefang::DKIM \- DKIM interface for MIMEDefang
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Mail::MIMEDefang::DKIM is a module with a set of DKIM related methods called
from \fImimedefang-filter\fR to operate with DKIM.
.SH METHODS
.IX Header "METHODS"
.IP md_dkim_sign 4
.IX Item "md_dkim_sign"
Returns a mail header and the DKIM signature for the message.
The method accepts the following parameters:
.RS 4
.ie n .IP $keyfile 4
.el .IP \f(CW$keyfile\fR 4
.IX Item "$keyfile"
The path to the private DKIM key
.ie n .IP $algorithm 4
.el .IP \f(CW$algorithm\fR 4
.IX Item "$algorithm"
The algorithm to be used to sign the message, by default is 'rsa\-sha1'
.ie n .IP $method 4
.el .IP \f(CW$method\fR 4
.IX Item "$method"
The method used to sign the message, by default is 'relaxed'
.ie n .IP $domain 4
.el .IP \f(CW$domain\fR 4
.IX Item "$domain"
The domain to be used when signing the message, by default it's autodetected
.ie n .IP $selector 4
.el .IP \f(CW$selector\fR 4
.IX Item "$selector"
The selector to be used when signing the message, by default it's 'default'
.ie n .IP $headers 4
.el .IP \f(CW$headers\fR 4
.IX Item "$headers"
The headers to sign, by default the headers are:
               From Sender Reply-To Subject Date
               Message-ID To Cc MIME-Version
               Content-Type Content-Transfer-Encoding Content-ID Content-Description
               Resent-Date Resent-From Resent-Sender Resent-To Resent-cc
               Resent-Message-ID
               In-Reply-To References
               List-Id List-Help List-Unsubscribe List-Subscribe
               List-Post List-Owner List-Archive
.RE
.RS 4
.RE
.IP md_dkim_verify 4
.IX Item "md_dkim_verify"
Verifies the DKIM signature of an email.
Return value can be "pass", "fail", "invalid", "temperror", "none".
In case of multiple signatures, the "best" result will be returned.
Best is defined as "pass", followed by "fail", "invalid", and "none".
The second return value is the domain that has applied the signature.
The third return value is the size of the DKIM public key.
The forth return value is the value of the "b" tag of the DKIM signature.