Mark Overmeer > HTML-FromMail-0.11 > HTML::FromMail::Object

Download:
HTML-FromMail-0.11.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.11   Source  

NAME ^

HTML::FromMail::Object - base-class for convertable items

INHERITANCE ^

 HTML::FromMail::Object
   is a Mail::Reporter

 HTML::FromMail::Object is extended by
   HTML::FromMail::Page

SYNOPSIS ^

DESCRIPTION ^

METHODS ^

HTML::FromMail::Object->new(OPTIONS)

 Option  --Default
 settings  {}
 topic     <required>

. settings => HASH-OF-HASHES

Contains the special settings for each of the topics. See HTML::FromMail::new(settings).

. topic => STRING

A symbolic representation of the group of objects which can be handled by the producer. Each extension of this base class will set a value for this option, so you will usually not specify this yourself.

The topic is used to get the right default settings and templates. See HTML::FromMail::new(settings) and HTML::FromMail::new(templates).

Attributes

$obj->settings([TOPIC])

Returns the settings for objects with a certain TOPIC, by default for objects of the current. An empty hash will be returned when not settings where specified.

$obj->topic

Returns the abstract topic of the producer.

Export

Other methods

$obj->plain2html(STRING)

Convert a STRING into HTML.

SEE ALSO ^

This module is part of HTML-FromMail distribution version 0.11, built on June 08, 2007. Website: http://perl.overmeer.net/html-from-mail/

LICENSE ^

Copyrights 2003,2004,2007 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

syntax highlighting: