Mail::Message::Body::Delayed

Section: User Contributed Perl Documentation (3)
Updated: 2021-01-27
Page Index

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.

Extends ``DESCRIPTION'' in Mail::Reporter.

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

Extends ``METHODS'' in Mail::Reporter.

Constructors

Extends ``Constructors'' in Mail::Reporter.

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

Extends ``Error handling'' in Mail::Reporter.

$obj->AUTOLOAD(): Inherited, see ``Error handling'' in Mail::Reporter
$obj->addReport($object): Inherited, see ``Error handling'' in Mail::Reporter
$obj->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
Mail::Message::Body::Delayed->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] ): Inherited, see ``Error handling'' in Mail::Reporter
$obj->errors(): Inherited, see ``Error handling'' in Mail::Reporter
$obj->log( [$level, [$strings]] )
Mail::Message::Body::Delayed->log( [$level, [$strings]] ): Inherited, see ``Error handling'' in Mail::Reporter
$obj->logPriority($level)
Mail::Message::Body::Delayed->logPriority($level): Inherited, see ``Error handling'' in Mail::Reporter
$obj->logSettings(): Inherited, see ``Error handling'' in Mail::Reporter
$obj->notImplemented(): Inherited, see ``Error handling'' in Mail::Reporter
$obj->report( [$level] ): Inherited, see ``Error handling'' in Mail::Reporter
$obj->reportAll( [$level] ): Inherited, see ``Error handling'' in Mail::Reporter
$obj->trace( [$level] ): Inherited, see ``Error handling'' in Mail::Reporter
$obj->warnings(): Inherited, see ``Error handling'' in Mail::Reporter

Cleanup

Extends ``Cleanup'' in Mail::Reporter.

$obj->DESTROY(): Inherited, 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.

LICENSE

Copyrights 2001-2020 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://dev.perl.org/licenses/