{
    "content": [
        {
            "type": "text",
            "text": "# Mail::Message::Convert::HtmlFormatText (perldoc)\n\n## NAME\n\nMail::Message::Convert::HtmlFormatText - Convert HTML into Text\n\n## SYNOPSIS\n\nuse Mail::Message::Convert::HtmlFormatText;\nmy $af = Mail::Message::Convert::HtmlFormatText->new;\nmy $plainbody = $af->format($body);\n\n## DESCRIPTION\n\nConvert HTML/XHTML message body objects into plain text bodies using HTML::FormatText. This\npackage requires HTML::TreeBuilder and HTML::FormatText which are not installed by default\ntogether with Mail::Box. See also Mail::Message::rebuild() with rule\n\"textalternativeforhtml\".\n\n## Sections\n\n- **NAME**\n- **INHERITANCE**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **METHODS** (4 subsections)\n- **DIAGNOSTICS**\n- **SEE ALSO**\n- **LICENSE**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n"
        }
    ],
    "structuredContent": {
        "command": "Mail::Message::Convert::HtmlFormatText",
        "section": "",
        "mode": "perldoc",
        "summary": "Mail::Message::Convert::HtmlFormatText - Convert HTML into Text",
        "synopsis": "use Mail::Message::Convert::HtmlFormatText;\nmy $af = Mail::Message::Convert::HtmlFormatText->new;\nmy $plainbody = $af->format($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": 5,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 9,
                "subsections": []
            },
            {
                "name": "METHODS",
                "lines": 2,
                "subsections": [
                    {
                        "name": "Constructors",
                        "lines": 20
                    },
                    {
                        "name": "Converting",
                        "lines": 9
                    },
                    {
                        "name": "Error handling",
                        "lines": 42
                    },
                    {
                        "name": "Cleanup",
                        "lines": 5
                    }
                ]
            },
            {
                "name": "DIAGNOSTICS",
                "lines": 6,
                "subsections": []
            },
            {
                "name": "SEE ALSO",
                "lines": 3,
                "subsections": []
            },
            {
                "name": "LICENSE",
                "lines": 5,
                "subsections": []
            }
        ],
        "sections": {
            "NAME": {
                "content": "Mail::Message::Convert::HtmlFormatText - Convert HTML into Text\n",
                "subsections": []
            },
            "INHERITANCE": {
                "content": "Mail::Message::Convert::HtmlFormatText\nis a Mail::Message::Convert\nis a Mail::Reporter\n",
                "subsections": []
            },
            "SYNOPSIS": {
                "content": "use Mail::Message::Convert::HtmlFormatText;\nmy $af = Mail::Message::Convert::HtmlFormatText->new;\n\nmy $plainbody = $af->format($body);\n",
                "subsections": []
            },
            "DESCRIPTION": {
                "content": "Convert HTML/XHTML message body objects into plain text bodies using HTML::FormatText. This\npackage requires HTML::TreeBuilder and HTML::FormatText which are not installed by default\ntogether with Mail::Box. See also Mail::Message::rebuild() with rule\n\"textalternativeforhtml\".\n\nThis module is a small wrapper around HTML::FormatText.\n\nExtends \"DESCRIPTION\" in Mail::Message::Convert.\n",
                "subsections": []
            },
            "METHODS": {
                "content": "Extends \"METHODS\" in Mail::Message::Convert.\n",
                "subsections": [
                    {
                        "name": "Constructors",
                        "content": "Extends \"Constructors\" in Mail::Message::Convert.\n\nMail::Message::Convert::HtmlFormatText->new(%options)\n-Option     --Defined in            --Default\nfields       Mail::Message::Convert  <see description>\nleftmargin                           3\nlog          Mail::Reporter          'WARNINGS'\nrightmargin                          72\ntrace        Mail::Reporter          'WARNINGS'\n\nfields => NAMES|ARRAY-OF-NAMES|REGEXS\nleftmargin => INTEGER\nThe column of the left margin, passed to the formatter.\n\nlog => LEVEL\nrightmargin => INTEGER\nThe column of the right margin, passed to the formatter.\n\ntrace => LEVEL\n"
                    },
                    {
                        "name": "Converting",
                        "content": "Extends \"Converting\" in Mail::Message::Convert.\n\n$obj->format($body)\nPass an html/xhtml encoded body, and a plain text body is returned. Characters are\ntranslated into Latin1.\n\n$obj->selectedFields($head)\nInherited, see \"Converting\" in Mail::Message::Convert\n"
                    },
                    {
                        "name": "Error handling",
                        "content": "Extends \"Error handling\" in Mail::Message::Convert.\n\n$obj->AUTOLOAD()\nInherited, see \"Error handling\" in Mail::Reporter\n\n$obj->addReport($object)\nInherited, see \"Error handling\" in Mail::Reporter\n\n$obj->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )\nMail::Message::Convert::HtmlFormatText->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level,\n$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::Convert::HtmlFormatText->log( [$level, [$strings]] )\nInherited, see \"Error handling\" in Mail::Reporter\n\n$obj->logPriority($level)\nMail::Message::Convert::HtmlFormatText->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::Convert.\n\n$obj->DESTROY()\nInherited, see \"Cleanup\" in Mail::Reporter\n"
                    }
                ]
            },
            "DIAGNOSTICS": {
                "content": "Error: 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",
                "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": []
            }
        }
    }
}