.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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 turned on, 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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Mail::GnuPG 3pm"
.TH Mail::GnuPG 3pm "2016-09-19" "perl v5.22.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 \s-1PGP\s0 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, \s-1LLC\s0
.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
\&\s-1WITHOUT ANY WARRANTY\s0; without even the implied warranty of
\&\s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE. \s0 See either the
\&\s-1GNU\s0 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