.\" -*- 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 "GnuPG::UserId 3"
.TH GnuPG::UserId 3 2024-03-13 "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
GnuPG::UserId \- GnuPG User ID Objects
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\&  # assumes a GnuPG::PublicKey object in $publickey
\&  my $user_id = $publickey\->user_ids_ref\->[0]\->as_string;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
GnuPG::UserId objects are generally not instantiated on their
own, but rather as part of GnuPG::PublicKey or GnuPG::SecretKey
objects.
.SH "OBJECT METHODS"
.IX Header "OBJECT METHODS"
.ie n .IP "new( \fR\fI%initialization_args\fR\fI\fR )" 4
.el .IP "new( \fR\f(CI%initialization_args\fR\fI\fR )" 4
.IX Item "new( %initialization_args )"
This methods creates a new object.  The optional arguments are
initialization of data members;
.ie n .IP "compare( \fR\fI$other\fR\fI\fR, \fI\fR\fI$deep\fR\fI\fR )" 4
.el .IP "compare( \fR\f(CI$other\fR\fI\fR, \fI\fR\f(CI$deep\fR\fI\fR )" 4
.IX Item "compare( $other, $deep )"
Returns non-zero only when this User ID is identical to the other
GnuPG::UserID.  If \f(CW$deep\fR is present and non-zero, the User ID's
signatures and revocations will also be compared.
.SH "OBJECT DATA MEMBERS"
.IX Header "OBJECT DATA MEMBERS"
.IP as_string 4
.IX Item "as_string"
A string of the user id.
.IP validity 4
.IX Item "validity"
A scalar holding the value GnuPG reports for the trust of authenticity
(a.k.a.) validity of a key.
See GnuPG's DETAILS file for details.
.IP signatures 4
.IX Item "signatures"
A list of GnuPG::Signature objects embodying the signatures
on this user id.
.IP revocations 4
.IX Item "revocations"
A list of revocations associated with this User ID, stored as
GnuPG::Signature objects (since revocations are a type of
certification as well).
.SH "SEE ALSO"
.IX Header "SEE ALSO"
GnuPG::Signature,