libmail-box-perl 2.110-1 / usr / share / perl5 / Mail / Message / TransferEnc.pod

=encoding utf8

=head1 NAME

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

=head1 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

=head1 SYNOPSIS

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

=head1 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 L<Mail::Message::decoded()|Mail::Message/"The body"> and
L<Mail::Message::encode()|Mail::Message/"The body"> 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:

=over 4

=item * L<Mail::Message::TransferEnc::Base64|Mail::Message::TransferEnc::Base64>

C<base64> for binary information.

=item * L<Mail::Message::TransferEnc::SevenBit|Mail::Message::TransferEnc::SevenBit>

C<7bit> for plain old ASCII characters only.

=item * L<Mail::Message::TransferEnc::EightBit|Mail::Message::TransferEnc::EightBit>

C<8bit> for extended character set data, not encoded.

=item * L<Mail::Message::TransferEnc::QuotedPrint|Mail::Message::TransferEnc::QuotedPrint>

C<quoted-printable> encdoded extended character set data.

=back

See L<documentation in the base class|Mail::Reporter/"DESCRIPTION">.
 
=head1 METHODS

See L<documentation in the base class|Mail::Reporter/"METHODS">.
 
=head2 Constructors

See L<documentation in the base class|Mail::Reporter/"Constructors">.
 
=over 4

=item Mail::Message::TransferEnc-E<gt>B<new>(OPTIONS)

See L<Mail::Reporter/"Constructors">

=back

=head2 The Encoder

=over 4

=item Mail::Message::TransferEnc-E<gt>B<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 C<Content-Transfer-Encoding>
field.

=item $obj-E<gt>B<create>(TYPE, OPTIONS)

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

=item $obj-E<gt>B<name>()

The name of the encoder.  Case is not significant.

=back

=head2 Encoding

=over 4

=item $obj-E<gt>B<check>(BODY, OPTIONS)

Check whether the body is correctly encoded.  If so, the body reference is
returned with the C<checked> flag set.  Otherwise, a new object is created
and returned.

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

=over 2

=item result_type => CLASS

The type of the body to be produced, when the checker decides to return
modified data.  

=back

=item $obj-E<gt>B<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>

=over 2

=item result_type => CLASS

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

=back

=item $obj-E<gt>B<encode>(BODY, OPTIONS)

Use the encoder to encode the content of BODY.

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

=over 2

=item result_type => CLASS

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

=back

=back

=head2 Error handling

See L<documentation in the base class|Mail::Reporter/"Error handling">.
 
=over 4

=item $obj-E<gt>B<AUTOLOAD>()

See L<Mail::Reporter/"Error handling">

=item $obj-E<gt>B<addReport>(OBJECT)

See L<Mail::Reporter/"Error handling">

=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

=item Mail::Message::TransferEnc-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

See L<Mail::Reporter/"Error handling">

=item $obj-E<gt>B<errors>()

See L<Mail::Reporter/"Error handling">

=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])

=item Mail::Message::TransferEnc-E<gt>B<log>([LEVEL [,STRINGS]])

See L<Mail::Reporter/"Error handling">

=item $obj-E<gt>B<logPriority>(LEVEL)

=item Mail::Message::TransferEnc-E<gt>B<logPriority>(LEVEL)

See L<Mail::Reporter/"Error handling">

=item $obj-E<gt>B<logSettings>()

See L<Mail::Reporter/"Error handling">

=item $obj-E<gt>B<notImplemented>()

See L<Mail::Reporter/"Error handling">

=item $obj-E<gt>B<report>([LEVEL])

See L<Mail::Reporter/"Error handling">

=item $obj-E<gt>B<reportAll>([LEVEL])

See L<Mail::Reporter/"Error handling">

=item $obj-E<gt>B<trace>([LEVEL])

See L<Mail::Reporter/"Error handling">

=item $obj-E<gt>B<warnings>()

See L<Mail::Reporter/"Error handling">

=back

=head2 Cleanup

See L<documentation in the base class|Mail::Reporter/"Cleanup">.
 
=over 4

=item $obj-E<gt>B<DESTROY>()

See L<Mail::Reporter/"Cleanup">

=back

=head1 DIAGNOSTICS

=over 4

=item 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.

=item Warning: No decoder for transfer encoding $type.

A decoder for the specified type of transfer encoding is not implemented.

=item 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.

=back

=head1 SEE ALSO

This module is part of Mail-Box distribution version 2.110,
built on January 05, 2014. Website: F<http://perl.overmeer.net/mailbox/>

=head1 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 F<http://www.perl.com/perl/misc/Artistic.html>