NAME

Mail::Message::TransferEnc::Base64 - encode/decode base64 message bodies

INHERITANCE

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

SYNOPSIS

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

DESCRIPTION

Encode or decode message bodies with base64. The e-mail protocol and user agents can not handle binary data. Therefore, binary data -but even sometimes non-binary data- is encoded into ASCII, this is transportable.

Base64 re-groups the bits of bytes, and maps them on characters. The data contains bytes of 8 bits (an octet). These are repacked into groups of 6 bits, pointing in an array of characters containing [A-Za-z0-9+/]. This way, three data bytes become 4 base64 bytes. The encoded data will be trailed by '=' characters to align on four bytes.

METHODS

Constructors

Mail::Message::TransferEnc::Base64->new(OPTIONS)

See Mail::Reporter/"Constructors"

The Encoder

Mail::Message::TransferEnc::Base64->addTransferEncoder(TYPE, CLASS)

See Mail::Message::TransferEnc/"The Encoder"

$obj->create(TYPE, OPTIONS)

See Mail::Message::TransferEnc/"The Encoder"

$obj->name

See Mail::Message::TransferEnc/"The Encoder"

Encoding

$obj->check(BODY, OPTIONS)

See Mail::Message::TransferEnc/"Encoding"

$obj->decode(BODY, OPTIONS)

 Option     --Defined in                --Default
 result_type  Mail::Message::TransferEnc  <type of source body>

. result_type => CLASS

$obj->encode(BODY, OPTIONS)

See Mail::Message::TransferEnc/"Encoding"

Error handling

$obj->AUTOLOAD

See Mail::Reporter/"Error handling"

$obj->addReport(OBJECT)

See Mail::Reporter/"Error handling"

$obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

Mail::Message::TransferEnc::Base64->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

See Mail::Reporter/"Error handling"

$obj->errors

See Mail::Reporter/"Error handling"

$obj->log([LEVEL [,STRINGS]])

Mail::Message::TransferEnc::Base64->log([LEVEL [,STRINGS]])

See Mail::Reporter/"Error handling"

$obj->logPriority(LEVEL)

Mail::Message::TransferEnc::Base64->logPriority(LEVEL)

See Mail::Reporter/"Error handling"

$obj->logSettings

See Mail::Reporter/"Error handling"

$obj->notImplemented

See Mail::Reporter/"Error handling"

$obj->report([LEVEL])

See Mail::Reporter/"Error handling"

$obj->reportAll([LEVEL])

See Mail::Reporter/"Error handling"

$obj->trace([LEVEL])

See Mail::Reporter/"Error handling"

$obj->warnings

See Mail::Reporter/"Error handling"

Cleanup

$obj->DESTROY

See Mail::Reporter/"Cleanup"

$obj->inGlobalDestruction

See Mail::Reporter/"Cleanup"

DIAGNOSTICS

Warning: Base64 line length not padded on 4.

While decoding base64 the data in a message body, a string was found which was not padded into a multiple of four bytes. This is illegal, and therefore this data is ignored.

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.

LICENSE

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