{
    "content": [
        {
            "type": "text",
            "text": "# Mail::Message::Body::File (perldoc)\n\n## NAME\n\nMail::Message::Body::File - body of a message temporarily stored in a file\n\n## SYNOPSIS\n\nSee Mail::Message::Body\n\n## DESCRIPTION\n\nThe body (content) of a message can be stored in various ways. In this documentation you find\nthe description of extra functionality you have when a message is stored in a file.\n\n## Sections\n\n- **NAME**\n- **INHERITANCE**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **OVERLOADED**\n- **METHODS** (8 subsections)\n- **DETAILS**\n- **DIAGNOSTICS**\n- **SEE ALSO**\n- **LICENSE**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n"
        }
    ],
    "structuredContent": {
        "command": "Mail::Message::Body::File",
        "section": "",
        "mode": "perldoc",
        "summary": "Mail::Message::Body::File - body of a message temporarily stored in a file",
        "synopsis": "See Mail::Message::Body",
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [],
        "examples": [],
        "see_also": [],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "INHERITANCE",
                "lines": 4,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 8,
                "subsections": []
            },
            {
                "name": "OVERLOADED",
                "lines": 14,
                "subsections": []
            },
            {
                "name": "METHODS",
                "lines": 2,
                "subsections": [
                    {
                        "name": "Constructors",
                        "lines": 41
                    },
                    {
                        "name": "Constructing a body",
                        "lines": 32
                    },
                    {
                        "name": "The body",
                        "lines": 17
                    },
                    {
                        "name": "About the payload",
                        "lines": 41
                    },
                    {
                        "name": "Access to the payload",
                        "lines": 26
                    },
                    {
                        "name": "Internals",
                        "lines": 36
                    },
                    {
                        "name": "Error handling",
                        "lines": 41
                    },
                    {
                        "name": "Cleanup",
                        "lines": 5
                    }
                ]
            },
            {
                "name": "DETAILS",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "DIAGNOSTICS",
                "lines": 29,
                "subsections": []
            },
            {
                "name": "SEE ALSO",
                "lines": 3,
                "subsections": []
            },
            {
                "name": "LICENSE",
                "lines": 5,
                "subsections": []
            }
        ],
        "sections": {
            "NAME": {
                "content": "Mail::Message::Body::File - body of a message temporarily stored in a file\n",
                "subsections": []
            },
            "INHERITANCE": {
                "content": "Mail::Message::Body::File\nis a Mail::Message::Body\nis a Mail::Reporter\n",
                "subsections": []
            },
            "SYNOPSIS": {
                "content": "See Mail::Message::Body\n",
                "subsections": []
            },
            "DESCRIPTION": {
                "content": "The body (content) of a message can be stored in various ways. In this documentation you find\nthe description of extra functionality you have when a message is stored in a file.\n\nStoring a whole message is a file is useful when the body is large. Although access through a\nfile is slower, it is saving a lot of memory.\n\nExtends \"DESCRIPTION\" in Mail::Message::Body.\n",
                "subsections": []
            },
            "OVERLOADED": {
                "content": "Extends \"OVERLOADED\" in Mail::Message::Body.\n\noverload: \"\"\nInherited, see \"OVERLOADED\" in Mail::Message::Body\n\noverload: '==' and '!='\nInherited, see \"OVERLOADED\" in Mail::Message::Body\n\noverload: @{}\nInherited, see \"OVERLOADED\" in Mail::Message::Body\n\noverload: bool\nInherited, see \"OVERLOADED\" in Mail::Message::Body\n",
                "subsections": []
            },
            "METHODS": {
                "content": "Extends \"METHODS\" in Mail::Message::Body.\n",
                "subsections": [
                    {
                        "name": "Constructors",
                        "content": "Extends \"Constructors\" in Mail::Message::Body.\n\n$obj->clone()\nInherited, see \"Constructors\" in Mail::Message::Body\n\nMail::Message::Body::File->new(%options)\n-Option           --Defined in         --Default\nbasedon           Mail::Message::Body  undef\ncharset            Mail::Message::Body  'PERL' or <undef>\nchecked            Mail::Message::Body  <false>\ncontentid         Mail::Message::Body  undef\ndata               Mail::Message::Body  undef\ndescription        Mail::Message::Body  undef\ndisposition        Mail::Message::Body  undef\neol                Mail::Message::Body  'NATIVE'\nfile               Mail::Message::Body  undef\nfilename           Mail::Message::Body  undef\nlog                Mail::Reporter       'WARNINGS'\nmessage            Mail::Message::Body  undef\nmimetype          Mail::Message::Body  'text/plain'\nmodified           Mail::Message::Body  <false>\ntrace              Mail::Reporter       'WARNINGS'\ntransferencoding  Mail::Message::Body  'none'\n\nbasedon => BODY\ncharset => CHARSET|'PERL'\nchecked => BOOLEAN\ncontentid => STRING\ndata => ARRAY-OF-LINES | STRING\ndescription => STRING|FIELD\ndisposition => STRING|FIELD\neol => 'CR'|'LF'|'CRLF'|'NATIVE'\nfile => FILENAME|FILEHANDLE|IOHANDLE\nfilename => FILENAME\nlog => LEVEL\nmessage => MESSAGE\nmimetype => STRING|FIELD|MIME\nmodified => BOOLEAN\ntrace => LEVEL\ntransferencoding => STRING|FIELD\n"
                    },
                    {
                        "name": "Constructing a body",
                        "content": "Extends \"Constructing a body\" in Mail::Message::Body.\n\n$obj->attach($messages, %options)\nInherited, see \"Constructing a body\" in Mail::Message::Body::Construct\n\n$obj->check()\nInherited, see \"Constructing a body\" in Mail::Message::Body::Encode\n\n$obj->concatenate($components)\nInherited, see \"Constructing a body\" in Mail::Message::Body::Construct\n\n$obj->decoded(%options)\nInherited, see \"Constructing a body\" in Mail::Message::Body\n\n$obj->encode(%options)\nInherited, see \"Constructing a body\" in Mail::Message::Body::Encode\n\n$obj->encoded()\nInherited, see \"Constructing a body\" in Mail::Message::Body::Encode\n\n$obj->eol( ['CR'|'LF'|'CRLF'|'NATIVE'] )\nInherited, see \"Constructing a body\" in Mail::Message::Body\n\n$obj->foreachLine(CODE)\nInherited, see \"Constructing a body\" in Mail::Message::Body::Construct\n\n$obj->stripSignature(%options)\nInherited, see \"Constructing a body\" in Mail::Message::Body::Construct\n\n$obj->unify($body)\nInherited, see \"Constructing a body\" in Mail::Message::Body::Encode\n"
                    },
                    {
                        "name": "The body",
                        "content": "Extends \"The body\" in Mail::Message::Body.\n\n$obj->isDelayed()\nInherited, see \"The body\" in Mail::Message::Body\n\n$obj->isMultipart()\nInherited, see \"The body\" in Mail::Message::Body\n\n$obj->isNested()\nInherited, see \"The body\" in Mail::Message::Body\n\n$obj->message( [$message] )\nInherited, see \"The body\" in Mail::Message::Body\n\n$obj->partNumberOf($part)\nInherited, see \"The body\" in Mail::Message::Body\n"
                    },
                    {
                        "name": "About the payload",
                        "content": "Extends \"About the payload\" in Mail::Message::Body.\n\n$obj->charset()\nInherited, see \"About the payload\" in Mail::Message::Body\n\n$obj->checked( [BOOLEAN] )\nInherited, see \"About the payload\" in Mail::Message::Body\n\n$obj->contentId( [STRING|$field] )\nInherited, see \"About the payload\" in Mail::Message::Body\n\n$obj->description( [STRING|$field] )\nInherited, see \"About the payload\" in Mail::Message::Body\n\n$obj->disposition( [STRING|$field] )\nInherited, see \"About the payload\" in Mail::Message::Body\n\n$obj->dispositionFilename( [$directory] )\nInherited, see \"About the payload\" in Mail::Message::Body::Encode\n\n$obj->isBinary()\nInherited, see \"About the payload\" in Mail::Message::Body::Encode\n\n$obj->isText()\nInherited, see \"About the payload\" in Mail::Message::Body::Encode\n\n$obj->mimeType()\nInherited, see \"About the payload\" in Mail::Message::Body\n\n$obj->nrLines()\nInherited, see \"About the payload\" in Mail::Message::Body\n\n$obj->size()\nInherited, see \"About the payload\" in Mail::Message::Body\n\n$obj->transferEncoding( [STRING|$field] )\nInherited, see \"About the payload\" in Mail::Message::Body\n\n$obj->type( [STRING|$field] )\nInherited, see \"About the payload\" in Mail::Message::Body\n"
                    },
                    {
                        "name": "Access to the payload",
                        "content": "Extends \"Access to the payload\" in Mail::Message::Body.\n\n$obj->endsOnNewline()\nInherited, see \"Access to the payload\" in Mail::Message::Body\n\n$obj->file()\nInherited, see \"Access to the payload\" in Mail::Message::Body\n\n$obj->lines()\nInherited, see \"Access to the payload\" in Mail::Message::Body\n\n$obj->print( [$fh] )\nInherited, see \"Access to the payload\" in Mail::Message::Body\n\n$obj->printEscapedFrom($fh)\nInherited, see \"Access to the payload\" in Mail::Message::Body\n\n$obj->string()\nInherited, see \"Access to the payload\" in Mail::Message::Body\n\n$obj->stripTrailingNewline()\nInherited, see \"Access to the payload\" in Mail::Message::Body\n\n$obj->write(%options)\nInherited, see \"Access to the payload\" in Mail::Message::Body\n"
                    },
                    {
                        "name": "Internals",
                        "content": "Extends \"Internals\" in Mail::Message::Body.\n\n$obj->addTransferEncHandler( $name, <$class|$object> )\nMail::Message::Body::File->addTransferEncHandler( $name, <$class|$object> )\nInherited, see \"Internals\" in Mail::Message::Body::Encode\n\n$obj->contentInfoFrom($head)\nInherited, see \"Internals\" in Mail::Message::Body\n\n$obj->contentInfoTo($head)\nInherited, see \"Internals\" in Mail::Message::Body\n\n$obj->fileLocation( [$begin, $end] )\nInherited, see \"Internals\" in Mail::Message::Body\n\n$obj->getTransferEncHandler($type)\nInherited, see \"Internals\" in Mail::Message::Body::Encode\n\n$obj->isModified()\nInherited, see \"Internals\" in Mail::Message::Body\n\n$obj->load()\nInherited, see \"Internals\" in Mail::Message::Body\n\n$obj->modified( [BOOLEAN] )\nInherited, see \"Internals\" in Mail::Message::Body\n\n$obj->moveLocation( [$distance] )\nInherited, see \"Internals\" in Mail::Message::Body\n\n$obj->read( $parser, $head, $bodytype, [$chars, [$lines]] )\nInherited, see \"Internals\" in Mail::Message::Body\n\n$obj->tempFilename( [$filename] )\nReturns the name of the temporary file which is used to store this body.\n"
                    },
                    {
                        "name": "Error handling",
                        "content": "Extends \"Error handling\" in Mail::Message::Body.\n\n$obj->AUTOLOAD()\nInherited, see \"Error handling\" in Mail::Message::Body\n\n$obj->addReport($object)\nInherited, see \"Error handling\" in Mail::Reporter\n\n$obj->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )\nMail::Message::Body::File->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )\nInherited, see \"Error handling\" in Mail::Reporter\n\n$obj->errors()\nInherited, see \"Error handling\" in Mail::Reporter\n\n$obj->log( [$level, [$strings]] )\nMail::Message::Body::File->log( [$level, [$strings]] )\nInherited, see \"Error handling\" in Mail::Reporter\n\n$obj->logPriority($level)\nMail::Message::Body::File->logPriority($level)\nInherited, see \"Error handling\" in Mail::Reporter\n\n$obj->logSettings()\nInherited, see \"Error handling\" in Mail::Reporter\n\n$obj->notImplemented()\nInherited, see \"Error handling\" in Mail::Reporter\n\n$obj->report( [$level] )\nInherited, see \"Error handling\" in Mail::Reporter\n\n$obj->reportAll( [$level] )\nInherited, see \"Error handling\" in Mail::Reporter\n\n$obj->trace( [$level] )\nInherited, see \"Error handling\" in Mail::Reporter\n\n$obj->warnings()\nInherited, see \"Error handling\" in Mail::Reporter\n"
                    },
                    {
                        "name": "Cleanup",
                        "content": "Extends \"Cleanup\" in Mail::Message::Body.\n\n$obj->DESTROY()\nThe temporary file is automatically removed when the body is not required anymore.\n"
                    }
                ]
            },
            "DETAILS": {
                "content": "Extends \"DETAILS\" in Mail::Message::Body.\n",
                "subsections": []
            },
            "DIAGNOSTICS": {
                "content": "Error: Cannot write to temporary body file $filename: $!\nThe message body is to be stored in a temporary file (probably because it is a large body),\nbut for the indicated reason, this file cannot be created.\n\nWarning: Charset $name is not known\nThe encoding or decoding of a message body encounters a character set which is not\nunderstood by Perl's Encode module.\n\nWarning: No decoder defined for transfer encoding $name.\nThe data (message body) is encoded in a way which is not currently understood, therefore no\ndecoding (or recoding) can take place.\n\nWarning: No encoder defined for transfer encoding $name.\nThe data (message body) has been decoded, but the required encoding is unknown. The decoded\ndata is returned.\n\nError: Package $package does not implement $method.\nFatal error: the specific package (or one of its superclasses) does not implement this\nmethod where it should. This message means that some other related classes do implement this\nmethod however the class at hand does not. Probably you should investigate this and probably\ninform the author of the package.\n\nError: Unable to read file $filename for message body file: $!\nA Mail::Message::Body::File object is to be created from a named file, but it is impossible\nto read that file to retrieve the lines within. Therefore, no copy to a temporary file can\nbe made.\n\nWarning: Unknown line terminator $eol ignored\n",
                "subsections": []
            },
            "SEE ALSO": {
                "content": "This module is part of Mail-Message distribution version 3.012, built on February 11, 2022.\nWebsite: http://perl.overmeer.net/CPAN/\n",
                "subsections": []
            },
            "LICENSE": {
                "content": "Copyrights 2001-2022 by [Mark Overmeer <markov@cpan.org>]. For other contributors see ChangeLog.\n\nThis program is free software; you can redistribute it and/or modify it under the same terms as\nPerl itself. See http://dev.perl.org/licenses/\n",
                "subsections": []
            }
        }
    }
}