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.
	enableReply(String workflow, boolean multiple) ⚠Deprecated since 04-24-2014. Use enableReply(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 will be invoked
	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.
Data	getData() Returns the Data object for this response.
String	getValue(String key) Returns the value associated with key if it exists, null otherwise. Shortcut for getData().getValue(key)
	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. Returns the number of emails sent.
int	sendToSharedGroup(String group) ⚠Deprecated since 11-11-2014. No replacement Sends this email to all users of the specified shared group. Returns the number of emails sent.
	set(String key, String value) Adds the key/value pair to the data map, over-writing any set that already exists with name key.
boolean	setAccessConsoleLink(String action, String profileId, String palId) Creates a link that can be clicked from within the email that will provide access to a Console Pal associated with the specified ID.The user must belong to the enterprise and have the appropriate Console Pal permissions OR must have been granted access to the Console Pal. This method will error if the specified Pal is not a Console Pal.
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	setAnonymousAccessConsoleLink(String action, String palId) Creates a link that can be clicked from within the email that will provide access to a Console Pal associated with the specified ID.The user will be granted access to the Console Pal with the personal profile upon successful authentication. This method will error if the specified Pal is not a Console Pal. By default, single use is set to true for security reasons. Additionally, new user email validation is set to true and we require the user account authenticating from the email to match the email address this was sent to. This means a profile or secondary email address of the user must match the email address this is sent to.
	setBoolean(String name, boolean value) Adds the key/value pair to the data map, over-writing any set that already exists with name key.
	setCreateOrAccessTransactionLink(String action, String palId, Data data) Creates a link that can be clicked from within the email that will either access last transaction user has role in or 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.
	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.
	setDate(String name, Date value) Adds the key/value pair to the data map, over-writing any set that already exists with name key.
	setDecimal(String name, double value) ⚠Deprecated since 08-28-2018. Use setDouble(String,double) Adds the key/value pair to the data map, over-writing any set that already exists with name key.
	setDouble(String name, double double) Adds the key/value pair to the data map, over-writing any set that already exists with name key.
	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.
	setInt(String name, long value) Adds the key/value pair to the data map, over-writing any set that already exists with name key.
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, links to Navigator will no longer work.
	setString(String name, String value) Adds the key/value pair to the data map, over-writing any set that already exists with name key.
	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.
	setValidationCode(String macroTarget) Creates a validation code and replaces the specified target in the message body with the code.
	setValue(String key, String value) Adds the key/value pair to the data object for this page, over-writing any set that already exists with name key. Shortcut for getData().setValue(key,value)
	setValue(String key, boolean value) ⚠Deprecated since 08-28-2018. Use setBoolean(String,boolean) Adds the key/value pair to the data object for this page, over-writing any set that already exists with name key. Shortcut for getData().setValue(key,value)
	setValue(String key, double value) ⚠Deprecated since 08-28-2018. Use setDouble(String,double) Adds the key/value pair to the data object for this page, over-writing any set that already exists with name key. Shortcut for getData().setValue(key,value)
	setValue(String key, int value) ⚠Deprecated since 08-28-2018. Use setInt(String,int) Adds the key/value pair to the data object for this page, over-writing any set that already exists with name key. Shortcut for getData().setValue(key,value)
	setValue(String key, long value) ⚠Deprecated since 08-28-2018. Use setInt(String,int) Adds the key/value pair to the data object for this page, over-writing any set that already exists with name key. Shortcut for getData().setValue(key,value)
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

---

enableReply(String workflow, boolean multiple)

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 will be invoked

Parameters:

• String   workflow  - system workflow name. Required parameter.
• boolean   multiple  - allow multiple responses to this email.

Since: 08-20-2010

This method has been deprecated since 04-24-2014. Use enableReply(workflow).

---

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

---

Data getData()

Returns the Data object for this response.

Returns:  Data

Since: 05-31-2007

---

String getValue(String key)

Returns the value associated with key if it exists, null otherwise. Shortcut for getData().getValue(key)

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. Returns the number of emails sent.

Parameters:

• String   group

Returns:  int

Since: 02-05-2009

---

int sendToSharedGroup(String group)

Sends this email to all users of the specified shared group. Returns the number of emails sent.

Parameters:

• String   group

Returns:  int

Since: 02-05-2009

This method has been deprecated since 11-11-2014. No replacement

---

set(String key, String value)

Adds the key/value pair to the data map, over-writing any set that already exists with name key.

Parameters:

• String   key Required parameter.
• String   value

Since: 08-28-2018

---

boolean setAccessConsoleLink(String action, String profileId, String palId)

Creates a link that can be clicked from within the email that will provide access to a Console Pal associated with the specified ID.The user must belong to the enterprise and have the appropriate Console Pal permissions OR must have been granted access to the Console Pal. This method will error if the specified Pal is not a Console Pal.

Parameters:

• String   action
• String   profileId
• String   palId

Returns:  boolean

Since: 05-26-2009

---

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: 02-05-2009

---

boolean setAnonymousAccessConsoleLink(String action, String palId)

Creates a link that can be clicked from within the email that will provide access to a Console Pal associated with the specified ID.The user will be granted access to the Console Pal with the personal profile upon successful authentication. This method will error if the specified Pal is not a Console Pal. By default, single use is set to true for security reasons. Additionally, new user email validation is set to true and we require the user account authenticating from the email to match the email address this was sent to. This means a profile or secondary email address of the user must match the email address this is sent to.

Parameters:

• String   action
• String   palId

Returns:  boolean

Since: 08-03-2009

---

setBoolean(String name, boolean value)

Adds the key/value pair to the data map, over-writing any set that already exists with name key.

Parameters:

• String   name Required parameter.
• boolean   value

Since: 08-28-2018

---

setCreateOrAccessTransactionLink(String action, String palId, Data data)

Creates a link that can be clicked from within the email that will either access last transaction user has role in or 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  - Action to access existing transaction with. Required parameter.
• String   palId  - Pal ID. Required parameter.
• Data   data  - Data to be passed to transaction.

Since: 03-11-2010

---

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: 02-05-2009

---

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

---

setDate(String name, Date value)

Adds the key/value pair to the data map, over-writing any set that already exists with name key.

Parameters:

• String   name Required parameter.
• Date   value

Since: 08-28-2018

---

setDecimal(String name, double value)

Adds the key/value pair to the data map, over-writing any set that already exists with name key.

Parameters:

• String   name Required parameter.
• double   value

Since: 08-28-2018

This method has been deprecated since 08-28-2018. Use setDouble(String,double)

---

setDouble(String name, double double)

Adds the key/value pair to the data map, over-writing any set that already exists with name key.

Parameters:

• String   name Required parameter.
• double   double

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: 02-05-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

---

setInt(String name, long value)

Adds the key/value pair to the data map, over-writing any set that already exists with name key.

Parameters:

• String   name Required parameter.
• long   value

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: 07-13-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, links to Navigator will no longer work.

Parameters:

• boolean   singleUse

Since: 02-05-2009

---

setString(String name, String value)

Adds the key/value pair to the data map, over-writing any set that already exists with name key.

Parameters:

• String   name Required parameter.
• String   value

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

---

setValidationCode(String macroTarget)

Creates a validation code and replaces the specified target in the message body with the code.

Parameters:

• String   macroTarget

Since: 04-27-2009

---

setValue(String key, String value)

Adds the key/value pair to the data object for this page, over-writing any set that already exists with name key. Shortcut for getData().setValue(key,value)

Parameters:

• String   key
• String   value

Since: 07-11-2008

---

setValue(String key, boolean value)

Adds the key/value pair to the data object for this page, over-writing any set that already exists with name key. Shortcut for getData().setValue(key,value)

Parameters:

• String   key
• boolean   value

Since: 04-06-2009

This method has been deprecated since 08-28-2018. Use setBoolean(String,boolean)

---

setValue(String key, double value)

Adds the key/value pair to the data object for this page, over-writing any set that already exists with name key. Shortcut for getData().setValue(key,value)

Parameters:

• String   key
• double   value

Since: 04-06-2009

This method has been deprecated since 08-28-2018. Use setDouble(String,double)

---

setValue(String key, int value)

Adds the key/value pair to the data object for this page, over-writing any set that already exists with name key. Shortcut for getData().setValue(key,value)

Parameters:

• String   key
• int   value

Since: 04-06-2009

This method has been deprecated since 08-28-2018. Use setInt(String,int)

---

setValue(String key, long value)

Adds the key/value pair to the data object for this page, over-writing any set that already exists with name key. Shortcut for getData().setValue(key,value)

Parameters:

• String   key
• long   value

Since: 04-06-2009

This method has been deprecated since 08-28-2018. Use setInt(String,int)

---

String toString()

Returns a description of this object.

Returns:  String

Since: 10-22-2010