NAME

Email::MIME::RFC2047::Group - MIME encoded mailbox groups

VERSION

version 0.97

SYNOPSIS

    use Email::MIME::RFC2047::Group;

    my $group = Email::MIME::RFC2047::Group->parse($string);
    print $group->name, "\n";
    my @mailboxes = $group->mailbox_list->items;

    my $group = Email::MIME::RFC2047::Group->new(
        name         => $name,
        mailbox_list => $mailbox_list,
    );
    $email->header_set('To', $group->format());

DESCRIPTION

This module handles RFC 2822 "group"s.

CONSTRUCTOR

new

    my $group = Email::MIME::RFC2047::Group->new(
        name         => $name,
        mailbox_list => $mailbox_list,
    );

Creates a new Email::MIME::RFC2047::Group object, optionally with a display name $name and an mailbox list $mailbox_list.

METHODS

name

    my $name = $group->name;
    $group->name($new_name);

Gets or sets the display name of the group.

mailbox_list

    my $mailbox_list = $group->mailbox_list;
    $group->mailbox_list($new_mailbox_list);

Gets or sets the mailbox list of the group.

format

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

Returns the formatted 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 is used.

AUTHOR

Nick Wellnhofer <wellnhofer@aevum.de>

COPYRIGHT AND LICENSE

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