Mark Overmeer > Mail-Box-2.109 > Mail::Message::Body::Delayed

Download:
Mail-Box-2.109.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  2
Open  17
View/Report Bugs
Module Version: 2.109   Source   Latest Release: Mail-Box-2.116

NAME ^

Mail::Message::Body::Delayed - body of a Mail::Message but not read yet.

INHERITANCE ^

 Mail::Message::Body::Delayed realizes a Mail::Message::Body

 Mail::Message::Body::Delayed
   is a Mail::Reporter

SYNOPSIS ^

 See Mail::Message::Body

DESCRIPTION ^

Message bodies of this type will be replaced by another type the moment you access the content. In this documentation you will find the description of how a message body gets delay loaded.

See documentation in the base class.

OVERLOADED ^

overload: ""()

(stringification) Returns the body as string --which will trigger completion-- unless called to produce a string for Carp. The latter to avoid deep recursions.

example: stringification of delayed body

 print $msg->body;   # implicit by print

 my $body = $msg->body;
 my $x    = "$body"; # explicit by interpolation
overload: @{}()

When a body object is used as being an array reference, the lines of the body are returned. This is the same as using the lines method.

overload: bool()

Always returns a true value, which is needed to have overloaded objects to be used as in if($body). Otherwise, if(defined $body) would be needed to avoid a runtime error.

METHODS ^

See documentation in the base class.

Constructors

See documentation in the base class.

Mail::Message::Body::Delayed->new(OPTIONS)
 -Option --Defined in     --Default
  log      Mail::Reporter   'WARNINGS'
  message                   <required>
  trace    Mail::Reporter   'WARNINGS'
log => LEVEL
message => MESSAGE

The MESSAGE object which contains this delayed body.

trace => LEVEL

The body

$obj->message()

About to the payload

$obj->guessSize()
$obj->isDelayed()
$obj->isModified()
$obj->isMultipart()
$obj->modified()
$obj->nrLines()

Internals

$obj->fileLocation([BEGIN, END])
$obj->load()

Returns the loaded version of this body.

$obj->moveLocation(DISTANCE)
$obj->read(PARSER, HEAD, BODYTYPE)

Error handling

See documentation in the base class.

$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::Body::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::Body::Delayed->log([LEVEL [,STRINGS]])

See "Error handling" in Mail::Reporter

$obj->logPriority(LEVEL)
Mail::Message::Body::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

See documentation in the base class.

$obj->DESTROY()

See "Cleanup" in Mail::Reporter

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.109, built on August 19, 2013. Website: http://perl.overmeer.net/mailbox/

LICENSE ^

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

syntax highlighting: