com.konakart.json.app
Class J_EmailOptions

java.lang.Object
  com.konakart.json.app.J_EmailOptions

All Implemented Interfaces:

java.io.Serializable

public class J_EmailOptions
extends java.lang.Object
implements java.io.Serializable

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

See Also:

Serialized Form

Constructor Summary

J_EmailOptions()

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()
J_NameValue[]	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(J_NameValue[] _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.

Methods inherited from class java.lang.Object

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

Constructor Detail

J_EmailOptions

public J_EmailOptions()

Method Detail

getTemplateName

public java.lang.String getTemplateName()

The name of the template used to send the mail.

Returns:

Returns the templateName.

setTemplateName

public void setTemplateName(java.lang.String _templateName)

The name of the template used to send the mail.

Parameters:

_templateName - The templateName to set.

getCountryCode

public 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

public 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

public J_NameValue[] 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

public void setCustomAttrs(J_NameValue[] _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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public boolean isDeleteAttachmentAfterSend()

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

Returns:

the deleteAttachmentAfterSend

setDeleteAttachmentAfterSend

public 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

public java.lang.String getCustom1()

Returns:

the custom1

setCustom1

public void setCustom1(java.lang.String _custom1)

Parameters:

_custom1 - the custom1 to set

getCustom2

public java.lang.String getCustom2()

Returns:

the custom2

setCustom2

public void setCustom2(java.lang.String _custom2)

Parameters:

_custom2 - the custom2 to set

getCustom3

public java.lang.String getCustom3()

Returns:

the custom3

setCustom3

public void setCustom3(java.lang.String _custom3)

Parameters:

_custom3 - the custom3 to set

getCustomInt1

public int getCustomInt1()

Returns:

the customInt1

setCustomInt1

public void setCustomInt1(int _customInt1)

Parameters:

_customInt1 - the customInt1 to set

getCustomInt2

public int getCustomInt2()

Returns:

the customInt2

setCustomInt2

public void setCustomInt2(int _customInt2)

Parameters:

_customInt2 - the customInt2 to set