1Mail::Message::Convert:U:sHetrmlCFoonrtmraitbTuetxetdM(a3Pi)elr:l:MDeoscsuamgeen:t:aCtoinovnert::HtmlFormatText(3)
2
3
4

NAME

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

INHERITANCE

9        Mail::Message::Convert::HtmlFormatText
10          is a Mail::Message::Convert
11          is a Mail::Reporter
12

SYNOPSIS

14        use Mail::Message::Convert::HtmlFormatText;
15        my $af = Mail::Message::Convert::HtmlFormatText->new;
16
17        my $plain_body = $af->format($body);
18

DESCRIPTION

20       Convert HTML/XHTML message body objects into plain text bodies using
21       HTML::FormatText.  This package requires HTML::TreeBuilder and
22       HTML::FormatText which are not installed by default together with
23       Mail::Box.  See also Mail::Message::rebuild() with rule
24       "text_alternative_for_html".
25
26       This module is a small wrapper around HTML::FormatText.
27
28       Extends "DESCRIPTION" in Mail::Message::Convert.
29

METHODS

31       Extends "METHODS" in Mail::Message::Convert.
32
33   Constructors
34       Extends "Constructors" in Mail::Message::Convert.
35
36       Mail::Message::Convert::HtmlFormatText->new(%options)
37            -Option     --Defined in            --Default
38             fields       Mail::Message::Convert  <see description>
39             leftmargin                           3
40             log          Mail::Reporter          'WARNINGS'
41             rightmargin                          72
42             trace        Mail::Reporter          'WARNINGS'
43
44           fields => NAMES|ARRAY-OF-NAMES|REGEXS
45           leftmargin => INTEGER
46             The column of the left margin, passed to the formatter.
47
48           log => LEVEL
49           rightmargin => INTEGER
50             The column of the right margin, passed to the formatter.
51
52           trace => LEVEL
53
54   Converting
55       Extends "Converting" in Mail::Message::Convert.
56
57       $obj->format($body)
58           Pass an html/xhtml encoded body, and a plain text body is returned.
59           Characters are translated into Latin1.
60
61       $obj->selectedFields($head)
62           Inherited, see "Converting" in Mail::Message::Convert
63
64   Error handling
65       Extends "Error handling" in Mail::Message::Convert.
66
67       $obj->AUTOLOAD()
68           Inherited, see "Error handling" in Mail::Reporter
69
70       $obj->addReport($object)
71           Inherited, see "Error handling" in Mail::Reporter
72
73       $obj->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level,
74       $callback] )
75       Mail::Message::Convert::HtmlFormatText->defaultTrace(
76       [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
77           Inherited, see "Error handling" in Mail::Reporter
78
79       $obj->errors()
80           Inherited, see "Error handling" in Mail::Reporter
81
82       $obj->log( [$level, [$strings]] )
83       Mail::Message::Convert::HtmlFormatText->log( [$level, [$strings]] )
84           Inherited, see "Error handling" in Mail::Reporter
85
86       $obj->logPriority($level)
87       Mail::Message::Convert::HtmlFormatText->logPriority($level)
88           Inherited, see "Error handling" in Mail::Reporter
89
90       $obj->logSettings()
91           Inherited, see "Error handling" in Mail::Reporter
92
93       $obj->notImplemented()
94           Inherited, see "Error handling" in Mail::Reporter
95
96       $obj->report( [$level] )
97           Inherited, see "Error handling" in Mail::Reporter
98
99       $obj->reportAll( [$level] )
100           Inherited, see "Error handling" in Mail::Reporter
101
102       $obj->trace( [$level] )
103           Inherited, see "Error handling" in Mail::Reporter
104
105       $obj->warnings()
106           Inherited, see "Error handling" in Mail::Reporter
107
108   Cleanup
109       Extends "Cleanup" in Mail::Message::Convert.
110
111       $obj->DESTROY()
112           Inherited, see "Cleanup" in Mail::Reporter
113

DIAGNOSTICS

115       Error: Package $package does not implement $method.
116           Fatal error: the specific package (or one of its superclasses) does
117           not implement this method where it should. This message means that
118           some other related classes do implement this method however the
119           class at hand does not.  Probably you should investigate this and
120           probably inform the author of the package.
121

SEE ALSO

123       This module is part of Mail-Message distribution version 3.012, built
124       on February 11, 2022. Website: http://perl.overmeer.net/CPAN/
125

LICENSE

127       Copyrights 2001-2022 by [Mark Overmeer <markov@cpan.org>]. For other
128       contributors see ChangeLog.
129
130       This program is free software; you can redistribute it and/or modify it
131       under the same terms as Perl itself.  See http://dev.perl.org/licenses/
132
133
134
135perl v5.36.0                      2023M-a0i1l-:2:0Message::Convert::HtmlFormatText(3)
Impressum