com.konakart.bl.modules.others

Class BaseMailModule

java.lang.Object

com.konakart.bl.modules.BaseModule

com.konakart.bl.modules.others.BaseMailModule

public class BaseMailModule
extends BaseModule

Base class for all external mail modules.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.konakartadmin.app.AdminCustomer	adminCustomer Admin customer object
protected com.konakartadmin.app.AdminOrder	adminOrder Admin order object
protected Customer	appCustomer Application customer object
protected Order	appOrder Application order object
protected java.lang.String[]	bccEmailsStrArray Blind copy addresses
protected java.lang.String	contentType Content type
protected org.apache.velocity.VelocityContext	context Velocity Context
protected java.lang.String	countryCode country code - it's really locale - eg: "en", "es", "de" etc
protected java.lang.String	customerName Name of customer
protected boolean	debugEmail Debug when set to true
protected boolean	deleteAttachmentAfterSend The attachment should be deleted after send when true
protected boolean	displayPricesWithTax Prices displayed with tax if true
protected boolean	doBlindCopy Blind copy activated when true
protected java.lang.String	emailAddr Destination email address
protected java.lang.String	emailBody Body of email
protected java.lang.String	emailSubject Subject of email
protected int	expiryMins Length of time in minutes before password expires
protected java.lang.String	friendlyAttachmentName Friendly attachment file name
protected java.lang.String	fromAddressStr From address in string format
protected java.lang.String	fromName From name
protected java.lang.String	fullAttachmentFilename Full attachment file name
protected java.lang.String	imageBaseUrl Image base URL
protected boolean	isAsync When true, email is sent asynchronously
protected java.lang.String	konakartAPI API called to send the mail
protected java.lang.String	message Email message
protected java.lang.String	newPassword New password
protected int	productId Set for sendStockReorderEmail
protected java.lang.String	productName Set for sendStockReorderEmail
protected int	productQuantity Set for sendStockReorderEmail
protected java.lang.String	replyToAddressStr Reply to address in string format
protected java.lang.String	replyToName Reply to name
protected static java.lang.String	resetCustomerPassword KonaKartAdmin API name
protected static java.lang.String	sendEmail KonaKartAdmin API name
protected static java.lang.String	sendNewPassword1 KonaKart API name
protected static java.lang.String	sendOrderConfirmationEmail1 KonaKart API name
protected static java.lang.String	sendStatusChangeEmailForState KonaKartAdmin API name
protected static java.lang.String	sendStockReorderEmail KonaKart API name
protected static java.lang.String	sendTemplateEmail KonaKartAdmin API name
protected static java.lang.String	sendTemplateEmailToCustomer1 KonaKart API name
protected static java.lang.String	sendWelcomeEmail1 KonaKart API name
protected java.lang.String	sku Set for sendStockReorderEmail
protected java.lang.String	storeId Id of store
protected java.lang.String	storeName Name of store
protected java.lang.String	storeOwner Store Owner
protected java.lang.String	storeOwnerEmailAddr Email address of store owner
protected java.lang.String	templateBase Velocity template base directory
protected java.lang.String	templateName template name
protected Order[]	vendorOrders Application vendor order objects when in multi-vendor mode

Fields inherited from class com.konakart.bl.modules.BaseModule

basePackage, debugStackTraceExclusions

Constructor Summary

Constructors

Constructor and Description
BaseMailModule()

Method Summary

Modifier and Type	Method and Description
protected void	deleteAttachmentFile() Deletes the attachment file
protected com.konakartadmin.blif.AdminConfigurationMgrIf	getAdminConfigMgr()
com.konakartadmin.appif.KKAdminIf	getAdminEng()
protected java.lang.String	getConfigurationValue(java.lang.String key) Works regardless of whether module is being called by Admin or App eng.
protected boolean	getConfigurationValueAsBool(java.lang.String key, boolean def) Works regardless of whether module is being called by Admin or App eng.
protected int	getConfigurationValueAsIntWithDefault(java.lang.String key, int def) Works regardless of whether module is being called by Admin or App eng.
protected java.lang.String	getContentType() Get some common content types
protected java.lang.String	getEncodedFileContent() Get the encoded file content required to send the mail
java.lang.String	getFormattedCustomerName(com.konakartadmin.app.AdminCustomer cust) Returns the customer name formatted by the template in the configuration variable
protected java.lang.String	getMailDebugInfo() Create a formatted string of debug information
protected java.lang.String	getStoreId() Return the storeId
protected void	init(com.konakartadmin.appif.KKAdminIf adminEng) Init method called from the super class when called from the Admin engine
protected boolean	isAvailable(java.lang.String configKey) Called to determine whether the module is available.Works regardless of whether module is being called by Admin or App eng.
ExternalMailResult	sendExternalMail(ExternalMailInput input) Called by the actual mail module to perform common tasks such as validating the input and setting local configuration variables
void	setAdminEng(com.konakartadmin.appif.KKAdminIf adminEng)
protected void	setConfigs() Set local configuration values from configuration variables
protected void	setConfigsFromInput(ExternalMailInput input) Set local configuration values used to send the mail, from the input data
void	setFromAddressStr(java.lang.String fromAddressStr) If it's in the format "name <abc@defg.com>" we set the name as well
void	setReplyToAddressStr(java.lang.String replyToAddressStr)
void	validateExternalMailInput(ExternalMailInput input) Common validation code for the input object

Methods inherited from class com.konakart.bl.modules.BaseModule

getBasketMgr, getCatMgr, getConfigMgr, getConfiguration, getConfigurationValueAsBigDecimalWithDefault, getCurrMgr, getCustMgr, getCustTagMgr, getDebugStackTraceExclusions, getEmailMgr, getEng, getLangMgr, getModuleClassName, getMultiStoreMgr, getNewCriteria, getOrderMgr, getOrderTotalMgr, getPaymentMgr, getProdMgr, getPromMgr, getRandomText, getRandomText, getResourceBundle, getRewardPointMgr, getSecMgr, getShippingMgr, getSolrMgr, getStoreMgr, getTaxMgr, getZoneCodeForZoneName, init, isAvailable, isMultiStoreShareCustomersOrProducts, setDebugStackTraceExclusions, updateStaticVariablesNow

Methods inherited from class java.lang.Object

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

Field Detail

sendNewPassword1

protected static final java.lang.String sendNewPassword1

KonaKart API name

See Also:

Constant Field Values

sendWelcomeEmail1

protected static final java.lang.String sendWelcomeEmail1

KonaKart API name

See Also:

Constant Field Values

sendOrderConfirmationEmail1

protected static final java.lang.String sendOrderConfirmationEmail1

KonaKart API name

See Also:

Constant Field Values

sendTemplateEmailToCustomer1

protected static final java.lang.String sendTemplateEmailToCustomer1

KonaKart API name

See Also:

Constant Field Values

sendStockReorderEmail

protected static final java.lang.String sendStockReorderEmail

KonaKart API name

See Also:

Constant Field Values

resetCustomerPassword

protected static final java.lang.String resetCustomerPassword

KonaKartAdmin API name

See Also:

Constant Field Values

sendStatusChangeEmailForState

protected static final java.lang.String sendStatusChangeEmailForState

KonaKartAdmin API name

See Also:

Constant Field Values

sendTemplateEmail

protected static final java.lang.String sendTemplateEmail

KonaKartAdmin API name

See Also:

Constant Field Values

sendEmail

protected static final java.lang.String sendEmail

KonaKartAdmin API name

See Also:

Constant Field Values

konakartAPI

protected java.lang.String konakartAPI

API called to send the mail

fromAddressStr

protected java.lang.String fromAddressStr

From address in string format

fromName

protected java.lang.String fromName

From name

replyToAddressStr

protected java.lang.String replyToAddressStr

Reply to address in string format

replyToName

protected java.lang.String replyToName

Reply to name

bccEmailsStrArray

protected java.lang.String[] bccEmailsStrArray

Blind copy addresses

debugEmail

protected boolean debugEmail

Debug when set to true

doBlindCopy

protected boolean doBlindCopy

Blind copy activated when true

context

protected org.apache.velocity.VelocityContext context

Velocity Context

storeOwner

protected java.lang.String storeOwner

Store Owner

storeOwnerEmailAddr

protected java.lang.String storeOwnerEmailAddr

Email address of store owner

storeName

protected java.lang.String storeName

Name of store

storeId

protected java.lang.String storeId

Id of store

imageBaseUrl

protected java.lang.String imageBaseUrl

Image base URL

templateBase

protected java.lang.String templateBase

Velocity template base directory

displayPricesWithTax

protected boolean displayPricesWithTax

Prices displayed with tax if true

customerName

protected java.lang.String customerName

Name of customer

appCustomer

protected Customer appCustomer

Application customer object

adminCustomer

protected com.konakartadmin.app.AdminCustomer adminCustomer

Admin customer object

emailSubject

protected java.lang.String emailSubject

Subject of email

emailBody

protected java.lang.String emailBody

Body of email

emailAddr

protected java.lang.String emailAddr

Destination email address

countryCode

protected java.lang.String countryCode

country code - it's really locale - eg: "en", "es", "de" etc

templateName

protected java.lang.String templateName

template name

message

protected java.lang.String message

Email message

appOrder

protected Order appOrder

Application order object

vendorOrders

protected Order[] vendorOrders

Application vendor order objects when in multi-vendor mode

adminOrder

protected com.konakartadmin.app.AdminOrder adminOrder

Admin order object

newPassword

protected java.lang.String newPassword

New password

expiryMins

protected int expiryMins

Length of time in minutes before password expires

contentType

protected java.lang.String contentType

Content type

isAsync

protected boolean isAsync

When true, email is sent asynchronously

fullAttachmentFilename

protected java.lang.String fullAttachmentFilename

Full attachment file name

friendlyAttachmentName

protected java.lang.String friendlyAttachmentName

Friendly attachment file name

deleteAttachmentAfterSend

protected boolean deleteAttachmentAfterSend

The attachment should be deleted after send when true

productName

protected java.lang.String productName

Set for sendStockReorderEmail

productQuantity

protected int productQuantity

Set for sendStockReorderEmail

productId

protected int productId

Set for sendStockReorderEmail

sku

protected java.lang.String sku

Set for sendStockReorderEmail

Constructor Detail

BaseMailModule

public BaseMailModule()

Method Detail

getAdminEng

public com.konakartadmin.appif.KKAdminIf getAdminEng()

Returns:

the adminEng

init

protected void init(com.konakartadmin.appif.KKAdminIf adminEng)

Init method called from the super class when called from the Admin engine

Parameters:

adminEng - the adminEng

setAdminEng

public void setAdminEng(com.konakartadmin.appif.KKAdminIf adminEng)

Parameters:

adminEng - the adminEng to set

getStoreId

protected java.lang.String getStoreId()
                               throws com.konakart.app.KKException

Return the storeId

Overrides:

getStoreId in class BaseModule

Returns:

Return the storeId

Throws:

com.konakart.app.KKException - an unexpected exception from the KonaKart engine

sendExternalMail

public ExternalMailResult sendExternalMail(ExternalMailInput input)
                                    throws java.lang.Exception

Called by the actual mail module to perform common tasks such as validating the input and setting local configuration variables

Parameters:

input - the input

Returns:

Returns null

Throws:

java.lang.Exception - an unexpected exception

setConfigs

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

Set local configuration values from configuration variables

Throws:

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

setConfigsFromInput

protected void setConfigsFromInput(ExternalMailInput input)
                            throws java.lang.Exception

Set local configuration values used to send the mail, from the input data

Parameters:

input - the input

Throws:

java.lang.Exception - an unexpected exception

getMailDebugInfo

protected java.lang.String getMailDebugInfo()

Create a formatted string of debug information

Returns:

Returns debug information

isAvailable

protected boolean isAvailable(java.lang.String configKey)
                       throws com.konakart.app.KKException

Called to determine whether the module is available.Works regardless of whether module is being called by Admin or App eng.

Overrides:

isAvailable in class BaseModule

Parameters:

configKey - the configKey

Returns:

Returns true or false

Throws:

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

getAdminConfigMgr

protected com.konakartadmin.blif.AdminConfigurationMgrIf getAdminConfigMgr()
                                                                    throws java.lang.Exception

Returns:

Returns the AdminConfigurationMgr.

Throws:

java.lang.Exception - an unexpected exception

validateExternalMailInput

public void validateExternalMailInput(ExternalMailInput input)
                               throws com.konakart.app.KKException

Common validation code for the input object

Parameters:

input - the input

Throws:

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

getFormattedCustomerName

public java.lang.String getFormattedCustomerName(com.konakartadmin.app.AdminCustomer cust)
                                          throws java.lang.Exception

Returns the customer name formatted by the template in the configuration variable

Parameters:

cust - the cust

Returns:

Returns the formatted customer name

Throws:

java.lang.Exception - an unexpected exception

getConfigurationValue

protected java.lang.String getConfigurationValue(java.lang.String key)
                                          throws com.konakart.app.KKException

Works regardless of whether module is being called by Admin or App eng.

Overrides:

getConfigurationValue in class BaseModule

Parameters:

key - the key

Returns:

Returns the String value of the configuration variable

Throws:

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

getConfigurationValueAsBool

protected boolean getConfigurationValueAsBool(java.lang.String key,
                                              boolean def)
                                       throws com.konakart.app.KKException

Works regardless of whether module is being called by Admin or App eng.

Overrides:

getConfigurationValueAsBool in class BaseModule

Parameters:

key - the key

def - the default

Returns:

Returns the boolean value of the configuration variable

Throws:

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

getConfigurationValueAsIntWithDefault

protected int getConfigurationValueAsIntWithDefault(java.lang.String key,
                                                    int def)
                                             throws com.konakart.app.KKException

Works regardless of whether module is being called by Admin or App eng.

Overrides:

getConfigurationValueAsIntWithDefault in class BaseModule

Parameters:

key - the key

def - the def

Returns:

Returns the int value of the configuration variable

Throws:

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

setFromAddressStr

public void setFromAddressStr(java.lang.String fromAddressStr)

If it's in the format "name <abc@defg.com>" we set the name as well

Parameters:

fromAddressStr - the fromAddressStr to set

setReplyToAddressStr

public void setReplyToAddressStr(java.lang.String replyToAddressStr)

Parameters:

replyToAddressStr - the replyToAddressStr to set

deleteAttachmentFile

protected void deleteAttachmentFile()

Deletes the attachment file

getEncodedFileContent

protected java.lang.String getEncodedFileContent()
                                          throws java.io.IOException

Get the encoded file content required to send the mail

Returns:

Returns the encoded file content

Throws:

java.io.IOException - an unexpected IOException exception

getContentType

protected java.lang.String getContentType()

Get some common content types

Returns:

Returns some common attachment content types