=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
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>.
=head1 METHODS
=head2 Constructors
Mail::Message::Convert::HtmlFormatText-E<gt>B<new>(OPTIONS)
=over 4
Option Defined in Default
fields L<Mail::Message::Convert> <see description>
leftmargin C<3>
log
L<Mail::Reporter> C<
'WARNINGS'
>
rightmargin C<72>
trace L<Mail::Reporter> C<
'WARNINGS'
>
. fields NAMES|ARRAY-OF-NAMES|REGEXS
. leftmargin INTEGER
=over 4
The column of the left margin, passed to the formatter.
=back
.
log
LEVEL
. rightmargin INTEGER
=over 4
The column of the right margin, passed to the formatter.
=back
. trace LEVEL
=back
=head2 Converting
$obj
-E<gt>B<
format
>(BODY)
=over 4
Pass an html/xhtml encoded body, and a plain text body is returned.
Characters are translated into Latin1.
=back
$obj
-E<gt>B<selectedFields>(HEAD)
=over 4
See L<Mail::Message::Convert/
"Converting"
>
=back
=head2 Error handling
$obj
-E<gt>B<AUTOLOAD>
=over 4
See L<Mail::Reporter/
"Error handling"
>
=back
$obj
-E<gt>B<addReport>(OBJECT)
=over 4
See L<Mail::Reporter/
"Error handling"
>
=back
$obj
-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
Mail::Message::Convert::HtmlFormatText-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
=over 4
See L<Mail::Reporter/
"Error handling"
>
=back
$obj
-E<gt>B<errors>
=over 4
See L<Mail::Reporter/
"Error handling"
>
=back
$obj
-E<gt>B<
log
>([LEVEL [,STRINGS]])
Mail::Message::Convert::HtmlFormatText-E<gt>B<
log
>([LEVEL [,STRINGS]])
=over 4
See L<Mail::Reporter/
"Error handling"
>
=back
$obj
-E<gt>B<logPriority>(LEVEL)
Mail::Message::Convert::HtmlFormatText-E<gt>B<logPriority>(LEVEL)
=over 4
See L<Mail::Reporter/
"Error handling"
>
=back
$obj
-E<gt>B<logSettings>
=over 4
See L<Mail::Reporter/
"Error handling"
>
=back
$obj
-E<gt>B<notImplemented>
=over 4
See L<Mail::Reporter/
"Error handling"
>
=back
$obj
-E<gt>B<report>([LEVEL])
=over 4
See L<Mail::Reporter/
"Error handling"
>
=back
$obj
-E<gt>B<reportAll>([LEVEL])
=over 4
See L<Mail::Reporter/
"Error handling"
>
=back
$obj
-E<gt>B<trace>([LEVEL])
=over 4
See L<Mail::Reporter/
"Error handling"
>
=back
$obj
-E<gt>B<warnings>
=over 4
See L<Mail::Reporter/
"Error handling"
>
=back
=head2 Cleanup
$obj
-E<gt>B<DESTROY>
=over 4
See L<Mail::Reporter/
"Cleanup"
>
=back
$obj
-E<gt>B<inGlobalDestruction>
=over 4
See L<Mail::Reporter/
"Cleanup"
>
=back
=head1 DIAGNOSTICS
I<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
.
=head1 REFERENCES
=head1 COPYRIGHTS
Distribution version 2.062.
Written by Mark Overmeer (mark
@overmeer
.net). See the ChangeLog
for
other contributors.
Copyright (c) 2001-2003 by the author(s). All rights reserved.
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.