/ 
Mail-Box-2.097
River stage one • 8 direct dependents • 8 total dependents
/ Mail::Message::Head::Delayed

NAME

Mail::Message::Head::Delayed - a not-read header of a Mail::Message

INHERITANCE

Mail::Message::Head::Delayed realizes a Mail::Message::Head::Complete

Mail::Message::Head::Delayed
  is a Mail::Message::Head
  is a Mail::Reporter

SYNOPSIS

my $delayed = Mail::Message::Head::Delayed->new(...)
$delayed->isa('Mail::Message::Head')  # true
$delayed->guessBodySize               # undef
$delayed->isDelayed                   # true

DESCRIPTION

This object is used as place-holder, to be replaced by a Mail::Message::Head when someone accesses the header of a message.

OVERLOADED

overload: ""

See "OVERLOADED" in Mail::Message::Head

overload: bool

See "OVERLOADED" in Mail::Message::Head

METHODS

Constructors

$obj->build(FIELDS)

You cannot create a delayed header with fields.

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

See "Constructors" in Mail::Message::Head

The header

$obj->isDelayed

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

$obj->isEmpty

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

$obj->isModified

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

$obj->knownNames

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

$obj->message([MESSAGE])

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

$obj->modified([BOOLEAN])

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

$obj->orderedFields

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

Access to the header

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

Get the information about the header line NAME. Realization will take place.

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

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

About the body

$obj->guessBodySize

On a delayed head, this retuns undef, because when there is no header there is also no body.

For messages in directory or network organized folders, Mail::Message::size() usually will give a figure for the whole message without much cost. Subtract a few hundred bytes for the header, and you will get a good estimate.

$obj->guessTimeStamp

Make a guess about when the message was originally posted. On a delayed head, this returns undef. For messages in directory or network organized folders, Mail::Message::timestamp() usually will give a figure without much cost.

$obj->isMultipart

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

Internals

$obj->addNoRealize(FIELD)

See "Internals" in Mail::Message::Head

$obj->addOrderedFields(FIELDS)

See "Internals" in Mail::Message::Head

$obj->fileLocation

See "Internals" in Mail::Message::Head

$obj->load

See "Internals" in Mail::Message::Head

$obj->moveLocation(DISTANCE)

See "Internals" in Mail::Message::Head

$obj->read(PARSER)

See "Internals" in Mail::Message::Head

$obj->setNoRealize(FIELD)

See "Internals" in Mail::Message::Head

Error handling

$obj->AUTOLOAD

See "Error handling" in Mail::Reporter

$obj->addReport(OBJECT)

See "Error handling" in Mail::Reporter

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

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

See "Error handling" in Mail::Reporter

$obj->errors

See "Error handling" in Mail::Reporter

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

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

See "Error handling" in Mail::Reporter

$obj->logPriority(LEVEL)

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

See "Error handling" in Mail::Reporter

$obj->logSettings

See "Error handling" in Mail::Reporter

$obj->notImplemented

See "Error handling" in Mail::Reporter

$obj->report([LEVEL])

See "Error handling" in Mail::Reporter

$obj->reportAll([LEVEL])

See "Error handling" in Mail::Reporter

$obj->trace([LEVEL])

See "Error handling" in Mail::Reporter

$obj->warnings

See "Error handling" in Mail::Reporter

Cleanup

$obj->DESTROY

See "Cleanup" in Mail::Reporter

$obj->inGlobalDestruction

See "Cleanup" in Mail::Reporter

DIAGNOSTICS

Error: Cannot build() a delayed header.

A delayed message header cannot contain any information, so cannot be build. You can construct complete or subset headers.

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.097, built on January 26, 2011. Website: http://perl.overmeer.net/mailbox/

LICENSE

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