EmailOptionsIf (KonaKart Server Engine API Documentation)

All Known Implementing Classes:

EmailOptions
```
public interface EmailOptionsIf
```
The interface of an object used to configure options used when sending eMails.

Method Summary

All Methods Instance Methods Abstract 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.

- 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.
  - getContentType
```
int getContentType()
```
    Get the Email Content Type. Options are:
    - KKConstants.NOT_SET (-1 the default)
    - KKConstants.EMAIL_AS_HTML (1)
    - KKConstants.EMAIL_AS_PLAIN_TEXT (2)
    Returns:
    
    the contentType
  - setContentType
```
void setContentType(int contentType)
```
    Set the Email Content Type. Options are:
    - KKConstants.NOT_SET (-1 the default)
    - KKConstants.EMAIL_AS_HTML (1)
    - KKConstants.EMAIL_AS_PLAIN_TEXT (2)
    Parameters:
    
    contentType - the contentType 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
  - getSubject
```
java.lang.String getSubject()
```
    subject.
    
    Returns:
    
    the subject as a String
  - setSubject
```
void setSubject(java.lang.String subject)
```
    subject.
    
    Parameters:
    
    subject - the subject as a String to set
  - getContent
```
java.lang.String getContent()
```
    content.
    
    Returns:
    
    the content for the email as a String
  - setContent
```
void setContent(java.lang.String content)
```
    content.
    
    Parameters:
    
    content - the content for the email as a String to set
  - getToAddress
```
java.lang.String getToAddress()
```
    toAddress.
    
    Returns:
    
    the toAddress as a String
  - setToAddress
```
void setToAddress(java.lang.String toAddress)
```
    toAddress.
    
    Parameters:
    
    toAddress - the toAddress as a String to set. This can be set to one or more email addresses. If there two or more the addresses must be separated with a semicolon.
  - getFromAddress
```
java.lang.String getFromAddress()
```
    If the from Address is null the fromAddress defined in the store's configuration parameter will be used.
    
    Returns:
    
    the fromAddress as a String
  - setFromAddress
```
void setFromAddress(java.lang.String fromAddress)
```
    If the from Address is null the fromAddress defined in the store's configuration parameter will be used.
    
    Parameters:
    
    fromAddress - the fromAddress as a String to set
  - getReplyToAddress
```
java.lang.String getReplyToAddress()
```
    If the Reply To Address is null the rpleyToAddress defined in the store's configuration parameter will be used.
    
    Returns:
    
    the replyToAddress as a String
  - setReplyToAddress
```
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.
    
    Parameters:
    
    replyToAddress - the replyToAddress as a String to set
  - getCcEmails
```
java.lang.String getCcEmails()
```
    Semicolon separated list of carbon copy email addresses.
    
    Returns:
    
    the ccEmails
  - setCcEmails
```
void setCcEmails(java.lang.String ccEmails)
```
    Semicolon separated list of carbon copy email addresses.
    
    Parameters:
    
    ccEmails - the ccEmails to set
  - getBccEmails
```
java.lang.String getBccEmails()
```
    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.
    
    Returns:
    
    the bccEmails
  - setDoBlindCopy
```
void setDoBlindCopy(boolean doBlindCopy)
```
    Set to true to BCC an address
    
    Parameters:
    
    doBlindCopy - the doBlindCopy to set
  - isDoBlindCopy
```
boolean isDoBlindCopy()
```
    Set to true to BCC an address
    
    Returns:
    
    the doBlindCopy
  - setAsync
```
void setAsync(boolean async)
```
    Set to true to send email asynchronously
    
    Parameters:
    
    async - the async to set
  - isAsync
```
boolean isAsync()
```
    Set to true to send email asynchronously
    
    Returns:
    
    the async
  - setBccEmails
```
void setBccEmails(java.lang.String bccEmails)
```
    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.
    
    Parameters:
    
    bccEmails - the bccEmails 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
  - getEmailAddr
```
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.
    
    Returns:
    
    the emailAddr
  - setEmailAddr
```
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.
    
    Parameters:
    
    emailAddr - the emailAddr to set
  - setCreateBarcode
```
void setCreateBarcode(boolean createBarcode)
```
    Set to true to create the barcode to print on the email.
    
    Parameters:
    
    createBarcode - set to true if the barcode should be created for printing on the email.
  - isCreateBarcode
```
boolean isCreateBarcode()
```
    Set to true to create the barcode to print on the email.
    
    Returns:
    
    true if the barcode should be created for printing on the email. If false the barcode is not created.
  - setBarcodeContent
```
void setBarcodeContent(java.lang.String barcodeContent)
```
    Set barcode content (raw text)
    
    Parameters:
    
    barcodeContent - the barcode content to set.
  - getBarcodeContent
```
java.lang.String getBarcodeContent()
```
    Get barcode content (raw text)
    
    Returns:
    
    the barcode content.

Interface EmailOptionsIf

Method Summary

Method Detail

getTemplateName

setTemplateName

getCountryCode

setCountryCode

getContentType

setContentType

getCustomAttrs

setCustomAttrs

setAttachInvoice

isAttachInvoice

setCreateInvoice

isCreateInvoice

getFullAttachmentFilename

setFullAttachmentFilename

getFriendlyAttachmentName

setFriendlyAttachmentName

isDeleteAttachmentAfterSend

setDeleteAttachmentAfterSend

getSubject

setSubject

getContent

setContent

getToAddress

setToAddress

getFromAddress

setFromAddress

getReplyToAddress

setReplyToAddress

getCcEmails

setCcEmails

getBccEmails

setDoBlindCopy

isDoBlindCopy

setAsync

isAsync

setBccEmails

getCustom1

setCustom1

getCustom2

setCustom2

getCustom3

setCustom3

getCustomInt1

setCustomInt1

getCustomInt2

setCustomInt2

getEmailAddr

setEmailAddr

setCreateBarcode

isCreateBarcode

setBarcodeContent

getBarcodeContent