EmailOptions (KonaKart Server Engine API Documentation)

java.lang.Object
- com.konakart.app.EmailOptions

All Implemented Interfaces:

EmailOptionsIf
```
public class EmailOptions
extends java.lang.Object
implements EmailOptionsIf
```
An object used to configure options used when sending eMails.

Constructor Summary

Constructors
Constructor and Description

EmailOptions()
Constructor

Constructors
Constructor and Description
`EmailOptions()` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getBarcodeContent()` Get barcode content (raw text)
`java.lang.String`	`getBccEmails()` Semicolon separated list of blind copy email addresses.
`java.lang.String`	`getCcEmails()` Semicolon separated list of carbon copy email addresses.
`java.lang.String`	`getContent()` content.
`int`	`getContentType()` Get the Email Content Type.
`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`	`getEmailAddr()` In the case of sendTemplateEmailToCustomer1() if the customerId doesn't reference a registered customer then the email is sent to this address.
`java.lang.String`	`getFriendlyAttachmentName()` The friendly filename of an attachment that can be viewed from the eMail.
`java.lang.String`	`getFromAddress()` If the from Address is null the fromAddress defined in the store's configuration parameter will be used.
`java.lang.String`	`getFullAttachmentFilename()` The complete filename of an attachment.
`java.lang.String`	`getReplyToAddress()` If the Reply To Address is null the rpleyToAddress defined in the store's configuration parameter will be used.
`java.lang.String`	`getSubject()` subject.
`java.lang.String`	`getTemplateName()` The name of the template used to send the mail.
`java.lang.String`	`getToAddress()` toAddress.
`boolean`	`isAsync()` Set to true to send email asynchronously
`boolean`	`isAttachInvoice()` Set to true to attach the invoice to the email.
`boolean`	`isCreateBarcode()` Set to true to create the barcode to print on 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.
`boolean`	`isDoBlindCopy()` Set to true to BCC an address
`void`	`setAsync(boolean async)` Set to true to send email asynchronously
`void`	`setAttachInvoice(boolean attachInvoice)` Set to true to attach the invoice to the email.
`void`	`setBarcodeContent(java.lang.String barcodeContent)` Set barcode content (raw text)
`void`	`setBccEmails(java.lang.String bccEmails)` Semicolon separated list of blind copy email addresses.
`void`	`setCcEmails(java.lang.String ccEmails)` Semicolon separated list of carbon copy email addresses.
`void`	`setContent(java.lang.String content)` content.
`void`	`setContentType(int contentType)` Set the Email Content Type.
`void`	`setCountryCode(java.lang.String countryCode)` The two letter country code used to determine the correct template to use.
`void`	`setCreateBarcode(boolean createBarcode)` Set to true to create the barcode to print on the email.
`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`	`setDoBlindCopy(boolean doBlindCopy)` Set to true to BCC an address
`void`	`setEmailAddr(java.lang.String emailAddr)` In the case of sendTemplateEmailToCustomer1() if the customerId doesn't reference a registered customer then the email is sent to this address.
`void`	`setFriendlyAttachmentName(java.lang.String friendlyAttachmentName)` The friendly filename of an attachment that can be viewed from the eMail.
`void`	`setFromAddress(java.lang.String fromAddress)` If the from Address is null the fromAddress defined in the store's configuration parameter will be used.
`void`	`setFullAttachmentFilename(java.lang.String fullAttachmentFilename)` The complete filename of an attachment.
`void`	`setReplyToAddress(java.lang.String replyToAddress)` If the Reply To Address is null the rpleyToAddress defined in the store's configuration parameter will be used.
`void`	`setSubject(java.lang.String subject)` subject.
`void`	`setTemplateName(java.lang.String templateName)` The name of the template used to send the mail.
`void`	`setToAddress(java.lang.String toAddress)` toAddress.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - EmailOptions
```
public EmailOptions()
```
    Constructor
- Method Detail
  - getTemplateName
```
public java.lang.String getTemplateName()
```
    Description copied from interface: EmailOptionsIf
    
    The name of the template used to send the mail.
    
    Specified by:
    
    getTemplateName in interface EmailOptionsIf
    
    Returns:
    
    Returns the templateName.
  - setTemplateName
```
public void setTemplateName(java.lang.String templateName)
```
    Description copied from interface: EmailOptionsIf
    
    The name of the template used to send the mail.
    
    Specified by:
    
    setTemplateName in interface EmailOptionsIf
    
    Parameters:
    
    templateName - The templateName to set.
  - getCountryCode
```
public java.lang.String getCountryCode()
```
    Description copied from interface: EmailOptionsIf
    
    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
    
    Specified by:
    
    getCountryCode in interface EmailOptionsIf
    
    Returns:
    
    Returns the countryCode.
  - setCountryCode
```
public void setCountryCode(java.lang.String countryCode)
```
    Description copied from interface: EmailOptionsIf
    
    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
    
    Specified by:
    
    setCountryCode in interface EmailOptionsIf
    
    Parameters:
    
    countryCode - The countryCode to set.
  - getContentType
```
public int getContentType()
```
    Description copied from interface: EmailOptionsIf
    Get the Email Content Type. Options are:
    - KKConstants.NOT_SET (-1 the default)
    - KKConstants.EMAIL_AS_HTML (1)
    - KKConstants.EMAIL_AS_PLAIN_TEXT (2)
    Specified by:
    
    getContentType in interface EmailOptionsIf
    
    Returns:
    
    the contentType
  - setContentType
```
public void setContentType(int contentType)
```
    Description copied from interface: EmailOptionsIf
    Set the Email Content Type. Options are:
    - KKConstants.NOT_SET (-1 the default)
    - KKConstants.EMAIL_AS_HTML (1)
    - KKConstants.EMAIL_AS_PLAIN_TEXT (2)
    Specified by:
    
    setContentType in interface EmailOptionsIf
    
    Parameters:
    
    contentType - the contentType to set
  - getCustomAttrs
```
public NameValueIf[] getCustomAttrs()
```
    Description copied from interface: EmailOptionsIf
    
    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.
    
    Specified by:
    
    getCustomAttrs in interface EmailOptionsIf
    
    Returns:
    
    Returns the customAttrs.
  - setCustomAttrs
```
public void setCustomAttrs(NameValueIf[] customAttrs)
```
    Description copied from interface: EmailOptionsIf
    
    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.
    
    Specified by:
    
    setCustomAttrs in interface EmailOptionsIf
    
    Parameters:
    
    customAttrs - The customAttrs to set.
  - isAttachInvoice
```
public boolean isAttachInvoice()
```
    Description copied from interface: EmailOptionsIf
    
    Set to true to attach the invoice to the email.
    
    Specified by:
    
    isAttachInvoice in interface EmailOptionsIf
    
    Returns:
    
    the attachInvoice
  - setAttachInvoice
```
public void setAttachInvoice(boolean attachInvoice)
```
    Description copied from interface: EmailOptionsIf
    
    Set to true to attach the invoice to the email.
    
    Specified by:
    
    setAttachInvoice in interface EmailOptionsIf
    
    Parameters:
    
    attachInvoice - the attachInvoice to set
  - isCreateInvoice
```
public boolean isCreateInvoice()
```
    Description copied from interface: EmailOptionsIf
    
    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.
    
    Specified by:
    
    isCreateInvoice in interface EmailOptionsIf
    
    Returns:
    
    the createInvoice
  - setCreateInvoice
```
public void setCreateInvoice(boolean createInvoice)
```
    Description copied from interface: EmailOptionsIf
    
    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.
    
    Specified by:
    
    setCreateInvoice in interface EmailOptionsIf
    
    Parameters:
    
    createInvoice - the createInvoice to set
  - getFullAttachmentFilename
```
public java.lang.String getFullAttachmentFilename()
```
    Description copied from interface: EmailOptionsIf
    The complete filename of an attachment. The following API calls support user defined attachments:
    - sendTemplateEmailToCustomer1()
    - sendWelcomeEmail1()
    - sendNewPassword1()
    Specified by:
    
    getFullAttachmentFilename in interface EmailOptionsIf
    
    Returns:
    
    the fullAttachmentFilename
  - setFullAttachmentFilename
```
public void setFullAttachmentFilename(java.lang.String fullAttachmentFilename)
```
    Description copied from interface: EmailOptionsIf
    The complete filename of an attachment. The following API calls support user defined attachments:
    - sendTemplateEmailToCustomer1()
    - sendWelcomeEmail1()
    - sendNewPassword1()
    Specified by:
    
    setFullAttachmentFilename in interface EmailOptionsIf
    
    Parameters:
    
    fullAttachmentFilename - the fullAttachmentFilename to set
  - getFriendlyAttachmentName
```
public java.lang.String getFriendlyAttachmentName()
```
    Description copied from interface: EmailOptionsIf
    The friendly filename of an attachment that can be viewed from the eMail. The following API calls support user defined attachments:
    - sendTemplateEmailToCustomer1()
    - sendWelcomeEmail1()
    - sendNewPassword1()
    Specified by:
    
    getFriendlyAttachmentName in interface EmailOptionsIf
    
    Returns:
    
    the friendlyAttachmentName
  - setFriendlyAttachmentName
```
public void setFriendlyAttachmentName(java.lang.String friendlyAttachmentName)
```
    Description copied from interface: EmailOptionsIf
    The friendly filename of an attachment that can be viewed from the eMail. The following API calls support user defined attachments:
    - sendTemplateEmailToCustomer1()
    - sendWelcomeEmail1()
    - sendNewPassword1()
    Specified by:
    
    setFriendlyAttachmentName in interface EmailOptionsIf
    
    Parameters:
    
    friendlyAttachmentName - the friendlyAttachmentName to set
  - isDeleteAttachmentAfterSend
```
public boolean isDeleteAttachmentAfterSend()
```
    Description copied from interface: EmailOptionsIf
    
    When set to true, the attachment is deleted after being sent. The default value is false.
    
    Specified by:
    
    isDeleteAttachmentAfterSend in interface EmailOptionsIf
    
    Returns:
    
    the deleteAttachmentAfterSend
  - setDeleteAttachmentAfterSend
```
public void setDeleteAttachmentAfterSend(boolean deleteAttachmentAfterSend)
```
    Description copied from interface: EmailOptionsIf
    
    When set to true, the attachment is deleted after being sent. The default value is false.
    
    Specified by:
    
    setDeleteAttachmentAfterSend in interface EmailOptionsIf
    
    Parameters:
    
    deleteAttachmentAfterSend - the deleteAttachmentAfterSend to set
  - getCustom1
```
public java.lang.String getCustom1()
```
    Specified by:
    
    getCustom1 in interface EmailOptionsIf
    
    Returns:
    
    the custom1
  - setCustom1
```
public void setCustom1(java.lang.String custom1)
```
    Specified by:
    
    setCustom1 in interface EmailOptionsIf
    
    Parameters:
    
    custom1 - the custom1 to set
  - getCustom2
```
public java.lang.String getCustom2()
```
    Specified by:
    
    getCustom2 in interface EmailOptionsIf
    
    Returns:
    
    the custom2
  - setCustom2
```
public void setCustom2(java.lang.String custom2)
```
    Specified by:
    
    setCustom2 in interface EmailOptionsIf
    
    Parameters:
    
    custom2 - the custom2 to set
  - getCustom3
```
public java.lang.String getCustom3()
```
    Specified by:
    
    getCustom3 in interface EmailOptionsIf
    
    Returns:
    
    the custom3
  - setCustom3
```
public void setCustom3(java.lang.String custom3)
```
    Specified by:
    
    setCustom3 in interface EmailOptionsIf
    
    Parameters:
    
    custom3 - the custom3 to set
  - getCustomInt1
```
public int getCustomInt1()
```
    Specified by:
    
    getCustomInt1 in interface EmailOptionsIf
    
    Returns:
    
    the customInt1
  - setCustomInt1
```
public void setCustomInt1(int customInt1)
```
    Specified by:
    
    setCustomInt1 in interface EmailOptionsIf
    
    Parameters:
    
    customInt1 - the customInt1 to set
  - getCustomInt2
```
public int getCustomInt2()
```
    Specified by:
    
    getCustomInt2 in interface EmailOptionsIf
    
    Returns:
    
    the customInt2
  - setCustomInt2
```
public void setCustomInt2(int customInt2)
```
    Specified by:
    
    setCustomInt2 in interface EmailOptionsIf
    
    Parameters:
    
    customInt2 - the customInt2 to set
  - getFromAddress
```
public java.lang.String getFromAddress()
```
    Description copied from interface: EmailOptionsIf
    
    If the from Address is null the fromAddress defined in the store's configuration parameter will be used.
    
    Specified by:
    
    getFromAddress in interface EmailOptionsIf
    
    Returns:
    
    the fromAddress as a String
  - setFromAddress
```
public void setFromAddress(java.lang.String fromAddress)
```
    Description copied from interface: EmailOptionsIf
    
    If the from Address is null the fromAddress defined in the store's configuration parameter will be used.
    
    Specified by:
    
    setFromAddress in interface EmailOptionsIf
    
    Parameters:
    
    fromAddress - the fromAddress as a String to set
  - getReplyToAddress
```
public java.lang.String getReplyToAddress()
```
    Description copied from interface: EmailOptionsIf
    
    If the Reply To Address is null the rpleyToAddress defined in the store's configuration parameter will be used.
    
    Specified by:
    
    getReplyToAddress in interface EmailOptionsIf
    
    Returns:
    
    the replyToAddress as a String
  - setReplyToAddress
```
public void setReplyToAddress(java.lang.String replyToAddress)
```
    Description copied from interface: EmailOptionsIf
    
    If the Reply To Address is null the rpleyToAddress defined in the store's configuration parameter will be used.
    
    Specified by:
    
    setReplyToAddress in interface EmailOptionsIf
    
    Parameters:
    
    replyToAddress - the replyToAddress as a String to set
  - getBccEmails
```
public java.lang.String getBccEmails()
```
    Description copied from interface: EmailOptionsIf
    
    Semicolon separated list of blind copy email addresses. When set, these will be used rather than the ones that may be present in a configuration variable.
    
    Specified by:
    
    getBccEmails in interface EmailOptionsIf
    
    Returns:
    
    the bccEmails
  - setBccEmails
```
public void setBccEmails(java.lang.String bccEmails)
```
    Description copied from interface: EmailOptionsIf
    
    Semicolon separated list of blind copy email addresses. When set, these will be used rather than the ones that may be present in a configuration variable.
    
    Specified by:
    
    setBccEmails in interface EmailOptionsIf
    
    Parameters:
    
    bccEmails - the bccEmails to set
  - getEmailAddr
```
public java.lang.String getEmailAddr()
```
    Description copied from interface: EmailOptionsIf
    
    In the case of sendTemplateEmailToCustomer1() if the customerId doesn't reference a registered customer then the email is sent to this address.
    
    Specified by:
    
    getEmailAddr in interface EmailOptionsIf
    
    Returns:
    
    the emailAddr
  - setEmailAddr
```
public void setEmailAddr(java.lang.String emailAddr)
```
    Description copied from interface: EmailOptionsIf
    
    In the case of sendTemplateEmailToCustomer1() if the customerId doesn't reference a registered customer then the email is sent to this address.
    
    Specified by:
    
    setEmailAddr in interface EmailOptionsIf
    
    Parameters:
    
    emailAddr - the emailAddr to set
  - isDoBlindCopy
```
public boolean isDoBlindCopy()
```
    Description copied from interface: EmailOptionsIf
    
    Set to true to BCC an address
    
    Specified by:
    
    isDoBlindCopy in interface EmailOptionsIf
    
    Returns:
    
    the doBlindCopy
  - setDoBlindCopy
```
public void setDoBlindCopy(boolean doBlindCopy)
```
    Description copied from interface: EmailOptionsIf
    
    Set to true to BCC an address
    
    Specified by:
    
    setDoBlindCopy in interface EmailOptionsIf
    
    Parameters:
    
    doBlindCopy - the doBlindCopy to set
  - isAsync
```
public boolean isAsync()
```
    Description copied from interface: EmailOptionsIf
    
    Set to true to send email asynchronously
    
    Specified by:
    
    isAsync in interface EmailOptionsIf
    
    Returns:
    
    the async
  - setAsync
```
public void setAsync(boolean async)
```
    Description copied from interface: EmailOptionsIf
    
    Set to true to send email asynchronously
    
    Specified by:
    
    setAsync in interface EmailOptionsIf
    
    Parameters:
    
    async - the async to set
  - getToAddress
```
public java.lang.String getToAddress()
```
    Description copied from interface: EmailOptionsIf
    
    toAddress.
    
    Specified by:
    
    getToAddress in interface EmailOptionsIf
    
    Returns:
    
    the toAddress
  - setToAddress
```
public void setToAddress(java.lang.String toAddress)
```
    Description copied from interface: EmailOptionsIf
    
    toAddress.
    
    Specified by:
    
    setToAddress in interface EmailOptionsIf
    
    Parameters:
    
    toAddress - the toAddress to set
  - getCcEmails
```
public java.lang.String getCcEmails()
```
    Description copied from interface: EmailOptionsIf
    
    Semicolon separated list of carbon copy email addresses.
    
    Specified by:
    
    getCcEmails in interface EmailOptionsIf
    
    Returns:
    
    the ccEmails
  - setCcEmails
```
public void setCcEmails(java.lang.String ccEmails)
```
    Description copied from interface: EmailOptionsIf
    
    Semicolon separated list of carbon copy email addresses.
    
    Specified by:
    
    setCcEmails in interface EmailOptionsIf
    
    Parameters:
    
    ccEmails - the ccEmails to set
  - getContent
```
public java.lang.String getContent()
```
    Description copied from interface: EmailOptionsIf
    
    content.
    
    Specified by:
    
    getContent in interface EmailOptionsIf
    
    Returns:
    
    the content
  - setContent
```
public void setContent(java.lang.String content)
```
    Description copied from interface: EmailOptionsIf
    
    content.
    
    Specified by:
    
    setContent in interface EmailOptionsIf
    
    Parameters:
    
    content - the content to set
  - getSubject
```
public java.lang.String getSubject()
```
    Description copied from interface: EmailOptionsIf
    
    subject.
    
    Specified by:
    
    getSubject in interface EmailOptionsIf
    
    Returns:
    
    the subject
  - setSubject
```
public void setSubject(java.lang.String subject)
```
    Description copied from interface: EmailOptionsIf
    
    subject.
    
    Specified by:
    
    setSubject in interface EmailOptionsIf
    
    Parameters:
    
    subject - the subject to set
  - isCreateBarcode
```
public boolean isCreateBarcode()
```
    Description copied from interface: EmailOptionsIf
    
    Set to true to create the barcode to print on the email.
    
    Specified by:
    
    isCreateBarcode in interface EmailOptionsIf
    
    Returns:
    
    the createBarcode
  - setCreateBarcode
```
public void setCreateBarcode(boolean createBarcode)
```
    Description copied from interface: EmailOptionsIf
    
    Set to true to create the barcode to print on the email.
    
    Specified by:
    
    setCreateBarcode in interface EmailOptionsIf
    
    Parameters:
    
    createBarcode - the createBarcode to set
  - setBarcodeContent
```
public void setBarcodeContent(java.lang.String barcodeContent)
```
    Set barcode content (raw text)
    
    Specified by:
    
    setBarcodeContent in interface EmailOptionsIf
    
    Parameters:
    
    barcodeContent - the barcode content to set.
  - getBarcodeContent
```
public java.lang.String getBarcodeContent()
```
    Get barcode content (raw text)
    
    Specified by:
    
    getBarcodeContent in interface EmailOptionsIf
    
    Returns:
    
    the barcode content.

Class EmailOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EmailOptions

Method Detail

getTemplateName

setTemplateName

getCountryCode

setCountryCode

getContentType

setContentType

getCustomAttrs

setCustomAttrs

isAttachInvoice

setAttachInvoice

isCreateInvoice

setCreateInvoice

getFullAttachmentFilename

setFullAttachmentFilename

getFriendlyAttachmentName

setFriendlyAttachmentName

isDeleteAttachmentAfterSend

setDeleteAttachmentAfterSend

getCustom1

setCustom1

getCustom2

setCustom2

getCustom3

setCustom3

getCustomInt1

setCustomInt1

getCustomInt2

setCustomInt2

getFromAddress

setFromAddress

getReplyToAddress

setReplyToAddress

getBccEmails

setBccEmails

getEmailAddr

setEmailAddr

isDoBlindCopy

setDoBlindCopy

isAsync

setAsync

getToAddress

setToAddress

getCcEmails

setCcEmails

getContent

setContent

getSubject

setSubject

isCreateBarcode

setCreateBarcode

setBarcodeContent

getBarcodeContent