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       Extends "DESCRIPTION" in Mail::Message::Convert.
27

METHODS

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

DIAGNOSTICS

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

SEE ALSO

121       This module is part of Mail-Message distribution version 3.008, built
122       on February 11, 2019. Website: http://perl.overmeer.net/CPAN/
123

LICENSE

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