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::ConvertUsermContributMeadilP:e:rMlessage::Convert::HtmlFormatText(3pm)



NAME
       Mail::Message::Convert::HtmlFormatText - Convert HTML into Text

INHERITANCE
        Mail::Message::Convert::HtmlFormatText
          is a Mail::Message::Convert
          is a Mail::Reporter

SYNOPSIS
        use Mail::Message::Convert::HtmlFormatText;
        my $af = Mail::Message::Convert::HtmlFormatText->new;

        my $plain_body = $af->format($body);

DESCRIPTION
       Convert HTML/XHTML message body objects into plain text bodies using
       HTML::FormatText.  This package requires HTML::TreeBuilder and
       HTML::FormatText which are not installed by default together with
       Mail::Box.  See also Mail::Message::rebuild() with rule
       "text_alternative_for_html".

       Converters between message objects

       Other converters

METHODS
       Constructors

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

        Option     --Defined in     --Default
        fields       Mail::Message::Convert  <see description>
        leftmargin                    3
        log          Mail::Reporter   'WARNINGS'
        rightmargin                   72
        trace        Mail::Reporter   'WARNINGS'

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

           . leftmargin => INTEGER

               The column of the left margin, passed to the formatter.

           . log => LEVEL

           . rightmargin => INTEGER

               The column of the right margin, passed to the formatter.

           . trace => LEVEL

       Converting

       $obj->format(BODY)

           Pass an html/xhtml encoded body, and a plain text body is returned.
           Characters are translated into Latin1.

       $obj->selectedFields(HEAD)

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

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

           See "Error handling" in Mail::Reporter

       $obj->logPriority(LEVEL)

       Mail::Message::Convert::HtmlFormatText->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                      2Mail::Message::Convert::HtmlFormatText(3pm)