GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  MAIL::MESSAGE::BODY::STRING (3)

.ds Aq ’

NAME

Mail::Message::Body::String - body of a Mail::Message stored as single string

CONTENTS

INHERITANCE



 Mail::Message::Body::String
   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 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.

See documentation in the base class.

OVERLOADED

See documentation in the base class.
overload: <B>‘‘’’B>() See OVERLOADED in Mail::Message::Body
overload: <B>’==’ and ’!=’B>() See OVERLOADED in Mail::Message::Body
overload: <B>@{}B>() See OVERLOADED in Mail::Message::Body
overload: <B>boolB>() See OVERLOADED in Mail::Message::Body

METHODS

See documentation in the base class.

    Constructors

See documentation in the base class.
$obj-><B>cloneB>() See Constructors in Mail::Message::Body
Mail::Message::Body::String-><B>newB>(OPTIONS)


 -Option           --Defined in         --Default
  based_on           Mail::Message::Body  undef
  charset            Mail::Message::Body  PERL or <undef>
  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
  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 => CHARSET|’PERL
checked => BOOLEAN
content_id => STRING
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

See documentation in the base class.
$obj-><B>attachB>(MESSAGES, OPTIONS) See Constructing a body in Mail::Message::Body::Construct
$obj-><B>checkB>() See Constructing a body in Mail::Message::Body::Encode
$obj-><B>concatenateB>(COMPONENTS) See Constructing a body in Mail::Message::Body::Construct
$obj-><B>decodedB>(OPTIONS) See Constructing a body in Mail::Message::Body
$obj-><B>encodeB>(OPTIONS) See Constructing a body in Mail::Message::Body::Encode
$obj-><B>encodedB>() See Constructing a body in Mail::Message::Body::Encode
$obj-><B>eolB>([’CR’|’LF’|’CRLF’|’NATIVE’]) See Constructing a body in Mail::Message::Body
$obj-><B>foreachLineB>(CODE) See Constructing a body in Mail::Message::Body::Construct
$obj-><B>stripSignatureB>(OPTIONS) See Constructing a body in Mail::Message::Body::Construct
$obj-><B>unifyB>(BODY) See Constructing a body in Mail::Message::Body::Encode

    The body

See documentation in the base class.
$obj-><B>isDelayedB>() See The body in Mail::Message::Body
$obj-><B>isMultipartB>() See The body in Mail::Message::Body
$obj-><B>isNestedB>() See The body in Mail::Message::Body
$obj-><B>messageB>([MESSAGE]) See The body in Mail::Message::Body
$obj-><B>partNumberOfB>(PART) See The body in Mail::Message::Body

    About the payload

See documentation in the base class.
$obj-><B>charsetB>() See About the payload in Mail::Message::Body
$obj-><B>checkedB>([BOOLEAN]) See About the payload in Mail::Message::Body
$obj-><B>contentIdB>([STRING|FIELD]) See About the payload in Mail::Message::Body
$obj-><B>descriptionB>([STRING|FIELD]) See About the payload in Mail::Message::Body
$obj-><B>dispositionB>([STRING|FIELD]) See About the payload in Mail::Message::Body
$obj-><B>dispositionFilenameB>([DIRECTORY]) See About the payload in Mail::Message::Body::Encode
$obj-><B>isBinaryB>() See About the payload in Mail::Message::Body::Encode
$obj-><B>isTextB>() See About the payload in Mail::Message::Body::Encode
$obj-><B>mimeTypeB>() See About the payload in Mail::Message::Body
$obj-><B>nrLinesB>() See About the payload in Mail::Message::Body
$obj-><B>sizeB>() See About the payload in Mail::Message::Body
$obj-><B>transferEncodingB>([STRING|FIELD]) See About the payload in Mail::Message::Body
$obj-><B>typeB>([STRING|FIELD]) See About the payload in Mail::Message::Body

    Access to the payload

See documentation in the base class.
$obj-><B>endsOnNewlineB>() See Access to the payload in Mail::Message::Body
$obj-><B>fileB>() See Access to the payload in Mail::Message::Body
$obj-><B>linesB>() See Access to the payload in Mail::Message::Body
$obj-><B>printB>([FILEHANDLE]) See Access to the payload in Mail::Message::Body
$obj-><B>printEscapedFromB>(FILEHANDLE) See Access to the payload in Mail::Message::Body
$obj-><B>stringB>() See Access to the payload in Mail::Message::Body
$obj-><B>stripTrailingNewlineB>() See Access to the payload in Mail::Message::Body
$obj-><B>writeB>(OPTIONS) See Access to the payload in Mail::Message::Body

    Internals

See documentation in the base class.
$obj-><B>addTransferEncHandlerB>(NAME, CLASS|OBJECT)
Mail::Message::Body::String-><B>addTransferEncHandlerB>(NAME, CLASS|OBJECT) See Internals in Mail::Message::Body::Encode
$obj-><B>contentInfoFromB>(HEAD) See Internals in Mail::Message::Body
$obj-><B>contentInfoToB>(HEAD) See Internals in Mail::Message::Body
$obj-><B>fileLocationB>([BEGIN,END]) See Internals in Mail::Message::Body
$obj-><B>getTransferEncHandlerB>(TYPE) See Internals in Mail::Message::Body::Encode
$obj-><B>isModifiedB>() See Internals in Mail::Message::Body
$obj-><B>loadB>() See Internals in Mail::Message::Body
$obj-><B>modifiedB>([BOOLEAN]) See Internals in Mail::Message::Body
$obj-><B>moveLocationB>([DISTANCE]) See Internals in Mail::Message::Body
$obj-><B>readB>(PARSER, HEAD, BODYTYPE [,CHARS [,LINES]]) See Internals in Mail::Message::Body

    Error handling

See documentation in the base class.
$obj-><B>AUTOLOADB>() See Error handling in Mail::Message::Body
$obj-><B>addReportB>(OBJECT) See Error handling in Mail::Reporter
$obj-><B>defaultTraceB>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
Mail::Message::Body::String-><B>defaultTraceB>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK]) See Error handling in Mail::Reporter
$obj-><B>errorsB>() See Error handling in Mail::Reporter
$obj-><B>logB>([LEVEL [,STRINGS]])
Mail::Message::Body::String-><B>logB>([LEVEL [,STRINGS]]) See Error handling in Mail::Reporter
$obj-><B>logPriorityB>(LEVEL)
Mail::Message::Body::String-><B>logPriorityB>(LEVEL) See Error handling in Mail::Reporter
$obj-><B>logSettingsB>() See Error handling in Mail::Reporter
$obj-><B>notImplementedB>() See Error handling in Mail::Reporter
$obj-><B>reportB>([LEVEL]) See Error handling in Mail::Reporter
$obj-><B>reportAllB>([LEVEL]) See Error handling in Mail::Reporter
$obj-><B>traceB>([LEVEL]) See Error handling in Mail::Reporter
$obj-><B>warningsB>() See Error handling in Mail::Reporter

    Cleanup

See documentation in the base class.
$obj-><B>DESTROYB>() See Cleanup in Mail::Reporter

DETAILS

See documentation in the base class.

DIAGNOSTICS

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.
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 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.
Warning: Unknown line terminator $eol ignored

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

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 MAIL::MESSAGE::BODY::STRING (3) 2013-08-19

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.