Mail::Message::Convert::HtmlFormatText (3)

Leading comments

Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)

Standard preamble:
========================================================================

(The comments found at the beginning of the groff file "man3/Mail::Message::Convert::HtmlFormatText.3pm".)

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 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".

Extends ``

in Mail::Message::Convert.

METHODS

Extends `` in Mail::Message::Convert.

Constructors

Extends ``Constructors'' in Mail::Message::Convert.

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

Extends ``Converting'' in Mail::Message::Convert.

$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

Error handling

Extends ``Error handling'' in Mail::Message::Convert.

$obj->

AUTOLOAD

()

Inherited, see ``Error handling'' in Mail::Reporter

$obj->addReport($object)

Inherited, see ``Error handling'' in Mail::Reporter

$obj->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )

Mail::Message::Convert::HtmlFormatText->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::Convert::HtmlFormatText->log( [$level, [$strings]] )

Inherited, see ``Error handling'' in Mail::Reporter

$obj->logPriority($level)

Mail::Message::Convert::HtmlFormatText->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::Convert.

$obj->

DESTROY

()

Inherited, see ``Cleanup'' in Mail::Reporter

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.120, built on September 21, 2016. Website: perl.overmeer.net/mailbox

LICENSE

Copyrights 2001-2016 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 www.perl.com/perl/misc/Artistic.html