/ 
Mail-Box-2.092
River stage one • 8 direct dependents • 8 total dependents
/ Mail::Message::Convert::HtmlFormatText

NAME

Mail::Message::Convert::HtmlFormatText - Convert HTML into Text

INHERITANCE

Mail::Message::Convert::HtmlFormatText
  is a Mail::Message::Convert
  is a Mail::Reporter

SYNOPSIS

use Mail::Message::Convert::HtmlFormatText;
my $af = Mail::Message::Convert::HtmlFormatText->new;

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

DESCRIPTION

Convert HTML/XHTML message body objects into plain text bodies using HTML::FormatText. This package requires HTML::TreeBuilder and HTML::FormatText which are not installed by default together with Mail::Box. See also Mail::Message::rebuild() with rule text_alternative_for_html.

Converters between message objects

Other converters

METHODS

Constructors

Mail::Message::Convert::HtmlFormatText->new(OPTIONS)

    Option     --Defined in     --Default
fields       Mail::Message::Convert  <see description>
leftmargin                    3
log          Mail::Reporter   'WARNINGS'
rightmargin                   72
trace        Mail::Reporter   '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

$obj->format(BODY)

    Pass an html/xhtml encoded body, and a plain text body is returned. Characters are translated into Latin1.

$obj->selectedFields(HEAD)

Error handling

$obj->AUTOLOAD

$obj->addReport(OBJECT)

$obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

Mail::Message::Convert::HtmlFormatText->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

$obj->errors

$obj->log([LEVEL [,STRINGS]])

Mail::Message::Convert::HtmlFormatText->log([LEVEL [,STRINGS]])

$obj->logPriority(LEVEL)

Mail::Message::Convert::HtmlFormatText->logPriority(LEVEL)

$obj->logSettings

$obj->notImplemented

$obj->report([LEVEL])

$obj->reportAll([LEVEL])

$obj->trace([LEVEL])

$obj->warnings

Cleanup

$obj->DESTROY

$obj->inGlobalDestruction

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-Box distribution version 2.092, built on November 20, 2009. Website: http://perl.overmeer.net/mailbox/

LICENSE

Copyrights 2001-2009 by Mark Overmeer. 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://www.perl.com/perl/misc/Artistic.html