# phpman > perldoc > Mail::Message::Convert::HtmlFormatText

## NAME
    [Mail::Message::Convert::HtmlFormatText](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AConvert%3A%3AHtmlFormatText/markdown) - Convert HTML into Text

## INHERITANCE
     [Mail::Message::Convert::HtmlFormatText](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AConvert%3A%3AHtmlFormatText/markdown)
       is a [Mail::Message::Convert](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AConvert/markdown)
       is a [Mail::Reporter](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AReporter/markdown)

## SYNOPSIS
     use [Mail::Message::Convert::HtmlFormatText](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AConvert%3A%3AHtmlFormatText/markdown);
     my $af = [Mail::Message::Convert::HtmlFormatText](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AConvert%3A%3AHtmlFormatText/markdown)->new;

     my $plain_body = $af->format($body);

## DESCRIPTION
    Convert HTML/XHTML message body objects into plain text bodies using [HTML::FormatText](https://www.chedong.com/phpMan.php/perldoc/HTML%3A%3AFormatText/markdown). This
    package requires [HTML::TreeBuilder](https://www.chedong.com/phpMan.php/perldoc/HTML%3A%3ATreeBuilder/markdown) and [HTML::FormatText](https://www.chedong.com/phpMan.php/perldoc/HTML%3A%3AFormatText/markdown) which are not installed by default
    together with [Mail::Box](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3ABox/markdown). See also [Mail::Message::rebuild](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3Arebuild/markdown)() with rule
    "text_alternative_for_html".

    This module is a small wrapper around [HTML::FormatText](https://www.chedong.com/phpMan.php/perldoc/HTML%3A%3AFormatText/markdown).

    Extends "DESCRIPTION" in [Mail::Message::Convert](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AConvert/markdown).

## METHODS
    Extends "METHODS" in [Mail::Message::Convert](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AConvert/markdown).

### Constructors
    Extends "Constructors" in [Mail::Message::Convert](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AConvert/markdown).

    [Mail::Message::Convert::HtmlFormatText](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AConvert%3A%3AHtmlFormatText/markdown)->new(%options)
         -Option     --Defined in            --Default
          fields       [Mail::Message::Convert](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AConvert/markdown)  <see description>
          leftmargin                           3
          log          [Mail::Reporter](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AReporter/markdown)          'WARNINGS'
          rightmargin                          72
          trace        [Mail::Reporter](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AReporter/markdown)          'WARNINGS'

        fields => NAMES|ARRAY-OF-NAMES|REGEXS
        leftmargin => INTEGER
          The column of the left margin, passed to the formatter.

        log => LEVEL
        rightmargin => INTEGER
          The column of the right margin, passed to the formatter.

        trace => LEVEL

### Converting
    Extends "Converting" in [Mail::Message::Convert](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AConvert/markdown).

    $obj->format($body)
        Pass an html/xhtml encoded body, and a plain text body is returned. Characters are
        translated into Latin1.

    $obj->selectedFields($head)
        Inherited, see "Converting" in [Mail::Message::Convert](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AConvert/markdown)

### Error handling
    Extends "Error handling" in [Mail::Message::Convert](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AConvert/markdown).

    $obj->AUTOLOAD()
        Inherited, see "Error handling" in [Mail::Reporter](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AReporter/markdown)

    $obj->addReport($object)
        Inherited, see "Error handling" in [Mail::Reporter](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AReporter/markdown)

    $obj->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
    [Mail::Message::Convert::HtmlFormatText](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AConvert%3A%3AHtmlFormatText/markdown)->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level,
    $callback] )
        Inherited, see "Error handling" in [Mail::Reporter](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AReporter/markdown)

    $obj->errors()
        Inherited, see "Error handling" in [Mail::Reporter](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AReporter/markdown)

    $obj->log( [$level, [$strings]] )
    [Mail::Message::Convert::HtmlFormatText](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AConvert%3A%3AHtmlFormatText/markdown)->log( [$level, [$strings]] )
        Inherited, see "Error handling" in [Mail::Reporter](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AReporter/markdown)

    $obj->logPriority($level)
    [Mail::Message::Convert::HtmlFormatText](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AConvert%3A%3AHtmlFormatText/markdown)->logPriority($level)
        Inherited, see "Error handling" in [Mail::Reporter](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AReporter/markdown)

    $obj->logSettings()
        Inherited, see "Error handling" in [Mail::Reporter](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AReporter/markdown)

    $obj->notImplemented()
        Inherited, see "Error handling" in [Mail::Reporter](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AReporter/markdown)

    $obj->report( [$level] )
        Inherited, see "Error handling" in [Mail::Reporter](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AReporter/markdown)

    $obj->reportAll( [$level] )
        Inherited, see "Error handling" in [Mail::Reporter](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AReporter/markdown)

    $obj->trace( [$level] )
        Inherited, see "Error handling" in [Mail::Reporter](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AReporter/markdown)

    $obj->warnings()
        Inherited, see "Error handling" in [Mail::Reporter](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AReporter/markdown)

### Cleanup
    Extends "Cleanup" in [Mail::Message::Convert](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AConvert/markdown).

    $obj->DESTROY()
        Inherited, see "Cleanup" in [Mail::Reporter](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AReporter/markdown)

## DIAGNOSTICS
    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.

## SEE ALSO
    This module is part of Mail-Message distribution version 3.012, built on February 11, 2022.
    Website: <http://perl.overmeer.net/CPAN/>

## LICENSE
    Copyrights 2001-2022 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/>