METHODS

See METHODS in Mail::Reporter

Constructors

$obj->address

Returns a Mail::Message::Field::Address object (or undef) which defines the posting address of the mailing list.

$obj->clone
See clone in Mail::Message::Head::FieldGroup.
$obj->from( HEAD|MESSAGE )

Create a Mail::Message::Head::ListGroup based in the specified MESSAGE or message HEAD.

$obj->implementedTypes
$class->implementedTypes
See implementedTypes in Mail::Message::Head::FieldGroup.
$obj->listname

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.

$class->new( FIELDS, OPTIONS )

Construct an object which maintains one set of mailing list headers

Option Defined in Default

address

undef

head

Mail::Message::Head::FieldGroup

undef

listname

<derived from address>

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
Address of the mailing list, which may be specified as STRING or e-mail containing object (a Mail::Address or Mail::Identity. In any case, the data is converted into a Mail::Identity.
head => HEAD
listname => STRING
A short textual representation of the mailing-list.
log => LEVEL
rfc => 'rfc2919'|'rfc2369'
Defines the mailing list software follows an rfc.
software => STRING
trace => LEVEL
type => STRING
version => STRING
» Error: Cannot convert "$string" into an address object

The new(address) is coerced into a Mail::Message::Field::Address, which fails. Have a look at Mail::Message::Field::Address::coerce() to see what valid arguments are.

$obj->rfc

When the mailing list software follows the guidelines of one of the dedicated RFCs, then this will be returned otherwise undef. The return values can be rfc2919, rfc2369, or undef.

The header

$obj->add( (FIELD, VALUE) | OBJECT )
See add in Mail::Message::Head::FieldGroup.
$obj->addFields( [FIELDNAMES] )
See addFields in Mail::Message::Head::FieldGroup.
$obj->attach( HEAD )
See attach in Mail::Message::Head::FieldGroup.
$obj->delete
See delete in Mail::Message::Head::FieldGroup.
$obj->fieldNames
See fieldNames in Mail::Message::Head::FieldGroup.
$obj->fields
See fields in Mail::Message::Head::FieldGroup.

Access to the header

$obj->isListGroupFieldName( NAME )
$class->isListGroupFieldName( NAME )
$obj->software
See software in Mail::Message::Head::FieldGroup.
$obj->type
See type in Mail::Message::Head::FieldGroup.
$obj->version
See version in Mail::Message::Head::FieldGroup.

Internals

$obj->collectFields

Scan the header for fields which are usually contained in mailing list software. This method is automatically called when a list group is constructed from() 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.

$obj->detected( TYPE, SOFTWARE, VERSION )
See detected in Mail::Message::Head::FieldGroup.

Error handling

$obj->AUTOLOAD
See AUTOLOAD in Mail::Reporter.
$obj->addReport( OBJECT )
See addReport in Mail::Reporter.
$obj->defaultTrace( [LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK] )
$class->defaultTrace( [LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK] )
See defaultTrace in Mail::Reporter.
$obj->details

Produce information about the detected/create list group, which may be helpful during debugging, by default to the selected file handle.

$obj->errors
See errors in Mail::Reporter.
$obj->log( [LEVEL [,STRINGS]] )
$class->log( [LEVEL [,STRINGS]] )
See log in Mail::Reporter.
$obj->logPriority( LEVEL )
$class->logPriority( LEVEL )
See logPriority in Mail::Reporter.
$obj->logSettings
See logSettings in Mail::Reporter.
$obj->notImplemented
See notImplemented in Mail::Reporter.
$obj->print( [FILEHANDLE] )
See print in Mail::Message::Head::FieldGroup.
$obj->report( [LEVEL] )
See report in Mail::Reporter.
$obj->reportAll( [LEVEL] )
See reportAll in Mail::Reporter.
$obj->trace( [LEVEL] )
See trace in Mail::Reporter.
$obj->warnings
See warnings in Mail::Reporter.

Cleanup

$obj->DESTROY
See DESTROY in Mail::Reporter.