org.ploin.pmf
Interface IMailReader

All Known Implementing Classes:

MailReader

public interface IMailReader

Description: This Interface offers methods for reading the template files.

$LastChangedBy: r.reiz $
$Revision: 77 $
$Date: 2010-03-15 13:13:45 +0100 (Mon, 15 Mar 2010) $

Method Summary

String	getDirectory() Returns the directory where the email-templates and the clients are in.
String	getHtmlExtension() returns the html extension.
String	getHtmlMail(TemplateConfig templateConfig) This method returns the html-mail-template to the mailName as String.
String	getPlainExtension() returns the plain extension.
String	getPlainMail(TemplateConfig templateConfig) This method returns the plain-mail template as String for a given mailName.
void	setDirectory(String directory) Set teh directory where the email-templates and the clients are in.
void	setHtmlExtension(String htmlExtension) Set the html extension.
void	setPlainExtension(String plainExtendsion) Set the plain extension.

Method Detail

getPlainMail

String getPlainMail(TemplateConfig templateConfig)
                    throws MailFactoryException

This method returns the plain-mail template as String for a given mailName. If there is no plain-mail-template, the method returns null.

Parameters:

templateConfig - containing client, locale, template-name and map.

Returns:

String or NULL

Throws:

Exception

MailFactoryException

getHtmlMail

String getHtmlMail(TemplateConfig templateConfig)
                   throws MailFactoryException

This method returns the html-mail-template to the mailName as String. If there is no html-mail-template the method returns null.

Parameters:

templateConfig - containing client, locale, template-name and map.

Returns:

String or NULL

Throws:

Exception

MailFactoryException

getDirectory

String getDirectory()

Returns the directory where the email-templates and the clients are in.

Returns:

String

setDirectory

void setDirectory(String directory)

Set teh directory where the email-templates and the clients are in.

Parameters:

directory -

getHtmlExtension

String getHtmlExtension()

returns the html extension.

Returns:

setHtmlExtension

void setHtmlExtension(String htmlExtension)

Set the html extension. The standard is ".html"

Parameters:

htmlExtension -

getPlainExtension

String getPlainExtension()

returns the plain extension.

Returns:

setPlainExtension

void setPlainExtension(String plainExtendsion)

Set the plain extension. The standard is ".txt"

Parameters:

plainExtendsion -