com.konakart.blif
Interface EmailMgrIf

All Known Implementing Classes:

EmailMgr

public interface EmailMgrIf

EmailMgrIf Interface which an implementation of this manager must adhere to.

Method Summary

Emailer	getEmailer() Used to get a new Emailer object used to send the E mails
boolean	isEmailValid(java.lang.String emailAddr) Determines whether the eMail address is valid
void	refreshConfigs() Setup variables needed to send the mail
void	sendHTML(java.lang.String toAddressString, java.lang.String theSubject, java.lang.String theContentHTML, boolean doBlindCopy, 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.
EmailIf	sendNewPasswordEmail1(java.lang.String emailAddr, java.lang.String newPassword, Customer cust, EmailOptionsIf options) Sends a new password to user who has forgotten password.
void	sendOrderConfirmationEmail(java.lang.String sessionId, int orderId, java.lang.String mailSubject, int languageId) Deprecated.
EmailIf	sendOrderConfirmationEmail1(java.lang.String sessionId, int orderId, int langIdForOrder, EmailOptionsIf options) An order confirmation email is sent after submitting an order.
void	sendStockReorderEmail(java.lang.String emailAddr, java.lang.String productName, int productQuantity, int productId, java.lang.String sku) Send an email to warn that a product stock level has fallen below a pre-defined level
void	sendTemplateEmailToCustomer(int customerId, java.lang.String templateName, java.lang.String message, java.lang.String countryCode) Deprecated.
EmailIf	sendTemplateEmailToCustomer1(int customerId, java.lang.String message, EmailOptionsIf options) Used to send a template based email to a customer
void	sendText(java.lang.String toAddressString, java.lang.String theSubject, java.lang.String theContentText, boolean doBlindCopy, boolean async) Send a text-only email message to the specified recipient, with the specified subject and text content.
void	sendWelcomeEmail(int customerId, java.lang.String mailSubject, java.lang.String countryCode) Deprecated.
EmailIf	sendWelcomeEmail1(int customerId, EmailOptionsIf options) A welcome email is sent after registration

Method Detail

refreshConfigs

void refreshConfigs()
                    throws java.lang.Exception

Setup variables needed to send the mail

Throws:

java.lang.Exception

sendHTML

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

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

Parameters:

toAddressString - TO: address

theSubject - the subject line

theContentHTML - the HTML body of the email

doBlindCopy - if true add the defined Blind Copy address, if false do not.

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

Throws:

KKException

sendText

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

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

Parameters:

toAddressString - TO: address

theSubject - the subject line

theContentText - the plan text body of the mail

doBlindCopy - if true add the defined Blind Copy address, if false do not.

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

Throws:

KKException

isEmailValid

boolean isEmailValid(java.lang.String emailAddr)

Determines whether the eMail address is valid

Parameters:

emailAddr -

Returns:

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

sendNewPasswordEmail

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

Deprecated.

Please use sendNewPasswordEmail1()

Parameters:

emailAddr -

newPassword -

mailSubject -

countryCode -

Throws:

java.lang.Exception

sendNewPasswordEmail1

EmailIf sendNewPasswordEmail1(java.lang.String emailAddr,
                              java.lang.String newPassword,
                              Customer cust,
                              EmailOptionsIf options)
                              throws java.lang.Exception

Sends a new password to user who has forgotten password.

Parameters:

emailAddr -

newPassword -

cust -

options -

Returns:

Returns an EmailIf object

Throws:

java.lang.Exception

sendStockReorderEmail

void sendStockReorderEmail(java.lang.String emailAddr,
                           java.lang.String productName,
                           int productQuantity,
                           int productId,
                           java.lang.String sku)
                           throws java.lang.Exception

Send an email to warn that a product stock level has fallen below a pre-defined level

Parameters:

emailAddr -

productName -

productQuantity -

productId -

sku -

Throws:

java.lang.Exception

sendWelcomeEmail

void sendWelcomeEmail(int customerId,
                      java.lang.String mailSubject,
                      java.lang.String countryCode)
                      throws java.lang.Exception

Deprecated.

A welcome email is sent after registration

Parameters:

customerId -

mailSubject -

countryCode -

Throws:

java.lang.Exception

sendWelcomeEmail1

EmailIf sendWelcomeEmail1(int customerId,
                          EmailOptionsIf options)
                          throws java.lang.Exception

A welcome email is sent after registration

Parameters:

customerId -

options -

Returns:

Returns an Email object

Throws:

java.lang.Exception

sendOrderConfirmationEmail

void sendOrderConfirmationEmail(java.lang.String sessionId,
                                int orderId,
                                java.lang.String mailSubject,
                                int languageId)
                                throws java.lang.Exception

Deprecated.

An order confirmation email is sent after submitting an order.

Parameters:

sessionId -

orderId -

mailSubject -

languageId -

Throws:

java.lang.Exception

sendOrderConfirmationEmail1

EmailIf sendOrderConfirmationEmail1(java.lang.String sessionId,
                                    int orderId,
                                    int langIdForOrder,
                                    EmailOptionsIf options)
                                    throws java.lang.Exception

An order confirmation email is sent after submitting an order.

Parameters:

sessionId -

orderId -

langIdForOrder -

options -

Returns:

Returns an Email object

Throws:

java.lang.Exception

sendTemplateEmailToCustomer

void sendTemplateEmailToCustomer(int customerId,
                                 java.lang.String templateName,
                                 java.lang.String message,
                                 java.lang.String countryCode)
                                 throws java.lang.Exception

Deprecated.

Used to send a template based email to a customer

Parameters:

customerId -

templateName -

message -

countryCode -

Throws:

java.lang.Exception

sendTemplateEmailToCustomer1

EmailIf sendTemplateEmailToCustomer1(int customerId,
                                     java.lang.String message,
                                     EmailOptionsIf options)
                                     throws java.lang.Exception

Used to send a template based email to a customer

Parameters:

customerId -

message -

options -

Returns:

Returns an Email object

Throws:

java.lang.Exception

getEmailer

Emailer getEmailer()
                   throws KKException

Used to get a new Emailer object used to send the E mails

Returns:

Returns a new Emailer.

Throws:

KKException