Crypt::OpenPGP::UserID - PGP User ID packet

Crypt-OpenPGP documentation Contained in the Crypt-OpenPGP distribution.

Index

Code Index:

NAME

Top

Crypt::OpenPGP::UserID - PGP User ID packet

SYNOPSIS

Top

    use Crypt::OpenPGP::UserID;

    my $uid = Crypt::OpenPGP::UserID->new( Identity => 'Foo' );
    my $serialized = $uid->save;
    my $identity = $uid->id;

DESCRIPTION

Top

Crypt::OpenPGP::UserID is a PGP User ID packet. Such a packet is used to represent the name and email address of the key holder, and typically contains an RFC822 mail name like

    Foo Bar <foo@bar.com>

USAGE

Top

Crypt::OpenPGP::UserID->new( [ Identity => $identity ] )

Creates a new User ID packet object and returns that object. If you do not supply an identity, the object is created empty; this is used, for example, in parse (below), to create an empty packet which is then filled from the data in the buffer.

If you wish to initialize a non-empty object, supply new with the Identity parameter along with a value $identity which should generally be in RFC822 form (above).

$uid->save

Returns the text of the user ID packet; this is the string passed to new (above) as $identity, for example.

Crypt::OpenPGP::UserID->parse($buffer)

Given $buffer, a Crypt::OpenPGP::Buffer object holding (or with offset pointing to) a User ID packet, returns a new <Crypt::OpenPGP::UserID> object, initialized with the user ID data in the buffer.

$uid->id

Returns the user ID data (eg. the string passed as $identity to new, above).

AUTHOR & COPYRIGHTS

Top

Please see the Crypt::OpenPGP manpage for author, copyright, and license information.

Crypt-OpenPGP documentation Contained in the Crypt-OpenPGP distribution. 
package Crypt::OpenPGP::UserID;
use strict;

use Crypt::OpenPGP::ErrorHandler;
use base qw( Crypt::OpenPGP::ErrorHandler );

sub new {
    my $id = bless { }, shift;
    $id->init(@_);
}

sub init {
    my $id = shift;
    my %param = @_;
    if (my $ident = $param{Identity}) {
        $id->{id} = $ident;
    }
    $id;
}

sub id { $_[0]->{id} }
sub parse {
    my $class = shift;
    my($buf) = @_;
    my $id = $class->new;
    $id->{id} = $buf->bytes;
    $id;
}

sub save { $_[0]->{id} }

1;
__END__