Send Document
The following command block is an example of how to send a document, the actual document you would attach to the email:
When sending documents to the clients by attaching them to the email, the email body must have at least one command block for the email to be processed and the document to be sent to the client.
If there are no command blocks for sending documents (but at least one other type), any relevant attachments will be sent on to the client, using the default values.
Send Document Parameter Definitions
The following table describes the parameters that can be used in the send document command block:
Parameter | Type | Required | Default | Repeatable | Description |
|---|---|---|---|---|---|
brackets | Enum: {, [, < | No | { | No | The encapsulating brackets to use |
notifySuccess | Email Address | No | No | Who to notify upon successful completion | |
notifyError | Email Address | No | Email Return Address | No | Who to notify of processing errors, if not specified then the email return address will be used |
quietMode | True, False | No | False | No | If true then turn off all notifications |
types | SEND_DOCUMENT | Yes | No | The type of command to be performed | |
caseReference | String | Yes | No | The case reference, a unique identifier you use to identify the case | |
title | String | No | The document name | No | A brief description of the document for the client to identify in their todo list |
message | String | No | Please see the attached document | No | A brief message to accompany the document |
documentMatcher | String | No | No | If you are sending multiple documents then this send document command block will match on the document that's name contains the value of this field | |
sender | String | No | The email sender | No | The sender of the notification that the process step has been completed, defaults to the sender of the email |
replyTo | Email Address | No | Yes or comma separated | Set this parameter if you would like to update the case reply to | |
sendPushNotification | Boolean | No | True | No | Whether to send a notification to the users devices |
notificationOnlyOnFirstDocument | Boolean | No | False | No | Whether to send a push notification to the users devices for subsequent documents in the same group of documents |
channel | String | No | No | This used to send messages to external recipients and should not be provided unless specifically requested to | |
bundleIdentifier | String | No | No | The bundle identifier to associate to or create an event bundle that this document is attached to, refer to the event bundle documentation for more information | |
bundleRecipients | Email Addresses (comma separated) | No | No | The bundle recipients, comma separated email addresses, who will receive a notification when the event bundle has been completed | |
bundleReminder | Reminder String | No | Yes | An event bundle reminder, to be sent when the event bundle has not been completed, please refer to the event bundle documentation |