com.konakart.appif
Interface EmailOptionsIf

All Known Implementing Classes:

EmailOptions

public interface EmailOptionsIf

The interface of an object used to configure options used when sending eMails.

Method Summary

java.lang.String	getCountryCode() The two letter country code used to determine the correct template to use.
java.lang.String	getCustom1()
java.lang.String	getCustom2()
java.lang.String	getCustom3()
NameValueIf[]	getCustomAttrs() An array of name value pairs used to pass custom information to the Velocity engine.
int	getCustomInt1()
int	getCustomInt2()
java.lang.String	getFriendlyAttachmentName() The friendly filename of an attachment that can be viewed from the eMail.
java.lang.String	getFullAttachmentFilename() The complete filename of an attachment.
java.lang.String	getTemplateName() The name of the template used to send the mail.
boolean	isAttachInvoice() Set to true to attach the invoice to the email.
boolean	isCreateInvoice() Set to true to create the invoice (if it isn't already present) to attach to the email.
boolean	isDeleteAttachmentAfterSend() When set to true, the attachment is deleted after being sent.
void	setAttachInvoice(boolean attachInvoice) Set to true to attach the invoice to the email.
void	setCountryCode(java.lang.String countryCode) The two letter country code used to determine the correct template to use.
void	setCreateInvoice(boolean createInvoice) Set to true to create the invoice (if it isn't already present) to attach to the email.
void	setCustom1(java.lang.String custom1)
void	setCustom2(java.lang.String custom2)
void	setCustom3(java.lang.String custom3)
void	setCustomAttrs(NameValueIf[] customAttrs) An array of name value pairs used to pass custom information to the Velocity engine.
void	setCustomInt1(int customInt1)
void	setCustomInt2(int customInt2)
void	setDeleteAttachmentAfterSend(boolean deleteAttachmentAfterSend) When set to true, the attachment is deleted after being sent.
void	setFriendlyAttachmentName(java.lang.String friendlyAttachmentName) The friendly filename of an attachment that can be viewed from the eMail.
void	setFullAttachmentFilename(java.lang.String fullAttachmentFilename) The complete filename of an attachment.
void	setTemplateName(java.lang.String templateName) The name of the template used to send the mail.

Method Detail

getTemplateName

java.lang.String getTemplateName()

The name of the template used to send the mail.

Returns:

Returns the templateName.

setTemplateName

void setTemplateName(java.lang.String templateName)

The name of the template used to send the mail.

Parameters:

templateName - The templateName to set.

getCountryCode

java.lang.String getCountryCode()

The two letter country code used to determine the correct template to use. The naming convention for templates is templateName_countryCode.vm. e.g. EmailNewPassword_en.vm

Returns:

Returns the countryCode.

setCountryCode

void setCountryCode(java.lang.String countryCode)

The two letter country code used to determine the correct template to use. The naming convention for templates is templateName_countryCode.vm. e.g. EmailNewPassword_en.vm

Parameters:

countryCode - The countryCode to set.

getCustomAttrs

NameValueIf[] getCustomAttrs()

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.

Returns:

Returns the customAttrs.

setCustomAttrs

void setCustomAttrs(NameValueIf[] 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.

Parameters:

customAttrs - The customAttrs to set.

setAttachInvoice

void setAttachInvoice(boolean attachInvoice)

Set to true to attach the invoice to the email.

Parameters:

attachInvoice - set to true if the invoice should be attached to the email.

isAttachInvoice

boolean isAttachInvoice()

Set to true to attach the invoice to the email.

Returns:

true if the invoice should be attached to the email. If false the invoice is not attached to the email.

setCreateInvoice

void setCreateInvoice(boolean createInvoice)

Set to true to create the invoice (if it isn't already present) to attach to the email. The invoice created will be deleted after attaching to the email.

Parameters:

createInvoice - set to true if the invoice should be created (if it isn't already present) for attaching to the email.

isCreateInvoice

boolean isCreateInvoice()

Set to true to create the invoice (if it isn't already present) to attach to the email. The invoice created will be deleted after attaching to the email.

Returns:

true if the invoice should be created (if it isn't already present) for attaching to the email. If false the invoice is not created.

getFullAttachmentFilename

java.lang.String getFullAttachmentFilename()

The complete filename of an attachment. The following API calls support user defined attachments:

• sendTemplateEmailToCustomer1()
• sendWelcomeEmail1()
• sendNewPassword1()

Returns:

the fullAttachmentFilename

setFullAttachmentFilename

void setFullAttachmentFilename(java.lang.String fullAttachmentFilename)

The complete filename of an attachment. The following API calls support user defined attachments:

• sendTemplateEmailToCustomer1()
• sendWelcomeEmail1()
• sendNewPassword1()

Parameters:

fullAttachmentFilename - the fullAttachmentFilename to set

getFriendlyAttachmentName

java.lang.String getFriendlyAttachmentName()

The friendly filename of an attachment that can be viewed from the eMail. The following API calls support user defined attachments:

• sendTemplateEmailToCustomer1()
• sendWelcomeEmail1()
• sendNewPassword1()

Returns:

the friendlyAttachmentName

setFriendlyAttachmentName

void setFriendlyAttachmentName(java.lang.String friendlyAttachmentName)

The friendly filename of an attachment that can be viewed from the eMail. The following API calls support user defined attachments:

• sendTemplateEmailToCustomer1()
• sendWelcomeEmail1()
• sendNewPassword1()

Parameters:

friendlyAttachmentName - the friendlyAttachmentName to set

isDeleteAttachmentAfterSend

boolean isDeleteAttachmentAfterSend()

When set to true, the attachment is deleted after being sent. The default value is false.

Returns:

the deleteAttachmentAfterSend

setDeleteAttachmentAfterSend

void setDeleteAttachmentAfterSend(boolean deleteAttachmentAfterSend)

When set to true, the attachment is deleted after being sent. The default value is false.

Parameters:

deleteAttachmentAfterSend - the deleteAttachmentAfterSend to set

getCustom1

java.lang.String getCustom1()

Returns:

the custom1

setCustom1

void setCustom1(java.lang.String custom1)

Parameters:

custom1 - the custom1 to set

getCustom2

java.lang.String getCustom2()

Returns:

the custom2

setCustom2

void setCustom2(java.lang.String custom2)

Parameters:

custom2 - the custom2 to set

getCustom3

java.lang.String getCustom3()

Returns:

the custom3

setCustom3

void setCustom3(java.lang.String custom3)

Parameters:

custom3 - the custom3 to set

getCustomInt1

int getCustomInt1()

Returns:

the customInt1

setCustomInt1

void setCustomInt1(int customInt1)

Parameters:

customInt1 - the customInt1 to set

getCustomInt2

int getCustomInt2()

Returns:

the customInt2

setCustomInt2

void setCustomInt2(int customInt2)

Parameters:

customInt2 - the customInt2 to set