.\" -*- 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::ARC 3"
.TH Mail::MIMEDefang::DKIM::ARC 3 2024-03-20 3.4.1 "Mail::MIMEDefang::DKIM::ARC 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::ARC \- ARC interface for MIMEDefang
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Mail::MIMEDefang::DKIM::ARC is a module with a set of ARC related methods called
from \fImimedefang-filter\fR to operate with ARC signatures.
.SH METHODS
.IX Header "METHODS"
.IP md_arc_sign 4
.IX Item "md_arc_sign"
Returns an hash with mail headers and the ARC signature for the message.
If ARC sign fails the hash will contain an error 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 ARC 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\-sha256'
.ie n .IP $chain 4
.el .IP \f(CW$chain\fR 4
.IX Item "$chain"
The cv= value for the Arc-Seal header.  "ar" means to copy it from an Authentication-Results header, or use none if there isn't one.
.ie n .IP $domain 4
.el .IP \f(CW$domain\fR 4
.IX Item "$domain"
The domain to be used when signing the message.
.ie n .IP $srvid 4
.el .IP \f(CW$srvid\fR 4
.IX Item "$srvid"
The authserv-id in the Authentication-Results headers, defaults to Domain.
.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