The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

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

CLASS HIERARCHY

 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.

METHOD INDEX

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

The general methods for Mail::Message::Convert::HtmlFormatText objects:

   MR errors                            MR report [LEVEL]
      format BODY                       MR reportAll [LEVEL]
   MR log [LEVEL [,STRINGS]]            MR trace [LEVEL]
      new OPTIONS                       MR warnings

The extra methods for extension writers:

   MR AUTOLOAD                          MR logPriority LEVEL
   MR DESTROY                           MR logSettings
   MR inGlobalDestruction               MR notImplemented

METHODS

new OPTIONS
 OPTION      DESCRIBED IN            DEFAULT
 fields      Mail::Message::Convert  <no used>
 leftmargin  <below>                 3
 rightmargin <below>                 72
 log         Mail::Reporter          'WARNINGS'
 trace       Mail::Reporter          'WARNINGS'
  • leftmargin => INTEGER

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

  • rightmargin => INTEGER

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

format BODY

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

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

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.