Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Introduction

English
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

Image Added

Figure 1: Email Tool Properties

NameDescription
Screens (Click to view)
To (Specific email address)Recipient fully qualified address
.

Image Removed

Figure 1: Email Tool Properties
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.

Info

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.

Info

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.

Info

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.

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.

Image Added

Figure 2: SMTP Settings

NameDescription
Screens (Click to view)
From

Sender email address.

Info
titleExample

no-reply@your-company-name.com

Image RemovedFigure 2: SMTP Settings

SMTP Host

Email Server SMTP Host

Info
titleExample

smtp.gmail.com

SMTP Port

Email Server SMTP Port

Info

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

Info

On Google email account, use your full email address.

SMTP Password

Email Server Account Password

Info

Password submitted will be encrypted for security reason.

Info
titleQuick Test

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

Configure Email Attachments

Image Added

Figure 3: Attachments

Image Added

Figure 4: ICS Attachment

NameDescription
Screens (Click to view)
FormFile attachment source form.
Image Removed

Figure 3: Attachments

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.

NameDescription
PathSource file path & filename.
Type
  • System Path
  • URL
File NameFile 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 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.

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

Image Removed

Sample

Image Added

Figure 5: Sample .ics File Opened using Microsoft Outlook

Image Removed

Image Added

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

Related Tutorials