NAME

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

CLASS INHERITANCE

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

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

SYNOPSIS

Available methods are very converter-specific.

DESCRIPTION

This class is the base for various message (and message parts) converters. When the conversion does not change the contents of the body, most of the converters will return the source object. In any case, an Mail::Message::Body is returned with the conversion applied but as much of the other meta data stored in the source body unchanged.

In most cases, converters are created by Mail::Message when they are needed; have a look at the encode and decoded methods on message objects.

The following converters are currently available:

• Mail::Message::Convert::Html

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

• Mail::Message::Convert::HtmlFormatText

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

• Mail::Message::Convert::HtmlFormatPS

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

• Mail::Message::Convert::MailInternet

  Converts the simple Mail::Internet messages into Mail::Message objects.

• Mail::Message::Convert::MimeEntity

  Converts the more complicated MIME::Entity messages into Mail::Message objects.

• Mail::Message::Convert::TextAutoformat

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

METHODS

Initiation

new OPTIONS

OPTION               DEFAULT
fields               <see description>
log                  'WARNINGS'
trace                'WARNINGS'

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 Mail::Message::Head::grepNames() whenever converters feel a need for header line selection. By default, the To, From, Cc, Bcc, Date, Subject, and their Resent- counterparts will be selected. Specify an empty list to get all fields.

log => LEVEL

See Mail::Reporter::new(log)

trace => LEVEL

See Mail::Reporter::new(trace)

Converting

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 the fields option for new().

Logging and Tracing

defaultTrace [LEVEL, [LEVEL]

See Mail::Reporter::defaultTrace()

errors

See Mail::Reporter::errors()

log [LEVEL [,STRINGS]]

See Mail::Reporter::log()

report [LEVEL]

See Mail::Reporter::report()

reportAll [LEVEL]

See Mail::Reporter::reportAll()

trace [LEVEL]

See Mail::Reporter::trace()

warnings

See Mail::Reporter::warnings()

Other Methods

AUTOLOAD

See Mail::Reporter::AUTOLOAD()

DESTROY

See Mail::Reporter::DESTROY()

inGlobalDestruction

See Mail::Reporter::inGlobalDestruction()

logPriority LEVEL

See Mail::Reporter::logPriority()

logSettings

See Mail::Reporter::logSettings()

notImplemented

See Mail::Reporter::notImplemented()

SEE ALSO

A good start to read is Mail::Box-Overview. More documentation and a mailinglist are available from the project's website at http://perl.overmeer.net/mailbox/.

AUTHOR

Mark Overmeer (mark@overmeer.net) with the help of many.

VERSION

This code is beta, version 2.023.

Copyright (c) 2001-2002 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.