1Mail::Message::Body::StUrsienrg(C3o)ntributed Perl DocumMeanitla:t:iMoenssage::Body::String(3)
2
3
4
6 Mail::Message::Body::String - body of a Mail::Message stored as single
7 string
8
10 Mail::Message::Body::String
11 is a Mail::Message::Body
12 is a Mail::Reporter
13
15 See Mail::Message::Body
16
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
27 Extends "DESCRIPTION" in Mail::Message::Body.
28
30 Extends "OVERLOADED" in Mail::Message::Body.
31
32 overload: ""
33 Inherited, see "OVERLOADED" in Mail::Message::Body
34
35 overload: '==' and '!='
36 Inherited, see "OVERLOADED" in Mail::Message::Body
37
38 overload: @{}
39 Inherited, see "OVERLOADED" in Mail::Message::Body
40
41 overload: bool
42 Inherited, see "OVERLOADED" in Mail::Message::Body
43
45 Extends "METHODS" in Mail::Message::Body.
46
47 Constructors
48 Extends "Constructors" in Mail::Message::Body.
49
50 $obj->clone()
51 Inherited, see "Constructors" in Mail::Message::Body
52
53 Mail::Message::Body::String->new(%options)
54 -Option --Defined in --Default
55 based_on Mail::Message::Body undef
56 charset Mail::Message::Body 'PERL'
57 checked Mail::Message::Body <false>
58 content_id Mail::Message::Body undef
59 data Mail::Message::Body undef
60 description Mail::Message::Body undef
61 disposition Mail::Message::Body undef
62 eol Mail::Message::Body 'NATIVE'
63 file Mail::Message::Body undef
64 filename Mail::Message::Body undef
65 log Mail::Reporter 'WARNINGS'
66 message Mail::Message::Body undef
67 mime_type Mail::Message::Body 'text/plain'
68 modified Mail::Message::Body <false>
69 trace Mail::Reporter 'WARNINGS'
70 transfer_encoding Mail::Message::Body 'none'
71
72 based_on => BODY
73 charset => CHARSET|'PERL'|<undef>
74 checked => BOOLEAN
75 content_id => STRING
76 data => ARRAY-OF-LINES | STRING
77 description => STRING|FIELD
78 disposition => STRING|FIELD
79 eol => 'CR'|'LF'|'CRLF'|'NATIVE'
80 file => FILENAME|FILEHANDLE|IOHANDLE
81 filename => FILENAME
82 log => LEVEL
83 message => MESSAGE
84 mime_type => STRING|FIELD|MIME
85 modified => BOOLEAN
86 trace => LEVEL
87 transfer_encoding => STRING|FIELD
88
89 Constructing a body
90 Extends "Constructing a body" in Mail::Message::Body.
91
92 $obj->attach($messages, %options)
93 Inherited, see "Constructing a body" in
94 Mail::Message::Body::Construct
95
96 $obj->charsetDetect(%options)
97 Inherited, see "Constructing a body" in Mail::Message::Body::Encode
98
99 Mail::Message::Body::String->charsetDetectAlgorithm(
100 [CODE|undef|METHOD] )
101 Inherited, see "Constructing a body" in Mail::Message::Body::Encode
102
103 $obj->check()
104 Inherited, see "Constructing a body" in Mail::Message::Body::Encode
105
106 $obj->concatenate($components)
107 Inherited, see "Constructing a body" in
108 Mail::Message::Body::Construct
109
110 $obj->decoded(%options)
111 Inherited, see "Constructing a body" in Mail::Message::Body
112
113 $obj->encode(%options)
114 Inherited, see "Constructing a body" in Mail::Message::Body::Encode
115
116 $obj->encoded(%options)
117 Inherited, see "Constructing a body" in Mail::Message::Body::Encode
118
119 $obj->eol( ['CR'|'LF'|'CRLF'|'NATIVE'] )
120 Inherited, see "Constructing a body" in Mail::Message::Body
121
122 $obj->foreachLine(CODE)
123 Inherited, see "Constructing a body" in
124 Mail::Message::Body::Construct
125
126 $obj->stripSignature(%options)
127 Inherited, see "Constructing a body" in
128 Mail::Message::Body::Construct
129
130 $obj->unify($body)
131 Inherited, see "Constructing a body" in Mail::Message::Body::Encode
132
133 The body
134 Extends "The body" in Mail::Message::Body.
135
136 $obj->isDelayed()
137 Inherited, see "The body" in Mail::Message::Body
138
139 $obj->isMultipart()
140 Inherited, see "The body" in Mail::Message::Body
141
142 $obj->isNested()
143 Inherited, see "The body" in Mail::Message::Body
144
145 $obj->message( [$message] )
146 Inherited, see "The body" in Mail::Message::Body
147
148 $obj->partNumberOf($part)
149 Inherited, see "The body" in Mail::Message::Body
150
151 About the payload
152 Extends "About the payload" in Mail::Message::Body.
153
154 $obj->charset()
155 Inherited, see "About the payload" in Mail::Message::Body
156
157 $obj->checked( [BOOLEAN] )
158 Inherited, see "About the payload" in Mail::Message::Body
159
160 $obj->contentId( [STRING|$field] )
161 Inherited, see "About the payload" in Mail::Message::Body
162
163 $obj->description( [STRING|$field] )
164 Inherited, see "About the payload" in Mail::Message::Body
165
166 $obj->disposition( [STRING|$field] )
167 Inherited, see "About the payload" in Mail::Message::Body
168
169 $obj->dispositionFilename( [$directory] )
170 Inherited, see "About the payload" in Mail::Message::Body::Encode
171
172 $obj->isBinary()
173 Inherited, see "About the payload" in Mail::Message::Body::Encode
174
175 $obj->isText()
176 Inherited, see "About the payload" in Mail::Message::Body::Encode
177
178 $obj->mimeType()
179 Inherited, see "About the payload" in Mail::Message::Body
180
181 $obj->nrLines()
182 Inherited, see "About the payload" in Mail::Message::Body
183
184 $obj->size()
185 Inherited, see "About the payload" in Mail::Message::Body
186
187 $obj->transferEncoding( [STRING|$field] )
188 Inherited, see "About the payload" in Mail::Message::Body
189
190 $obj->type( [STRING|$field] )
191 Inherited, see "About the payload" in Mail::Message::Body
192
193 Access to the payload
194 Extends "Access to the payload" in Mail::Message::Body.
195
196 $obj->endsOnNewline()
197 Inherited, see "Access to the payload" in Mail::Message::Body
198
199 $obj->file()
200 Inherited, see "Access to the payload" in Mail::Message::Body
201
202 $obj->lines()
203 Inherited, see "Access to the payload" in Mail::Message::Body
204
205 $obj->print( [$fh] )
206 Inherited, see "Access to the payload" in Mail::Message::Body
207
208 $obj->printEscapedFrom($fh)
209 Inherited, see "Access to the payload" in Mail::Message::Body
210
211 $obj->string()
212 Inherited, see "Access to the payload" in Mail::Message::Body
213
214 $obj->stripTrailingNewline()
215 Inherited, see "Access to the payload" in Mail::Message::Body
216
217 $obj->write(%options)
218 Inherited, see "Access to the payload" in Mail::Message::Body
219
220 Internals
221 Extends "Internals" in Mail::Message::Body.
222
223 $obj->addTransferEncHandler( $name, <$class|$object> )
224 Mail::Message::Body::String->addTransferEncHandler( $name,
225 <$class|$object> )
226 Inherited, see "Internals" in Mail::Message::Body::Encode
227
228 $obj->contentInfoFrom($head)
229 Inherited, see "Internals" in Mail::Message::Body
230
231 $obj->contentInfoTo($head)
232 Inherited, see "Internals" in Mail::Message::Body
233
234 $obj->fileLocation( [$begin, $end] )
235 Inherited, see "Internals" in Mail::Message::Body
236
237 $obj->getTransferEncHandler($type)
238 Inherited, see "Internals" in Mail::Message::Body::Encode
239
240 $obj->isModified()
241 Inherited, see "Internals" in Mail::Message::Body
242
243 $obj->load()
244 Inherited, see "Internals" in Mail::Message::Body
245
246 $obj->modified( [BOOLEAN] )
247 Inherited, see "Internals" in Mail::Message::Body
248
249 $obj->moveLocation( [$distance] )
250 Inherited, see "Internals" in Mail::Message::Body
251
252 $obj->read( $parser, $head, $bodytype, [$chars, [$lines]] )
253 Inherited, see "Internals" in Mail::Message::Body
254
255 Error handling
256 Extends "Error handling" in Mail::Message::Body.
257
258 $obj->AUTOLOAD()
259 Inherited, see "Error handling" in Mail::Message::Body
260
261 $obj->addReport($object)
262 Inherited, see "Error handling" in Mail::Reporter
263
264 $obj->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level,
265 $callback] )
266 Mail::Message::Body::String->defaultTrace( [$level]|[$loglevel,
267 $tracelevel]|[$level, $callback] )
268 Inherited, see "Error handling" in Mail::Reporter
269
270 $obj->errors()
271 Inherited, see "Error handling" in Mail::Reporter
272
273 $obj->log( [$level, [$strings]] )
274 Mail::Message::Body::String->log( [$level, [$strings]] )
275 Inherited, see "Error handling" in Mail::Reporter
276
277 $obj->logPriority($level)
278 Mail::Message::Body::String->logPriority($level)
279 Inherited, see "Error handling" in Mail::Reporter
280
281 $obj->logSettings()
282 Inherited, see "Error handling" in Mail::Reporter
283
284 $obj->notImplemented()
285 Inherited, see "Error handling" in Mail::Reporter
286
287 $obj->report( [$level] )
288 Inherited, see "Error handling" in Mail::Reporter
289
290 $obj->reportAll( [$level] )
291 Inherited, see "Error handling" in Mail::Reporter
292
293 $obj->trace( [$level] )
294 Inherited, see "Error handling" in Mail::Reporter
295
296 $obj->warnings()
297 Inherited, see "Error handling" in Mail::Reporter
298
299 Cleanup
300 Extends "Cleanup" in Mail::Message::Body.
301
302 $obj->DESTROY()
303 Inherited, see "Cleanup" in Mail::Reporter
304
306 Extends "DETAILS" in Mail::Message::Body.
307
309 Warning: Charset $name is not known
310 The encoding or decoding of a message body encounters a character
311 set which is not understood by Perl's Encode module.
312
313 Warning: No decoder defined for transfer encoding $name.
314 The data (message body) is encoded in a way which is not currently
315 understood, therefore no decoding (or recoding) can take place.
316
317 Warning: No encoder defined for transfer encoding $name.
318 The data (message body) has been decoded, but the required encoding
319 is unknown. The decoded data is returned.
320
321 Error: Package $package does not implement $method.
322 Fatal error: the specific package (or one of its superclasses) does
323 not implement this method where it should. This message means that
324 some other related classes do implement this method however the
325 class at hand does not. Probably you should investigate this and
326 probably inform the author of the package.
327
328 Error: Unable to read file $filename for message body scalar: $!
329 A Mail::Message::Body::String object is to be created from a named
330 file, but it is impossible to read that file to retrieve the lines
331 within.
332
333 Warning: Unknown line terminator $eol ignored
334
336 This module is part of Mail-Message distribution version 3.013, built
337 on June 24, 2023. Website: http://perl.overmeer.net/CPAN/
338
340 Copyrights 2001-2023 by [Mark Overmeer <markov@cpan.org>]. For other
341 contributors see ChangeLog.
342
343 This program is free software; you can redistribute it and/or modify it
344 under the same terms as Perl itself. See http://dev.perl.org/licenses/
345
346
347
348perl v5.38.0 2023-07-20 Mail::Message::Body::String(3)