NAME

Mail::Message::Convert::Html - Format messages from or to HTML

CLASS INHERITANCE

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

SYNOPSIS

 use Mail::Message::Convert::Html;
 my $Html = Mail::Message::Convert::Html->new;

 print $html->fieldToHtml($head);
 print $html->headToHtmlHead($head);
 print $html->headToHtmlTable($head);
 print $html->textToHtml($text);

DESCRIPTION

The package contains various translators which handle HTML or XHTML without the help of external modules. There are more HTML related modules, which do require extra packages to be installed.

METHODS

Initiation

new OPTIONS

 OPTION               DEFAULT
 fields               <see description>
 head_mailto          <true>
 log                  'WARNINGS'
 produce              'HTML'
 trace                'WARNINGS'

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

See Mail::Message::Convert::new(fields)

head_mailto => BOOLEAN

Whether to replace e-mail addresses in some header lines with links.

log => LEVEL

See Mail::Reporter::new(log)

produce => 'HTML'|'XHTML'

Produce HTML or XHTML output. The output is slightly different, even html browsers will usually accept the XHTML data.

trace => LEVEL

See Mail::Reporter::new(trace)

Converting

fieldContentsToHtml FIELD, [SUBJECT]

Format one field from the header to HTML. When the header line usually usually contains e-mail addresses, the line is scanned and valid addresses are linked with an mailto: anchor. The SUBJECT can be specified to be included in that link.

fieldToHtml FIELD, [SUBJECT]

Reformat one header line field to HTML. The FIELD's name is printed in bold, followed by the formatted field content, which is produced by the fieldContentsToHtml method.

headToHtmlHead HEAD, META

Translate the selected header lines (fields) to an html page header. Each selected field will get its own meta line with the same name as the line. Furthermore:

• the Subject field will become the title,

• From is used for the Author

Besides, you can specify your own meta fields, which will overrule header fields. Empty fields will not be included. When a title is specified, this will become the html title, otherwise the Subject field is taken. In list context, the lines are separately, where in scalar context the whole text is returned as one.

If you need to add lines to the head (for instance, http-equiv lines), then splice them before the last element in the returned list.

Examples:

 my @head = $html->headToHtmlHead
     ( $head
     , description => 'This is a message'
     , generator   => 'Mail::Box'
     );
 splice @head, -1, 0, '<meta http-equiv=...>';
 print @head;

headToHtmlTable HEAD, [TABLE-PARAMS]

Produce a display of the selected fields of the header (see selectedFields()) in a table shape. The optional TABLE-PARAMS are added as parameters to the produced TABLE tag. In list context, the separate lines are returned. In scalar context, everything is returned as one.

Examples:

 print $html->headToHtmlTable($head, 'width="50%"');

selectedFields HEAD

See Mail::Message::Convert::selectedFields()

textToHtml LINES

Translate one or more LINES from text into HTML. Each line is taken one after the other, and only simple things are translated. The plainToHtml method is able to convert large plain texts in a descent fashion. In scalar context, the resulting lines are returned as one.

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

Written by Mark Overmeer (mark@overmeer.net) with the help of many. See the ChangeLog for details.

VERSION

This code is beta, version 2.028.

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