com.konakart.bl

Class Emailer

java.lang.Object

com.konakart.bl.Emailer

public class Emailer
extends java.lang.Object

Emailer class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Emailer.SMTPAuthenticator SimpleAuthenticator is used to do simple authentication when the SMTP server requires it.

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.commons.logging.Log	log the log

Constructor Summary

Constructors

Constructor and Description
Emailer(EmailConfig emailConfig) Constructor
Emailer(KKEngIf eng) Constructor

Method Summary

Modifier and Type	Method and Description
protected int	createSmtpPortInt(java.lang.String smtpPort)
protected java.lang.String	emailConfigurationToString()
java.lang.String	getAttachmentFriendlyName()
java.lang.String	getAttachmentFullFilename()
java.lang.String	getBccEmails()
java.lang.String	getCcEmails()
ConfigurationMgr	getConfigMgr()
java.lang.String	getContentHTML()
java.lang.String	getContentText()
static int	getContentTypeOfTemplate(java.lang.String subjectAndBody, java.lang.String templateFileName) Try to determine the contentType of the template.
java.lang.String	getDefaultBccEmails()
protected EmailIntegrationMgrInterface	getEmailIntegrationMgr() Used to get an instance of the EmailIntegrationMgr
javax.mail.Address	getFromAddress()
javax.mail.Address	getReplyToAddress()
java.lang.String	getSmtpPassword()
java.lang.String	getSmtpUsername()
java.lang.String	getSubject()
static EmailTemplate	getSubjectAndBody(java.lang.String subjectAndBody, java.lang.String templateFileName, int contentType) Extract the subject and body from the supplied String that should contain the subject and the body.
java.lang.String	getToEmails()
boolean	isDeleteAttachmentFileAfterSend()
boolean	isDoBlindCopy()
static boolean	isEmailValid(java.lang.String emailAddr) Determines whether the eMail address is valid
boolean	isStartTLS()
void	refreshConfigs() Setup variables needed to send the mail
protected void	send() Send an email message that has been fully defined before this call.
void	sendHTML(EmailOptionsIf options) Send a HTML-only email message to the specified recipient, with the specified subject, HTML content and attachment options.
void	sendHTML(java.lang.String toAddressString, java.lang.String theSubject, java.lang.String theContentHTML, boolean blindCopy, java.lang.String bccEmails, boolean async) Send a HTML-only email message to the specified recipient, with the specified subject and HTML content.
void	sendHTML(java.lang.String toAddressString, java.lang.String theSubject, java.lang.String theContentHTML, boolean blindCopy, java.lang.String fullAttachmentFilename, java.lang.String friendlyAttachmentName, boolean delAttachmentAfterSend, java.lang.String bccEmails, boolean async) Send a HTML-only email message to the specified recipient, with the specified subject, HTML content and attachment options.
void	sendHTML(java.lang.String toAddressString, java.lang.String fromAddressString, java.lang.String theSubject, java.lang.String theContentHTML, boolean blindCopy, java.lang.String bccEmails, boolean async) Send a HTML-only email message to the specified recipient, with the specified subject and HTML content.
void	sendHTML(java.lang.String toAddressString, java.lang.String fromAddressString, java.lang.String replyToAddressString, java.lang.String theSubject, java.lang.String theContentHTML, boolean blindCopy, java.lang.String bccEmails, boolean async) Send a HTML-only email message to the specified recipient, from the specified email address with the specified subject and HTML content.
void	sendMail(boolean async) Send the mail either synchronously or asynchronously
void	sendText(EmailOptionsIf options) Send a Text email message to the specified recipient, with the specified subject, Text content and attachment options.
void	sendText(java.lang.String toAddressString, java.lang.String theSubject, java.lang.String theContentText, boolean blindCopy, java.lang.String bccEmails, boolean async) Send a text-only email message to the specified recipient, with the specified subject and text content.
void	sendText(java.lang.String toAddressString, java.lang.String theSubject, java.lang.String theContentText, boolean blindCopy, java.lang.String fullAttachmentFilename, java.lang.String friendlyAttachmentName, boolean delAttachmentAfterSend, java.lang.String bccEmails, boolean async) Send a text-only email message to the specified recipient, with the specified subject, text content and attachment options.
void	sendText(java.lang.String toAddressString, java.lang.String fromAddr, java.lang.String theSubject, java.lang.String theContentText, boolean blindCopy, java.lang.String bccEmails, boolean async) Send a text-only email message to the specified recipient, with the specified subject and text content.
void	sendText(java.lang.String toAddressString, java.lang.String fromAddr, java.lang.String replyToAddr, java.lang.String theSubject, java.lang.String theContentText, boolean blindCopy, java.lang.String bccEmails, boolean async) Send a text-only email message to the specified recipient, with the specified fromAddress, replyToAddress, subject and text content.
void	setAttachmentFriendlyName(java.lang.String attachmentFriendlyName)
void	setAttachmentFullFilename(java.lang.String attachmentFullFilename)
void	setBccEmails(java.lang.String bccEmails)
void	setCcEmails(java.lang.String ccEmails)
void	setContentHTML(java.lang.String contentHTML)
void	setContentText(java.lang.String contentText)
void	setDefaultBccEmails(java.lang.String defaultBccEmails)
void	setDeleteAttachmentFileAfterSend(boolean deleteAttachmentFileAfterSend)
void	setDoBlindCopy(boolean doBlindCopy)
void	setFromAddress(javax.mail.Address fromAddress)
void	setFromAddressFromString(java.lang.String fromAddressStr)
void	setReplyToAddress(javax.mail.Address replyToAddress)
void	setReplyToAddressFromString(java.lang.String replyToAddressStr)
void	setStartTLS(boolean startTLS)
void	setSubject(java.lang.String subject)
void	setToAddressFromString(java.lang.String toAddressString) This is for backwards compatibility.
void	setToEmails(java.lang.String toEmails)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

log

protected static org.apache.commons.logging.Log log

the log

Constructor Detail

Emailer

public Emailer(KKEngIf eng)
        throws java.lang.Exception

Constructor

Parameters:

eng - the eng

Throws:

java.lang.Exception - an unexpected exception

Emailer

public Emailer(EmailConfig emailConfig)
        throws java.lang.Exception

Constructor

Parameters:

emailConfig - Object containing configuration parameters

Throws:

java.lang.Exception - an unexpected exception

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

Returns a string containing the attributes of the object.

refreshConfigs

public void refreshConfigs()
                    throws java.lang.Exception

Setup variables needed to send the mail

Throws:

java.lang.Exception - an unexpected exception

createSmtpPortInt

protected int createSmtpPortInt(java.lang.String smtpPort)

sendHTML

public void sendHTML(java.lang.String toAddressString,
                     java.lang.String theSubject,
                     java.lang.String theContentHTML,
                     boolean blindCopy,
                     java.lang.String bccEmails,
                     boolean async)
              throws com.konakart.app.KKException

Send a HTML-only email message to the specified recipient, with the specified subject and HTML content.

Parameters:

toAddressString - the toAddressString

theSubject - the theSubject

theContentHTML - the theContentHTML

blindCopy - the blindCopy

bccEmails - the bccEmails

async - the async

Throws:

com.konakart.app.KKException - an unexpected KKException exception

sendHTML

public void sendHTML(java.lang.String toAddressString,
                     java.lang.String fromAddressString,
                     java.lang.String theSubject,
                     java.lang.String theContentHTML,
                     boolean blindCopy,
                     java.lang.String bccEmails,
                     boolean async)
              throws com.konakart.app.KKException

Send a HTML-only email message to the specified recipient, with the specified subject and HTML content.

Parameters:

toAddressString - the toAddressString

fromAddressString - the fromAddressString

theSubject - the theSubject

theContentHTML - the theContentHTML

blindCopy - the blindCopy

bccEmails - the bccEmails

async - the async

Throws:

com.konakart.app.KKException - an unexpected KKException exception

sendHTML

public void sendHTML(java.lang.String toAddressString,
                     java.lang.String fromAddressString,
                     java.lang.String replyToAddressString,
                     java.lang.String theSubject,
                     java.lang.String theContentHTML,
                     boolean blindCopy,
                     java.lang.String bccEmails,
                     boolean async)
              throws com.konakart.app.KKException

Send a HTML-only email message to the specified recipient, from the specified email address with the specified subject and HTML content.

Parameters:

toAddressString - the toAddressString

fromAddressString - the fromAddressString

replyToAddressString - the replyToAddressString

theSubject - the theSubject

theContentHTML - the theContentHTML

blindCopy - the blindCopy

bccEmails - the bccEmails

async - the async

Throws:

com.konakart.app.KKException - an unexpected KKException exception

sendHTML

public void sendHTML(java.lang.String toAddressString,
                     java.lang.String theSubject,
                     java.lang.String theContentHTML,
                     boolean blindCopy,
                     java.lang.String fullAttachmentFilename,
                     java.lang.String friendlyAttachmentName,
                     boolean delAttachmentAfterSend,
                     java.lang.String bccEmails,
                     boolean async)
              throws com.konakart.app.KKException

Send a HTML-only email message to the specified recipient, with the specified subject, HTML content and attachment options.

Parameters:

toAddressString - the toAddressString

theSubject - the theSubject

theContentHTML - the theContentHTML

blindCopy - the blindCopy

fullAttachmentFilename - full filename of the attachment

friendlyAttachmentName - friendly name to use for the attachment

delAttachmentAfterSend - set to true to delete the attachment file after the send

bccEmails - the bccEmails

async - the async

Throws:

com.konakart.app.KKException - an unexpected KKException exception

sendHTML

public void sendHTML(EmailOptionsIf options)
              throws com.konakart.app.KKException

Send a HTML-only email message to the specified recipient, with the specified subject, HTML content and attachment options.

Parameters:

options - the EmailOptionsIf object

Throws:

com.konakart.app.KKException - an unexpected KKException exception

sendText

public void sendText(java.lang.String toAddressString,
                     java.lang.String fromAddr,
                     java.lang.String theSubject,
                     java.lang.String theContentText,
                     boolean blindCopy,
                     java.lang.String bccEmails,
                     boolean async)
              throws com.konakart.app.KKException

Send a text-only email message to the specified recipient, with the specified subject and text content.

Parameters:

toAddressString - the toAddressString

fromAddr - the fromAddr

theSubject - the theSubject

theContentText - the theContentText

blindCopy - the blindCopy

bccEmails - the bccEmails

async - the async

Throws:

com.konakart.app.KKException - an unexpected KKException exception

sendText

public void sendText(java.lang.String toAddressString,
                     java.lang.String theSubject,
                     java.lang.String theContentText,
                     boolean blindCopy,
                     java.lang.String bccEmails,
                     boolean async)
              throws com.konakart.app.KKException

Send a text-only email message to the specified recipient, with the specified subject and text content.

Parameters:

toAddressString - the toAddressString

theSubject - the theSubject

theContentText - the theContentText

blindCopy - the blindCopy

bccEmails - the bccEmails

async - the async

Throws:

com.konakart.app.KKException - an unexpected KKException exception

sendText

public void sendText(java.lang.String toAddressString,
                     java.lang.String fromAddr,
                     java.lang.String replyToAddr,
                     java.lang.String theSubject,
                     java.lang.String theContentText,
                     boolean blindCopy,
                     java.lang.String bccEmails,
                     boolean async)
              throws com.konakart.app.KKException

Send a text-only email message to the specified recipient, with the specified fromAddress, replyToAddress, subject and text content.

Parameters:

toAddressString - the toAddressString

fromAddr - the fromAddr

replyToAddr - the replyToAddr

theSubject - the theSubject

theContentText - the theContentText

blindCopy - the blindCopy

bccEmails - the bccEmails

async - the async

Throws:

com.konakart.app.KKException - an unexpected KKException exception

sendText

public void sendText(java.lang.String toAddressString,
                     java.lang.String theSubject,
                     java.lang.String theContentText,
                     boolean blindCopy,
                     java.lang.String fullAttachmentFilename,
                     java.lang.String friendlyAttachmentName,
                     boolean delAttachmentAfterSend,
                     java.lang.String bccEmails,
                     boolean async)
              throws com.konakart.app.KKException

Send a text-only email message to the specified recipient, with the specified subject, text content and attachment options.

Parameters:

toAddressString - the toAddressString

theSubject - the theSubject

theContentText - the theContentText

blindCopy - the blindCopy

fullAttachmentFilename - full filename of the attachment

friendlyAttachmentName - friendly name to use for the attachment

delAttachmentAfterSend - set to true to delete the attachment file after the send

bccEmails - the bccEmails

async - the async

Throws:

com.konakart.app.KKException - an unexpected KKException exception

sendText

public void sendText(EmailOptionsIf options)
              throws com.konakart.app.KKException

Send a Text email message to the specified recipient, with the specified subject, Text content and attachment options.

Parameters:

options - the EmailOptionsIf object

Throws:

com.konakart.app.KKException - an unexpected KKException exception

sendMail

public void sendMail(boolean async)
              throws com.konakart.app.KKException

Send the mail either synchronously or asynchronously

Parameters:

async - the async

Throws:

com.konakart.app.KKException - an unexpected KKException exception

send

protected void send()
             throws com.konakart.app.KKException

Send an email message that has been fully defined before this call.

Throws:

com.konakart.app.KKException - an unexpected KKException exception

emailConfigurationToString

protected java.lang.String emailConfigurationToString()

getConfigMgr

public ConfigurationMgr getConfigMgr()
                              throws java.lang.Exception

Returns:

Returns the configMgr creating one if it doesn't exist.

Throws:

java.lang.Exception - an unexpected exception

isEmailValid

public static boolean isEmailValid(java.lang.String emailAddr)

Determines whether the eMail address is valid

Parameters:

emailAddr - the emailAddr

Returns:

Returns true if the email address is valid. Otherwise returns false.

getEmailIntegrationMgr

protected EmailIntegrationMgrInterface getEmailIntegrationMgr()
                                                       throws org.apache.torque.TorqueException,
                                                              com.konakart.app.KKException,
                                                              com.workingdogs.village.DataSetException,
                                                              java.lang.Exception

Used to get an instance of the EmailIntegrationMgr

Returns:

Returns an EmailIntegrationMgr Object

Throws:

java.lang.Exception - an unexpected exception

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

com.konakart.app.KKException - an unexpected KKException exception

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

getSubjectAndBody

public static EmailTemplate getSubjectAndBody(java.lang.String subjectAndBody,
                                              java.lang.String templateFileName,
                                              int contentType)
                                       throws com.konakart.app.KKException

Extract the subject and body from the supplied String that should contain the subject and the body. The subject should be placed on the first line that should be terminated by a line terminator (either "\r\n" or "\n").

The extracted items are returned in the EmailTemplate object.

Parameters:

subjectAndBody - the subjectAndBody

templateFileName - supplied only to provide context information in error messages and exceptions

contentType - the contentType

Returns:

the EmailTemplate object populated after parsing the subjectAndBody

Throws:

com.konakart.app.KKException - an unexpected KKException exception

getContentTypeOfTemplate

public static int getContentTypeOfTemplate(java.lang.String subjectAndBody,
                                           java.lang.String templateFileName)
                                    throws com.konakart.app.KKException

Try to determine the contentType of the template.

The logic is fairly crude; if we find HTML or DOCTYPE tags we assume it's HTML, otherwise plain text.

Parameters:

subjectAndBody - the subjectAndBody

templateFileName - supplied only to provide context information in error messages and exceptions

Returns:

the content type derived by parsing the subjectAndBody String

Throws:

com.konakart.app.KKException - an unexpected KKException exception

getSubject

public java.lang.String getSubject()

Returns:

the subject

getSmtpUsername

public java.lang.String getSmtpUsername()

Returns:

the smtpUsername

getSmtpPassword

public java.lang.String getSmtpPassword()

Returns:

the smtpPassword

getFromAddress

public javax.mail.Address getFromAddress()

Returns:

the fromAddress

setFromAddress

public void setFromAddress(javax.mail.Address fromAddress)

Parameters:

fromAddress - the fromAddress to set

setFromAddressFromString

public void setFromAddressFromString(java.lang.String fromAddressStr)
                              throws com.konakart.app.KKException

Parameters:

fromAddressStr - the fromAddress to set

Throws:

com.konakart.app.KKException - an unexpected KKException exception

getReplyToAddress

public javax.mail.Address getReplyToAddress()

Returns:

the replyToAddress

setReplyToAddress

public void setReplyToAddress(javax.mail.Address replyToAddress)

Parameters:

replyToAddress - the replyToAddress to set

setReplyToAddressFromString

public void setReplyToAddressFromString(java.lang.String replyToAddressStr)
                                 throws com.konakart.app.KKException

Parameters:

replyToAddressStr - the replyToAddress to set

Throws:

com.konakart.app.KKException - an unexpected KKException exception

setSubject

public void setSubject(java.lang.String subject)

Parameters:

subject - the subject to set

getBccEmails

public java.lang.String getBccEmails()

Returns:

the bccEmails

setBccEmails

public void setBccEmails(java.lang.String bccEmails)

Parameters:

bccEmails - the bccEmails to set

getContentText

public java.lang.String getContentText()

Returns:

the contentText

setContentText

public void setContentText(java.lang.String contentText)

Parameters:

contentText - the contentText to set

getContentHTML

public java.lang.String getContentHTML()

Returns:

the contentHTML

setContentHTML

public void setContentHTML(java.lang.String contentHTML)

Parameters:

contentHTML - the contentHTML to set

getAttachmentFullFilename

public java.lang.String getAttachmentFullFilename()

Returns:

the attachmentFullFilename

setAttachmentFullFilename

public void setAttachmentFullFilename(java.lang.String attachmentFullFilename)

Parameters:

attachmentFullFilename - the attachmentFullFilename to set

getAttachmentFriendlyName

public java.lang.String getAttachmentFriendlyName()

Returns:

the attachmentFriendlyName

setAttachmentFriendlyName

public void setAttachmentFriendlyName(java.lang.String attachmentFriendlyName)

Parameters:

attachmentFriendlyName - the attachmentFriendlyName to set

isDeleteAttachmentFileAfterSend

public boolean isDeleteAttachmentFileAfterSend()

Returns:

the deleteAttachmentFileAfterSend

setDeleteAttachmentFileAfterSend

public void setDeleteAttachmentFileAfterSend(boolean deleteAttachmentFileAfterSend)

Parameters:

deleteAttachmentFileAfterSend - the deleteAttachmentFileAfterSend to set

isDoBlindCopy

public boolean isDoBlindCopy()

Returns:

the doBlindCopy

setDoBlindCopy

public void setDoBlindCopy(boolean doBlindCopy)

Parameters:

doBlindCopy - the doBlindCopy to set

getCcEmails

public java.lang.String getCcEmails()

Returns:

the ccEmails

setCcEmails

public void setCcEmails(java.lang.String ccEmails)

Parameters:

ccEmails - the ccEmails to set

getToEmails

public java.lang.String getToEmails()

Returns:

the toEmails

setToEmails

public void setToEmails(java.lang.String toEmails)

Parameters:

toEmails - the toEmails to set

setToAddressFromString

public void setToAddressFromString(java.lang.String toAddressString)

This is for backwards compatibility.

Parameters:

toAddressString - the to address

getDefaultBccEmails

public java.lang.String getDefaultBccEmails()

Returns:

the defaultBccEmails

setDefaultBccEmails

public void setDefaultBccEmails(java.lang.String defaultBccEmails)

Parameters:

defaultBccEmails - the defaultBccEmails to set

isStartTLS

public boolean isStartTLS()

Returns:

the startTLS

setStartTLS

public void setStartTLS(boolean startTLS)

Parameters:

startTLS - the startTLS to set