man Mail::Message::Convert () - conversions between message types

NAME

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

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 CWencode and CWdecoded 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

Constructors

Mail::Message::Convert->new(OPTIONS)

 Option  Defined in       Default          
 fields                   <see description>
 log     L<Mail::Reporter>  C<'WARNINGS'>    
 trace   L<Mail::Reporter>  C<'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::Complete::grepNames() whenever converters feel a need for header line selection. By default, the CWTo, CWFrom, CWCc, CWBcc, CWDate, CWSubject, and their CWResent- counterparts will be selected. Specify an empty list to get all fields. . log LEVEL . trace LEVEL

Converting

$obj->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 new(fields).

Error handling

$obj->AUTOLOAD See Error handling in Mail::Reporter

$obj->addReport(OBJECT) See Error handling in Mail::Reporter

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

Mail::Message::Convert->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK]) See Error handling in Mail::Reporter

$obj->errors See Error handling in Mail::Reporter

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

Mail::Message::Convert->log([LEVEL [,STRINGS]]) See Error handling in Mail::Reporter

$obj->logPriority(LEVEL)

Mail::Message::Convert->logPriority(LEVEL) See Error handling in Mail::Reporter

$obj->logSettings See Error handling in Mail::Reporter

$obj->notImplemented See Error handling in Mail::Reporter

$obj->report([LEVEL]) See Error handling in Mail::Reporter

$obj->reportAll([LEVEL]) See Error handling in Mail::Reporter

$obj->trace([LEVEL]) See Error handling in Mail::Reporter

$obj->warnings See Error handling in Mail::Reporter

Cleanup

$obj->DESTROY See Cleanup in Mail::Reporter

$obj->inGlobalDestruction See Cleanup in Mail::Reporter

DIAGNOSTICS

Error: Package CW$package does not implement CW$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.

REFERENCES

See the MailBox website at <http://perl.overmeer.net/mailbox/> for more details.

COPYRIGHTS

Distribution version 2.063. Written by Mark Overmeer (mark@overmeer.net). See the ChangeLog for other contributors.

Copyright (c) 2001-2003 by the author(s). All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.