Mail::Message::TransferEnc(3pm)

1Mail::Message::TransferUEsnecr(3C)ontributed Perl DocumeMnatialt:i:oMnessage::TransferEnc(3)
2
3
4

NAME

6       Mail::Message::TransferEnc - message transfer encoder/decoder
7

INHERITANCE

9        Mail::Message::TransferEnc
10          is a Mail::Reporter
11
12        Mail::Message::TransferEnc is extended by
13          Mail::Message::TransferEnc::Base64
14          Mail::Message::TransferEnc::Binary
15          Mail::Message::TransferEnc::EightBit
16          Mail::Message::TransferEnc::QuotedPrint
17          Mail::Message::TransferEnc::SevenBit
18

SYNOPSIS

20        my Mail::Message $msg = ...;
21        my $decoded = $msg->decoded;
22        my $encoded = $msg->encode(transfer => 'base64');
23

DESCRIPTION

25       This class is the base for various encoders and decoders, which are
26       used during transport of the message.  These packages, and all which
27       are derived, are invoked by the message's Mail::Message::decoded() and
28       Mail::Message::encode() methods:
29
30        my $message = $folder->message(3);
31        my $decoded_body = $message->decoded;
32        my $encoded_body = $message->encode(transfer => 'base64');
33
34       The following coders/decoders are currently available:
35
36       ·   Mail::Message::TransferEnc::Base64
37
38           "base64" for binary information.
39
40       ·   Mail::Message::TransferEnc::SevenBit
41
42           "7bit" for plain old ASCII characters only.
43
44       ·   Mail::Message::TransferEnc::EightBit
45
46           "8bit" for extended character set data, not encoded.
47
48       ·   Mail::Message::TransferEnc::QuotedPrint
49
50           "quoted-printable" encdoded extended character set data.
51

METHODS

53   Constructors
54       Mail::Message::TransferEnc->new(OPTIONS)
55           See "Constructors" in Mail::Reporter
56
57   The Encoder
58       Mail::Message::TransferEnc->addTransferEncoder(TYPE, CLASS)
59           Adds one new encoder to the list known by the Mail::Box suite.  The
60           TYPE is found in the message's header in the
61           "Content-Transfer-Encoding" field.
62
63       $obj->create(TYPE, OPTIONS)
64           Create a new coder/decoder based on the required type.
65
66       $obj->name
67           The name of the encoder.  Case is not significant.
68
69   Encoding
70       $obj->check(BODY, OPTIONS)
71           Check whether the body is correctly encoded.  If so, the body
72           reference is returned with the "checked" flag set.  Otherwise, a
73           new object is created and returned.
74
75            -Option     --Default
76             result_type  <type of source body>
77
78           result_type => CLASS
79             The type of the body to be produced, when the checker decides to
80             return modified data.
81
82       $obj->decode(BODY [, OPTIONS])
83           Use the encoder to decode the content of BODY.  A new body is
84           returned.
85
86            -Option     --Default
87             result_type  <type of source body>
88
89           result_type => CLASS
90             The type of the body to be produced, when the decoder decides to
91             return modified data.
92
93       $obj->encode(BODY, OPTIONS)
94           Use the encoder to encode the content of BODY.
95
96            -Option     --Default
97             result_type  <type of source body>
98
99           result_type => CLASS
100             The type of the body to be produced, when the decoder decides to
101             return modified data.
102
103   Error handling
104       $obj->AUTOLOAD
105           See "Error handling" in Mail::Reporter
106
107       $obj->addReport(OBJECT)
108           See "Error handling" in Mail::Reporter
109
110       $obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
111           Mail::Message::TransferEnc->defaultTrace([LEVEL]|[LOGLEVEL,
112           TRACELEVEL]|[LEVEL, CALLBACK])
113
114           See "Error handling" in Mail::Reporter
115
116       $obj->errors
117           See "Error handling" in Mail::Reporter
118
119       $obj->log([LEVEL [,STRINGS]])
120           Mail::Message::TransferEnc->log([LEVEL [,STRINGS]])
121
122           See "Error handling" in Mail::Reporter
123
124       $obj->logPriority(LEVEL)
125           Mail::Message::TransferEnc->logPriority(LEVEL)
126
127           See "Error handling" in Mail::Reporter
128
129       $obj->logSettings
130           See "Error handling" in Mail::Reporter
131
132       $obj->notImplemented
133           See "Error handling" in Mail::Reporter
134
135       $obj->report([LEVEL])
136           See "Error handling" in Mail::Reporter
137
138       $obj->reportAll([LEVEL])
139           See "Error handling" in Mail::Reporter
140
141       $obj->trace([LEVEL])
142           See "Error handling" in Mail::Reporter
143
144       $obj->warnings
145           See "Error handling" in Mail::Reporter
146
147   Cleanup
148       $obj->DESTROY
149           See "Cleanup" in Mail::Reporter
150
151       $obj->inGlobalDestruction
152           See "Cleanup" in Mail::Reporter
153

DIAGNOSTICS

155       Error: Decoder for transfer encoding $type does not work: $@
156           Compiling the required transfer encoding resulted in errors, which
157           means that the decoder can not be used.
158
159       Warning: No decoder for transfer encoding $type.
160           A decoder for the specified type of transfer encoding is not
161           implemented.
162
163       Error: Package $package does not implement $method.
164           Fatal error: the specific package (or one of its superclasses) does
165           not implement this method where it should. This message means that
166           some other related classes do implement this method however the
167           class at hand does not.  Probably you should investigate this and
168           probably inform the author of the package.
169

LICENSE

175       Copyrights 2001-2011 by Mark Overmeer. For other contributors see
176       ChangeLog.
177
178       This program is free software; you can redistribute it and/or modify it
179       under the same terms as Perl itself.  See
180       http://www.perl.com/perl/misc/Artistic.html
181
182
183
184perl v5.12.3                      2011-01-26     Mail::Message::TransferEnc(3)