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:

...

Email Tool Properties

Configure Email Tool

Image RemovedImage Added

Figure 1: Email Tool Properties

...

Tip

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

Image RemovedImage Added

Figure 2: SMTP Settings

...

Info
titleQuick Test

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

Digital Signature

Image RemovedImage Added

NameDescription
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 PassphraseThe .jks file's Passphrase.
Issuer AliasThe digital certificate's or signature's Issuer name (alias).

Error Handling

Image RemovedImage Added

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

Configure Email Attachments

Image RemovedImage Added

Figure 3: Attachments

Image RemovedImage Added

Figure 4: ICS Attachment

NameDescription
FormFile 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.

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 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.

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.

Note

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

...

...