GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  MAIL::MESSAGE::TRANSFERENC (3)

.ds Aq ’

NAME

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

CONTENTS

INHERITANCE



 Mail::Message::TransferEnc
   is a Mail::Reporter

 Mail::Message::TransferEnc is extended by
   Mail::Message::TransferEnc::Base64
   Mail::Message::TransferEnc::Binary
   Mail::Message::TransferEnc::EightBit
   Mail::Message::TransferEnc::QuotedPrint
   Mail::Message::TransferEnc::SevenBit



SYNOPSIS



 my Mail::Message $msg = ...;
 my $decoded = $msg->decoded;
 my $encoded = $msg->encode(transfer => base64);



DESCRIPTION

This class is the base for various encoders and decoders, which are used during transport of the message. These packages, and all which are derived, are invoked by the message’s Mail::Message::decoded() and Mail::Message::encode() methods:



 my $message = $folder->message(3);
 my $decoded_body = $message->decoded;
 my $encoded_body = $message->encode(transfer => base64);



The following coders/decoders are currently available:
o Mail::Message::TransferEnc::Base64

base64 for binary information.

o Mail::Message::TransferEnc::SevenBit

7bit for plain old ASCII characters only.

o Mail::Message::TransferEnc::EightBit

8bit for extended character set data, not encoded.

o Mail::Message::TransferEnc::QuotedPrint

quoted-printable encdoded extended character set data.

See documentation in the base class.

METHODS

See documentation in the base class.

    Constructors

See documentation in the base class.
Mail::Message::TransferEnc-><B>newB>(OPTIONS) See Constructors in Mail::Reporter

    The Encoder

Mail::Message::TransferEnc-><B>addTransferEncoderB>(TYPE, CLASS) Adds one new encoder to the list known by the Mail::Box suite. The TYPE is found in the message’s header in the Content-Transfer-Encoding field.
$obj-><B>createB>(TYPE, OPTIONS) Create a new coder/decoder based on the required type.
$obj-><B>nameB>() The name of the encoder. Case is not significant.

    Encoding

$obj-><B>checkB>(BODY, OPTIONS) Check whether the body is correctly encoded. If so, the body reference is returned with the checked flag set. Otherwise, a new object is created and returned.



 -Option     --Default
  result_type  <type of source body>



result_type => CLASS The type of the body to be produced, when the checker decides to return modified data.
$obj-><B>decodeB>(BODY [, OPTIONS]) Use the encoder to decode the content of BODY. A new body is returned.



 -Option     --Default
  result_type  <type of source body>



result_type => CLASS The type of the body to be produced, when the decoder decides to return modified data.
$obj-><B>encodeB>(BODY, OPTIONS) Use the encoder to encode the content of BODY.



 -Option     --Default
  result_type  <type of source body>



result_type => CLASS The type of the body to be produced, when the decoder decides to return modified data.

    Error handling

See documentation in the base class.
$obj-><B>AUTOLOADB>() See Error handling in Mail::Reporter
$obj-><B>addReportB>(OBJECT) See Error handling in Mail::Reporter
$obj-><B>defaultTraceB>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
Mail::Message::TransferEnc-><B>defaultTraceB>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK]) See Error handling in Mail::Reporter
$obj-><B>errorsB>() See Error handling in Mail::Reporter
$obj-><B>logB>([LEVEL [,STRINGS]])
Mail::Message::TransferEnc-><B>logB>([LEVEL [,STRINGS]]) See Error handling in Mail::Reporter
$obj-><B>logPriorityB>(LEVEL)
Mail::Message::TransferEnc-><B>logPriorityB>(LEVEL) See Error handling in Mail::Reporter
$obj-><B>logSettingsB>() See Error handling in Mail::Reporter
$obj-><B>notImplementedB>() See Error handling in Mail::Reporter
$obj-><B>reportB>([LEVEL]) See Error handling in Mail::Reporter
$obj-><B>reportAllB>([LEVEL]) See Error handling in Mail::Reporter
$obj-><B>traceB>([LEVEL]) See Error handling in Mail::Reporter
$obj-><B>warningsB>() See Error handling in Mail::Reporter

    Cleanup

See documentation in the base class.
$obj-><B>DESTROYB>() See Cleanup in Mail::Reporter

DIAGNOSTICS

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

SEE ALSO

This module is part of Mail-Box distribution version 2.109, built on August 19, 2013. Website: http://perl.overmeer.net/mailbox/

LICENSE

Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See http://www.perl.com/perl/misc/Artistic.html

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 MAIL::MESSAGE::TRANSFERENC (3) 2013-08-19

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.