NAME

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

CLASS HIERARCHY

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

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. This packages, and all which are derived, are invoked by the message's decoded() and 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:

• base64 via Mail::Message::TransferEnc::Base64

• 7bit via Mail::Message::TransferEnc::SevenBit

• 8bit via Mail::Message::TransferEnc::EightBit

• quoted-printable via Mail::Message::TransferEnc::QuotedPrint

METHOD INDEX

The general methods for Mail::Message::TransferEnc objects:

      check BODY [, OPTIONS]               name
      create TYPE, OPTIONS                 new OPTIONS
      decode BODY [, OPTIONS]           MR report [LEVEL]
      encode BODY [, OPTIONS]           MR reportAll [LEVEL]
   MR errors                            MR trace [LEVEL]
   MR log [LEVEL [,STRINGS]]            MR warnings

The extra methods for extension writers:

   MR AUTOLOAD                          MR inGlobalDestruction
   MR DESTROY                           MR logPriority LEVEL
      addTransferEncoder TYPE, CLASS    MR logSettings

Prefixed methods are described in MR = Mail::Reporter.

METHODS

new OPTIONS

 OPTION            DESCRIBED IN          DEFAULT
 log               Mail::Reporter        'WARNINGS'
 trace             Mail::Reporter        'WARNINGS'

create TYPE, OPTIONS

Create a new coder/decoder based on the required type.

name

The name of the encoder. Case is not significant.

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       DESCRIBED_IN                DEFAULT
 result_type  Mail::Message::TransferEnc  <type of source body>

decode BODY [, OPTIONS]

Use the encoder to decode the content of BODY. A new body is returned.

 OPTION       DESCRIBED_IN                DEFAULT
 result_type  Mail::Message::TransferEnc  <type of source body>

encode BODY [, OPTIONS]

Use the encoder to encode the content of BODY. A new body is returned.

METHODS for extension writers

addTransferEncoder TYPE, CLASS

(Class method) 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.

SEE ALSO

Mail::Box-Overview

AUTHOR

Mark Overmeer (mailbox@overmeer.net). All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

VERSION

This code is beta, version 2.009.

Copyright (c) 2001 Mark Overmeer. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.