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   Converters between message objects
21   Other converters
22       Convert HTML/XHTML message body objects into plain text bodies using
23       HTML::FormatText.  This package requires HTML::TreeBuilder and
24       HTML::FormatText which are not installed by default together with
25       Mail::Box.  See also Mail::Message::rebuild() with rule
26       "text_alternative_for_html".
27

METHODS

29   Constructors
30       Mail::Message::Convert::HtmlFormatText->new(OPTIONS)
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           leftmargin => INTEGER
40             The column of the left margin, passed to the formatter.
41
42           log => LEVEL
43           rightmargin => INTEGER
44             The column of the right margin, passed to the formatter.
45
46           trace => LEVEL
47
48   Converting
49       $obj->format(BODY)
50           Pass an html/xhtml encoded body, and a plain text body is returned.
51           Characters are translated into Latin1.
52
53       $obj->selectedFields(HEAD)
54           See "Converting" in Mail::Message::Convert
55
56   Error handling
57       $obj->AUTOLOAD
58           See "Error handling" in Mail::Reporter
59
60       $obj->addReport(OBJECT)
61           See "Error handling" in Mail::Reporter
62
63       $obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
64           Mail::Message::Convert::HtmlFormatText->defaultTrace([LEVEL]|[LOGLEVEL,
65           TRACELEVEL]|[LEVEL, CALLBACK])
66
67           See "Error handling" in Mail::Reporter
68
69       $obj->errors
70           See "Error handling" in Mail::Reporter
71
72       $obj->log([LEVEL [,STRINGS]])
73           Mail::Message::Convert::HtmlFormatText->log([LEVEL [,STRINGS]])
74
75           See "Error handling" in Mail::Reporter
76
77       $obj->logPriority(LEVEL)
78           Mail::Message::Convert::HtmlFormatText->logPriority(LEVEL)
79
80           See "Error handling" in Mail::Reporter
81
82       $obj->logSettings
83           See "Error handling" in Mail::Reporter
84
85       $obj->notImplemented
86           See "Error handling" in Mail::Reporter
87
88       $obj->report([LEVEL])
89           See "Error handling" in Mail::Reporter
90
91       $obj->reportAll([LEVEL])
92           See "Error handling" in Mail::Reporter
93
94       $obj->trace([LEVEL])
95           See "Error handling" in Mail::Reporter
96
97       $obj->warnings
98           See "Error handling" in Mail::Reporter
99
100   Cleanup
101       $obj->DESTROY
102           See "Cleanup" in Mail::Reporter
103
104       $obj->inGlobalDestruction
105           See "Cleanup" in Mail::Reporter
106

DIAGNOSTICS

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

SEE ALSO

116       This module is part of Mail-Box distribution version 2.097, built on
117       January 26, 2011. Website: http://perl.overmeer.net/mailbox/
118

LICENSE

120       Copyrights 2001-2011 by Mark Overmeer. For other contributors see
121       ChangeLog.
122
123       This program is free software; you can redistribute it and/or modify it
124       under the same terms as Perl itself.  See
125       http://www.perl.com/perl/misc/Artistic.html
126
127
128
129perl v5.12.3                      2011M-a0i1l-:2:6Message::Convert::HtmlFormatText(3)
Impressum