public interface EmailOptionsIf
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.
|
java.lang.String getTemplateName()
void setTemplateName(java.lang.String templateName)
templateName
- The templateName to set.java.lang.String getCountryCode()
void setCountryCode(java.lang.String countryCode)
countryCode
- The countryCode to set.int getContentType()
void setContentType(int contentType)
contentType
- the contentType to setNameValueIf[] getCustomAttrs()
void setCustomAttrs(NameValueIf[] customAttrs)
customAttrs
- The customAttrs to set.void setAttachInvoice(boolean attachInvoice)
attachInvoice
- set to true if the invoice should be attached to the email.boolean isAttachInvoice()
void setCreateInvoice(boolean createInvoice)
createInvoice
- set to true if the invoice should be created (if it isn't already present) for
attaching to the email.boolean isCreateInvoice()
java.lang.String getFullAttachmentFilename()
void setFullAttachmentFilename(java.lang.String fullAttachmentFilename)
fullAttachmentFilename
- the fullAttachmentFilename to setjava.lang.String getFriendlyAttachmentName()
void setFriendlyAttachmentName(java.lang.String friendlyAttachmentName)
friendlyAttachmentName
- the friendlyAttachmentName to setboolean isDeleteAttachmentAfterSend()
true
, the attachment is deleted after being sent. The default value
is false
.void setDeleteAttachmentAfterSend(boolean deleteAttachmentAfterSend)
true
, the attachment is deleted after being sent. The default value
is false
.deleteAttachmentAfterSend
- the deleteAttachmentAfterSend to setjava.lang.String getSubject()
void setSubject(java.lang.String subject)
subject
- the subject as a String to setjava.lang.String getContent()
void setContent(java.lang.String content)
content
- the content for the email as a String to setjava.lang.String getToAddress()
void setToAddress(java.lang.String toAddress)
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.java.lang.String getFromAddress()
void setFromAddress(java.lang.String fromAddress)
fromAddress
- the fromAddress as a String to setjava.lang.String getReplyToAddress()
void setReplyToAddress(java.lang.String replyToAddress)
replyToAddress
- the replyToAddress as a String to setjava.lang.String getCcEmails()
void setCcEmails(java.lang.String ccEmails)
ccEmails
- the ccEmails to setjava.lang.String getBccEmails()
void setDoBlindCopy(boolean doBlindCopy)
doBlindCopy
- the doBlindCopy to setboolean isDoBlindCopy()
void setAsync(boolean async)
async
- the async to setboolean isAsync()
void setBccEmails(java.lang.String bccEmails)
bccEmails
- the bccEmails to setjava.lang.String getCustom1()
void setCustom1(java.lang.String custom1)
custom1
- the custom1 to setjava.lang.String getCustom2()
void setCustom2(java.lang.String custom2)
custom2
- the custom2 to setjava.lang.String getCustom3()
void setCustom3(java.lang.String custom3)
custom3
- the custom3 to setint getCustomInt1()
void setCustomInt1(int customInt1)
customInt1
- the customInt1 to setint getCustomInt2()
void setCustomInt2(int customInt2)
customInt2
- the customInt2 to setjava.lang.String getEmailAddr()
void setEmailAddr(java.lang.String emailAddr)
emailAddr
- the emailAddr to setvoid setCreateBarcode(boolean createBarcode)
createBarcode
- set to true if the barcode should be created for
printing on the email.boolean isCreateBarcode()
void setBarcodeContent(java.lang.String barcodeContent)
barcodeContent
- the barcode content to set.java.lang.String getBarcodeContent()
Copyright © 2018 DS Data Systems UK Ltd.