...
| Table of Contents |
|---|
Introduction
| English | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
| Email Tool enables one to send emails as part of a workflow process. |
| Panel | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
New feature added in Joget Workflow v6.
|
You can also use the Email Tool in Post Form Submission Processing to send out an email when the user submits the form on:
- Data creation, or
- Data update or
- Both Data creation and Data update.
Email Tool Properties
Configure Email Tool
Figure 1: Email Tool Properties
| Name | Description | ||
|---|---|---|---|
| To (Specific email address) | Recipient fully qualified address or usernames where you have already setup emails for the users(Example: admin,cat). | ||
| To (Participant ID) | Participant ID(s) according to the process flow it resides in. Multiple values can be accepted by separating them with semicolons.
| ||
| CC | Fully qualified address is expected. Multiple values can be accepted by separating them with semicolons.
| ||
| BCC | Fully qualified address is expected. Multiple values can be accepted by separating them with semicolons.
| ||
| Subject | Email Subject. | ||
| Message | Email Message. | ||
| HTML Content? | Check if "Message" is intended to be a HTML content. |
...
Configure SMTP Settings
| Tip |
|---|
If no you leave the SMTP settings is configured here, this tool below empty, Joget will read the default SMTP configuration in values from the "General Settings ".You may configure common SMTP settings in "General Settings > SMTP Settings" for your future convenience.> SMTP Settings page. |
Figure 2: SMTP Settings
| Name | Description | |||||
|---|---|---|---|---|---|---|
| From | Sender email address.
| |||||
SMTP Host | Email Server SMTP Host
| |||||
| SMTP Port | Email Server SMTP Port
| |||||
| Security |
Alternatively, you can click on the "hash" symbol to allow the input of hash variables. | |||||
| SMTP Username | Email Server Account Username
| |||||
| SMTP Password | Email Server Account Password
|
| Info | ||
|---|---|---|
| ||
Hit on the "Send Test Email" button to quickly validate and test out your the email settings. |
Configure Email Attachments
Figure 3: Email Tool Properties - AttachmentsAttachments
Figure 4: ICS Attachment
| Name | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Form | File attachment source form. | ||||||||||
| Form Upload Fields | Field ID: File attachment field ID(s) in the Form selected above. Embed: Click the checkbox to embed the image attachment in the email and display the image using HTML, for example: <img src="cid:#form.table.FileUpload?url#" /> | ||||||||||
| Files | This attribute allows one to define the file attachment freely by defining a system path or absolute URL.
See Send Datalist as attachment in Email Tool for more information. | ||||||||||
| Attach ICS File | Check this option to prepare an event and attach as an ICS file in the email. When this attribute is checked, one will need to populate the details for the calendar ICS file in the fields below. |
|
Sample Screenshot of Settings
Important: The organizer or sender email must not be the same as your destination/recipient email. If sender and recipient emails are the same, you will not see the "Add to calendar" box in your email. |
Figure 5: Sample .ics File Opened using Microsoft Outlook
...
Figure 6: Sample .ics File Opened using Gmail
Images In Email Tool
In Joget DX, we introduced a new ?img2base64 hash variable escape char to convert images tag src in Rich text editor field to base64 data string so that Email Tool can display the image. The syntax is: #form.tableName.richTextFieldId?img2base64#
Note: Google Gmail will not allow images having base64 data.
Alternatively, starting from Joget DX v7.0.7, we can now easily embed images via the "Embed" option in the "Files" property.
See this section: Configure Email Attachments
Sample app available below.
Download Demo App
- APP_email_tool_with_ics_attachment_dx_kb.jwa
- APP_embed_image_email_dx.jwa (Requires Joget DX v7.0.7 or higher)
Related Tutorials
- Sending Email
- User Notification Plugin Plugin
- User Notifications Tutorial Tutorial
- Export Form Email Tool
- Send JasperReports PDF in Email Tool
- Add Signature Form Element as Image into Email Content
...