.\" -*- 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::GnuPG 3pm"
.TH Mail::GnuPG 3pm 2024-02-18 "perl v5.38.2" "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::GnuPG \- Process email with GPG.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 3
\&  use Mail::GnuPG;
\&  my $mg = new Mail::GnuPG( key => \*(AqABCDEFGH\*(Aq );
\&  $ret = $mg\->mime_sign( $MIMEObj, \*(Aqyou@my.dom\*(Aq );
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Use GnuPG::Interface to process or create PGP signed or encrypted
email.
.SS new
.IX Subsection "new"
.Vb 1
\&  Create a new Mail::GnuPG instance.
\&
\& Arguments:
\&   Paramhash...
\&
\&   key    => gpg key id
\&   keydir => gpg configuration/key directory
\&   passphrase => primary key password
\&   use_agent => use gpg\-agent if non\-zero
\&   always_trust => always trust a public key
\&   # FIXME: we need more things here, maybe primary key id.
.Ve
.SS decrypt
.IX Subsection "decrypt"
.Vb 1
\& Decrypt an encrypted message
\&
\& Input:
\&   MIME::Entity containing email message to decrypt.
\&
\&  The message can either be in RFC compliant\-ish multipart/encrypted
\&  format, or just a single part ascii armored message.
\&
\& Output:
\&  On Failure:
\&    Exit code of gpg.  (0 on success)
\&
\&  On Success: (just encrypted)
\&    (0, undef, undef)
\&
\&  On success: (signed and encrypted)
\&    ( 0,
\&      keyid,           # ABCDDCBA
\&      emailaddress     # Foo Bar <foo@bar.com>
\&    )
\&
\&   where the keyid is the key that signed it, and emailaddress is full
\&   name and email address of the primary uid
\&
\&
\&  $self\->{last_message} => any errors from gpg
\&  $self\->{plaintext}    => plaintext output from gpg
\&  $self\->{decrypted}    => parsed output as MIME::Entity
.Ve
.SS get_decrypt_key
.IX Subsection "get_decrypt_key"
.Vb 1
\& determines the decryption key (and corresponding mail) of a message
\&
\& Input:
\&   MIME::Entity containing email message to analyze.
\&
\&  The message can either be in RFC compliant\-ish multipart/signed
\&  format, or just a single part ascii armored message.
\&
\& Output:
\&  $key    \-\- decryption key
\&  $mail   \-\- corresponding mail address
.Ve
.SS verify
.IX Subsection "verify"
.Vb 1
\& verify a signed message
\&
\& Input:
\&   MIME::Entity containing email message to verify.
\&
\&  The message can either be in RFC compliant\-ish multipart/signed
\&  format, or just a single part ascii armored message.
\&
\&  Note that MIME\-encoded data should be supplied unmodified inside
\&  the MIME::Entity input message, otherwise the signature will be
\&  broken. Since MIME\-tools version 5.419, this can be achieved with
\&  the C<decode_bodies> method of MIME::Parser. See the MIME::Parser
\&  documentation for more information.
\&
\& Output:
\&  On error:
\&    Exit code of gpg.  (0 on success)
\&  On success
\&    ( 0,
\&      keyid,           # ABCDDCBA
\&      emailaddress     # Foo Bar <foo@bar.com>
\&    )
\&
\&   where the keyid is the key that signed it, and emailaddress is full
\&   name and email address of the primary uid. The email/uid is UTF8
\&   encoded, as output by GPG.
\&
\&  $self\->{last_message} => any errors from gpg
.Ve
.SS has_public_key
.IX Subsection "has_public_key"
Does the keyring have a public key for the specified email address?
.PP
.Vb 2
\& FIXME: document better.  talk about caching.  maybe put a better
\& interface in.
.Ve
.SS mime_sign
.IX Subsection "mime_sign"
.Vb 1
\&  sign an email message
\&
\& Input:
\&   MIME::Entity containing email message to sign
\&
\& Output:
\&  Exit code of gpg.  (0 on success)
\&
\&  $self\->{last_message} => any errors from gpg
\&
\&  The provided $entity will be signed.  (i.e. it _will_ be modified.)
.Ve
.SS clear_sign
.IX Subsection "clear_sign"
.Vb 1
\&  clearsign the body of an email message
\&
\& Input:
\&   MIME::Entity containing email message to sign.
\&   This entity MUST have a body.
\&
\& Output:
\&  Exit code of gpg.  (0 on success)
\&
\&  $self\->{last_message} => any errors from gpg
\&
\&  The provided $entity will be signed.  (i.e. it _will_ be modified.)
.Ve
.SS ascii_encrypt
.IX Subsection "ascii_encrypt"
.Vb 1
\&  encrypt an email message body using ascii armor
\&
\& Input:
\&   MIME::Entity containing email message to encrypt.
\&   This entity MUST have a body.
\&
\&   list of recipients
\&
\& Output:
\&  Exit code of gpg.  (0 on success)
\&
\&  $self\->{last_message} => any errors from gpg
\&
\&  The provided $entity will be encrypted.  (i.e. it _will_ be modified.)
.Ve
.SS ascii_signencrypt
.IX Subsection "ascii_signencrypt"
.Vb 1
\&  encrypt and sign an email message body using ascii armor
\&
\& Input:
\&   MIME::Entity containing email message to encrypt.
\&   This entity MUST have a body.
\&
\&   list of recipients
\&
\& Output:
\&  Exit code of gpg.  (0 on success)
\&
\&  $self\->{last_message} => any errors from gpg
\&
\&  The provided $entity will be encrypted.  (i.e. it _will_ be modified.)
.Ve
.SS mime_encrypt
.IX Subsection "mime_encrypt"
.Vb 1
\&  encrypt an email message
\&
\& Input:
\&   MIME::Entity containing email message to encrypt
\&   list of email addresses to sign to
\&
\& Output:
\&  Exit code of gpg.  (0 on success)
\&
\&  $self\->{last_message} => any errors from gpg
\&
\&  The provided $entity will be encrypted.  (i.e. it _will_ be modified.)
.Ve
.SS mime_signencrypt
.IX Subsection "mime_signencrypt"
.Vb 1
\&  sign and encrypt an email message
\&
\& Input:
\&   MIME::Entity containing email message to sign encrypt
\&   list of email addresses to sign to
\&
\& Output:
\&  Exit code of gpg.  (0 on success)
\&
\&  $self\->{last_message} => any errors from gpg
\&
\&  The provided $entity will be encrypted.  (i.e. it _will_ be modified.)
.Ve
.SS is_signed
.IX Subsection "is_signed"
.Vb 2
\&  best guess as to whether a message is signed or not (by looking at
\&  the mime type and message content)
\&
\& Input:
\&   MIME::Entity containing email message to test
\&
\& Output:
\&  True or False value
.Ve
.SS is_encrypted
.IX Subsection "is_encrypted"
.Vb 2
\&  best guess as to whether a message is signed or not (by looking at
\&  the mime type and message content)
\&
\& Input:
\&   MIME::Entity containing email message to test
\&
\& Output:
\&  True or False value
.Ve
.SH LICENSE
.IX Header "LICENSE"
Copyright 2003 Best Practical Solutions, LLC
.PP
This program is free software; you can redistribute it and/or modify
it under the terms of either:
.PP
.Vb 3
\&    a) the GNU General Public License as published by the Free
\&    Software Foundation; version 2
\&    http://www.opensource.org/licenses/gpl\-license.php
\&
\&    b) the "Artistic License"
\&    http://www.opensource.org/licenses/artistic\-license.php
.Ve
.PP
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See either the
GNU General Public License or the Artistic License for more details.
.SH AUTHOR
.IX Header "AUTHOR"
Robert Spier
.PP
David Bremner <ddb@cpan.org>
.SH BUGS/ISSUES/PATCHES
.IX Header "BUGS/ISSUES/PATCHES"
Please send all bugs/issues/patches to
    bug\-Mail\-GnuPG@rt.cpan.org
.SH "SEE ALSO"
.IX Header "SEE ALSO"
perl.
.PP
GnuPG::Interface,
.PP
MIME::Entity