unixdev.net


Switch to SpeakEasy.net DSL

The Modular Manual Browser

Home Page
Manual: (Debian-5.0)
Page:
Section:
Apropos / Subsearch:
optional field

Mail::Message::ConvertUsermContributed Perl DMail::Message::Convert::Html(3pm)



NAME
       Mail::Message::Convert::Html - Format messages in HTML

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.

       Converters between message objects

       Other converters

METHODS
       Constructors

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

        Option     --Defined in     --Default
        fields       Mail::Message::Convert  <see description>
        head_mailto                   <true>
        log          Mail::Reporter   'WARNINGS'
        produce                       HTML
        trace        Mail::Reporter   'WARNINGS'

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

           . head_mailto => BOOLEAN

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

           . log => LEVEL

           . produce => 'HTML'|'XHTML'

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

           . trace => LEVEL

       Converting

       $obj->fieldContentsToHtml(FIELD, [SUBJECT])

           Format one field from the header to HTML.  When the header line
           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.

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

       $obj->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", and "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;

       $obj->headToHtmlTable(HEAD, [TABLE-PARAMS])

           Produce a display of the selectedFields() of the header 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%"');

       $obj->selectedFields(HEAD)

           See "Converting" in Mail::Message::Convert

       $obj->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.
           "textToHtml" is able to convert large plain texts in a descent
           fashion.  In scalar context, the resulting lines are returned as
           one.

       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::Html->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::Html->log([LEVEL [,STRINGS]])

           See "Error handling" in Mail::Reporter

       $obj->logPriority(LEVEL)

       Mail::Message::Convert::Html->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 $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.082, built on
       April 28, 2008. Website: http://perl.overmeer.net/mailbox/

LICENSE
       Copyrights 2001-2008 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
       http://www.perl.com/perl/misc/Artistic.html



perl v5.10.0                      2008-04-28 Mail::Message::Convert::Html(3pm)