com.konakartadmin.blif

Interface AdminEmailMgrIf

All Known Implementing Classes:

AdminEmailMgr

public interface AdminEmailMgrIf

AdminEmailMgrIf

Method Summary

Modifier and Type	Method and Description
com.konakart.bl.Emailer	getEmailer()
org.apache.velocity.VelocityContext	getVelocityContext() Returns the Velocity Context
void	notifySysAdmin(java.lang.String message, AdminEmailOptions options) This method is used to send a template based eMail to the System Administrator.
void	refreshConfigs() Refresh the configuration of the Admin Email Manager
boolean	sendEmail(AdminEmail adminEmailData) To send an email
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	sendNewPasswordEmail(java.lang.String emailAddr, java.lang.String newPassword, java.lang.String mailSubject, 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.
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 options) 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.

Method Detail

sendEmail

boolean sendEmail(AdminEmail adminEmailData)
           throws KKAdminException

To send an email

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

sendNewPasswordEmail

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

Deprecated.

Send out an email notifying a user of a new password

Parameters:

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

newPassword - the new password that was randomly generated

mailSubject - 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

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

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

sendHTML

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.

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

sendText

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.

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

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.

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

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.

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

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.

Parameters:

order - the order that has a changed status

state - the state of the order

Throws:

java.lang.Exception - an unexpected exception

sendStatusChangeEmail

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

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

Parameters:

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

Throws:

java.lang.Exception - an unexpected exception

getEmailer

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

Returns:

Returns a new Emailer.

Throws:

KKAdminException - an unexpected KKAdminException exception

sendTemplateEmail

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 options)
                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.

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".

options - the options

Throws:

java.lang.Exception - an unexpected exception

notifySysAdmin

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

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

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

getVelocityContext

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

Returns the Velocity Context

Returns:

Returns a VelocityContext

Throws:

java.lang.Exception - an unexpected exception

refreshConfigs

void refreshConfigs()
             throws java.lang.Exception

Refresh the configuration of the Admin Email Manager

Throws:

java.lang.Exception - an unexpected exception