.\" -*- 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::DKIM::PublicKey 3"
.TH Mail::DKIM::PublicKey 3 2023-10-09 "perl v5.38.0" "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::PublicKey \- Represents a DKIM key
.SH VERSION
.IX Header "VERSION"
version 1.20230911
.SH CONSTRUCTOR
.IX Header "CONSTRUCTOR"
.SS "\fBfetch()\fP \- retrieve a public key record from DNS"
.IX Subsection "fetch() - retrieve a public key record from DNS"
.Vb 5
\&  my $public_key = Mail::DKIM::PublicKey\->fetch(
\&                      Protocol => \*(Aqdns\*(Aq,
\&                      Selector => \*(Aqbrisbane\*(Aq,
\&                      Domain => \*(Aqexample.com\*(Aq,
\&                    );
.Ve
.PP
If the public key is found, a Mail::DKIM::PublicKey object
is returned, representing the information found in DNS.
If the public key does not exist in DNS, then \f(CW\*(C`undef\*(C'\fR is
returned.
If a DNS error occurs while fetching the key, then this method
will \f(CW\*(C`die\*(C'\fR.
If the public key was found, but is not valid (e.g. it is "revoked"),
then this method will \f(CW\*(C`die\*(C'\fR.
.SH METHODS
.IX Header "METHODS"
.SS "\fBgranularity()\fP \- get or set the granularity (g=) field"
.IX Subsection "granularity() - get or set the granularity (g=) field"
.Vb 1
\&  my $g = $public_key\->granularity;
\&
\&  $public_key\->granularity(\*(Aq*\*(Aq);
.Ve
.PP
Granularity of the key. The value must match the Local-part of the
effective "i=" tag of the DKIM-Signature header field.
The granularity is a literal value, or a pattern with a single '*'
wildcard character that matches zero or more characters.
.PP
If no granularity is defined, then the default value, '*', will
be returned.
.SH AUTHORS
.IX Header "AUTHORS"
.IP \(bu 4
Jason Long <jason@long.name>
.IP \(bu 4
Marc Bradshaw <marc@marcbradshaw.net>
.IP \(bu 4
Bron Gondwana <brong@fastmailteam.com> (ARC)
.SH THANKS
.IX Header "THANKS"
Work on ensuring that this module passes the ARC test suite was
generously sponsored by Valimail (https://www.valimail.com/)
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
.IP \(bu 4
Copyright (C) 2013 by Messiah College
.IP \(bu 4
Copyright (C) 2010 by Jason Long
.IP \(bu 4
Copyright (C) 2017 by Standcore LLC
.IP \(bu 4
Copyright (C) 2020 by FastMail Pty Ltd
.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.