NAME
Mail::Message::Body::Lines - body of a Mail::Message stored as array of lines
INHERITANCE
Mail::Message::Body::Lines
is a Mail::Message::Body
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 find the description of extra functionality you have when a message is stored in an array of lines.
Storing a whole message as an array of lines is useful when the data is not encoded, and you want to process it on a line-by-line basis (a common practice for inspecting message bodies).
OVERLOADED
overload: ""
overload: '==' and '!='
overload: @{}
overload: bool
METHODS
Constructors
$obj->clone
Mail::Message::Body::Lines->new(OPTIONS)
Option --Defined in --Default based_on Mail::Message::Body undef charset Mail::Message::Body 'us-ascii'
checked Mail::Message::Body <false> 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 log Mail::Reporter 'WARNINGS'
message Mail::Message::Body undef mime_type Mail::Message::Body 'text/plain'
modified Mail::Message::Body <false> trace Mail::Reporter 'WARNINGS'
transfer_encoding Mail::Message::Body 'none'
. based_on BODY
. charset STRING
. checked BOOLEAN
. data ARRAY-OF-LINES | STRING
. description STRING|FIELD
. disposition STRING|FIELD
. eol 'CR'|'LF'|'CRLF'|'NATIVE'
. file FILENAME|FILEHANDLE|IOHANDLE
. log LEVEL
. message MESSAGE
. mime_type STRING|FIELD|MIME
. modified BOOLEAN
. trace LEVEL
. transfer_encoding STRING|FIELD
Constructing a body
$obj->attach(MESSAGES, OPTIONS)
$obj->check
$obj->concatenate(COMPONENTS)
$obj->decoded(OPTIONS)
$obj->encode(OPTIONS)
$obj->encoded
$obj->eol(['CR'|'LF'|'CRLF'|'NATIVE'])
$obj->foreachLine(CODE)
$obj->stripSignature(OPTIONS)
$obj->unify(BODY)
The body
$obj->isDelayed
$obj->isMultipart
$obj->isNested
$obj->message([MESSAGE])
About the payload
$obj->charset
$obj->checked([BOOLEAN])
$obj->description([STRING|FIELD])
$obj->disposition([STRING|FIELD])
$obj->dispositionFilename([DIRECTORY])
$obj->isBinary
$obj->isText
$obj->mimeType
$obj->nrLines
$obj->size
$obj->transferEncoding([STRING|FIELD])
$obj->type([STRING|FIELD])
Access to the payload
$obj->endsOnNewline
$obj->file
$obj->lines
$obj->print([FILEHANDLE])
$obj->printEscapedFrom(FILEHANDLE)
$obj->string
$obj->stripTrailingNewline
$obj->write(OPTIONS)
Internals
$obj->addTransferEncHandler(NAME, CLASS|OBJECT)
Mail::Message::Body::Lines->addTransferEncHandler(NAME, CLASS|OBJECT)
$obj->contentInfoFrom(HEAD)
$obj->contentInfoTo(HEAD)
$obj->fileLocation([BEGIN,END])
$obj->getTransferEncHandler(TYPE)
$obj->isModified
$obj->load
$obj->modified([BOOLEAN])
$obj->moveLocation([DISTANCE])
$obj->read(PARSER, HEAD, BODYTYPE [,CHARS [,LINES]])
Error handling
$obj->AUTOLOAD
$obj->addReport(OBJECT)
$obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
Mail::Message::Body::Lines->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
$obj->errors
$obj->log([LEVEL [,STRINGS]])
Mail::Message::Body::Lines->log([LEVEL [,STRINGS]])
$obj->logPriority(LEVEL)
Mail::Message::Body::Lines->logPriority(LEVEL)
$obj->logSettings
$obj->notImplemented
$obj->report([LEVEL])
$obj->reportAll([LEVEL])
$obj->trace([LEVEL])
$obj->warnings
Cleanup
$obj->DESTROY
$obj->inGlobalDestruction
DIAGNOSTICS
Warning: No decoder defined for transfer encoding $name.
The data (message body) is encoded in a way which is not currently understood, therefore no decoding (or recoding) can take place.
Warning: No encoder defined for transfer encoding $name.
The data (message body) has been decoded, but the required encoding is unknown. The decoded data is returned.
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.
Error: Unable to read file $filename for message body lines: $!
A Mail::Message::Body::Lines object is to be created from a named file, but it is impossible to read that file to retrieve the lines within.
DETAILS
REFERENCES
See the MailBox website at http://perl.overmeer.net/mailbox/ for more details.
COPYRIGHTS
Distribution version 2.067. Written by Mark Overmeer (mark@overmeer.net). See the ChangeLog for other contributors.
Copyright (c) 2001-2006 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.