/ 
Email-MIME-RFC2047-0.97
River stage zero No dependents
/ Email::MIME::RFC2047::AddressList

NAME

Email::MIME::RFC2047::AddressList - MIME encoded address lists

VERSION

version 0.97

SYNOPSIS

use Email::MIME::RFC2047::AddressList;

my $address_list = Email::MIME::RFC2047::AddressList->parse($string);
my @items = $address_list->items;

my $address_list = Email::MIME::RFC2047::AddressList->new();
$address_list->push($mailbox);
$address_list->push($group);
$email->header_set('To', $address_list->format());

DESCRIPTION

This module handles RFC 2822 address-lists.

CLASS METHODS

parse

my $address_list = Email::MIME::RFC2047::AddressList->parse(
    $string, [$decoder]
);

Parse a RFC 2822 address-list. Returns an Email::MIME::RFC2047::AddressList object containing Email::MIME::RFC2047::Address items. $decoder is an optional Email::MIME::RFC2047::Decoder. If it isn't provided, a new temporary decoder is used.

CONSTRUCTOR

new

my $address_list = Email::MIME::RFC2047::AddressList->new([@items]);

Creates a new Email::MIME::RFC2047::AddressList object, with optional items @items.

METHODS

items

my @items = $address_list->items;

Gets the items of the address list.

push

$address_list->push(@items);

Appends items to the address list.

format

my $string = $address_list->format([$encoder]);

Returns the formatted address list string for use in a message header.

$encoder is an optional Email::MIME::RFC2047::Encoder object used for encoding display names with non-ASCII characters. If it isn't provided, a default UTF-8 encoder will be used.

AUTHOR

Nick Wellnhofer <wellnhofer@aevum.de>

COPYRIGHT AND LICENSE

This software is copyright (c) 2017 by Nick Wellnhofer.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.