Message::Convert::Html(3)

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

CLASS HIERARCHY
 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.

METHOD INDEX
Methods prefixed with an abbreviation are described in Mail::Reporter (MR), Mail::Message::Convert (MMC).

The general methods for "Mail::Message::Convert::Html" objects:

   MR errors                            MR report [LEVEL]
      fieldToHtml FIELD, [SUBJECT]      MR reportAll [LEVEL]
      headToHtmlHead HEAD, META            textToHtml LINES
      headToHtmlTable HEAD, [TABL...    MR trace [LEVEL]
   MR log [LEVEL [,STRINGS]]            MR warnings
      new OPTIONS

The extra methods for extension writers:

   MR AUTOLOAD                          MR logPriority LEVEL
   MR DESTROY                           MR logSettings
      fieldContentsToHtml FIELD, ...    MR notImplemented
   MR inGlobalDestruction              MMC selectedFields HEAD

METHODS

new OPTIONS
     OPTION      DESCRIBED IN                   DEFAULT
     fields      Mail::Message::Convert         <some>
     head_mailto Mail::Message::Convert::Html   1
     log         Mail::Reporter                 'WARNINGS'
     produce     Mail::Message::Convert::Html   'HTML'
     trace       Mail::Reporter                 'WARNINGS'

    * head_mailto => BOOLEAN
        Whether to replace e-mail addresses in some header lines with links.

    * produce => 'HTML'|'XHTML'
        Produce HTML or XHTML output. The output is slightly different, even html browsers will usually accept the xhtml data.

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.

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.

headToHtmlTable HEAD, [TABLE-PARAMS]
    Produce a display of the selected fields of the header (see the "selectedFields" method) 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.

    Example:

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

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

    * 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.

    Example:

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

METHODS for extension writers

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.

SEE ALSO
Mail::Box-Overview

For support and additional documentation, see http://perl.overmeer.net/mailbox/

AUTHOR
Mark Overmeer (mailbox@overmeer.net). All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

VERSION
This code is beta, version 2.018.

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.