Mail::Message::Field::AddrGroup - A group of Mail::Message::Field::Address objects
Mail::Message::Field::AddrGroup is a User::Identity::Collection::Emails is a User::Identity::Collection is a User::Identity::Item
my $g = Mail::Message::Field::AddrGroup->new(name => 'name'); my $a = Mail::Message::Field::Address->new(...); $g->addAddress($a); my $f = Mail::Message::Field::Addresses->new; $f->addGroup($g);
An address group collects a set of e-mail addresses (in this case they are Mail::Message::Field::Address objects).
See documentation in the base class.
See "OVERLOADED" in User::Identity::Collection
Returns the string() value.
Returns the address group as string. When no name is specified, it will only be a comma separated list of addresses. With a name, the groups name will be prepended and a semi-colon appended. When no addresses where included and there is no name, then undef is returned.
undef
Coerce an OBJECT into a Mail::Message::Field::AddrGroup. Currently, you can only coerce User::Identity::Collection::Emails (which is the base class for this one) into this one.
See "Constructors" in User::Identity::Collection::Emails
See "Attributes" in User::Identity::Item
See "Attributes" in User::Identity::Collection
See "Collections" in User::Identity::Item
See "Maintaining roles" in User::Identity::Collection
See "Searching" in User::Identity::Collection
Add one e-mail address to the list which is maintained in the group. This is a wrapper around addRole() adding flexibility on how addresses are specified. An ADDRESS can be anything which is acceptable for Mail::Message::Field::Address::coerce() or a list of options which will create such an object.
example: of adding an address to an address group
my @data = (full_name => "Myself", address => 'me@tux.org'); $group->addAddress(@data); my $addr = Mail::Message::Field::Address->new(@data); $group->addAddress(@data); my $ma = Mail::Address->new(...); $group->addAddress($ma);
Returns all addresses defined in this group. The addresses will be ordered alphabetically to make automated testing possible: roles are stored in a hash, so have an unpredictable order by default.
example: getting all addresses from a group
my @addrs = $group->addresses; my @addrs = map { $_->address } $self->roles; #same
The first argument is an object, but not of a class which extends User::Identity::Collection.
Some options are specified to create a $type object, which is native to this collection. However, for some reason this failed.
Either the specified $type does not exist, or that module named $class returns compilation errors. If the type as specified in the warning is not the name of a package, you specified a nickname which was not defined. Maybe you forgot the 'require' the package which defines the nickname.
The $class did compile, but it was not possible to create an object of that class using the options you specified.
If you add a collection, it must either by a collection object or a list of options which can be used to create a collection object. In the latter case, the type of collection must be specified.
The collection with $name does not exist and can not be created.
Each $collection groups sets of roles of one specific type ($expect). You cannot add objects of a different $type.
This module is part of Mail-Box distribution version 2.110, built on January 05, 2014. Website: http://perl.overmeer.net/mailbox/
Copyrights 2001-2014 by [Mark Overmeer]. For other contributors see ChangeLog.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See http://www.perl.com/perl/misc/Artistic.html
To install Mail::Box, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Mail::Box
CPAN shell
perl -MCPAN -e shell install Mail::Box
For more information on module installation, please visit the detailed CPAN module installation guide.