NAME

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

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:

       •   Mail::Message::TransferEnc::Base64

           "base64" for binary information.

       •   Mail::Message::TransferEnc::SevenBit

           "7bit" for plain old ASCII characters only.

       •   Mail::Message::TransferEnc::EightBit

           "8bit" for extended character set data, not encoded.

       •   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->new(OPTIONS)
           See "Constructors" in Mail::Reporter

   The Encoder
       Mail::Message::TransferEnc->addTransferEncoder(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->create(TYPE, OPTIONS)
           Create a new coder/decoder based on the required type.

       $obj->name()
           The name of the encoder.  Case is not significant.

   Encoding
       $obj->check(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->decode(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->encode(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->AUTOLOAD()
           See "Error handling" in Mail::Reporter

       $obj->addReport(OBJECT)
           See "Error handling" in Mail::Reporter

       $obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
       Mail::Message::TransferEnc->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
           See "Error handling" in Mail::Reporter

       $obj->errors()
           See "Error handling" in Mail::Reporter

       $obj->log([LEVEL [,STRINGS]])
       Mail::Message::TransferEnc->log([LEVEL [,STRINGS]])
           See "Error handling" in Mail::Reporter

       $obj->logPriority(LEVEL)
       Mail::Message::TransferEnc->logPriority(LEVEL)
           See "Error handling" in Mail::Reporter

       $obj->logSettings()
           See "Error handling" in Mail::Reporter

       $obj->notImplemented()
           See "Error handling" in Mail::Reporter

       $obj->report([LEVEL])
           See "Error handling" in Mail::Reporter

       $obj->reportAll([LEVEL])
           See "Error handling" in Mail::Reporter

       $obj->trace([LEVEL])
           See "Error handling" in Mail::Reporter

       $obj->warnings()
           See "Error handling" in Mail::Reporter

   Cleanup
       See documentation in the base class.

       $obj->DESTROY()
           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.110, built on January 05, 2014.
       Website: http://perl.overmeer.net/mailbox/

LICENSE

       Copyrights 2001-2014 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