com.konakartadmin.bl

Class AdminEmailMgr

java.lang.Object

com.konakartadmin.bl.AdminBaseMgr

com.konakartadmin.bl.AdminEmailMgr

All Implemented Interfaces:

AdminEmailMgrIf

public class AdminEmailMgr
extends AdminBaseMgr
implements AdminEmailMgrIf

Manager for sending emails

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AdminEmailMgr.StaticData Used to store the external mail module

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	debugEmail debugEmail
protected java.lang.String	defaultBccEmails defaultBccEmails
protected boolean	displayPricesWithTax displayPricesWithTax
protected static java.lang.String	emailMgrMutex Mutex for the email manager
protected java.lang.String	imageBase imageBase
protected static org.apache.commons.logging.Log	log the log
protected java.lang.String	logFileDirectory logFileDirectory
protected static java.lang.String	NEW_PASSWORD_TEMPLATE global static constant
protected static java.lang.String	ORDER_STATUS_CHANGE_TEMPLATE global static constant
protected java.lang.String	pdfBase pdfBase
protected static java.util.Map<java.lang.String,AdminEmailMgr.StaticData>	staticDataHM Hash Map that contains the static data
protected java.lang.String	storeName storeName
protected java.lang.String	storeOwner storeOwner
protected java.lang.String	storeOwnerEmailAddr storeOwnerEmailAddr
protected java.lang.String	storeUrl storeUrl
protected java.lang.String	sysAdminEmailAddress sysAdminEmailAddress

Fields inherited from class com.konakartadmin.bl.AdminBaseMgr

adminEng, baseMgrMutex, baseStaticDataHM, cDataEnd, cDataStart, debugStackTraceExclusions, kkAdminPropsFilePath, kkConf, kkInstanceId, mgrFactory, STORE_ID, templateBaseDir

Constructor Summary

Constructors

Constructor and Description
AdminEmailMgr(KKAdminIf eng) Constructor

Method Summary

Modifier and Type	Method and Description
private boolean	getAsyncFromSynchronousity(int synchcronousity, boolean def)
protected com.konakart.bl.EmailConfig	getConfigData() Return an EmailConfig object that contains attributes required to configure the eMail.
private java.lang.String	getContentTypeStr(int contentType)
com.konakart.bl.Emailer	getEmailer()
protected javax.mail.Address	getMailAddressFromString(java.lang.String addrString) Return an Address for the specified String.
org.apache.velocity.VelocityContext	getVelocityContext() Returns the Velocity Context
protected org.apache.velocity.app.VelocityEngine	getVelocityEngine() Returns the Velocity engine
protected boolean	isExternalMailEnabled(AdminEmailMgr.StaticData sd) Method to determine whether an external mail module is enabled
void	notifySysAdmin(java.lang.String message, AdminEmailOptions options) This method is used to send a template based eMail to the System Administrator.
void	refreshConfigs() Setup the external mail module class.
protected void	refreshPrivateConfigs() Setup variables needed to send the mail.
void	saveEmailContents(java.lang.String toAddr, int contentType, java.lang.String templateName, boolean doBCC, java.lang.String subject, java.lang.String body, java.lang.String addTofileName) Write the mail contents to a file which is handy for diagnosing problems
boolean	sendEmail(AdminEmail adminEmailData) To send an email
protected boolean	sendExternalMail(org.apache.velocity.VelocityContext context, java.lang.String konakartAPI, java.lang.String emailAddr, com.konakart.app.EmailTemplate emailTemplate, AdminEmailOptions options, AdminEmail adminEmailData) If an external mail module has been defined and it is active then it is called to send the mail
void	sendHTML(AdminEmail adminEmailData, 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 doBlindCopy, 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 doBlindCopy, java.lang.String fullAttachmentFilename, java.lang.String friendlyAttachmentName, boolean deleteAttachmentAfterSend, java.lang.String bccEmails, boolean async) Send a HTML-only email message to the specified recipient, with the specified subject and HTML content.
void	sendMail(int contentTypeIn, java.lang.String toAddressString, java.lang.String theSubject, java.lang.String theContent, boolean doBlindCopy, boolean async) Send an email message to the specified recipient, with the specified subject and content with the specified Content Type.
void	sendMail(int contentTypeIn, java.lang.String toAddressString, java.lang.String theSubject, java.lang.String theContent, boolean doBlindCopy, boolean async, AdminEmailOptions optionsIn) Send an email message to the specified recipient, with the specified subject and content with the specified Content Type.
void	sendNewPasswordEmail(java.lang.String emailAddr, java.lang.String newPassword, java.lang.String mailSubjectIn, java.lang.String countryCode) Deprecated.
void	sendNewPasswordEmail1(java.lang.String emailAddr, java.lang.String newPassword, java.lang.String countryCode) Send out an email notifying a user of a new password.
void	sendStatusChangeEmail(int orderId) A status change email is sent when the status of an order is changed
void	sendStatusChangeEmailForState(AdminOrder order, int state) A status change email is sent when the status of an order is changed.
void	sendStatusChangeEmailForState(int orderId, int state) A status change email is sent when the status of an order is changed.
protected void	sendStatusChangeEmailPrivate(AdminOrder orderIn, int orderId, int state) A status change email is sent when the status of an order is changed.
void	sendTemplateEmail(AdminCustomer customer, java.lang.String templateName, java.lang.Object obj1, java.lang.Object obj2, java.lang.Object obj3, java.lang.Object obj4, java.lang.Object obj5, AdminEmailOptions optionsIn) An email is sent to the customer.
void	sendText(java.lang.String toAddressString, java.lang.String theSubject, java.lang.String theContentText, boolean doBlindCopy, 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 fromAddressString, java.lang.String replyToAddressString, java.lang.String theSubject, java.lang.String theContentText, boolean doBlindCopy, java.lang.String bccEmails, boolean async) Send a text-only email message to the specified recipient, with the specified subject and text content.
protected void	setInstalledExternalMailModule(AdminEmailMgr.StaticData sd) Determines whether an external email module is installed and sets it on the static data if it is.

Methods inherited from class com.konakartadmin.bl.AdminBaseMgr

addInsertAttr, addInsertAttr, addStringRuleConstraint, addStringRuleConstraint, checkAPICallEnabled, checkIntInRange, checkIntIsSet, checkRequired, executeQuery, executeQuery, getAdminAddressMgr, getAdminAuditMgr, getAdminBillingMgr, getAdminBookableProductMgr, getAdminCatMgr, getAdminConfigMgr, getAdminContentMgr, getAdminCurrMgr, getAdminCustMgr, getAdminCustPwdHistMgr, getAdminCustTagMgr, getAdminEmailMgr, getAdminEng, getAdminEngineCacheMgr, getAdminEventMgr, getAdminExecuteMgr, getAdminFileMgr, getAdminFilterMgr, getAdminHtmlMgr, getAdminImportMgr, getAdminLanguageMgr, getAdminManuMgr, getAdminMessageMgr, getAdminMiscItemMgr, getAdminMiscPriceMgr, getAdminModulesMgr, getAdminMultiStoreMgr, getAdminOrderMgr, getAdminPdfMgr, getAdminProdAttrMgr, getAdminProdMgr, getAdminPromMgr, getAdminReviewMgr, getAdminSearchRuleMgr, getAdminSecMgr, getAdminServletMgr, getAdminShipmentMgr, getAdminSolrMgr, getAdminStoreMgr, getAdminSuggestionMgr, getAdminTagMgr, getAdminTaxMgr, getAdminValidationMgr, getAdminVelocityContextMgr, getAdminWishListMgr, getBooleanFromString, getDebugStackTraceExclusions, getEmailThreadGracefulShutdownTimeout, getExportMgr, getExportMgr, getExportXMLData, getIntFromString, getKkAdminPropsFilePath, getKkConfig, getKkInstanceId, getMode, getModeString, getMqMgr, getNewCriteria, getNewCriteria, getNewCriteria, getNewCriteria, getOtherModuleByName, getPostSearchText, getPreSearchText, getProductsToCategoresCriteria, getPropertyValue, getPropertyValue, getPropertyValueAsBool, getPropertyValueAsInt, getPropertyValueAsLong, getRecordCount, getRecordCount, getRewardPointMgr, getSingleIntResult, getStoreId, getTemplate, getTemplateBase, getXml_io, init, insertKKEvent, insertKKEvent, isBusiness, isBusinessOrEnterprise, isCommunity, isConfigSet, isEnterprise, isMultiStoreLanguagesShared, isMultiStoreMode, isMultiStoreShareCategories, isMultiStoreShareCustomers, isMultiStoreShareCustomersOrProducts, isMultiStoreShareProducts, isMultiStoreSingleDBCSMode, isMultiStoreSingleDBMode, isMultiStoreSingleDBNonCSMode, isUnix, isWindows, manageException, manageThrowable, removeCData, sendMQMessages, setAdminEng, setDebugStackTraceExclusions, setKkAdminPropsFilePath, setupWildCardRules, setWildCardAfter, setWildCardBefore, shutdownGracefully, shutdownGracefully, timestampStr, updateStaticVariablesNow

Methods inherited from class java.lang.Object

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

Field Detail

log

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

the log

storeOwner

protected java.lang.String storeOwner

storeOwner

storeName

protected java.lang.String storeName

storeName

storeUrl

protected java.lang.String storeUrl

storeUrl

storeOwnerEmailAddr

protected java.lang.String storeOwnerEmailAddr

storeOwnerEmailAddr

defaultBccEmails

protected java.lang.String defaultBccEmails

defaultBccEmails

logFileDirectory

protected java.lang.String logFileDirectory

logFileDirectory

pdfBase

protected java.lang.String pdfBase

pdfBase

imageBase

protected java.lang.String imageBase

imageBase

debugEmail

protected boolean debugEmail

debugEmail

displayPricesWithTax

protected boolean displayPricesWithTax

displayPricesWithTax

sysAdminEmailAddress

protected java.lang.String sysAdminEmailAddress

sysAdminEmailAddress

NEW_PASSWORD_TEMPLATE

protected static final java.lang.String NEW_PASSWORD_TEMPLATE

global static constant

See Also:

Constant Field Values

ORDER_STATUS_CHANGE_TEMPLATE

protected static final java.lang.String ORDER_STATUS_CHANGE_TEMPLATE

global static constant

See Also:

Constant Field Values

staticDataHM

protected static java.util.Map<java.lang.String,AdminEmailMgr.StaticData> staticDataHM

Hash Map that contains the static data

emailMgrMutex

protected static java.lang.String emailMgrMutex

Mutex for the email manager

Constructor Detail

AdminEmailMgr

public AdminEmailMgr(KKAdminIf eng)
              throws java.lang.Exception

Constructor

Parameters:

eng - KKAdmin engine

Throws:

java.lang.Exception - an unexpected exception

Method Detail

refreshConfigs

public void refreshConfigs()
                    throws java.lang.Exception

Setup the external mail module class. Only called when refreshConfigs() is called by the refresh thread.

Specified by:

refreshConfigs in interface AdminEmailMgrIf

Overrides:

refreshConfigs in class AdminBaseMgr

Throws:

java.lang.Exception - an unexpected exception

refreshPrivateConfigs

protected void refreshPrivateConfigs()
                              throws java.lang.Exception

Setup variables needed to send the mail. Called every time the manager is instantiated. All config variables are cached by the AdminConfigurationMgr.

Throws:

java.lang.Exception - an unexpected exception

sendNewPasswordEmail

@Deprecated
public void sendNewPasswordEmail(java.lang.String emailAddr,
                                             java.lang.String newPassword,
                                             java.lang.String mailSubjectIn,
                                             java.lang.String countryCode)
                                      throws java.lang.Exception

Deprecated.

Send out an email notifying a user of a new password

Specified by:

sendNewPasswordEmail in interface AdminEmailMgrIf

Parameters:

emailAddr - Email address to send to - the TO: address

newPassword - the new password that was randomly generated

mailSubjectIn - the email subject line. If null it is retrieved from the first line of the new password template.

countryCode - country code (to pick the appropriate velocity template)

Throws:

java.lang.Exception - an unexpected exception

sendNewPasswordEmail1

public void sendNewPasswordEmail1(java.lang.String emailAddr,
                                  java.lang.String newPassword,
                                  java.lang.String countryCode)
                           throws java.lang.Exception

Send out an email notifying a user of a new password. Get mail subject from first line of the template.

Specified by:

sendNewPasswordEmail1 in interface AdminEmailMgrIf

Parameters:

emailAddr - Email address to send to - the TO: address

newPassword - the new password that was randomly generated

countryCode - country code (to pick the appropriate velocity template)

Throws:

java.lang.Exception - an unexpected exception

sendEmail

public boolean sendEmail(AdminEmail adminEmailData)
                  throws KKAdminException

To send an email

Specified by:

sendEmail in interface AdminEmailMgrIf

Parameters:

adminEmailData - the Email object to fill out to define the email to send

Returns:

true if the email is sent successfully, and exception is raised in other cases

Throws:

KKAdminException - typically when the email could not be sent

sendMail

public void sendMail(int contentTypeIn,
                     java.lang.String toAddressString,
                     java.lang.String theSubject,
                     java.lang.String theContent,
                     boolean doBlindCopy,
                     boolean async)
              throws KKAdminException

Send an email message to the specified recipient, with the specified subject and content with the specified Content Type. If the Content Type is Not Set (-1) it will be derived from the content.

Parameters:

contentTypeIn - the Content Type (Not set, Plain or HTML)

toAddressString - the TO: address

theSubject - the subject line of the email

theContent - the body of the email

doBlindCopy - if true the defined Blind Copy address will be added

async - set to true to send the mail asynchronously or false to send it synchronously

Throws:

KKAdminException - an unexpected KKAdminException exception

sendMail

public void sendMail(int contentTypeIn,
                     java.lang.String toAddressString,
                     java.lang.String theSubject,
                     java.lang.String theContent,
                     boolean doBlindCopy,
                     boolean async,
                     AdminEmailOptions optionsIn)
              throws KKAdminException

Send an email message to the specified recipient, with the specified subject and content with the specified Content Type. If the Content Type is Not Set (-1) it will be derived from the content.

Parameters:

contentTypeIn - the Content Type (Not set, Plain or HTML)

toAddressString - the TO: address

theSubject - the subject line of the email

theContent - the body of the email

doBlindCopy - if true the defined Blind Copy address will be added

async - set to true to send the mail asynchronously or false to send it synchronously

optionsIn - Email options

Throws:

KKAdminException - an unexpected KKAdminException exception

sendHTML

public void sendHTML(java.lang.String toAddressString,
                     java.lang.String theSubject,
                     java.lang.String theContentHTML,
                     boolean doBlindCopy,
                     java.lang.String bccEmails,
                     boolean async)
              throws KKAdminException

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

Specified by:

sendHTML in interface AdminEmailMgrIf

Parameters:

toAddressString - the TO: address

theSubject - the subject line of the email

theContentHTML - the HTML body of the email

doBlindCopy - if true the defined Blind Copy address will be added

bccEmails - Semicolon separated list of blind copy email addresses.

async - set to true to send the mail asynchronously or false to send it synchronously

Throws:

KKAdminException - an unexpected KKAdminException exception

sendHTML

public void sendHTML(java.lang.String toAddressString,
                     java.lang.String theSubject,
                     java.lang.String theContentHTML,
                     boolean doBlindCopy,
                     java.lang.String fullAttachmentFilename,
                     java.lang.String friendlyAttachmentName,
                     boolean deleteAttachmentAfterSend,
                     java.lang.String bccEmails,
                     boolean async)
              throws KKAdminException

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

Parameters:

toAddressString - the TO: address

theSubject - the subject line of the email

theContentHTML - the HTML body of the email

doBlindCopy - if true the defined Blind Copy address will be added

fullAttachmentFilename - full filename of the attachment

friendlyAttachmentName - friendly name to use for the attachment

bccEmails - Semicolon separated list of blind copy email addresses.

async - set to true to send the mail asynchronously or false to send it synchronously

deleteAttachmentAfterSend - the deleteAttachmentAfterSend

Throws:

KKAdminException - an unexpected KKAdminException exception

sendHTML

public void sendHTML(AdminEmail adminEmailData,
                     boolean async)
              throws KKAdminException

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

Parameters:

adminEmailData - defines the email

async - set to true to send the mail asynchronously or false to send it synchronously

Throws:

KKAdminException - an unexpected KKAdminException exception

sendText

public void sendText(java.lang.String toAddressString,
                     java.lang.String theSubject,
                     java.lang.String theContentText,
                     boolean doBlindCopy,
                     java.lang.String bccEmails,
                     boolean async)
              throws KKAdminException

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

Specified by:

sendText in interface AdminEmailMgrIf

Parameters:

toAddressString - the TO: address

theSubject - the subject line of the email

theContentText - the plain text body of the email

doBlindCopy - if true the defined Blind Copy address will be added

bccEmails - Semicolon separated list of blind copy email addresses.

async - set to true to send the mail asynchronously or false to send it synchronously

Throws:

KKAdminException - an unexpected KKAdminException exception

sendText

public void sendText(java.lang.String toAddressString,
                     java.lang.String fromAddressString,
                     java.lang.String replyToAddressString,
                     java.lang.String theSubject,
                     java.lang.String theContentText,
                     boolean doBlindCopy,
                     java.lang.String bccEmails,
                     boolean async)
              throws KKAdminException

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

Specified by:

sendText in interface AdminEmailMgrIf

Parameters:

toAddressString - TO: address

fromAddressString - From address

replyToAddressString - reply to address

theSubject - the theSubject

theContentText - the plain text body of the email

doBlindCopy - if true the defined Blind Copy address will be added

bccEmails - Semicolon separated list of blind copy email addresses.

async - set to true to send the mail asynchronously or false to send it synchronously

Throws:

KKAdminException - an unexpected KKAdminException exception

sendStatusChangeEmailForState

public void sendStatusChangeEmailForState(int orderId,
                                          int state)
                                   throws java.lang.Exception

A status change email is sent when the status of an order is changed. A different template can be picked up depending on the state of the order. Set state to -1 to pick up the default template.

Specified by:

sendStatusChangeEmailForState in interface AdminEmailMgrIf

Parameters:

orderId - the order Id of the order that has a changed status

state - the state of the order

Throws:

java.lang.Exception - an unexpected exception

sendStatusChangeEmailForState

public void sendStatusChangeEmailForState(AdminOrder order,
                                          int state)
                                   throws java.lang.Exception

A status change email is sent when the status of an order is changed. A different template can be picked up depending on the state of the order. Set state to -1 to pick up the default template.

Specified by:

sendStatusChangeEmailForState in interface AdminEmailMgrIf

Parameters:

order - the order that has a changed status

state - the state of the order

Throws:

java.lang.Exception - an unexpected exception

sendStatusChangeEmail

public void sendStatusChangeEmail(int orderId)
                           throws java.lang.Exception

A status change email is sent when the status of an order is changed

Specified by:

sendStatusChangeEmail in interface AdminEmailMgrIf

Parameters:

orderId - the order Id of the order whose status has a changed status

Throws:

java.lang.Exception - an unexpected exception

sendStatusChangeEmailPrivate

protected void sendStatusChangeEmailPrivate(AdminOrder orderIn,
                                            int orderId,
                                            int state)
                                     throws java.lang.Exception

A status change email is sent when the status of an order is changed. A different template can be picked up depending on the state of the order.

Parameters:

orderIn - the order that has a changed status

orderId - the order Id of the order whose status has a changed status. Only used if the order is null.

state - the state of the order

Throws:

java.lang.Exception - an unexpected exception

getEmailer

public com.konakart.bl.Emailer getEmailer()
                                   throws KKAdminException

Specified by:

getEmailer in interface AdminEmailMgrIf

Returns:

Returns a new Emailer.

Throws:

KKAdminException - an unexpected KKAdminException exception

getConfigData

protected com.konakart.bl.EmailConfig getConfigData()
                                             throws java.lang.Exception

Return an EmailConfig object that contains attributes required to configure the eMail. The values are stored in configuration parameters and konakart_mail.properties

Returns:

returns an EmailConfig object

Throws:

java.lang.Exception - an unexpected exception

getMailAddressFromString

protected javax.mail.Address getMailAddressFromString(java.lang.String addrString)
                                               throws KKAdminException

Return an Address for the specified String.

Parameters:

addrString - the address in String form

Returns:

An Internet Address

Throws:

KKAdminException - an unexpected KKAdminException exception

sendTemplateEmail

public void sendTemplateEmail(AdminCustomer customer,
                              java.lang.String templateName,
                              java.lang.Object obj1,
                              java.lang.Object obj2,
                              java.lang.Object obj3,
                              java.lang.Object obj4,
                              java.lang.Object obj5,
                              AdminEmailOptions optionsIn)
                       throws java.lang.Exception

An email is sent to the customer. The email is generated by the template called templateName and the objects obj1-obj5 are passed to the template. The subject of the eMail is picked up from the first line of the template.

Specified by:

sendTemplateEmail in interface AdminEmailMgrIf

Parameters:

customer - The customer to which the eMail will be sent. It will be passed to the velocity template with the name "cust".

templateName - The name of the template. The country code and .vm will be appended automatically. i.e. If the template name is newsletter and the country code is en, then we will look for a file called newsletter_en.vm.

obj1 - This object will be passed to the velocity template with the name "obj1".

obj2 - This object will be passed to the velocity template with the name "obj2".

obj3 - This object will be passed to the velocity template with the name "obj3".

obj4 - This object will be passed to the velocity template with the name "obj4".

obj5 - This object will be passed to the velocity template with the name "obj5".

optionsIn - Email Options

Throws:

java.lang.Exception - an unexpected exception

notifySysAdmin

public void notifySysAdmin(java.lang.String message,
                           AdminEmailOptions options)
                    throws java.lang.Exception

Description copied from interface: AdminEmailMgrIf

This method is used to send a template based eMail to the System Administrator. The System Administrator's email address is defined in the SYSADMIN_EMAIL_ADDRESS configuration variable.

Valid options are:

• templateName: The name of the template used to send the mail without the country code and the .vm extension. e.g. If the name of the template is myTemplate and the two letter country code is en, then KonaKart will search for a template called myTemplate_en.vm .
• countryCode: The two letter (lower case) country code used to search for the template. e.g. en, de, es etc.
• customAttrs: An array of name value pairs used to pass custom information to the Velocity engine. The value can be retrieved from the template using the name preceded by the $ sign. e.g. If a name value pair contains StoreId and 22, the value 22 will be displayed in the eMail where the template contains $StoreId.
• fullAttachmentFilename: The complete filename of an attachment.
• friendlyAttachmentName: The friendly filename of an attachment that can be viewed from the eMail.
• deleteAttachmentAfterSend: When set to true, the attachment is deleted after being sent. The default value is false.

The Velocity context contains the following data:

• customerName: The name of the customer in the format firstName lastName
• customer: The CustomerIf object
• message: The message that may be used by the template
• storeOwner: The name of the store owner.
• storeName: The name of the store.
• storeOwnerEmailAddr: The email address of the store owner.
• dateTool: org.apache.velocity.tools.generic.DateTool object used to format dates.
• locale: java.util.Locale object
• currencyMgr: Used to format prices

Specified by:

notifySysAdmin in interface AdminEmailMgrIf

Parameters:

message - The information within the message may be used by the template. Typically this might be an exception message.

options - Options for the email

Throws:

java.lang.Exception - an unexpected exception

saveEmailContents

public void saveEmailContents(java.lang.String toAddr,
                              int contentType,
                              java.lang.String templateName,
                              boolean doBCC,
                              java.lang.String subject,
                              java.lang.String body,
                              java.lang.String addTofileName)

Write the mail contents to a file which is handy for diagnosing problems

Parameters:

toAddr - the toAddr

contentType - the contentType

templateName - the templateName

doBCC - the doBCC

subject - the subject

body - the body

addTofileName - the addTofileName

getAsyncFromSynchronousity

private boolean getAsyncFromSynchronousity(int synchcronousity,
                                           boolean def)

getContentTypeStr

private java.lang.String getContentTypeStr(int contentType)

getVelocityEngine

protected org.apache.velocity.app.VelocityEngine getVelocityEngine()
                                                            throws java.lang.Exception

Returns the Velocity engine

Returns:

Returns a VelocityEngine

Throws:

java.lang.Exception - an unexpected exception

getVelocityContext

public org.apache.velocity.VelocityContext getVelocityContext()
                                                       throws java.lang.Exception

Returns the Velocity Context

Specified by:

getVelocityContext in interface AdminEmailMgrIf

Returns:

Returns a VelocityContext

Throws:

java.lang.Exception - an unexpected exception

sendExternalMail

protected boolean sendExternalMail(org.apache.velocity.VelocityContext context,
                                   java.lang.String konakartAPI,
                                   java.lang.String emailAddr,
                                   com.konakart.app.EmailTemplate emailTemplate,
                                   AdminEmailOptions options,
                                   AdminEmail adminEmailData)

If an external mail module has been defined and it is active then it is called to send the mail

Parameters:

context - the context

konakartAPI - the konakartAPI

emailAddr - the emailAddr

emailTemplate - the emailTemplate

options - the options

adminEmailData - the adminEmailData

Returns:

Returns true if the email was sent otherwise false. If an exception occurs this will return false

isExternalMailEnabled

protected boolean isExternalMailEnabled(AdminEmailMgr.StaticData sd)
                                 throws com.konakart.app.KKException

Method to determine whether an external mail module is enabled

Parameters:

sd - the sd

Returns:

Returns true if a module is enabled. Otherwise returns false.

Throws:

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

setInstalledExternalMailModule

protected void setInstalledExternalMailModule(AdminEmailMgr.StaticData sd)
                                       throws java.lang.Exception

Determines whether an external email module is installed and sets it on the static data if it is.

Parameters:

sd - the sd

Throws:

java.lang.Exception - an unexpected exception