1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
|
=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
L<Mail::Box|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 $class-E<gt>B<new>(%options)
Inherited, see L<Mail::Reporter/"Constructors">
-Option --Defined in --Default
fields Mail::Message::Convert <see description>
leftmargin 3
rightmargin 72
=over 2
=item fields => $name|$regex|\@names|\@regexes
=item leftmargin => INTEGER
The column of the left margin, passed to the formatter.
=item rightmargin => INTEGER
The column of the right margin, passed to the formatter.
=back
=back
=head2 Attributes
Extends L<"Attributes" in Mail::Message::Convert|Mail::Message::Convert/"Attributes">.
=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>()
Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
Extends L<"Cleanup" in Mail::Message::Convert|Mail::Message::Convert/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
Inherited, see L<Mail::Reporter/"Cleanup">
=back
=head1 DIAGNOSTICS
=over 4
=item Error: class $package does not implement method $method.
Fatal error: the specific C<$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.
Cast by C<notImplemented()>
=back
=head1 SEE ALSO
This module is part of Mail-Message version 4.02,
built on January 22, 2026. Website: F<http://perl.overmeer.net/CPAN/>
=head1 LICENSE
For contributors see file ChangeLog.
This software is copyright (c) 2001-2026 by Mark Overmeer.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
|
