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

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 OVERLOADED in the Mail::Message::Head manpage

overload: bool

See OVERLOADED in the Mail::Message::Head manpage

METHODS

Constructors

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

See Constructors in the Mail::Message::Head manpage

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

See Constructors in the Mail::Message::Head manpage

The header

$obj->isDelayed

See The header in the Mail::Message::Head manpage

$obj->isEmpty

See The header in the Mail::Message::Head manpage

$obj->isModified

See The header in the Mail::Message::Head manpage

$obj->knownNames

See The header in the Mail::Message::Head manpage

$obj->message([MESSAGE])

See The header in the Mail::Message::Head manpage

$obj->modified([BOOLEAN])

See The header in the Mail::Message::Head manpage

$obj->orderedFields

See The header in the Mail::Message::Head manpage

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 Access to the header in the Mail::Message::Head manpage

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 About the body in the Mail::Message::Head manpage

Internals

$obj->addNoRealize(FIELD)

See Internals in the Mail::Message::Head manpage

$obj->addOrderedFields(FIELDS)

See Internals in the Mail::Message::Head manpage

$obj->fileLocation

See Internals in the Mail::Message::Head manpage

$obj->load

See Internals in the Mail::Message::Head manpage

$obj->moveLocation(DISTANCE)

See Internals in the Mail::Message::Head manpage

$obj->read(PARSER)

See Internals in the Mail::Message::Head manpage

$obj->setNoRealize(FIELD)

See Internals in the Mail::Message::Head manpage

Error handling

$obj->AUTOLOAD

See Error handling in the Mail::Reporter manpage

$obj->addReport(OBJECT)

See Error handling in the Mail::Reporter manpage

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

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

See Error handling in the Mail::Reporter manpage

$obj->errors

See Error handling in the Mail::Reporter manpage

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

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

See Error handling in the Mail::Reporter manpage

$obj->logPriority(LEVEL)

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

See Error handling in the Mail::Reporter manpage

$obj->logSettings

See Error handling in the Mail::Reporter manpage

$obj->notImplemented

See Error handling in the Mail::Reporter manpage

$obj->report([LEVEL])

See Error handling in the Mail::Reporter manpage

$obj->reportAll([LEVEL])

See Error handling in the Mail::Reporter manpage

$obj->trace([LEVEL])

See Error handling in the Mail::Reporter manpage

$obj->warnings

See Error handling in the Mail::Reporter manpage

Cleanup

$obj->DESTROY

See Cleanup in the Mail::Reporter manpage

$obj->inGlobalDestruction

See Cleanup in the Mail::Reporter manpage

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.

DETAILS

REFERENCES

See the MailBox website at http://perl.overmeer.net/mailbox/ for more details.

COPYRIGHTS

Distribution version 2.059. Written by Mark Overmeer (mark@overmeer.net) See the ChangeLog for other contributors.

Copyright (c) 2001-2003 by the author(s). All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

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