AdminEmailOptions (KonaKartAdmin API Documentation)

java.lang.Object
- com.konakartadmin.app.AdminEmailOptions

```
public class AdminEmailOptions
extends java.lang.Object
```
An object used to configure options used when sending eMails from the AdminApp

Field Summary

Fields
Modifier and Type	Field and Description
`private java.lang.String`	`bccEmails`
`private int`	`contentType`
`private java.lang.String`	`countryCode`
`private java.lang.String`	`custom1`
`private java.lang.String`	`custom2`
`private java.lang.String`	`custom3`
`private AdminNameValue[]`	`customAttrs`
`private int`	`customInt1`
`private int`	`customInt2`
`private boolean`	`deleteAttachmentAfterSend`
`private java.lang.String`	`friendlyAttachmentName`
`private java.lang.String`	`fromAddress`
`private java.lang.String`	`fullAttachmentFilename`
`private java.lang.String`	`replyToAddress`
`private boolean`	`sendBlindCopies`
`private int`	`synchronousity`
`private java.lang.String`	`templateName`
`private boolean`	`useCustomerLocale`

Constructor Summary

Constructors
Constructor and Description

AdminEmailOptions()

Constructors
Constructor and Description
`AdminEmailOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getBccEmails()` Semicolon separated list of blind copy email addresses.
`int`	`getContentType()` Get the Email Content Type.
`java.lang.String`	`getCountryCode()` If set, this is the country code that will be used to search for the eMail template.
`java.lang.String`	`getCustom1()`
`java.lang.String`	`getCustom2()`
`java.lang.String`	`getCustom3()`
`AdminNameValue[]`	`getCustomAttrs()`
`int`	`getCustomInt1()`
`int`	`getCustomInt2()`
`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.
`int`	`getSynchronousity()` Return the integer defining whether the email should be sent synchronously or asynchronously.
`java.lang.String`	`getTemplateName()` The template name is used by the notifySysAdmin call
`boolean`	`isDeleteAttachmentAfterSend()` When set to `true`, the attachment is deleted after being sent.
`boolean`	`isSendBlindCopies()` If set to true the email will be blind-copied to the email address (or addresses) defined in the "Send Extra Emails To" configuration variable (the key of this configuration variable is "SEND_EXTRA_EMAILS_TO").
`boolean`	`isUseCustomerLocale()` When set, the eMail sender looks for a template with the customer's language rather than the default language.
`void`	`setBccEmails(java.lang.String bccEmails)` Semicolon separated list of blind copy email addresses.
`void`	`setContentType(int contentType)` Set the Email Content Type.
`void`	`setCountryCode(java.lang.String countryCode)` If set, this is the country code that will be used to search for the eMail template.
`void`	`setCustom1(java.lang.String custom1)`
`void`	`setCustom2(java.lang.String custom2)`
`void`	`setCustom3(java.lang.String custom3)`
`void`	`setCustomAttrs(AdminNameValue[] customAttrs)`
`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`	`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`	`setSendBlindCopies(boolean sendBlindCopies)` If set to true the email will be blind-copied to the email address (or addresses) defined in the "Send Extra Emails To" configuration variable (the key of this configuration variable is "SEND_EXTRA_EMAILS_TO").
`void`	`setSynchronousity(int synchronousity)` Set to define whether the email should be sent synchronously or asynchronously.
`void`	`setTemplateName(java.lang.String templateName)` The template name is used by the notifySysAdmin call
`void`	`setUseCustomerLocale(boolean useCustomerLocale)` When set, the eMail sender looks for a template with the customer's language rather than the default language.
`java.lang.String`	`toString()`

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

- Field Detail
  - customAttrs
```
private AdminNameValue[] customAttrs
```
  - useCustomerLocale
```
private boolean useCustomerLocale
```
  - countryCode
```
private java.lang.String countryCode
```
  - contentType
```
private int contentType
```
  - custom1
```
private java.lang.String custom1
```
  - custom2
```
private java.lang.String custom2
```
  - custom3
```
private java.lang.String custom3
```
  - customInt1
```
private int customInt1
```
  - customInt2
```
private int customInt2
```
  - sendBlindCopies
```
private boolean sendBlindCopies
```
  - synchronousity
```
private int synchronousity
```
  - fullAttachmentFilename
```
private java.lang.String fullAttachmentFilename
```
  - friendlyAttachmentName
```
private java.lang.String friendlyAttachmentName
```
  - deleteAttachmentAfterSend
```
private boolean deleteAttachmentAfterSend
```
  - bccEmails
```
private java.lang.String bccEmails
```
  - fromAddress
```
private java.lang.String fromAddress
```
  - replyToAddress
```
private java.lang.String replyToAddress
```
  - templateName
```
private java.lang.String templateName
```
- Constructor Detail
  - AdminEmailOptions
```
public AdminEmailOptions()
```
- Method Detail
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    Returns a string containing the attributes of the object.
  - getCustomAttrs
```
public AdminNameValue[] getCustomAttrs()
```
    Returns:
    
    Returns the customAttrs.
  - setCustomAttrs
```
public void setCustomAttrs(AdminNameValue[] customAttrs)
```
    Parameters:
    
    customAttrs - The customAttrs to set.
  - isUseCustomerLocale
```
public boolean isUseCustomerLocale()
```
    When set, the eMail sender looks for a template with the customer's language rather than the default language.
    
    Returns:
    
    the useCustomerLocale
  - setUseCustomerLocale
```
public void setUseCustomerLocale(boolean useCustomerLocale)
```
    When set, the eMail sender looks for a template with the customer's language rather than the default language.
    
    Parameters:
    
    useCustomerLocale - the useCustomerLocale to set
  - getCountryCode
```
public java.lang.String getCountryCode()
```
    If set, this is the country code that will be used to search for the eMail template. It should contain two lower case characters such as "en", "de", "es" etc.
    
    Returns:
    
    the countryCode
  - setCountryCode
```
public void setCountryCode(java.lang.String countryCode)
```
    If set, this is the country code that will be used to search for the eMail template. It should contain two lower case characters such as "en", "de", "es" etc.
    
    Parameters:
    
    countryCode - the countryCode to set
  - getContentType
```
public 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
```
public 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
  - 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
  - isSendBlindCopies
```
public boolean isSendBlindCopies()
```
    If set to true the email will be blind-copied to the email address (or addresses) defined in the "Send Extra Emails To" configuration variable (the key of this configuration variable is "SEND_EXTRA_EMAILS_TO"). If this is set to false, no emails will be blind-copied even if they are defined in the "Send Extra Emails To" configuration variable.
    The default is set to true.
    
    Returns:
    
    the sendBlindCopies
  - setSendBlindCopies
```
public void setSendBlindCopies(boolean sendBlindCopies)
```
    If set to true the email will be blind-copied to the email address (or addresses) defined in the "Send Extra Emails To" configuration variable (the key of this configuration variable is "SEND_EXTRA_EMAILS_TO"). If this is set to false, no emails will be blind-copied even if they are defined in the "Send Extra Emails To" configuration variable.
    The default is set to true.
    
    Parameters:
    
    sendBlindCopies - the sendBlindCopies to set
  - getSynchronousity
```
public int getSynchronousity()
```
    Return the integer defining whether the email should be sent synchronously or asynchronously. Options are:
    - KKConstants.NOT_SET (-1 the default)
    - KKConstants.EMAIL_ASYNCHRONOUS (1)
    - KKConstants.EMAIL_SYNCHRONOUS (2)
    Returns:
    
    the synchronisity
  - setSynchronousity
```
public void setSynchronousity(int synchronousity)
```
    Set to define whether the email should be sent synchronously or asynchronously. Options are:
    - KKConstants.NOT_SET (-1 the default)
    - KKConstants.EMAIL_ASYNCHRONOUS (1)
    - KKConstants.EMAIL_SYNCHRONOUS (2)
    Parameters:
    
    synchronousity - the synchronousity to set
  - getFullAttachmentFilename
```
public java.lang.String getFullAttachmentFilename()
```
    The complete filename of an attachment.
    
    Returns:
    
    the fullAttachmentFilename
  - setFullAttachmentFilename
```
public void setFullAttachmentFilename(java.lang.String fullAttachmentFilename)
```
    The complete filename of an attachment.
    
    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.
    
    Returns:
    
    the friendlyAttachmentName
  - setFriendlyAttachmentName
```
public void setFriendlyAttachmentName(java.lang.String friendlyAttachmentName)
```
    The friendly filename of an attachment that can be viewed from the eMail.
    
    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
  - getBccEmails
```
public 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
  - setBccEmails
```
public 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
  - getFromAddress
```
public 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
  - setFromAddress
```
public 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 to set
  - getReplyToAddress
```
public 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
  - setReplyToAddress
```
public 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 to set
  - getTemplateName
```
public java.lang.String getTemplateName()
```
    The template name is used by the notifySysAdmin call
    
    Returns:
    
    the templateName
  - setTemplateName
```
public void setTemplateName(java.lang.String templateName)
```
    The template name is used by the notifySysAdmin call
    
    Parameters:
    
    templateName - the templateName to set

Class AdminEmailOptions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

customAttrs

useCustomerLocale

countryCode

contentType

custom1

custom2

custom3

customInt1

customInt2

sendBlindCopies

synchronousity

fullAttachmentFilename

friendlyAttachmentName

deleteAttachmentAfterSend

bccEmails

fromAddress

replyToAddress

templateName

Constructor Detail

AdminEmailOptions

Method Detail

toString

getCustomAttrs

setCustomAttrs

isUseCustomerLocale

setUseCustomerLocale

getCountryCode

setCountryCode

getContentType

setContentType

getCustom1

setCustom1

getCustom2

setCustom2

getCustom3

setCustom3

getCustomInt1

setCustomInt1

getCustomInt2

setCustomInt2

isSendBlindCopies

setSendBlindCopies

getSynchronousity

setSynchronousity

getFullAttachmentFilename

setFullAttachmentFilename

getFriendlyAttachmentName

setFriendlyAttachmentName

isDeleteAttachmentAfterSend

setDeleteAttachmentAfterSend

getBccEmails

setBccEmails

getFromAddress

setFromAddress

getReplyToAddress

setReplyToAddress

getTemplateName

setTemplateName