Mail::Message::Body::File - body of a message temporarily stored in a file

Description

       The body (content) of a message can be stored in various ways.  In this documentation you find the
       description of extra functionality you have when a message is stored in a file.

       Storing a whole message is a file is useful when the body is large.  Although access through a file is
       slower, it is saving a lot of memory.

       Extends "DESCRIPTION" in Mail::Message::Body.

Details

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

Diagnostics

       Error: Cannot write to temporary body file $filename: $!
           The  message  body is to be stored in a temporary file (probably because it is a large body), but for
           the indicated reason, this file cannot be created.

       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 file: $!
           A Mail::Message::Body::File object is to be created from a named file, but it is impossible  to  read
           that file to retrieve the lines within.  Therefore, no copy to a temporary file can be made.

       Warning: Unknown line terminator $eol ignored

Inheritance

        Mail::Message::Body::File
          is a Mail::Message::Body
          is a Mail::Reporter

License

       Copyrights 2001-2025 by [Mark Overmeer <markov@cpan.org>]. 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://dev.perl.org/licenses/

perl v5.40.1                                       2025-04-25                     Mail::Message::Body::File(3pm)

Methods

       Extends "METHODS" in Mail::Message::Body.

   Constructors
       Extends "Constructors" in Mail::Message::Body.

       $obj->clone()
           Inherited, see "Constructors" in Mail::Message::Body

       Mail::Message::Body::File->new(%options)
            -Option           --Defined in         --Default
             based_on           Mail::Message::Body  undef
             charset            Mail::Message::Body  'PERL'
             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
             filename           Mail::Message::Body  undef
             language           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'|<undef>
           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
           filename => FILENAME
           language => STRING|ARRAY|LIST|FIELD
           log => LEVEL
           message => MESSAGE
           mime_type => STRING|FIELD|MIME
           modified => BOOLEAN
           trace => LEVEL
           transfer_encoding => STRING|FIELD

   Constructingabody
       Extends "Constructing a body" in Mail::Message::Body.

       $obj->attach($messages, %options)
           Inherited, see "Constructing a body" in Mail::Message::Body::Construct

       $obj->charsetDetect(%options)
           Inherited, see "Constructing a body" in Mail::Message::Body::Encode

       Mail::Message::Body::File->charsetDetectAlgorithm( [CODE|undef|METHOD] )
           Inherited, see "Constructing a body" in Mail::Message::Body::Encode

       $obj->check()
           Inherited, see "Constructing a body" in Mail::Message::Body::Encode

       $obj->concatenate($components)
           Inherited, see "Constructing a body" in Mail::Message::Body::Construct

       $obj->decoded(%options)
           Inherited, see "Constructing a body" in Mail::Message::Body

       $obj->encode(%options)
           Inherited, see "Constructing a body" in Mail::Message::Body::Encode

       $obj->encoded(%options)
           Inherited, see "Constructing a body" in Mail::Message::Body::Encode

       $obj->eol( ['CR'|'LF'|'CRLF'|'NATIVE'] )
           Inherited, see "Constructing a body" in Mail::Message::Body

       $obj->foreachLine(CODE)
           Inherited, see "Constructing a body" in Mail::Message::Body::Construct

       $obj->stripSignature(%options)
           Inherited, see "Constructing a body" in Mail::Message::Body::Construct

       $obj->unify($body)
           Inherited, see "Constructing a body" in Mail::Message::Body::Encode

   Thebody
       Extends "The body" in Mail::Message::Body.

       $obj->isDelayed()
           Inherited, see "The body" in Mail::Message::Body

       $obj->isMultipart()
           Inherited, see "The body" in Mail::Message::Body

       $obj->isNested()
           Inherited, see "The body" in Mail::Message::Body

       $obj->message( [$message] )
           Inherited, see "The body" in Mail::Message::Body

       $obj->partNumberOf($part)
           Inherited, see "The body" in Mail::Message::Body

   Aboutthepayload
       Extends "About the payload" in Mail::Message::Body.

       $obj->charset()
           Inherited, see "About the payload" in Mail::Message::Body

       $obj->checked( [BOOLEAN] )
           Inherited, see "About the payload" in Mail::Message::Body

       $obj->contentId( [STRING|$field] )
           Inherited, see "About the payload" in Mail::Message::Body

       $obj->description( [STRING|$field] )
           Inherited, see "About the payload" in Mail::Message::Body

       $obj->disposition( [STRING|$field] )
           Inherited, see "About the payload" in Mail::Message::Body

       $obj->dispositionFilename( [$directory] )
           Inherited, see "About the payload" in Mail::Message::Body::Encode

       $obj->isBinary()
           Inherited, see "About the payload" in Mail::Message::Body::Encode

       $obj->isText()
           Inherited, see "About the payload" in Mail::Message::Body::Encode

       $obj->language( [@langs|\@langs|$langs|$field] )
           Inherited, see "About the payload" in Mail::Message::Body

       $obj->mimeType()
           Inherited, see "About the payload" in Mail::Message::Body

       $obj->nrLines()
           Inherited, see "About the payload" in Mail::Message::Body

       $obj->size()
           Inherited, see "About the payload" in Mail::Message::Body

       $obj->transferEncoding( [STRING|$field] )
           Inherited, see "About the payload" in Mail::Message::Body

       $obj->type( [STRING|$field] )
           Inherited, see "About the payload" in Mail::Message::Body

   Accesstothepayload
       Extends "Access to the payload" in Mail::Message::Body.

       $obj->endsOnNewline()
           Inherited, see "Access to the payload" in Mail::Message::Body

       $obj->file()
           Inherited, see "Access to the payload" in Mail::Message::Body

       $obj->lines()
           Inherited, see "Access to the payload" in Mail::Message::Body

       $obj->print( [$fh] )
           Inherited, see "Access to the payload" in Mail::Message::Body

       $obj->printEscapedFrom($fh)
           Inherited, see "Access to the payload" in Mail::Message::Body

       $obj->string()
           Inherited, see "Access to the payload" in Mail::Message::Body

       $obj->stripTrailingNewline()
           Inherited, see "Access to the payload" in Mail::Message::Body

       $obj->write(%options)
           Inherited, see "Access to the payload" in Mail::Message::Body

   Internals
       Extends "Internals" in Mail::Message::Body.

       $obj->addTransferEncHandler( $name, <$class|$object> )
       Mail::Message::Body::File->addTransferEncHandler( $name, <$class|$object> )
           Inherited, see "Internals" in Mail::Message::Body::Encode

       $obj->contentInfoFrom($head)
           Inherited, see "Internals" in Mail::Message::Body

       $obj->contentInfoTo($head)
           Inherited, see "Internals" in Mail::Message::Body

       $obj->fileLocation( [$begin, $end] )
           Inherited, see "Internals" in Mail::Message::Body

       $obj->getTransferEncHandler($type)
           Inherited, see "Internals" in Mail::Message::Body::Encode

       $obj->isModified()
           Inherited, see "Internals" in Mail::Message::Body

       $obj->load()
           Inherited, see "Internals" in Mail::Message::Body

       $obj->modified( [BOOLEAN] )
           Inherited, see "Internals" in Mail::Message::Body

       $obj->moveLocation( [$distance] )
           Inherited, see "Internals" in Mail::Message::Body

       $obj->read( $parser, $head, $bodytype, [$chars, [$lines]] )
           Inherited, see "Internals" in Mail::Message::Body

       $obj->tempFilename( [$filename] )
           Returns the name of the temporary file which is used to store this body.

   Errorhandling
       Extends "Error handling" in Mail::Message::Body.

       $obj->AUTOLOAD()
           Inherited, see "Error handling" in Mail::Message::Body

       $obj->addReport($object)
           Inherited, see "Error handling" in Mail::Reporter

       $obj->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
       Mail::Message::Body::File->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
           Inherited, see "Error handling" in Mail::Reporter

       $obj->errors()
           Inherited, see "Error handling" in Mail::Reporter

       $obj->log( [$level, [$strings]] )
       Mail::Message::Body::File->log( [$level, [$strings]] )
           Inherited, see "Error handling" in Mail::Reporter

       $obj->logPriority($level)
       Mail::Message::Body::File->logPriority($level)
           Inherited, see "Error handling" in Mail::Reporter

       $obj->logSettings()
           Inherited, see "Error handling" in Mail::Reporter

       $obj->notImplemented()
           Inherited, see "Error handling" in Mail::Reporter

       $obj->report( [$level] )
           Inherited, see "Error handling" in Mail::Reporter

       $obj->reportAll( [$level] )
           Inherited, see "Error handling" in Mail::Reporter

       $obj->trace( [$level] )
           Inherited, see "Error handling" in Mail::Reporter

       $obj->warnings()
           Inherited, see "Error handling" in Mail::Reporter

   Cleanup
       Extends "Cleanup" in Mail::Message::Body.

       $obj->DESTROY()
           The temporary file is automatically removed when the body is not required anymore.

Name

       Mail::Message::Body::File - body of a message temporarily stored in a file

Overloaded

       Extends "OVERLOADED" in Mail::Message::Body.

       overload: ""
           Inherited, see "OVERLOADED" in Mail::Message::Body

       overload: '=='and'!='
           Inherited, see "OVERLOADED" in Mail::Message::Body

       overload: @{}
           Inherited, see "OVERLOADED" in Mail::Message::Body

       overload: bool
           Inherited, see "OVERLOADED" in Mail::Message::Body