com.konakart.blif

Interface EmailMgrIf

All Known Implementing Classes:

EmailMgr, EmailMgrWond

public interface EmailMgrIf

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

Method Summary

Modifier and Type	Method and Description
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
EmailIf	notifySysAdmin(java.lang.String message, EmailOptionsIf options)
void	refreshConfigs() Setup variables needed to send the mail
void	sendHTML(EmailOptionsIf options) Send a HTML-only email message to the specified recipient, with the options all specified in the EmailOptions object.
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 fromAddressString, 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 and from address, 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 doBlindCopy, java.lang.String bccEmails, boolean async) Send a HTML-only email message to the specified recipient and from address, 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
EmailIf	sendTemplateEmailTo(int customerId, java.lang.String message, EmailOptionsIf options) Used to send a template based email to a receiver
void	sendTemplateEmailToCustomer(int customerId, java.lang.String templateName, java.lang.String message, java.lang.String countryCode) Deprecated.
void	sendText(EmailOptionsIf options) Send a Text email message to the specified recipient, with the options all specified in the EmailOptions object.
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 theSubject, java.lang.String theContentText, boolean doBlindCopy, java.lang.String bccEmails, boolean async) Send a text-only email message to the specified recipient and from Address 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 and from Address 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 - an unexpected exception

sendHTML

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

Send a HTML-only email message to the specified recipient, with the options all specified in the EmailOptions object.

Parameters:

options - Email Options

Throws:

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

sendHTML

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

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

Parameters:

toAddressString - TO: address

fromAddressString - From address - if null the store default is used

replyToAddressString - Reply To address - if null the store default is used

theSubject - the subject line

theContentHTML - the HTML body of the email

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

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:

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

sendHTML

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

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

Parameters:

toAddressString - TO: address

fromAddressString - From address - if null the store default is used

theSubject - the subject line

theContentHTML - the HTML body of the email

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

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:

com.konakart.app.KKException - an unexpected KKException 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 com.konakart.app.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.

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:

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

sendText

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

Send a Text email message to the specified recipient, with the options all specified in the EmailOptions object.

Parameters:

options - Email Options

Throws:

com.konakart.app.KKException - an unexpected KKException 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 com.konakart.app.KKException

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

Parameters:

toAddressString - TO: address

fromAddressString - From address - if null the store default is used

replyToAddressString - Reply To address - if null the store default is used

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.

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:

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

sendText

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

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

Parameters:

toAddressString - TO: address

fromAddressString - From address - if null the store default is used

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.

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:

com.konakart.app.KKException - an unexpected KKException 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 com.konakart.app.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.

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:

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

isEmailValid

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.

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.

Please use sendNewPasswordEmail1()

Parameters:

emailAddr - the emailAddr

newPassword - the newPassword

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

countryCode - the countryCode

Throws:

java.lang.Exception - an unexpected 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 - the emailAddr

newPassword - the newPassword

cust - the cust

options - the options

Returns:

Returns an EmailIf object

Throws:

java.lang.Exception - an unexpected 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 - the emailAddr

productName - the productName

productQuantity - the productQuantity

productId - the productId

sku - the sku

Throws:

java.lang.Exception - an unexpected exception

sendWelcomeEmail

@Deprecated
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 - the customerId

mailSubject - the email subject line. If null it is retrieved from the first line of the template.

countryCode - the countryCode

Throws:

java.lang.Exception - an unexpected exception

sendWelcomeEmail1

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

A welcome email is sent after registration

Parameters:

customerId - the customerId

options - the options

Returns:

Returns an Email object

Throws:

java.lang.Exception - an unexpected exception

sendOrderConfirmationEmail

@Deprecated
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 - the sessionId

orderId - the orderId

mailSubject - the email subject line. If null it is retrieved from the first line of the template.

languageId - the languageId

Throws:

java.lang.Exception - an unexpected 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 - the sessionId

orderId - the orderId

langIdForOrder - the langIdForOrder

options - the options

Returns:

Returns an Email object

Throws:

java.lang.Exception - an unexpected exception

sendTemplateEmailToCustomer

@Deprecated
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 - the customerId

templateName - the templateName

message - the message

countryCode - the countryCode

Throws:

java.lang.Exception - an unexpected exception

sendTemplateEmailTo

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

Used to send a template based email to a receiver

Parameters:

customerId - the customerId

message - the message

options - the options

Returns:

Returns an Email object

Throws:

java.lang.Exception - an unexpected exception

notifySysAdmin

EmailIf notifySysAdmin(java.lang.String message,
                       EmailOptionsIf options)
                throws java.lang.Exception

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

Returns:

Returns an Email object

Throws:

java.lang.Exception - an unexpected exception

getEmailer

Emailer getEmailer()
            throws com.konakart.app.KKException

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

Returns:

Returns a new Emailer.

Throws:

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