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

METHODS

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

DIAGNOSTICS

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

LICENSE

161       Copyrights 2001-2023 by [Mark Overmeer <markov@cpan.org>]. For other
162       contributors see ChangeLog.
163
164       This program is free software; you can redistribute it and/or modify it
165       under the same terms as Perl itself.  See http://dev.perl.org/licenses/
166
167
168
169perl v5.38.0                      2023-07-20         Mail::Message::Convert(3)