Introduction

Email Tool enables one to send emails as part of a workflow process.

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. When To (Specific email address) and To (Participant ID) are both populated, email will be sent to both.
CC	Fully qualified address is expected. Multiple values can be accepted by separating them with semicolons. CC: lets you send a copy of a message to someone who's interested, but is not the primary recipient.
BCC	Fully qualified address is expected. Multiple values can be accepted by separating them with semicolons. Both Cc and Bcc forward a copy of the message to everyone you've listed. The main difference between Cc or Carbon copy and Bcc (Blind carbon copy) is that, with the latter, the recipients do not get to know each other.
Subject	Email Subject.
Message	Email Message.
HTML Content?	Check if "Message" is intended to be a HTML content.

Configure SMTP Settings

If you leave the SMTP settings below empty, Joget will read the default SMTP configuration values from the General Settings > SMTP Settings page.

Figure 2: SMTP Settings

Name	Description
From	Sender email address. Example no-reply@your-company-name.com
SMTP Host	Email Server SMTP Host Example smtp.gmail.com
SMTP Port	Email Server SMTP Port Typically, port 465 for SSL security option and 587 for TLS
Security	None TLS SSL Alternatively, you can click on the "hash" symbol to allow the input of hash variables.
SMTP Username	Email Server Account Username On Google email account, use your full email address.
SMTP Password	Email Server Account Password Password submitted will be encrypted for security reason.

Quick Test

Hit on the "Send Test Email" button to quickly validate and test the email settings.

Digital Signature

Name	Description
Key Store File Path (P12)	File path of the .pfx (or .p12) file under the "wflow" folder in your Joget DX installation folder.
Key Store Passphrase	The .jks file's Passphrase.
Issuer Alias	The digital certificate's or signature's Issuer name (alias).

Error Handling

Name	Description
Number of Retry When Fail to Send Out Email	Number of Retry when the email failed to be sent.
Retry Interval (Seconds)	Retry Interval in Seconds.

Configure Email Attachments

Figure 3: Attachments

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.

Name	Description
Path	Source file path & filename.
Type	System Path URL
File Name	File name to be used in Email attachment.
Embed	Click the checkbox to embed the image attachment in the email and display the image using HTML, for example: <img src="cid:cat.jpg" />

See Send List 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.

Event Name
Start Date Time
End Date Time
Date Format
Timezone (e.g. America/Los_Angeles) (Reference:
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
All Day?
Event Description
Location
Organizer Email
Attendees ( Name and Email are mandatory fields if one chooses to add attendees)

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.

Start date time 00:00 and end date time is 23:59 is considered as all day event.

Advisable to not set time for an all day event when "All day?" is checked.

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)}

Space shortcuts

Page tree