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::EmailSimple
14          Mail::Message::Convert::Html
15          Mail::Message::Convert::HtmlFormatPS
16          Mail::Message::Convert::HtmlFormatText
17          Mail::Message::Convert::MailInternet
18          Mail::Message::Convert::MimeEntity
19          Mail::Message::Convert::TextAutoformat
20

SYNOPSIS

22       Available methods are very converter-specific.
23

DESCRIPTION

25   Converters between message objects
26       Internally, the Mail::Message::coerce() is called when foreign objects
27       are used where message objects are expected.  That method will
28       automatically create the converting objects, and re-use them.
29
30       ·   Mail::Message::Convert::MailInternet
31
32           Converts the simple Mail::Internet messages into Mail::Message
33           objects.
34
35       ·   Mail::Message::Convert::MimeEntity
36
37           Converts the more complicated MIME::Entity messages into
38           Mail::Message objects.
39
40       ·   Mail::Message::Convert::EmailSimple
41
42           Converts Email::Simple messages into Mail::Message objects.
43
44   Other converters
45       ·   Mail::Message::Convert::Html
46
47           Plays tricks with HTML/XMHTML without help of external modules.
48
49       ·   Mail::Message::Convert::HtmlFormatText
50
51           Converts HTML body objects to plain text objects using the
52           HTML::FormatText module.
53
54       ·   Mail::Message::Convert::HtmlFormatPS
55
56           Converts HTML body objects to Postscript objects using the
57           HTML::FormatPS module.
58
59       ·   Mail::Message::Convert::TextAutoformat
60
61           Converts a text message into text using Text::Autoformat.
62
63       This class is the base for various message (and message parts)
64       converters.
65

METHODS

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

DIAGNOSTICS

144       Error: Package $package does not implement $method.
145           Fatal error: the specific package (or one of its superclasses) does
146           not implement this method where it should. This message means that
147           some other related classes do implement this method however the
148           class at hand does not.  Probably you should investigate this and
149           probably inform the author of the package.
150

SEE ALSO

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

LICENSE

156       Copyrights 2001-2011 by Mark Overmeer. For other contributors see
157       ChangeLog.
158
159       This program is free software; you can redistribute it and/or modify it
160       under the same terms as Perl itself.  See
161       http://www.perl.com/perl/misc/Artistic.html
162
163
164
165perl v5.12.3                      2011-01-26         Mail::Message::Convert(3)