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 "text_alterna‐
24       tive_for_html".
25

METHODS

27       Constructors
28
29       Mail::Message::Convert::HtmlFormatText->new(OPTIONS)
30
31        Option     --Defined in     --Default
32        fields       Mail::Message::Convert  <see description>
33        leftmargin                    3
34        log          Mail::Reporter   'WARNINGS'
35        rightmargin                   72
36        trace        Mail::Reporter   'WARNINGS'
37
38           . fields NAMES⎪ARRAY-OF-NAMES⎪REGEXS
39
40           . leftmargin INTEGER
41
42               The column of the left margin, passed to the formatter.
43
44           . log LEVEL
45
46           . rightmargin INTEGER
47
48               The column of the right margin, passed to the formatter.
49
50           . trace LEVEL
51
52       Converting
53
54       $obj->format(BODY)
55
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
61           See "Converting" in Mail::Message::Convert
62
63       Error handling
64
65       $obj->AUTOLOAD
66
67           See "Error handling" in Mail::Reporter
68
69       $obj->addReport(OBJECT)
70
71           See "Error handling" in Mail::Reporter
72
73       $obj->defaultTrace([LEVEL]⎪[LOGLEVEL, TRACELEVEL]⎪[LEVEL, CALLBACK])
74
75       Mail::Message::Convert::HtmlFormatText->defaultTrace([LEVEL]⎪[LOGLEVEL,
76       TRACELEVEL]⎪[LEVEL, CALLBACK])
77
78           See "Error handling" in Mail::Reporter
79
80       $obj->errors
81
82           See "Error handling" in Mail::Reporter
83
84       $obj->log([LEVEL [,STRINGS]])
85
86       Mail::Message::Convert::HtmlFormatText->log([LEVEL [,STRINGS]])
87
88           See "Error handling" in Mail::Reporter
89
90       $obj->logPriority(LEVEL)
91
92       Mail::Message::Convert::HtmlFormatText->logPriority(LEVEL)
93
94           See "Error handling" in Mail::Reporter
95
96       $obj->logSettings
97
98           See "Error handling" in Mail::Reporter
99
100       $obj->notImplemented
101
102           See "Error handling" in Mail::Reporter
103
104       $obj->report([LEVEL])
105
106           See "Error handling" in Mail::Reporter
107
108       $obj->reportAll([LEVEL])
109
110           See "Error handling" in Mail::Reporter
111
112       $obj->trace([LEVEL])
113
114           See "Error handling" in Mail::Reporter
115
116       $obj->warnings
117
118           See "Error handling" in Mail::Reporter
119
120       Cleanup
121
122       $obj->DESTROY
123
124           See "Cleanup" in Mail::Reporter
125
126       $obj->inGlobalDestruction
127
128           See "Cleanup" in Mail::Reporter
129

DIAGNOSTICS

131       Error: Package $package does not implement $method.
132
133       Fatal error: the specific package (or one of its superclasses) does not
134       implement this method where it should. This message means that some
135       other related classes do implement this method however the class at
136       hand does not.  Probably you should investigate this and probably
137       inform the author of the package.
138

SEE ALSO

140       This module is part of Mail-Box distribution version 2.070, built on
141       March 25, 2007. Website: http://perl.overmeer.net/mailbox/
142

LICENSE

144       Copyrights 2001-2007 by Mark Overmeer.For other contributors see
145       ChangeLog.
146
147       This program is free software; you can redistribute it and/or modify it
148       under the same terms as Perl itself.  See
149       http://www.perl.com/perl/misc/Artistic.html
150
151
152
153perl v5.8.8                       2007M-a0i3l-:2:5Message::Convert::HtmlFormatText(3)
Impressum