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 : Convert.pod

=encoding utf8

=head1 NAME

Mail::Message::Convert - conversions between message types

=head1 INHERITANCE

Mail::Message::Convert
   is a Mail::Reporter

Mail::Message::Convert is extended by
   Mail::Message::Convert::EmailSimple
   Mail::Message::Convert::Html
   Mail::Message::Convert::HtmlFormatPS
   Mail::Message::Convert::HtmlFormatText
   Mail::Message::Convert::MailInternet
   Mail::Message::Convert::MimeEntity
   Mail::Message::Convert::TextAutoformat

=head1 SYNOPSIS

Available methods are very converter-specific.

=head1 DESCRIPTION

This class is the base for various message (and message parts) converters.

Extends L<"DESCRIPTION" in Mail::Reporter|Mail::Reporter/"DESCRIPTION">.
 
=head2 Converters between message objects

Internally, the L<Mail::Message::coerce()|Mail::Message/"Internals"> is called when foreign objects
are used where message objects are expected.  That method will automatically
create the converting objects, and re-use them.

=over 4

=item * L<Mail::Message::Convert::MailInternet|Mail::Message::Convert::MailInternet>

Converts the simple L<Mail::Internet|Mail::Internet> messages into L<Mail::Message|Mail::Message>
objects.

=item * L<Mail::Message::Convert::MimeEntity|Mail::Message::Convert::MimeEntity>

Converts the more complicated MIME::Entity messages into
L<Mail::Message|Mail::Message> objects.

=item * L<Mail::Message::Convert::EmailSimple|Mail::Message::Convert::EmailSimple>

Converts Email::Simple messages into L<Mail::Message|Mail::Message> objects.

=back

=head2 Other converters

=over 4

=item * L<Mail::Message::Convert::Html|Mail::Message::Convert::Html>

Plays tricks with HTML/XMHTML without help of external modules.

=item * L<Mail::Message::Convert::HtmlFormatText|Mail::Message::Convert::HtmlFormatText>

Converts HTML body objects to plain text objects using the
HTML::FormatText module.

=item * L<Mail::Message::Convert::HtmlFormatPS|Mail::Message::Convert::HtmlFormatPS>

Converts HTML body objects to Postscript objects using the
HTML::FormatPS module.

=item * L<Mail::Message::Convert::TextAutoformat|Mail::Message::Convert::TextAutoformat>

Converts a text message into text using Text::Autoformat.

=back

=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::Convert-E<gt>B<new>(%options)

-Option--Defined in     --Default
  fields                   <see description>
  log     Mail::Reporter   'WARNINGS'
  trace   Mail::Reporter   'WARNINGS'

=over 2

=item fields => NAMES|ARRAY-OF-NAMES|REGEXS

Select the fields of a header which are to be handled.  Other
fields will not be used.  The value of this option is passed to
L<Mail::Message::Head::Complete::grepNames()|Mail::Message::Head::Complete/"Access to the header"> whenever converters feel
a need for header line selection.
By default, the C<To>, C<From>, C<Cc>, C<Bcc>, C<Date>, C<Subject>, and their
C<Resent-> counterparts will be selected.  Specify an empty list to get all
fields.

=item log => LEVEL

=item trace => LEVEL

=back

=head2 Converting

=over 4

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

Returns a list of fields to be included in the format.  The list is
an ordered selection of the fields in the actual header, and filtered
through the information as specified with L<new(fields)|Mail::Message::Convert/"METHODS">.

=back

=head2 Error handling

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

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