com.raritantechnologies.utils.email
Interface IMailer

All Superinterfaces:

IConfigurable

All Known Implementing Classes:

ProtocolNeutralMailer, SimpleSMTPMailer

public interface IMailer

extends IConfigurable

Method Summary

java.lang.String	getMsgTemplate(java.lang.String name)
java.lang.String	getMsgTemplateFile()
java.lang.String	getName()
java.lang.String	getPassword()
java.util.ArrayList	getRecipientList()
java.lang.String	getType()
java.lang.String	getUserID()
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
boolean	sendMail(java.lang.String msgStr)
boolean	sendMail(java.lang.String msgStr, java.lang.String subject) Sends an email to the recipients.
boolean	sendMail(java.lang.String msgStr, java.lang.String subject, java.lang.String contentType) Sends an email to the recipients.
void	setAuthenticationRequired(boolean authRequired)
void	setAuthenticationRequired(java.lang.String authRequired)
void	setMsgTemplate(java.util.HashMap msgTemplate)
void	setMsgTemplate(java.lang.String name, java.lang.String msgTemplateText)
void	setMsgTemplateFile(java.lang.String msgTemplateFile)
void	setName(java.lang.String name)
void	setPassword(java.lang.String password)
void	setRecipientList(java.util.ArrayList recipList)
void	setRecipientList(java.lang.String recipient) Sets the recipient list to one recipient.
void	setRecipientList(java.lang.String[] recipList)
void	setType(java.lang.String type)
void	setUserID(java.lang.String userID)

Method Detail

initialize

public void initialize(org.w3c.dom.Element elem)

Description copied from interface: IConfigurable

Initializes the object from an XML tag or element. This method is called by the Framework as part of the application initializtion. see ConfigurationManager, XMLConfigurationManager, XMLSearchFieldMapFactory, XMLSearchSourceFactory. Configurable objects that are owned or contained by other configurable objects will be initialized in by the parent object.

Specified by:

initialize in interface IConfigurable

getUserID

public java.lang.String getUserID()

setUserID

public void setUserID(java.lang.String userID)

getPassword

public java.lang.String getPassword()

setPassword

public void setPassword(java.lang.String password)

getType

public java.lang.String getType()

getRecipientList

public java.util.ArrayList getRecipientList()

setRecipientList

public void setRecipientList(java.lang.String recipient)

Sets the recipient list to one recipient.

Parameters:

recipient - The receivers email address.

setRecipientList

public void setRecipientList(java.lang.String[] recipList)

setRecipientList

public void setRecipientList(java.util.ArrayList recipList)

setType

public void setType(java.lang.String type)

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getMsgTemplateFile

public java.lang.String getMsgTemplateFile()

setMsgTemplateFile

public void setMsgTemplateFile(java.lang.String msgTemplateFile)

getMsgTemplate

public java.lang.String getMsgTemplate(java.lang.String name)

setMsgTemplate

public void setMsgTemplate(java.lang.String name,
                           java.lang.String msgTemplateText)

setMsgTemplate

public void setMsgTemplate(java.util.HashMap msgTemplate)

setAuthenticationRequired

public void setAuthenticationRequired(java.lang.String authRequired)

setAuthenticationRequired

public void setAuthenticationRequired(boolean authRequired)

sendMail

public boolean sendMail(java.lang.String msgStr)

sendMail

public boolean sendMail(java.lang.String msgStr,
                        java.lang.String subject)

Sends an email to the recipients.

Parameters:

msgStr - The message body of the email.

subject - The email Subject header

sendMail

public boolean sendMail(java.lang.String msgStr,
                        java.lang.String subject,
                        java.lang.String contentType)

Sends an email to the recipients.

Parameters:

msgStr - The message body of the email.

subject - The email Subject header

contentType - The content type of the message (e.g. 'text/html' or 'text/plain'