Gecko [ fernandoquevedodop.com ]

Name	Size	Permission
EmailSimple.pm	1.16 KB	-rw-r--r--
EmailSimple.pod	4.92 KB	-rw-r--r--
Html.pm	4.12 KB	-rw-r--r--
Html.pod	6.5 KB	-rw-r--r--
HtmlFormatPS.pm	1.25 KB	-rw-r--r--
HtmlFormatPS.pod	4.2 KB	-rw-r--r--
HtmlFormatText.pm	1.32 KB	-rw-r--r--
HtmlFormatText.pod	4.53 KB	-rw-r--r--
MailInternet.pm	2.07 KB	-rw-r--r--
MailInternet.pod	4.79 KB	-rw-r--r--
MimeEntity.pm	1.22 KB	-rw-r--r--
MimeEntity.pod	5.2 KB	-rw-r--r--
TextAutoformat.pm	1.02 KB	-rw-r--r--
TextAutoformat.pod	4.24 KB	-rw-r--r--

Code Editor : HtmlFormatText.pod

=encoding utf8

=head1 NAME

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

=head1 INHERITANCE

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

=head1 SYNOPSIS

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

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

=head1 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 L<Mail::Message::rebuild()|Mail::Message::Construct::Rebuild/"Constructing a message"> with rule
C<text_alternative_for_html>.

This module is a small wrapper around HTML::FormatText.

Extends L<"DESCRIPTION" in Mail::Message::Convert|Mail::Message::Convert/"DESCRIPTION">.
 
=head1 METHODS

Extends L<"METHODS" in Mail::Message::Convert|Mail::Message::Convert/"METHODS">.
 
=head2 Constructors

Extends L<"Constructors" in Mail::Message::Convert|Mail::Message::Convert/"Constructors">.
 
=over 4

=item Mail::Message::Convert::HtmlFormatText-E<gt>B<new>(%options)

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

=over 2

=item fields => NAMES|ARRAY-OF-NAMES|REGEXS

=item leftmargin => INTEGER

The column of the left margin, passed to the formatter.

=item log => LEVEL

=item rightmargin => INTEGER

The column of the right margin, passed to the formatter.

=item trace => LEVEL

=back

=head2 Converting

Extends L<"Converting" in Mail::Message::Convert|Mail::Message::Convert/"Converting">.
 
=over 4

=item $obj-E<gt>B<format>($body)

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

=item $obj-E<gt>B<selectedFields>($head)

Inherited, see L<Mail::Message::Convert/"Converting">

=back

=head2 Error handling

Extends L<"Error handling" in Mail::Message::Convert|Mail::Message::Convert/"Error handling">.
 
=over 4

=item $obj-E<gt>B<AUTOLOAD>()