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
27       Extends "DESCRIPTION" in Mail::Message::Body.
28

OVERLOADED

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

METHODS

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' or <undef>
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'
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->check()
97           Inherited, see "Constructing a body" in Mail::Message::Body::Encode
98
99       $obj->concatenate($components)
100           Inherited, see "Constructing a body" in
101           Mail::Message::Body::Construct
102
103       $obj->decoded(%options)
104           Inherited, see "Constructing a body" in Mail::Message::Body
105
106       $obj->encode(%options)
107           Inherited, see "Constructing a body" in Mail::Message::Body::Encode
108
109       $obj->encoded()
110           Inherited, see "Constructing a body" in Mail::Message::Body::Encode
111
112       $obj->eol( ['CR'|'LF'|'CRLF'|'NATIVE'] )
113           Inherited, see "Constructing a body" in Mail::Message::Body
114
115       $obj->foreachLine(CODE)
116           Inherited, see "Constructing a body" in
117           Mail::Message::Body::Construct
118
119       $obj->stripSignature(%options)
120           Inherited, see "Constructing a body" in
121           Mail::Message::Body::Construct
122
123       $obj->unify($body)
124           Inherited, see "Constructing a body" in Mail::Message::Body::Encode
125
126   The body
127       Extends "The body" in Mail::Message::Body.
128
129       $obj->isDelayed()
130           Inherited, see "The body" in Mail::Message::Body
131
132       $obj->isMultipart()
133           Inherited, see "The body" in Mail::Message::Body
134
135       $obj->isNested()
136           Inherited, see "The body" in Mail::Message::Body
137
138       $obj->message( [$message] )
139           Inherited, see "The body" in Mail::Message::Body
140
141       $obj->partNumberOf($part)
142           Inherited, see "The body" in Mail::Message::Body
143
144   About the payload
145       Extends "About the payload" in Mail::Message::Body.
146
147       $obj->charset()
148           Inherited, see "About the payload" in Mail::Message::Body
149
150       $obj->checked( [BOOLEAN] )
151           Inherited, see "About the payload" in Mail::Message::Body
152
153       $obj->contentId( [STRING|$field] )
154           Inherited, see "About the payload" in Mail::Message::Body
155
156       $obj->description( [STRING|$field] )
157           Inherited, see "About the payload" in Mail::Message::Body
158
159       $obj->disposition( [STRING|$field] )
160           Inherited, see "About the payload" in Mail::Message::Body
161
162       $obj->dispositionFilename( [$directory] )
163           Inherited, see "About the payload" in Mail::Message::Body::Encode
164
165       $obj->isBinary()
166           Inherited, see "About the payload" in Mail::Message::Body::Encode
167
168       $obj->isText()
169           Inherited, see "About the payload" in Mail::Message::Body::Encode
170
171       $obj->mimeType()
172           Inherited, see "About the payload" in Mail::Message::Body
173
174       $obj->nrLines()
175           Inherited, see "About the payload" in Mail::Message::Body
176
177       $obj->size()
178           Inherited, see "About the payload" in Mail::Message::Body
179
180       $obj->transferEncoding( [STRING|$field] )
181           Inherited, see "About the payload" in Mail::Message::Body
182
183       $obj->type( [STRING|$field] )
184           Inherited, see "About the payload" in Mail::Message::Body
185
186   Access to the payload
187       Extends "Access to the payload" in Mail::Message::Body.
188
189       $obj->endsOnNewline()
190           Inherited, see "Access to the payload" in Mail::Message::Body
191
192       $obj->file()
193           Inherited, see "Access to the payload" in Mail::Message::Body
194
195       $obj->lines()
196           Inherited, see "Access to the payload" in Mail::Message::Body
197
198       $obj->print( [$fh] )
199           Inherited, see "Access to the payload" in Mail::Message::Body
200
201       $obj->printEscapedFrom($fh)
202           Inherited, see "Access to the payload" in Mail::Message::Body
203
204       $obj->string()
205           Inherited, see "Access to the payload" in Mail::Message::Body
206
207       $obj->stripTrailingNewline()
208           Inherited, see "Access to the payload" in Mail::Message::Body
209
210       $obj->write(%options)
211           Inherited, see "Access to the payload" in Mail::Message::Body
212
213   Internals
214       Extends "Internals" in Mail::Message::Body.
215
216       $obj->addTransferEncHandler( $name, <$class|$object> )
217       Mail::Message::Body::String->addTransferEncHandler( $name,
218       <$class|$object> )
219           Inherited, see "Internals" in Mail::Message::Body::Encode
220
221       $obj->contentInfoFrom($head)
222           Inherited, see "Internals" in Mail::Message::Body
223
224       $obj->contentInfoTo($head)
225           Inherited, see "Internals" in Mail::Message::Body
226
227       $obj->fileLocation( [$begin, $end] )
228           Inherited, see "Internals" in Mail::Message::Body
229
230       $obj->getTransferEncHandler($type)
231           Inherited, see "Internals" in Mail::Message::Body::Encode
232
233       $obj->isModified()
234           Inherited, see "Internals" in Mail::Message::Body
235
236       $obj->load()
237           Inherited, see "Internals" in Mail::Message::Body
238
239       $obj->modified( [BOOLEAN] )
240           Inherited, see "Internals" in Mail::Message::Body
241
242       $obj->moveLocation( [$distance] )
243           Inherited, see "Internals" in Mail::Message::Body
244
245       $obj->read( $parser, $head, $bodytype, [$chars, [$lines]] )
246           Inherited, see "Internals" in Mail::Message::Body
247
248   Error handling
249       Extends "Error handling" in Mail::Message::Body.
250
251       $obj->AUTOLOAD()
252           Inherited, see "Error handling" in Mail::Message::Body
253
254       $obj->addReport($object)
255           Inherited, see "Error handling" in Mail::Reporter
256
257       $obj->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level,
258       $callback] )
259       Mail::Message::Body::String->defaultTrace( [$level]|[$loglevel,
260       $tracelevel]|[$level, $callback] )
261           Inherited, see "Error handling" in Mail::Reporter
262
263       $obj->errors()
264           Inherited, see "Error handling" in Mail::Reporter
265
266       $obj->log( [$level, [$strings]] )
267       Mail::Message::Body::String->log( [$level, [$strings]] )
268           Inherited, see "Error handling" in Mail::Reporter
269
270       $obj->logPriority($level)
271       Mail::Message::Body::String->logPriority($level)
272           Inherited, see "Error handling" in Mail::Reporter
273
274       $obj->logSettings()
275           Inherited, see "Error handling" in Mail::Reporter
276
277       $obj->notImplemented()
278           Inherited, see "Error handling" in Mail::Reporter
279
280       $obj->report( [$level] )
281           Inherited, see "Error handling" in Mail::Reporter
282
283       $obj->reportAll( [$level] )
284           Inherited, see "Error handling" in Mail::Reporter
285
286       $obj->trace( [$level] )
287           Inherited, see "Error handling" in Mail::Reporter
288
289       $obj->warnings()
290           Inherited, see "Error handling" in Mail::Reporter
291
292   Cleanup
293       Extends "Cleanup" in Mail::Message::Body.
294
295       $obj->DESTROY()
296           Inherited, see "Cleanup" in Mail::Reporter
297

DETAILS

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

DIAGNOSTICS

302       Warning: Charset $name is not known
303           The encoding or decoding of a message body encounters a character
304           set which is not understood by Perl's Encode module.
305
306       Warning: No decoder defined for transfer encoding $name.
307           The data (message body) is encoded in a way which is not currently
308           understood, therefore no decoding (or recoding) can take place.
309
310       Warning: No encoder defined for transfer encoding $name.
311           The data (message body) has been decoded, but the required encoding
312           is unknown.  The decoded data is returned.
313
314       Error: Package $package does not implement $method.
315           Fatal error: the specific package (or one of its superclasses) does
316           not implement this method where it should. This message means that
317           some other related classes do implement this method however the
318           class at hand does not.  Probably you should investigate this and
319           probably inform the author of the package.
320
321       Error: Unable to read file $filename for message body scalar: $!
322           A Mail::Message::Body::String object is to be created from a named
323           file, but it is impossible to read that file to retrieve the lines
324           within.
325
326       Warning: Unknown line terminator $eol ignored
327

LICENSE

333       Copyrights 2001-2022 by [Mark Overmeer <markov@cpan.org>]. For other
334       contributors see ChangeLog.
335
336       This program is free software; you can redistribute it and/or modify it
337       under the same terms as Perl itself.  See http://dev.perl.org/licenses/
338
339
340
341perl v5.36.0                      2022-07-22    Mail::Message::Body::String(3)