Mail::Message::Convert (3)

Leading comments

Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)

Standard preamble:
========================================================================

(The comments found at the beginning of the groff file "man3/Mail::Message::Convert.3pm".)

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

SYNOPSIS

Available methods are very converter-specific.

DESCRIPTION

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

Extends ``

in Mail::Reporter.

Converters between message objects

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

*

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::EmailSimple

Converts Email::Simple messages into Mail::Message objects.

Other converters

*

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::TextAutoformat

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

METHODS

Extends `` in Mail::Reporter.

Constructors

Extends ``Constructors'' in Mail::Reporter.

Mail::Message::Convert->new(%options)

 -Option--Defined in     --Default
  fields                   <see description>
  log     Mail::Reporter   'WARNINGS'
  trace   Mail::Reporter   '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 "To", "From", "Cc", "Bcc", "Date", "Subject", and their "Resent-" 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

Extends ``Error handling'' in Mail::Reporter.

$obj->

AUTOLOAD

()

Inherited, see ``Error handling'' in Mail::Reporter

$obj->addReport($object)

Inherited, see ``Error handling'' in Mail::Reporter

$obj->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )

Mail::Message::Convert->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )

Inherited, see ``Error handling'' in Mail::Reporter

$obj->errors()

Inherited, see ``Error handling'' in Mail::Reporter

$obj->log( [$level, [$strings]] )

Mail::Message::Convert->log( [$level, [$strings]] )

Inherited, see ``Error handling'' in Mail::Reporter

$obj->logPriority($level)

Mail::Message::Convert->logPriority($level)

Inherited, see ``Error handling'' in Mail::Reporter

$obj->logSettings()

Inherited, see ``Error handling'' in Mail::Reporter

$obj->notImplemented()

Inherited, see ``Error handling'' in Mail::Reporter

$obj->report( [$level] )

Inherited, see ``Error handling'' in Mail::Reporter

$obj->reportAll( [$level] )

Inherited, see ``Error handling'' in Mail::Reporter

$obj->trace( [$level] )

Inherited, see ``Error handling'' in Mail::Reporter

$obj->warnings()

Inherited, see ``Error handling'' in Mail::Reporter

Cleanup

Extends ``Cleanup'' in Mail::Reporter.

$obj->

DESTROY

()

Inherited, see ``Cleanup'' in Mail::Reporter

DIAGNOSTICS

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.

SEE ALSO

This module is part of Mail-Box distribution version 2.120, built on September 21, 2016. Website: perl.overmeer.net/mailbox

LICENSE

Copyrights 2001-2016 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 www.perl.com/perl/misc/Artistic.html