Gecko [ fernandoquevedodop.com ]

Name	Size	Permission
Body	[ DIR ]	drwxr-xr-x
Construct	[ DIR ]	drwxr-xr-x
Convert	[ DIR ]	drwxr-xr-x
Field	[ DIR ]	drwxr-xr-x
Head	[ DIR ]	drwxr-xr-x
Replace	[ DIR ]	drwxr-xr-x
TransferEnc	[ DIR ]	drwxr-xr-x
Wrapper	[ DIR ]	drwxr-xr-x
Body.pm	11.04 KB	-rw-r--r--
Body.pod	30.47 KB	-rw-r--r--
Construct.pm	1.53 KB	-rw-r--r--
Construct.pod	1.43 KB	-rw-r--r--
Convert.pm	931 B	-rw-r--r--
Convert.pod	5.77 KB	-rw-r--r--
Dummy.pm	1 KB	-rw-r--r--
Dummy.pod	14.77 KB	-rw-r--r--
Field.pm	11.8 KB	-rw-r--r--
Field.pod	30.11 KB	-rw-r--r--
Head.pm	4.72 KB	-rw-r--r--
Head.pod	14.7 KB	-rw-r--r--
Part.pm	3.09 KB	-rw-r--r--
Part.pod	15.85 KB	-rw-r--r--
Test.pm	2.43 KB	-rw-r--r--
TransferEnc.pm	1.59 KB	-rw-r--r--
TransferEnc.pod	6.08 KB	-rw-r--r--

Code Editor : 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

Extends L<"DESCRIPTION" in Mail::Reporter|Mail::Reporter/"DESCRIPTION">.
 
=head1 METHODS

Extends L<"METHODS" in Mail::Reporter|Mail::Reporter/"METHODS">.
 
=head2 Constructors

Extends L<"Constructors" in Mail::Reporter|Mail::Reporter/"Constructors">.
 
=over 4

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

Inherited, 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

=head2 Error handling

Extends L<"Error handling" in Mail::Reporter|Mail::Reporter/"Error handling">.
 
=over 4

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