1=encoding utf8 2 3=head1 NAME 4 5Mail::Message::Body::Lines - body of a Mail::Message stored as array of lines 6 7=head1 INHERITANCE 8 9 Mail::Message::Body::Lines 10 is a Mail::Message::Body 11 is a Mail::Reporter 12 13=head1 SYNOPSIS 14 15 See Mail::Message::Body 16 17=head1 DESCRIPTION 18 19The body (content) of a message can be stored in various ways. In this 20documentation you find the description of extra functionality you have 21when a message is stored in an array of lines. 22 23Storing a whole message as an array of lines is useful when the data is not 24encoded, and you want to process it on a line-by-line basis (a common practice 25for inspecting message bodies). 26 27Extends L<"DESCRIPTION" in Mail::Message::Body|Mail::Message::Body/"DESCRIPTION">. 28 29=head1 OVERLOADED 30 31Extends L<"OVERLOADED" in Mail::Message::Body|Mail::Message::Body/"OVERLOADED">. 32 33=over 4 34 35=item overload: B<""> 36 37Inherited, see L<Mail::Message::Body/"OVERLOADED"> 38 39=item overload: B<'==' and '!='> 40 41Inherited, see L<Mail::Message::Body/"OVERLOADED"> 42 43=item overload: B<@{}> 44 45Inherited, see L<Mail::Message::Body/"OVERLOADED"> 46 47=item overload: B<bool> 48 49Inherited, see L<Mail::Message::Body/"OVERLOADED"> 50 51=back 52 53=head1 METHODS 54 55Extends L<"METHODS" in Mail::Message::Body|Mail::Message::Body/"METHODS">. 56 57=head2 Constructors 58 59Extends L<"Constructors" in Mail::Message::Body|Mail::Message::Body/"Constructors">. 60 61=over 4 62 63=item $obj-E<gt>B<clone>() 64 65Inherited, see L<Mail::Message::Body/"Constructors"> 66 67=item Mail::Message::Body::Lines-E<gt>B<new>(%options) 68 69 -Option --Defined in --Default 70 based_on Mail::Message::Body undef 71 charset Mail::Message::Body 'PERL' or <undef> 72 checked Mail::Message::Body <false> 73 content_id Mail::Message::Body undef 74 data Mail::Message::Body undef 75 description Mail::Message::Body undef 76 disposition Mail::Message::Body undef 77 eol Mail::Message::Body 'NATIVE' 78 file Mail::Message::Body undef 79 filename Mail::Message::Body undef 80 log Mail::Reporter 'WARNINGS' 81 message Mail::Message::Body undef 82 mime_type Mail::Message::Body 'text/plain' 83 modified Mail::Message::Body <false> 84 trace Mail::Reporter 'WARNINGS' 85 transfer_encoding Mail::Message::Body 'none' 86 87=over 2 88 89=item based_on => BODY 90 91=item charset => CHARSET|'PERL' 92 93=item checked => BOOLEAN 94 95=item content_id => STRING 96 97=item data => ARRAY-OF-LINES | STRING 98 99=item description => STRING|FIELD 100 101=item disposition => STRING|FIELD 102 103=item eol => 'CR'|'LF'|'CRLF'|'NATIVE' 104 105=item file => FILENAME|FILEHANDLE|IOHANDLE 106 107=item filename => FILENAME 108 109=item log => LEVEL 110 111=item message => MESSAGE 112 113=item mime_type => STRING|FIELD|MIME 114 115=item modified => BOOLEAN 116 117=item trace => LEVEL 118 119=item transfer_encoding => STRING|FIELD 120 121=back 122 123=back 124 125=head2 Constructing a body 126 127Extends L<"Constructing a body" in Mail::Message::Body|Mail::Message::Body/"Constructing a body">. 128 129=over 4 130 131=item $obj-E<gt>B<attach>($messages, %options) 132 133Inherited, see L<Mail::Message::Body::Construct/"Constructing a body"> 134 135=item $obj-E<gt>B<check>() 136 137Inherited, see L<Mail::Message::Body::Encode/"Constructing a body"> 138 139=item $obj-E<gt>B<concatenate>($components) 140 141Inherited, see L<Mail::Message::Body::Construct/"Constructing a body"> 142 143=item $obj-E<gt>B<decoded>(%options) 144 145Inherited, see L<Mail::Message::Body/"Constructing a body"> 146 147=item $obj-E<gt>B<encode>(%options) 148 149Inherited, see L<Mail::Message::Body::Encode/"Constructing a body"> 150 151=item $obj-E<gt>B<encoded>() 152 153Inherited, see L<Mail::Message::Body::Encode/"Constructing a body"> 154 155=item $obj-E<gt>B<eol>( ['CR'|'LF'|'CRLF'|'NATIVE'] ) 156 157Inherited, see L<Mail::Message::Body/"Constructing a body"> 158 159=item $obj-E<gt>B<foreachLine>(CODE) 160 161Inherited, see L<Mail::Message::Body::Construct/"Constructing a body"> 162 163=item $obj-E<gt>B<stripSignature>(%options) 164 165Inherited, see L<Mail::Message::Body::Construct/"Constructing a body"> 166 167=item $obj-E<gt>B<unify>($body) 168 169Inherited, see L<Mail::Message::Body::Encode/"Constructing a body"> 170 171=back 172 173=head2 The body 174 175Extends L<"The body" in Mail::Message::Body|Mail::Message::Body/"The body">. 176 177=over 4 178 179=item $obj-E<gt>B<isDelayed>() 180 181Inherited, see L<Mail::Message::Body/"The body"> 182 183=item $obj-E<gt>B<isMultipart>() 184 185Inherited, see L<Mail::Message::Body/"The body"> 186 187=item $obj-E<gt>B<isNested>() 188 189Inherited, see L<Mail::Message::Body/"The body"> 190 191=item $obj-E<gt>B<message>( [$message] ) 192 193Inherited, see L<Mail::Message::Body/"The body"> 194 195=item $obj-E<gt>B<partNumberOf>($part) 196 197Inherited, see L<Mail::Message::Body/"The body"> 198 199=back 200 201=head2 About the payload 202 203Extends L<"About the payload" in Mail::Message::Body|Mail::Message::Body/"About the payload">. 204 205=over 4 206 207=item $obj-E<gt>B<charset>() 208 209Inherited, see L<Mail::Message::Body/"About the payload"> 210 211=item $obj-E<gt>B<checked>( [BOOLEAN] ) 212 213Inherited, see L<Mail::Message::Body/"About the payload"> 214 215=item $obj-E<gt>B<contentId>( [STRING|$field] ) 216 217Inherited, see L<Mail::Message::Body/"About the payload"> 218 219=item $obj-E<gt>B<description>( [STRING|$field] ) 220 221Inherited, see L<Mail::Message::Body/"About the payload"> 222 223=item $obj-E<gt>B<disposition>( [STRING|$field] ) 224 225Inherited, see L<Mail::Message::Body/"About the payload"> 226 227=item $obj-E<gt>B<dispositionFilename>( [$directory] ) 228 229Inherited, see L<Mail::Message::Body::Encode/"About the payload"> 230 231=item $obj-E<gt>B<isBinary>() 232 233Inherited, see L<Mail::Message::Body::Encode/"About the payload"> 234 235=item $obj-E<gt>B<isText>() 236 237Inherited, see L<Mail::Message::Body::Encode/"About the payload"> 238 239=item $obj-E<gt>B<mimeType>() 240 241Inherited, see L<Mail::Message::Body/"About the payload"> 242 243=item $obj-E<gt>B<nrLines>() 244 245Inherited, see L<Mail::Message::Body/"About the payload"> 246 247=item $obj-E<gt>B<size>() 248 249Inherited, see L<Mail::Message::Body/"About the payload"> 250 251=item $obj-E<gt>B<transferEncoding>( [STRING|$field] ) 252 253Inherited, see L<Mail::Message::Body/"About the payload"> 254 255=item $obj-E<gt>B<type>( [STRING|$field] ) 256 257Inherited, see L<Mail::Message::Body/"About the payload"> 258 259=back 260 261=head2 Access to the payload 262 263Extends L<"Access to the payload" in Mail::Message::Body|Mail::Message::Body/"Access to the payload">. 264 265=over 4 266 267=item $obj-E<gt>B<endsOnNewline>() 268 269Inherited, see L<Mail::Message::Body/"Access to the payload"> 270 271=item $obj-E<gt>B<file>() 272 273Inherited, see L<Mail::Message::Body/"Access to the payload"> 274 275=item $obj-E<gt>B<lines>() 276 277Inherited, see L<Mail::Message::Body/"Access to the payload"> 278 279=item $obj-E<gt>B<print>( [$fh] ) 280 281Inherited, see L<Mail::Message::Body/"Access to the payload"> 282 283=item $obj-E<gt>B<printEscapedFrom>($fh) 284 285Inherited, see L<Mail::Message::Body/"Access to the payload"> 286 287=item $obj-E<gt>B<string>() 288 289Inherited, see L<Mail::Message::Body/"Access to the payload"> 290 291=item $obj-E<gt>B<stripTrailingNewline>() 292 293Inherited, see L<Mail::Message::Body/"Access to the payload"> 294 295=item $obj-E<gt>B<write>(%options) 296 297Inherited, see L<Mail::Message::Body/"Access to the payload"> 298 299=back 300 301=head2 Internals 302 303Extends L<"Internals" in Mail::Message::Body|Mail::Message::Body/"Internals">. 304 305=over 4 306 307=item $obj-E<gt>B<addTransferEncHandler>( $name, <$class|$object> ) 308 309=item Mail::Message::Body::Lines-E<gt>B<addTransferEncHandler>( $name, <$class|$object> ) 310 311Inherited, see L<Mail::Message::Body::Encode/"Internals"> 312 313=item $obj-E<gt>B<contentInfoFrom>($head) 314 315Inherited, see L<Mail::Message::Body/"Internals"> 316 317=item $obj-E<gt>B<contentInfoTo>($head) 318 319Inherited, see L<Mail::Message::Body/"Internals"> 320 321=item $obj-E<gt>B<fileLocation>( [$begin, $end] ) 322 323Inherited, see L<Mail::Message::Body/"Internals"> 324 325=item $obj-E<gt>B<getTransferEncHandler>($type) 326 327Inherited, see L<Mail::Message::Body::Encode/"Internals"> 328 329=item $obj-E<gt>B<isModified>() 330 331Inherited, see L<Mail::Message::Body/"Internals"> 332 333=item $obj-E<gt>B<load>() 334 335Inherited, see L<Mail::Message::Body/"Internals"> 336 337=item $obj-E<gt>B<modified>( [BOOLEAN] ) 338 339Inherited, see L<Mail::Message::Body/"Internals"> 340 341=item $obj-E<gt>B<moveLocation>( [$distance] ) 342 343Inherited, see L<Mail::Message::Body/"Internals"> 344 345=item $obj-E<gt>B<read>( $parser, $head, $bodytype, [$chars, [$lines]] ) 346 347Inherited, see L<Mail::Message::Body/"Internals"> 348 349=back 350 351=head2 Error handling 352 353Extends L<"Error handling" in Mail::Message::Body|Mail::Message::Body/"Error handling">. 354 355=over 4 356 357=item $obj-E<gt>B<AUTOLOAD>() 358 359Inherited, see L<Mail::Message::Body/"Error handling"> 360 361=item $obj-E<gt>B<addReport>($object) 362 363Inherited, see L<Mail::Reporter/"Error handling"> 364 365=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] ) 366 367=item Mail::Message::Body::Lines-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] ) 368 369Inherited, see L<Mail::Reporter/"Error handling"> 370 371=item $obj-E<gt>B<errors>() 372 373Inherited, see L<Mail::Reporter/"Error handling"> 374 375=item $obj-E<gt>B<log>( [$level, [$strings]] ) 376 377=item Mail::Message::Body::Lines-E<gt>B<log>( [$level, [$strings]] ) 378 379Inherited, see L<Mail::Reporter/"Error handling"> 380 381=item $obj-E<gt>B<logPriority>($level) 382 383=item Mail::Message::Body::Lines-E<gt>B<logPriority>($level) 384 385Inherited, see L<Mail::Reporter/"Error handling"> 386 387=item $obj-E<gt>B<logSettings>() 388 389Inherited, see L<Mail::Reporter/"Error handling"> 390 391=item $obj-E<gt>B<notImplemented>() 392 393Inherited, see L<Mail::Reporter/"Error handling"> 394 395=item $obj-E<gt>B<report>( [$level] ) 396 397Inherited, see L<Mail::Reporter/"Error handling"> 398 399=item $obj-E<gt>B<reportAll>( [$level] ) 400 401Inherited, see L<Mail::Reporter/"Error handling"> 402 403=item $obj-E<gt>B<trace>( [$level] ) 404 405Inherited, see L<Mail::Reporter/"Error handling"> 406 407=item $obj-E<gt>B<warnings>() 408 409Inherited, see L<Mail::Reporter/"Error handling"> 410 411=back 412 413=head2 Cleanup 414 415Extends L<"Cleanup" in Mail::Message::Body|Mail::Message::Body/"Cleanup">. 416 417=over 4 418 419=item $obj-E<gt>B<DESTROY>() 420 421Inherited, see L<Mail::Reporter/"Cleanup"> 422 423=back 424 425=head1 DETAILS 426 427Extends L<"DETAILS" in Mail::Message::Body|Mail::Message::Body/"DETAILS">. 428 429=head1 DIAGNOSTICS 430 431=over 4 432 433=item Warning: Charset $name is not known 434 435The encoding or decoding of a message body encounters a character set which 436is not understood by Perl's Encode module. 437 438=item Warning: No decoder defined for transfer encoding $name. 439 440The data (message body) is encoded in a way which is not currently understood, 441therefore no decoding (or recoding) can take place. 442 443=item Warning: No encoder defined for transfer encoding $name. 444 445The data (message body) has been decoded, but the required encoding is 446unknown. The decoded data is returned. 447 448=item Error: Package $package does not implement $method. 449 450Fatal error: the specific package (or one of its superclasses) does not 451implement this method where it should. This message means that some other 452related classes do implement this method however the class at hand does 453not. Probably you should investigate this and probably inform the author 454of the package. 455 456=item Error: Unable to read file $filename for message body lines: $! 457 458A L<Mail::Message::Body::Lines|Mail::Message::Body::Lines> object is to be created from a named file, 459but it is impossible to read that file to retrieve the lines within. 460 461=item Warning: Unknown line terminator $eol ignored 462 463=back 464 465=head1 SEE ALSO 466 467This module is part of Mail-Message distribution version 3.011, 468built on July 27, 2021. Website: F<http://perl.overmeer.net/CPAN/> 469 470=head1 LICENSE 471 472Copyrights 2001-2021 by [Mark Overmeer <markov@cpan.org>]. For other contributors see ChangeLog. 473 474This program is free software; you can redistribute it and/or modify it 475under the same terms as Perl itself. 476See F<http://dev.perl.org/licenses/> 477 478