Email

Method Summary
boolean	addChart(Chart chart) Adds chart to email. Note - only server charts supported (created using ChartTool) otherwise exception occurs
	addData(Data data) Adds the specified Data to this response.
boolean	addDataList(DataList list) Adds the specified list to a page
boolean	addDataMap(String id, Data data) Registers the data in the response with the specified id.
boolean	addDataMaps(String keyColumn, DataList list) Extracts the records from the list and registers them in the response using the values in the key column. Limited to 500 records per response.
boolean	addDataRecord(String id, DataRecord dataRecord) Registers the DataRecord in the response with the specified id. Limited to 500 records per response.
boolean	addFile(File file) Attaches the file to the email as an attachment.
	addPayload(Payload payload) Adds the payload to this response.
	allowHTML(String key) Permits any rendering target with the specified key to be rendered as HTML.
	enableDeliveryStatus() Enables delivery status for this email. This method requires inbound email configured if SMTP settings are configured for current enterprise or a DSN Cloud Subscription Service. When delivery status received, this email job will be marked as "delivered" or "failed"
	enableReply(String workflow) Allows recipient to reply to this email. This method requires inbound email configuration for current enterprise or a DSN Cloud Subscription Service. When recipient replies to the email, specified system workflow name will be provided to the listener.
	enableWorkflowDeliveryStatus(String workflow) Enables delivery status for this email. This method requires inbound email configuration for current enterprise or a DSN Cloud Subscription Service. When a delivery status event occurs, this email job have its DSN status updated and specified workflow will be provided to the listener.
String	get(String key) Returns the value associated with key if it exists, null otherwise.
int	getAttachmentCount() Returns the number of attachments to this email.
int	getAttachmentSize() Returns the size of the attachment payload in KB.
Boolean	getBoolean(String field) Returns the given field as a boolean. The value must be true or false. Throws exception if the value does not exist or cannot be cast to the correct type.
Boolean	getCommonBoolean(String field) Returns the given field as a boolean. The value must be any of the following combinations: [true/false], [1/0], [yes,no], [on,off]. Throws exception if the value does not exist or cannot be cast to the correct type.
Data	getData() Returns the Data object for this response.
Date	getDate(String field) Returns the given field as a Date. Throws exception if the value does not exist or cannot be cast to the correct type.
Boolean	getDefaultBoolean(String field, Boolean defaultBoolean) Returns the given field as a boolean. If the field does not exist or refers to a non-boolean field, it returns the default value
Date	getDefaultDate(String field, Date defaultDate) Returns the given field as a date. If the field does not exist or refers to a non-date field, it returns the default value
Double	getDefaultDouble(String field, Number defaultDouble) Returns the given field as a double. If the field does not exist or refers to a non-double field, it returns the default value
Integer	getDefaultInt(String field, Number defaultInt) Returns the given field as an int. If the field does not exist or refers to a non-int field, it returns the default value
String	getDefaultValue(String field, String defaultValue, boolean emptyIsNull) Returns the given field. If the field does not exist, it returns the default value. If the field exists but is value is empty, this method returns defaultValue only if emptyIsNull=true.
Double	getDouble(String key) Returns the given value of the given key as a double. Throws exception if the value does not exist or cannot be cast to the correct type.
Integer	getInt(String key) Returns the given value of the given key as an Java Int which is smaller than a Javascript Int. Throws exception if the value does not exist or cannot be cast to the correct type.
Long	getLong(String key) Returns the given value of the given key as Java Long which is larger. Throws exception if the value does not exist or cannot be cast to the correct type.
String	getValue(String key) Returns the value associated with key if it exists, null otherwise.
	removeAttachments() Removes the attachments, if any.
	removeDataList(String name) Removes the datalist from the payload
	removeDataMap(String id) Removes the data in the response with the specified id.
	removeValue(String key) Removes the associated key from the response.
	schedule(Date date) Schedules the email to be sent after the specified date.
String	sendToAddress(String email) Sends the email to the specified email address and returns the email job id. This will return the word 'BLOCKED' if the email is on the system block list.
	sendToAddresses(String[] addresses) Sends the email to the specified addresses.
int	sendToGroup(String group) Sends this email to all users of the specified group who have the Access Transaction permission on this Transaction. Returns the number of emails sent.
boolean	set(String name, Object value) Sets the string value referenced by name. Returns false on fail (e.g. if the column does not exist, etc). The object must be capable of being serialized as a String.
boolean	setAccessTransactionLink(String action, String txId) Creates a link that can be clicked from within the email that will allow access to the specified transaction. Note that the user accessing the transaction must already have a role on the transaction or group access to the transaction. This method return false if the given txId does not belong to the enterprise or has been deleted.
boolean	setBoolean(String name, Boolean value) Sets the boolean value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
	setCreateTransactionLink(String action, String palId, Data data) Creates a link that can be clicked from within the email that will create a new transaction using the Pal associated with the specified ID.If data is non null, the data will be available as part of the creation of the new transaction-- as if it was passed on the request.
boolean	setData(String id, Data data) Registers the data in the response with the specified id.
boolean	setDate(String name, Date value) Sets the date value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
boolean	setDouble(String name, Number double) Sets the decimal value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
	setExpiration(Date date) Sets the expiration date on links in the email. After this date, they will no longer work. Note- this method is a potential security hole. You should use good judgement in setting an expiration date.
boolean	setFrom(String name, String address) Sets the 'From' information for the email, over-writing the default provided by the system. This functionality requires the email SMTP server to be configued for support and the email setting being used must allow alias sending. Pass null to remove these settings.
	setHTML(String key, String xhtml) Adds the given XHTML to the page (the XHTML should ideally be well-formed). You must use the c:html tag for displaying the content. Throws exception if the content contains illegal tags or attributes. You should avoid inline scripts or script blocks.
boolean	setInt(String name, Number value) Sets the integer value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
boolean	setLoginPage(String loginPage) Sets the login page for the returning email. Returns false if the login page does not exist or if the Pal does not support custom login screens. Use null to set the default login page.
	setNewUserEmailValidation(boolean validate) This method applies only to new users who will create an account as a result of accessing the transaction from an email link. This is false by default. If set to true, the user will be forced to validate the email as part of the account creation process.
	setReplyTo(String email) Sets the replyTo email address. Pass null to remove the replyTo.
	setSingleUse(boolean singleUse) Marks the email as single use (or not). Single use means once it has been used it will no longer be able to access the transaction.
boolean	setString(String name, String value) Sets the string value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).
	setSubject(String subject) Sets the subject of the email (over-rides the subject set during Pal development).
	setUtilityReference(String reference) Sets the utility billing reference for this email. This is a development feature.
	setValue(String key, Object value) Sets the string value referenced by name. The object must be capable of being serialized as a String.
String	toString() Returns a description of this object.

Method Detail

---

boolean addChart(Chart chart)

Adds chart to email. Note - only server charts supported (created using ChartTool) otherwise exception occurs

Parameters:

• Chart   chart Required parameter.

Returns:  boolean

Since: 10-22-2010

---

addData(Data data)

Adds the specified Data to this response.

Parameters:

• Data   data

Since: 05-28-2010

---

boolean addDataList(DataList list)

Adds the specified list to a page

Parameters:

• DataList   list

Returns:  boolean

Since: 07-11-2008

---

boolean addDataMap(String id, Data data)

Registers the data in the response with the specified id.

Parameters:

• String   id Required parameter.
• Data   data Required parameter.

Returns:  boolean

Since: 05-28-2010

---

boolean addDataMaps(String keyColumn, DataList list)

Extracts the records from the list and registers them in the response using the values in the key column. Limited to 500 records per response.

Parameters:

• String   keyColumn Required parameter.
• DataList   list Required parameter.

Returns:  boolean

Since: 05-28-2010

---

boolean addDataRecord(String id, DataRecord dataRecord)

Registers the DataRecord in the response with the specified id. Limited to 500 records per response.

Parameters:

• String   id Required parameter.
• DataRecord   dataRecord Required parameter.

Returns:  boolean

Since: 11-09-2010

---

boolean addFile(File file)

Attaches the file to the email as an attachment.

Parameters:

• File   file Required parameter.

Returns:  boolean

Since: 10-22-2010

---

addPayload(Payload payload)

Adds the payload to this response.

Parameters:

• Payload   payload

Since: 07-20-2010

---

allowHTML(String key)

Permits any rendering target with the specified key to be rendered as HTML.

Parameters:

• String   key Required parameter.

Since: 08-02-2017

---

enableDeliveryStatus()

Enables delivery status for this email. This method requires inbound email configured if SMTP settings are configured for current enterprise or a DSN Cloud Subscription Service. When delivery status received, this email job will be marked as "delivered" or "failed"

Since: 10-22-2010

---

enableReply(String workflow)

Allows recipient to reply to this email. This method requires inbound email configuration for current enterprise or a DSN Cloud Subscription Service. When recipient replies to the email, specified system workflow name will be provided to the listener.

Parameters:

• String   workflow  - workflow name. Required parameter. Maximum allowed size of parameter: 100

Since: 04-09-2014

---

enableWorkflowDeliveryStatus(String workflow)

Enables delivery status for this email. This method requires inbound email configuration for current enterprise or a DSN Cloud Subscription Service. When a delivery status event occurs, this email job have its DSN status updated and specified workflow will be provided to the listener.

Parameters:

• String   workflow  - system workflow name. Required parameter. Maximum allowed size of parameter: 100

Since: 04-09-2014

---

String get(String key)

Returns the value associated with key if it exists, null otherwise.

Parameters:

• String   key

Returns:  String

Since: 08-28-2018

---

int getAttachmentCount()

Returns the number of attachments to this email.

Returns:  int

Since: 10-22-2010

---

int getAttachmentSize()

Returns the size of the attachment payload in KB.

Returns:  int

Since: 10-22-2010

---

Boolean getBoolean(String field)

Returns the given field as a boolean. The value must be true or false. Throws exception if the value does not exist or cannot be cast to the correct type.

Parameters:

• String   field

Returns:  Boolean

Since: 07-11-2008

---

Boolean getCommonBoolean(String field)

Returns the given field as a boolean. The value must be any of the following combinations: [true/false], [1/0], [yes,no], [on,off]. Throws exception if the value does not exist or cannot be cast to the correct type.

Parameters:

• String   field

Returns:  Boolean

Since: 08-22-2008

---

Data getData()

Returns the Data object for this response.

Returns:  Data

Since: 05-31-2007

---

Date getDate(String field)

Returns the given field as a Date. Throws exception if the value does not exist or cannot be cast to the correct type.

Parameters:

• String   field

Returns:  Date

Since: 07-11-2008

---

Boolean getDefaultBoolean(String field, Boolean defaultBoolean)

Returns the given field as a boolean. If the field does not exist or refers to a non-boolean field, it returns the default value

Parameters:

• String   field
• Boolean   defaultBoolean

Returns:  Boolean

Since: 09-05-2008

---

Date getDefaultDate(String field, Date defaultDate)

Returns the given field as a date. If the field does not exist or refers to a non-date field, it returns the default value

Parameters:

• String   field
• Date   defaultDate

Returns:  Date

Since: 09-05-2008

---

Double getDefaultDouble(String field, Number defaultDouble)

Returns the given field as a double. If the field does not exist or refers to a non-double field, it returns the default value

Parameters:

• String   field
• Number   defaultDouble

Returns:  Double

Since: 09-05-2008

---

Integer getDefaultInt(String field, Number defaultInt)

Returns the given field as an int. If the field does not exist or refers to a non-int field, it returns the default value

Parameters:

• String   field
• Number   defaultInt

Returns:  Integer

Since: 09-05-2008

---

String getDefaultValue(String field, String defaultValue, boolean emptyIsNull)

Returns the given field. If the field does not exist, it returns the default value. If the field exists but is value is empty, this method returns defaultValue only if emptyIsNull=true.

Parameters:

• String   field
• String   defaultValue
• boolean   emptyIsNull

Returns:  String

Since: 09-05-2008

---

Double getDouble(String key)

Returns the given value of the given key as a double. Throws exception if the value does not exist or cannot be cast to the correct type.

Parameters:

• String   key Required parameter.

Returns:  Double

Since: 07-11-2008

---

Integer getInt(String key)

Returns the given value of the given key as an Java Int which is smaller than a Javascript Int. Throws exception if the value does not exist or cannot be cast to the correct type.

Parameters:

• String   key Required parameter.

Returns:  Integer

Since: 07-11-2008

---

Long getLong(String key)

Returns the given value of the given key as Java Long which is larger. Throws exception if the value does not exist or cannot be cast to the correct type.

Parameters:

• String   key Required parameter.

Returns:  Long

Since: 05-28-2022

---

String getValue(String key)

Returns the value associated with key if it exists, null otherwise.

Parameters:

• String   key

Returns:  String

Since: 07-11-2008

---

removeAttachments()

Removes the attachments, if any.

Since: 10-22-2010

---

removeDataList(String name)

Removes the datalist from the payload

Parameters:

• String   name  - name of data list in payload. Required parameter.

Since: 06-29-2021

---

removeDataMap(String id)

Removes the data in the response with the specified id.

Parameters:

• String   id Required parameter.

Since: 12-21-2017

---

removeValue(String key)

Removes the associated key from the response.

Parameters:

• String   key

Since: 05-28-2010

---

schedule(Date date)

Schedules the email to be sent after the specified date.

Parameters:

• Date   date Required parameter.

Since: 10-22-2010

---

String sendToAddress(String email)

Sends the email to the specified email address and returns the email job id. This will return the word 'BLOCKED' if the email is on the system block list.

Parameters:

• String   email Required parameter. Maximum allowed size of parameter: 254

Returns:  String

Since: 10-22-2010

---

sendToAddresses(String[] addresses)

Sends the email to the specified addresses.

Parameters:

• String[]   addresses Required parameter.

Since: 10-22-2010

---

int sendToGroup(String group)

Sends this email to all users of the specified group who have the Access Transaction permission on this Transaction. Returns the number of emails sent.

Parameters:

• String   group

Returns:  int

Since: 08-10-2009

---

boolean set(String name, Object value)

Sets the string value referenced by name. Returns false on fail (e.g. if the column does not exist, etc). The object must be capable of being serialized as a String.

Parameters:

• String   name
• Object   value

Returns:  boolean

Since: 08-28-2018

---

boolean setAccessTransactionLink(String action, String txId)

Creates a link that can be clicked from within the email that will allow access to the specified transaction. Note that the user accessing the transaction must already have a role on the transaction or group access to the transaction. This method return false if the given txId does not belong to the enterprise or has been deleted.

Parameters:

• String   action
• String   txId

Returns:  boolean

Since: 08-17-2011

---

boolean setBoolean(String name, Boolean value)

Sets the boolean value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).

Parameters:

• String   name
• Boolean   value

Returns:  boolean

Since: 08-28-2018

---

setCreateTransactionLink(String action, String palId, Data data)

Creates a link that can be clicked from within the email that will create a new transaction using the Pal associated with the specified ID.If data is non null, the data will be available as part of the creation of the new transaction-- as if it was passed on the request.

Parameters:

• String   action
• String   palId
• Data   data

Since: 08-17-2011

---

boolean setData(String id, Data data)

Registers the data in the response with the specified id.

Parameters:

• String   id Required parameter.
• Data   data Required parameter.

Returns:  boolean

Since: 02-11-2019

---

boolean setDate(String name, Date value)

Sets the date value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).

Parameters:

• String   name
• Date   value

Returns:  boolean

Since: 08-28-2018

---

boolean setDouble(String name, Number double)

Sets the decimal value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).

Parameters:

• String   name
• Number   double

Returns:  boolean

Since: 08-28-2018

---

setExpiration(Date date)

Sets the expiration date on links in the email. After this date, they will no longer work. Note- this method is a potential security hole. You should use good judgement in setting an expiration date.

Parameters:

• Date   date

Since: 08-10-2009

---

boolean setFrom(String name, String address)

Sets the 'From' information for the email, over-writing the default provided by the system. This functionality requires the email SMTP server to be configued for support and the email setting being used must allow alias sending. Pass null to remove these settings.

Parameters:

• String   name  - sender name. Maximum allowed size of parameter: 100
• String   address  - sender email. Maximum allowed size of parameter: 100

Returns:  boolean

Since: 02-20-2021

---

setHTML(String key, String xhtml)

Adds the given XHTML to the page (the XHTML should ideally be well-formed). You must use the c:html tag for displaying the content. Throws exception if the content contains illegal tags or attributes. You should avoid inline scripts or script blocks.

Parameters:

• String   key
• String   xhtml

Since: 07-11-2008

---

boolean setInt(String name, Number value)

Sets the integer value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).

Parameters:

• String   name
• Number   value

Returns:  boolean

Since: 08-28-2018

---

boolean setLoginPage(String loginPage)

Sets the login page for the returning email. Returns false if the login page does not exist or if the Pal does not support custom login screens. Use null to set the default login page.

Parameters:

• String   loginPage

Returns:  boolean

Since: 11-03-2010

---

setNewUserEmailValidation(boolean validate)

This method applies only to new users who will create an account as a result of accessing the transaction from an email link. This is false by default. If set to true, the user will be forced to validate the email as part of the account creation process.

Parameters:

• boolean   validate

Since: 08-10-2009

---

setReplyTo(String email)

Sets the replyTo email address. Pass null to remove the replyTo.

Parameters:

• String   email Maximum allowed size of parameter: 254

Since: 10-22-2010

---

setSingleUse(boolean singleUse)

Marks the email as single use (or not). Single use means once it has been used it will no longer be able to access the transaction.

Parameters:

• boolean   singleUse

Since: 08-10-2009

---

boolean setString(String name, String value)

Sets the string value referenced by name. Returns false on fail (e.g. if the column does not exist, etc).

Parameters:

• String   name
• String   value

Returns:  boolean

Since: 08-28-2018

---

setSubject(String subject)

Sets the subject of the email (over-rides the subject set during Pal development).

Parameters:

• String   subject Required parameter.

Since: 10-22-2010

---

setUtilityReference(String reference)

Sets the utility billing reference for this email. This is a development feature.

Parameters:

• String   reference Required parameter. Maximum allowed size of parameter: 20

Since: 04-22-2011

---

setValue(String key, Object value)

Sets the string value referenced by name. The object must be capable of being serialized as a String.

Parameters:

• String   key
• Object   value

Since: 07-11-2008

---

String toString()

Returns a description of this object.

Returns:  String

Since: 10-22-2010