NAME

Mail::Message::Head::Subset - subset of header information of a message

INHERITANCE 

 Mail::Message::Head::Subset realizes a Mail::Message::Head::Complete

 Mail::Message::Head::Subset
   is a Mail::Message::Head
   is a Mail::Reporter

SYNOPSIS 

 my Mail::Message::Head::Subset $subset = ...;
 $subset->isa('Mail::Message::Head')  # true
 $subset->guessBodySize               # integer or undef
 $subset->isDelayed                   # true

DESCRIPTION

Some types of folders contain an index file which lists a few lines of information per messages. Especially when it is costly to read header lines, the index speeds-up access considerably. For instance, the subjects of all messages are often wanted, but waiting for a thousand messages of the folder to be read may imply a thousand network reads (IMAP) or file openings (MH)

When you access header fields which are not in the header subset, the whole header has to be parsed (which may consume considerable time, depending on the type of folder).

OVERLOADED

overload: ""

See Mail::Message::Head/"OVERLOADED"

overload: bool

See Mail::Message::Head/"OVERLOADED"

METHODS

Constructors

$obj->build([PAIR|FIELD]-LIST)

See Mail::Message::Head/"Constructors"

Mail::Message::Head::Subset->new(OPTIONS)

See Mail::Message::Head/"Constructors"

The header

$obj->isDelayed

See Mail::Message::Head/"The header"

$obj->isEmpty

See Mail::Message::Head/"The header"

$obj->isModified

See Mail::Message::Head/"The header"

$obj->knownNames

See Mail::Message::Head/"The header"

$obj->message([MESSAGE])

See Mail::Message::Head/"The header"

$obj->modified([BOOLEAN])

See Mail::Message::Head/"The header"

$obj->orderedFields

See Mail::Message::Head/"The header"

Access to the header

$obj->count(NAME)

Count the number of fields with this NAME. If the NAME cannot be found, the full header get loaded. In case we find any NAME field, it is decided we know all of them, and loading is not needed.

$obj->get(NAME [,INDEX])

Get the data which is related to the field with the NAME. The case of the characters in NAME does not matter. When a NAME is used which is not known yet, realization will take place.

$obj->study(NAME [,INDEX])

See Mail::Message::Head/"Access to the header"

About the body

$obj->guessBodySize

The body size is defined in the Content-Length field. However, this field may not be known. In that case, a guess is made based on the known Lines field. When also that field is not known yet, undef is returned.

$obj->isMultipart

See Mail::Message::Head/"About the body"

Internals

$obj->addNoRealize(FIELD)

See Mail::Message::Head/"Internals"

$obj->addOrderedFields(FIELDS)

See Mail::Message::Head/"Internals"

$obj->fileLocation

See Mail::Message::Head/"Internals"

$obj->load

See Mail::Message::Head/"Internals"

$obj->moveLocation(DISTANCE)

See Mail::Message::Head/"Internals"

$obj->read(PARSER)

See Mail::Message::Head/"Internals"

$obj->setNoRealize(FIELD)

See Mail::Message::Head/"Internals"

Error handling

$obj->AUTOLOAD

See Mail::Reporter/"Error handling"

$obj->addReport(OBJECT)

See Mail::Reporter/"Error handling"

$obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

Mail::Message::Head::Subset->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

See Mail::Reporter/"Error handling"

$obj->errors

See Mail::Reporter/"Error handling"

$obj->log([LEVEL [,STRINGS]])

Mail::Message::Head::Subset->log([LEVEL [,STRINGS]])

See Mail::Reporter/"Error handling"

$obj->logPriority(LEVEL)

Mail::Message::Head::Subset->logPriority(LEVEL)

See Mail::Reporter/"Error handling"

$obj->logSettings

See Mail::Reporter/"Error handling"

$obj->notImplemented

See Mail::Reporter/"Error handling"

$obj->report([LEVEL])

See Mail::Reporter/"Error handling"

$obj->reportAll([LEVEL])

See Mail::Reporter/"Error handling"

$obj->trace([LEVEL])

See Mail::Reporter/"Error handling"

$obj->warnings

See Mail::Reporter/"Error handling"

Cleanup

$obj->DESTROY

See Mail::Reporter/"Cleanup"

$obj->inGlobalDestruction

See Mail::Reporter/"Cleanup"

DETAILS

DIAGNOSTICS

Error: Package $package does not implement $method.

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.

SEE ALSO

This module is part of Mail-Box distribution version 2.082, built on April 28, 2008. Website: http://perl.overmeer.net/mailbox/

LICENSE

Copyrights 2001-2008 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