Joget DX Available for Download

Check out Joget DX, the next generation successor to Joget Workflow for faster, simpler digital transformation.

Skip to end of metadata
Go to start of metadata

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

New Feature

New feature added in Joget Workflow v6.

  • ICS Attachment

Figure 1: Email Tool Properties

To (Specific email address)Recipient fully qualified address.
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.


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.


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.

SubjectEmail Subject.
MessageEmail Message.
HTML Content?Check if "Message" is intended to be a HTML content.

Figure 2: Email Tool Properties - SMTP Settings

If no SMTP settings is configured here, this tool will read the SMTP configuration in the "General Settings".

You may configure common SMTP settings in "General Settings > SMTP Settings" for your future convenience.


Sender email address.


Email Server SMTP Host


Email Server SMTP Port

Typically, port 465 for SSL security option and 587 for TLS

  • 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 out your email settings.

Figure 3: Email Tool Properties - Attachments

FormFile attachment source form.
Form Upload FieldsFile attachment field ID(s) in the Form selected above.

This attribute allows one to define the file attachment freely by defining a system path or absolute URL.

PathSource file path & filename.
  • System Path
  • URL
File NameFile name to be used in Email attachment.
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.

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.

Sample Screenshot of Settings

Sample .ics File Opened using Microsoft Outlook

Related Tutorials

  • No labels