Mail::Message::Body::String(3pm)

1Mail::Message::Body::StUrsienrg(C3o)ntributed Perl DocumMeanitla:t:iMoenssage::Body::String(3)
2
3
4

NAME

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

INHERITANCE

10        Mail::Message::Body::String
11          is a Mail::Message::Body
12          is a Mail::Reporter
13

SYNOPSIS

15        See Mail::Message::Body
16

DESCRIPTION

18       The body (content) of a message can be stored in various ways.  In this
19       documentation you will find the description of extra functionality you
20       have when a message is stored as a single scalar.
21
22       Storing a whole message in one string is only a smart choice when the
23       content is small or encoded. Even when stored as a scalar, you can
24       still treat the body as if the data is stored in lines or an external
25       file, but this will be slower.
26

OVERLOADED

28       overload: ""
29           See "OVERLOADED" in Mail::Message::Body
30
31       overload: '==' and '!='
32           See "OVERLOADED" in Mail::Message::Body
33
34       overload: @{}
35           See "OVERLOADED" in Mail::Message::Body
36
37       overload: bool
38           See "OVERLOADED" in Mail::Message::Body
39

METHODS

41   Constructors
42       $obj->clone
43           See "Constructors" in Mail::Message::Body
44
45       Mail::Message::Body::String->new(OPTIONS)
46            -Option           --Defined in     --Default
47             based_on           Mail::Message::Body  undef
48             charset            Mail::Message::Body  'PERL' or <undef>
49             checked            Mail::Message::Body  <false>
50             data               Mail::Message::Body  undef
51             description        Mail::Message::Body  undef
52             disposition        Mail::Message::Body  undef
53             eol                Mail::Message::Body  'NATIVE'
54             file               Mail::Message::Body  undef
55             log                Mail::Reporter   'WARNINGS'
56             message            Mail::Message::Body  undef
57             mime_type          Mail::Message::Body  'text/plain'
58             modified           Mail::Message::Body  <false>
59             trace              Mail::Reporter   'WARNINGS'
60             transfer_encoding  Mail::Message::Body  'none'
61
62           based_on => BODY
63           charset => CHARSET|'PERL'
64           checked => BOOLEAN
65           data => ARRAY-OF-LINES | STRING
66           description => STRING|FIELD
67           disposition => STRING|FIELD
68           eol => 'CR'|'LF'|'CRLF'|'NATIVE'
69           file => FILENAME|FILEHANDLE|IOHANDLE
70           log => LEVEL
71           message => MESSAGE
72           mime_type => STRING|FIELD|MIME
73           modified => BOOLEAN
74           trace => LEVEL
75           transfer_encoding => STRING|FIELD
76
77   Constructing a body
78       $obj->attach(MESSAGES, OPTIONS)
79           See "Constructing a body" in Mail::Message::Body::Construct
80
81       $obj->check
82           See "Constructing a body" in Mail::Message::Body::Encode
83
84       $obj->concatenate(COMPONENTS)
85           See "Constructing a body" in Mail::Message::Body::Construct
86
87       $obj->decoded(OPTIONS)
88           See "Constructing a body" in Mail::Message::Body
89
90       $obj->encode(OPTIONS)
91           See "Constructing a body" in Mail::Message::Body::Encode
92
93       $obj->encoded
94           See "Constructing a body" in Mail::Message::Body::Encode
95
96       $obj->eol(['CR'|'LF'|'CRLF'|'NATIVE'])
97           See "Constructing a body" in Mail::Message::Body
98
99       $obj->foreachLine(CODE)
100           See "Constructing a body" in Mail::Message::Body::Construct
101
102       $obj->stripSignature(OPTIONS)
103           See "Constructing a body" in Mail::Message::Body::Construct
104
105       $obj->unify(BODY)
106           See "Constructing a body" in Mail::Message::Body::Encode
107
108   The body
109       $obj->isDelayed
110           See "The body" in Mail::Message::Body
111
112       $obj->isMultipart
113           See "The body" in Mail::Message::Body
114
115       $obj->isNested
116           See "The body" in Mail::Message::Body
117
118       $obj->message([MESSAGE])
119           See "The body" in Mail::Message::Body
120
121   About the payload
122       $obj->charset
123           See "About the payload" in Mail::Message::Body
124
125       $obj->checked([BOOLEAN])
126           See "About the payload" in Mail::Message::Body
127
128       $obj->description([STRING|FIELD])
129           See "About the payload" in Mail::Message::Body
130
131       $obj->disposition([STRING|FIELD])
132           See "About the payload" in Mail::Message::Body
133
134       $obj->dispositionFilename([DIRECTORY])
135           See "About the payload" in Mail::Message::Body::Encode
136
137       $obj->isBinary
138           See "About the payload" in Mail::Message::Body::Encode
139
140       $obj->isText
141           See "About the payload" in Mail::Message::Body::Encode
142
143       $obj->mimeType
144           See "About the payload" in Mail::Message::Body
145
146       $obj->nrLines
147           See "About the payload" in Mail::Message::Body
148
149       $obj->size
150           See "About the payload" in Mail::Message::Body
151
152       $obj->transferEncoding([STRING|FIELD])
153           See "About the payload" in Mail::Message::Body
154
155       $obj->type([STRING|FIELD])
156           See "About the payload" in Mail::Message::Body
157
158   Access to the payload
159       $obj->endsOnNewline
160           See "Access to the payload" in Mail::Message::Body
161
162       $obj->file
163           See "Access to the payload" in Mail::Message::Body
164
165       $obj->lines
166           See "Access to the payload" in Mail::Message::Body
167
168       $obj->print([FILEHANDLE])
169           See "Access to the payload" in Mail::Message::Body
170
171       $obj->printEscapedFrom(FILEHANDLE)
172           See "Access to the payload" in Mail::Message::Body
173
174       $obj->string
175           See "Access to the payload" in Mail::Message::Body
176
177       $obj->stripTrailingNewline
178           See "Access to the payload" in Mail::Message::Body
179
180       $obj->write(OPTIONS)
181           See "Access to the payload" in Mail::Message::Body
182
183   Internals
184       $obj->addTransferEncHandler(NAME, CLASS|OBJECT)
185           Mail::Message::Body::String->addTransferEncHandler(NAME,
186           CLASS|OBJECT)
187
188           See "Internals" in Mail::Message::Body::Encode
189
190       $obj->contentInfoFrom(HEAD)
191           See "Internals" in Mail::Message::Body
192
193       $obj->contentInfoTo(HEAD)
194           See "Internals" in Mail::Message::Body
195
196       $obj->fileLocation([BEGIN,END])
197           See "Internals" in Mail::Message::Body
198
199       $obj->getTransferEncHandler(TYPE)
200           See "Internals" in Mail::Message::Body::Encode
201
202       $obj->isModified
203           See "Internals" in Mail::Message::Body
204
205       $obj->load
206           See "Internals" in Mail::Message::Body
207
208       $obj->modified([BOOLEAN])
209           See "Internals" in Mail::Message::Body
210
211       $obj->moveLocation([DISTANCE])
212           See "Internals" in Mail::Message::Body
213
214       $obj->read(PARSER, HEAD, BODYTYPE [,CHARS [,LINES]])
215           See "Internals" in Mail::Message::Body
216
217   Error handling
218       $obj->AUTOLOAD
219           See "Error handling" in Mail::Message::Body
220
221       $obj->addReport(OBJECT)
222           See "Error handling" in Mail::Reporter
223
224       $obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
225           Mail::Message::Body::String->defaultTrace([LEVEL]|[LOGLEVEL,
226           TRACELEVEL]|[LEVEL, CALLBACK])
227
228           See "Error handling" in Mail::Reporter
229
230       $obj->errors
231           See "Error handling" in Mail::Reporter
232
233       $obj->log([LEVEL [,STRINGS]])
234           Mail::Message::Body::String->log([LEVEL [,STRINGS]])
235
236           See "Error handling" in Mail::Reporter
237
238       $obj->logPriority(LEVEL)
239           Mail::Message::Body::String->logPriority(LEVEL)
240
241           See "Error handling" in Mail::Reporter
242
243       $obj->logSettings
244           See "Error handling" in Mail::Reporter
245
246       $obj->notImplemented
247           See "Error handling" in Mail::Reporter
248
249       $obj->report([LEVEL])
250           See "Error handling" in Mail::Reporter
251
252       $obj->reportAll([LEVEL])
253           See "Error handling" in Mail::Reporter
254
255       $obj->trace([LEVEL])
256           See "Error handling" in Mail::Reporter
257
258       $obj->warnings
259           See "Error handling" in Mail::Reporter
260
261   Cleanup
262       $obj->DESTROY
263           See "Cleanup" in Mail::Reporter
264
265       $obj->inGlobalDestruction
266           See "Cleanup" in Mail::Reporter
267

DIAGNOSTICS

269       Warning: Charset $name is not known
270           The encoding or decoding of a message body encounters a character
271           set which is not understood by Perl's Encode module.
272
273       Warning: No decoder defined for transfer encoding $name.
274           The data (message body) is encoded in a way which is not currently
275           understood, therefore no decoding (or recoding) can take place.
276
277       Warning: No encoder defined for transfer encoding $name.
278           The data (message body) has been decoded, but the required encoding
279           is unknown.  The decoded data is returned.
280
281       Error: Package $package does not implement $method.
282           Fatal error: the specific package (or one of its superclasses) does
283           not implement this method where it should. This message means that
284           some other related classes do implement this method however the
285           class at hand does not.  Probably you should investigate this and
286           probably inform the author of the package.
287
288       Error: Unable to read file $filename for message body scalar: $!
289           A Mail::Message::Body::String object is to be created from a named
290           file, but it is impossible to read that file to retrieve the lines
291           within.
292
293       Warning: Unknown line terminator $eol ignored
294

LICENSE

300       Copyrights 2001-2011 by Mark Overmeer. For other contributors see
301       ChangeLog.
302
303       This program is free software; you can redistribute it and/or modify it
304       under the same terms as Perl itself.  See
305       http://www.perl.com/perl/misc/Artistic.html
306
307
308
309perl v5.12.3                      2011-01-26    Mail::Message::Body::String(3)