|
Method Detailboolean addChart(Chart chart) Adds chart to email. Note - only server charts supported (created using ChartTool) otherwise exception occurs
Parameters:
Returns: boolean Since: 10-22-2010 addData(Data data) Adds the specified Data to this response.
Parameters:
Since: 05-28-2010 boolean addDataList(DataList list) Adds the specified list to a page
Parameters:
Returns: boolean Since: 07-11-2008 boolean addDataMap(String id, Data data) Registers the data in the response with the specified id.
Parameters:
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:
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:
Returns: boolean Since: 11-09-2010 boolean addFile(File file) Attaches the file to the email as an attachment.
Parameters:
Returns: boolean Since: 10-22-2010 addPayload(Payload payload) Adds the payload to this response.
Parameters:
Since: 07-20-2010 allowHTML(String key) Permits any rendering target with the specified key to be rendered as HTML.
Parameters:
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:
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:
Since: 04-09-2014 String get(String key) Returns the value associated with key if it exists, null otherwise.
Parameters:
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:
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:
Since: 06-29-2021 removeDataMap(String id) Removes the data in the response with the specified id.
Parameters:
Since: 12-21-2017 removeValue(String key) Removes the associated key from the response.
Parameters:
Since: 05-28-2010 schedule(Date date) Schedules the email to be sent after the specified date.
Parameters:
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:
Returns: String Since: 10-22-2010 sendToAddresses(String[] addresses) Sends the email to the specified addresses.
Parameters:
Since: 10-22-2010 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:
Since: 08-28-2018 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:
Since: 08-28-2018 boolean setData(String id, Data data) Registers the data in the response with the specified id.
Parameters:
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:
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:
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:
Since: 08-28-2018 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:
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:
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:
Since: 08-28-2018 setReplyTo(String email) Sets the replyTo email address. Pass null to remove the replyTo.
Parameters:
Since: 10-22-2010 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:
Since: 08-28-2018 setSubject(String subject) Sets the subject of the email (over-rides the subject set during Pal development).
Parameters:
Since: 10-22-2010 setUtilityReference(String reference) Sets the utility billing reference for this email. This is a development feature.
Parameters:
Since: 04-22-2011 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:
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:
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:
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:
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:
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-21-2010 |
Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. | API Date: May 01, 2024 05:15 AM |