Mail::Message::Body::String

INHERITANCE

 Mail::Message::Body::String
   is a Mail::Message::Body
   is a Mail::Reporter
   Mail::Message::Body also extends Mail::Reporter
   is a Mail::Reporter

SYNOPSIS

  See Mail::Message::Body

DESCRIPTION

The body (content) of a message can be stored in various ways. In this documentation you will find the description of extra functionality you have when a message is stored as a single scalar.

Storing a whole message in one string is only a smart choice when the content is small or encoded. Even when stored as a scalar, you can still treat the body as if the data is stored in lines or an external file, but this will be slower.

Extends "DESCRIPTION" in Mail::Message::Body.

OVERLOADED

Extends "OVERLOADED" in Mail::Message::Body.

overload: "" stringification: Inherited, see "OVERLOADED" in Mail::Message::Body
overload: '==' numerical comparison: Inherited, see "OVERLOADED" in Mail::Message::Body
overload: @{} addressed as array: Inherited, see "OVERLOADED" in Mail::Message::Body
overload: bool true/false: Inherited, see "OVERLOADED" in Mail::Message::Body

METHODS

Extends "METHODS" in Mail::Message::Body.

Constructors

Extends "Constructors" in Mail::Message::Body.

$obj->clone()

Inherited, see "Constructors" in Mail::Message::Body

$class->new(%options)

Inherited, see "Constructors" in Mail::Message::Body

 -Option           --Defined in         --Default
  based_on           Mail::Message::Body  undef
  charset            Mail::Message::Body  'PERL'
  checked            Mail::Message::Body  false
  content_id         Mail::Message::Body  undef
  data               Mail::Message::Body  undef
  description        Mail::Message::Body  undef
  disposition        Mail::Message::Body  undef
  eol                Mail::Message::Body  'NATIVE'
  file               Mail::Message::Body  undef
  filename           Mail::Message::Body  undef
  language           Mail::Message::Body  undef
  message            Mail::Message::Body  undef
  mime_type          Mail::Message::Body  'text/plain'
  modified           Mail::Message::Body  false
  transfer_encoding  Mail::Message::Body  'none'

based_on => $body
charset => $charset|'PERL'|<undef>
checked => BOOLEAN
content_id => STRING
data => \@lines|$text
description => STRING|$field
disposition => STRING|$field
eol => 'CR'|'LF'|'CRLF'|'NATIVE'
file => $file|$handle|$io
filename => $file
language => STRING|\@lang|$field
message => $message
mime_type => STRING|$field|$mime
modified => BOOLEAN
transfer_encoding => STRING|$field

Attributes

Extends "Attributes" in Mail::Message::Body.

$obj->charsetDetectAlgorithm( [CODE|undef|METHOD] ): Inherited, see "Attributes" in Mail::Message::Body::Encode

Constructing a body

Extends "Constructing a body" in Mail::Message::Body.

$obj->attach(@messages, %options): Inherited, see "Constructing a body" in Mail::Message::Body::Construct
$obj->charsetDetect(%options): Inherited, see "Constructing a body" in Mail::Message::Body::Encode
$obj->check(): Inherited, see "Constructing a body" in Mail::Message::Body::Encode
$obj->concatenate(@components): Inherited, see "Constructing a body" in Mail::Message::Body::Construct
$obj->decoded(%options): Inherited, see "Constructing a body" in Mail::Message::Body
$obj->encode(%options): Inherited, see "Constructing a body" in Mail::Message::Body::Encode
$obj->encoded(%options): Inherited, see "Constructing a body" in Mail::Message::Body::Encode
$obj->eol( ['CR'|'LF'|'CRLF'|'NATIVE'] ): Inherited, see "Constructing a body" in Mail::Message::Body::Encode
$obj->foreachLine(CODE): Inherited, see "Constructing a body" in Mail::Message::Body::Construct
$obj->stripSignature(%options): Inherited, see "Constructing a body" in Mail::Message::Body::Construct
$obj->unify($body): Inherited, see "Constructing a body" in Mail::Message::Body::Encode

The body

Extends "The body" in Mail::Message::Body.

$obj->isDelayed(): Inherited, see "The body" in Mail::Message::Body
$obj->isMultipart(): Inherited, see "The body" in Mail::Message::Body
$obj->isNested(): Inherited, see "The body" in Mail::Message::Body
$obj->message( [$message] ): Inherited, see "The body" in Mail::Message::Body
$obj->partNumberOf($part): Inherited, see "The body" in Mail::Message::Body

About the payload

Extends "About the payload" in Mail::Message::Body.

$obj->charset(): Inherited, see "About the payload" in Mail::Message::Body
$obj->checked( [BOOLEAN] ): Inherited, see "About the payload" in Mail::Message::Body
$obj->contentId( [STRING|$field] ): Inherited, see "About the payload" in Mail::Message::Body
$obj->description( [STRING|$field] ): Inherited, see "About the payload" in Mail::Message::Body
$obj->disposition( [STRING|$field] ): Inherited, see "About the payload" in Mail::Message::Body
$obj->dispositionFilename( [$directory] ): Inherited, see "About the payload" in Mail::Message::Body::Encode
$obj->isBinary(): Inherited, see "About the payload" in Mail::Message::Body::Encode
$obj->isText(): Inherited, see "About the payload" in Mail::Message::Body::Encode
$obj->language( [@langs|\@langs|$langs|$field] ): Inherited, see "About the payload" in Mail::Message::Body
$obj->mimeType(): Inherited, see "About the payload" in Mail::Message::Body
$obj->nrLines(): Inherited, see "About the payload" in Mail::Message::Body
$obj->size(): Inherited, see "About the payload" in Mail::Message::Body
$obj->transferEncoding( [STRING|$field] ): Inherited, see "About the payload" in Mail::Message::Body
$obj->type( [STRING|$field] ): Inherited, see "About the payload" in Mail::Message::Body

Access to the payload

Extends "Access to the payload" in Mail::Message::Body.

$obj->endsOnNewline(): Inherited, see "Access to the payload" in Mail::Message::Body
$obj->file(): Inherited, see "Access to the payload" in Mail::Message::Body
$obj->lines(): Inherited, see "Access to the payload" in Mail::Message::Body
$obj->print( [$fh] ): Inherited, see "Access to the payload" in Mail::Message::Body
$obj->printEscapedFrom($fh): Inherited, see "Access to the payload" in Mail::Message::Body
$obj->string(): Inherited, see "Access to the payload" in Mail::Message::Body
$obj->stripTrailingNewline(): Inherited, see "Access to the payload" in Mail::Message::Body
$obj->write(%options): Inherited, see "Access to the payload" in Mail::Message::Body

Internals

Extends "Internals" in Mail::Message::Body.

$any->addTransferEncHandler( $name, <$class|$object> ): Inherited, see "Internals" in Mail::Message::Body::Encode
$obj->contentInfoFrom($head): Inherited, see "Internals" in Mail::Message::Body
$obj->contentInfoTo($head): Inherited, see "Internals" in Mail::Message::Body
$obj->fileLocation( [$begin, $end] ): Inherited, see "Internals" in Mail::Message::Body
$obj->getTransferEncHandler($type): Inherited, see "Internals" in Mail::Message::Body::Encode
$obj->isModified(): Inherited, see "Internals" in Mail::Message::Body
$obj->load(): Inherited, see "Internals" in Mail::Message::Body
$obj->modified( [BOOLEAN] ): Inherited, see "Internals" in Mail::Message::Body
$obj->moveLocation( [$distance] ): Inherited, see "Internals" in Mail::Message::Body
$obj->read( $parser, $head, $bodytype, [$chars, [$lines]] ): Inherited, see "Internals" in Mail::Message::Body

Error handling

Extends "Error handling" in Mail::Message::Body.

$obj->AUTOLOAD(): Inherited, see "Error handling" in Mail::Message::Body
$obj->notImplemented(): Inherited, see "Error handling" in Mail::Reporter
$obj->notImplemented(): Inherited, see "Error handling" in Mail::Reporter

Cleanup

Extends "Cleanup" in Mail::Message::Body.

$obj->DESTROY(): Inherited, see "Cleanup" in Mail::Reporter
$obj->DESTROY(): Inherited, see "Cleanup" in Mail::Reporter

DETAILS

Extends "DETAILS" in Mail::Message::Body.

DIAGNOSTICS

Warning: Content-Transfer-Encoding '$te' requires explicit charset, defaulted to utf-8.: Cast by encode()
Fault: Unable to read file $name for message body scalar: $!: A Mail::Message::Body::String object is to be created from a named file, but it is impossible to read that file to retrieve the lines within. Cast by new()
Error: cannot concatenate element $which: Cast by concatenate()
Fault: cannot open $file to write body: $!: Cast by write()
Warning: charset '$name' is not known.: The encoding or decoding of a message body encounters a character set which is not understood by Perl's Encode module. Cast by encode()
Error: class $package does not implement method $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. Cast by notImplemented()
Error: class $package does not implement method $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. Cast by notImplemented()
Fault: error closing $file after write body: $!: Cast by write()
Warning: no decoder defined for transfer encoding '$encoding'.: The data (message body) is encoded in a way which is not currently understood, therefore no decoding (or recoding) can take place. Cast by encode()
Warning: no encoder defined for transfer encoding '$encoding'.: The data (message body) has been decoded, but the required encoding is unknown. The decoded data is returned. Cast by encode()
Error: no filename parameter for write() body.: Cast by write()
Error: part number needs multi-part or nested.: Cast by partNumberOf()
Error: unknown line terminator '$eol'.: Cast by eol()

LICENSE

For contributors see file ChangeLog.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

Ubuntu Manpages