Mail::Message::Convert(3pm)

1Mail::Message::Convert(U3s)er Contributed Perl DocumentatMiaoinl::Message::Convert(3)
2
3
4

NAME

6       Mail::Message::Convert - conversions between message types
7

INHERITANCE

9        Mail::Message::Convert
10          is a Mail::Reporter
11
12        Mail::Message::Convert is extended by
13          Mail::Message::Convert::Html
14          Mail::Message::Convert::HtmlFormatPS
15          Mail::Message::Convert::HtmlFormatText
16          Mail::Message::Convert::MailInternet
17          Mail::Message::Convert::MimeEntity
18          Mail::Message::Convert::TextAutoformat
19

SYNOPSIS

21       Available methods are very converter-specific.
22

DESCRIPTION

24       This class is the base for various message (and message parts) convert‐
25       ers.  When the conversion does not change the contents of the body,
26       most of the converters will return the source object.  In any case, an
27       Mail::Message::Body is returned with the conversion applied but as much
28       of the other meta data stored in the source body unchanged.
29
30       In most cases, converters are created by Mail::Message when they are
31       needed; have a look at the "encode" and "decoded" methods on message
32       objects.
33
34       The following converters are currently available:
35
36       * Mail::Message::Convert::Html
37           Plays tricks with HTML/XMHTML without help of external modules.
38
39       * Mail::Message::Convert::HtmlFormatText
40           Converts HTML body objects to plain text objects using the
41           HTML::FormatText module.
42
43       * Mail::Message::Convert::HtmlFormatPS
44           Converts HTML body objects to Postscript objects using the
45           HTML::FormatPS module.
46
47       * Mail::Message::Convert::MailInternet
48           Converts the simple Mail::Internet messages into Mail::Message
49           objects.
50
51       * Mail::Message::Convert::MimeEntity
52           Converts the more complicated MIME::Entity messages into Mail::Mes‐
53           sage objects.
54
55       * Mail::Message::Convert::TextAutoformat
56           Converts a text message into text using Text::Autoformat.
57

METHODS

59       Constructors
60
61       Mail::Message::Convert->new(OPTIONS)
62
63        Option--Defined in     --Default
64        fields                   <see description>
65        log     Mail::Reporter   'WARNINGS'
66        trace   Mail::Reporter   'WARNINGS'
67
68           . fields NAMES⎪ARRAY-OF-NAMES⎪REGEXS
69
70               Select the fields of a header which are to be handled.  Other
71               fields will not be used.  The value of this option is passed to
72               Mail::Message::Head::Complete::grepNames() whenever converters
73               feel a need for header line selection.  By default, the "To",
74               "From", "Cc", "Bcc", "Date", "Subject", and their "Resent-"
75               counterparts will be selected.  Specify an empty list to get
76               all fields.
77
78           . log LEVEL
79
80           . trace LEVEL
81
82       Converting
83
84       $obj->selectedFields(HEAD)
85
86           Returns a list of fields to be included in the format.  The list is
87           an ordered selection of the fields in the actual header, and fil‐
88           tered through the information as specified with new(fields).
89
90       Error handling
91
92       $obj->AUTOLOAD
93
94           See "Error handling" in Mail::Reporter
95
96       $obj->addReport(OBJECT)
97
98           See "Error handling" in Mail::Reporter
99
100       $obj->defaultTrace([LEVEL]⎪[LOGLEVEL, TRACELEVEL]⎪[LEVEL, CALLBACK])
101
102       Mail::Message::Convert->defaultTrace([LEVEL]⎪[LOGLEVEL,
103       TRACELEVEL]⎪[LEVEL, CALLBACK])
104
105           See "Error handling" in Mail::Reporter
106
107       $obj->errors
108
109           See "Error handling" in Mail::Reporter
110
111       $obj->log([LEVEL [,STRINGS]])
112
113       Mail::Message::Convert->log([LEVEL [,STRINGS]])
114
115           See "Error handling" in Mail::Reporter
116
117       $obj->logPriority(LEVEL)
118
119       Mail::Message::Convert->logPriority(LEVEL)
120
121           See "Error handling" in Mail::Reporter
122
123       $obj->logSettings
124
125           See "Error handling" in Mail::Reporter
126
127       $obj->notImplemented
128
129           See "Error handling" in Mail::Reporter
130
131       $obj->report([LEVEL])
132
133           See "Error handling" in Mail::Reporter
134
135       $obj->reportAll([LEVEL])
136
137           See "Error handling" in Mail::Reporter
138
139       $obj->trace([LEVEL])
140
141           See "Error handling" in Mail::Reporter
142
143       $obj->warnings
144
145           See "Error handling" in Mail::Reporter
146
147       Cleanup
148
149       $obj->DESTROY
150
151           See "Cleanup" in Mail::Reporter
152
153       $obj->inGlobalDestruction
154
155           See "Cleanup" in Mail::Reporter
156

DIAGNOSTICS

158       Error: Package $package does not implement $method.
159
160       Fatal error: the specific package (or one of its superclasses) does not
161       implement this method where it should. This message means that some
162       other related classes do implement this method however the class at
163       hand does not.  Probably you should investigate this and probably
164       inform the author of the package.
165

LICENSE

171       Copyrights 2001-2007 by Mark Overmeer.For other contributors see
172       ChangeLog.
173
174       This program is free software; you can redistribute it and/or modify it
175       under the same terms as Perl itself.  See
176       http://www.perl.com/perl/misc/Artistic.html
177
178
179
180perl v5.8.8                       2007-03-25         Mail::Message::Convert(3)