=head1 NAME Mail::Message::Head::ListGroup - mailinglist related header fields =head1 INHERITANCE Mail::Message::Head::ListGroup is a Mail::Message::Head::FieldGroup is a Mail::Reporter =head1 SYNOPSIS my $lg = Mail::Message::Head::ListGroup->new(head => $head, ...); $head->addListGroup($lg); my $lg = $head->addListGroup(...); $lg->delete; =head1 DESCRIPTION A I is a set of header fields which are added by mailing-list managing software. This class knowns various details about that software. The knowledge and test messages which are used to initially implement this module is taken from Mail::ListDetector, written by Michael Stevens . The logic is redesigned to add flexibility and use the powerful MailBox features. =head1 METHODS =head2 Constructors $obj-EB
=over 4 Returns a L object (or C) which defines the posting address of the mailing list. =back $obj-EB =over 4 See L =back $obj-EB(HEAD|MESSAGE) =over 4 Create a C based in the specified MESSAGE or message HEAD. =back $obj-EB Mail::Message::Head::ListGroup-EB =over 4 See L =back $obj-EB =over 4 Returns the name of the mailing list, which is usually a part of the e-mail address which is used to post the messages to. =back Mail::Message::Head::ListGroup-EB(FIELDS, OPTIONS) =over 4 Construct an object which maintains one set of mailing list headers Option --Defined in --Default address undef head Mail::Message::Head::FieldGroup undef listname log Mail::Reporter 'WARNINGS' rfc undef software Mail::Message::Head::FieldGroup undef trace Mail::Reporter 'WARNINGS' type Mail::Message::Head::FieldGroup undef version Mail::Message::Head::FieldGroup undef . address => STRING|OBJECT =over 4 Address of the mailing list, which may be specified as STRING or e-mail containing object (a L or L. In any case, the data is converted into a L. =back . head => HEAD . listname => STRING =over 4 A short textual representation of the mailing-list. =back . log => LEVEL . rfc => 'rfc2919'|'rfc2369' =over 4 Defines the mailing list software follows an rfc. =back . software => STRING . trace => LEVEL . type => STRING . version => STRING =back $obj-EB =over 4 When the mailing list software follows the guidelines of one of the dedicated RFCs, then this will be returned otherwise C. The return values can be C, C, or C. =back =head2 The header $obj-EB((FIELD, VALUE) | OBJECT) =over 4 See L =back $obj-EB([FIELDNAMES]) =over 4 See L =back $obj-EB(HEAD) =over 4 See L =back $obj-EB =over 4 See L =back $obj-EB =over 4 See L =back $obj-EB =over 4 See L =back $obj-EB =over 4 See L =back =head2 Access to the header $obj-EB(NAME) Mail::Message::Head::ListGroup-EB(NAME) =over 4 =back $obj-EB =over 4 See L =back $obj-EB =over 4 See L =back $obj-EB =over 4 See L =back =head2 Internals $obj-EB =over 4 Scan the header for fields which are usually contained in mailing list software. This method is automatically called when a list group is constructed L an existing header or message. Returned are the names of the list header fields found, in scalar context the amount. An empty list/zero indicates that this is not a mailing list message. Please warn the author of MailBox if you see that to few or too many fields are included. =back $obj-EB(TYPE, SOFTWARE, VERSION) =over 4 See L =back =head2 Error handling $obj-EB =over 4 See L =back $obj-EB(OBJECT) =over 4 See L =back $obj-EB([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK]) Mail::Message::Head::ListGroup-EB([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK]) =over 4 See L =back $obj-EB
=over 4 Produce information about the detected/create list group, which may be helpful during debugging, by default to the selected file handle. =back $obj-EB =over 4 See L =back $obj-EB([LEVEL [,STRINGS]]) Mail::Message::Head::ListGroup-EB([LEVEL [,STRINGS]]) =over 4 See L =back $obj-EB(LEVEL) Mail::Message::Head::ListGroup-EB(LEVEL) =over 4 See L =back $obj-EB =over 4 See L =back $obj-EB =over 4 See L =back $obj-EB([FILEHANDLE]) =over 4 See L =back $obj-EB([LEVEL]) =over 4 See L =back $obj-EB([LEVEL]) =over 4 See L =back $obj-EB([LEVEL]) =over 4 See L =back $obj-EB =over 4 See L =back =head2 Cleanup $obj-EB =over 4 See L =back $obj-EB =over 4 See L =back =head1 DETAILS =head2 Mailing list fields =head3 Detected lists The L class can detect many different mailing lists, some of which are very popular and some of which are rare. Numerous fields in a header are addded when the message is passed through a mailing list server. Each list software has defined its own fields, sometimes woth conflicting definitions. There are also two RFCs about mailing list: C and C. The following lists are currently detected. Between parenthesis is the string returned by L when that differs from the software name. =over 4 =item * CommuniGate Legacy commercial MacOS implementation by Stalker Software Inc. L =item * CommuniGate Pro (CommuniGatePro) Commercial rfc2919 compliant implementation by Stalker Software Inc. L =item * Ecartis Commercial mailing list manager, formerly known as Listar. Produced by NodeRunner Computing. See L. =item * Ezmlm Open Source mailing list manager, available from L. =item * FML Open Source mailing list manager, see L. =item * Listar Old name for Ecartis. =item * Listbox Mailing lists defined at L. =item * Mailman GNU's mailing list manager, available from L. =item * Majordomo Free (licenced) mailing list manager by Great Circle Associates, available from L =item * Smartlist Related to procmail, as expressed by their shared main page at L. =item * Yahoo! Groups (YahooGroups) Mailing lists defined at L. =item * Listserv Commercial mailing list manager, produced by L-Soft. See L. =back =head1 DIAGNOSTICS Error: Cannot convert "$string" into an address object =over 4 The L is coerced into a L, which fails. Have a look at L to see what valid arguments are. =back Error: Package $package does not implement $method. =over 4 Fatal error: the specific package (or one of its superclasses) does not implement this method where it should. This message means that some other related classes do implement this method however the class at hand does not. Probably you should investigate this and probably inform the author of the package. =back =head1 SEE ALSO This module is part of Mail-Box distribution version 2.079, built on November 28, 2007. Website: F =head1 LICENSE Copyrights 2001-2007 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 F