Streamline email management with inbound monitors
Email monitors allow you to define an inbox for an email address you want to monitor for incoming email messages. This can be handy for managing emails sent to a group inbox, especially from external sources like customers, vendors, students, etc.
How does it work?
When a message arrives in a monitored mailbox, it’ll generate a new request in Workflow Automation. To manage the request, assign a mailbox and create a process.
The data captured from the email will include the following:
- "Subject"
- "Sender Name"
- "Sender Address"
- "CC Addresses"
- "Date/Time"
- "Date"
- "Time"
- "BodyText”
- "BodyHTML"
- "Body"
- "Attachments"
These data points can then be used as prefilled data and within your business rules for routing during process execution.
Configuring an inbound email monitor
Select System Settings > Email Monitors from the left-side navigation menu.
Then choose Add Email Monitor.
Once selected, you’ll be presented with the following options to configure an email monitor.
Email monitor attributes
Here are the attributes you can define:
| Attribute | Option | Required | Description |
|---|---|---|---|
| Name | None | Yes | The name of the email monitor. |
| Description | None | No | The description of the email monitor. |
| IMAP Mail Server Host Name | None | No | The fully qualified domain name of the IMAP Server you want to use. |
| Port | None | No | The port for your connection. Standard IMAP ports are 143 for non-SSL and 993 for SSL connections. |
| Frequency (minutes) | None | Yes | The frequency at which the email monitor checks for unread emails, measured in minutes. |
| Active | Slide button | No | Select to make the email monitor active. |
| User | None | No | The username for your connection (if required). |
| Password | None | No | The password for your connection (if required). |
| Process | Select list | No | The process you wish to initiate from the inbound email. |
| Task | Select list | No | Dynamic based on the process selected. The task within the process you wish to complete with the inbound email. |
| Use SSL | Slide button | No | If using SSL for your connection. |
Using the email monitor with Gmail
To authenticate with a Gmail account set up with IMAP, a unique app password must be generated to provide Workflow Automation access to the inbox. Check out this article(opens in a new tab) for information on how to set this up and generate a one-time password for the email monitor.
Example email monitor configuration
Here’s an example of an email monitor configuration.
Once you’ve saved an email monitor, you can see that the process will start and the task will be completed with data from the inbound email.
Form task definition for the email monitor
When you define a process and its form task that will start based on an email being received in your configurations, you’ll need to ensure that the form used in your form task has questions with specifically titled questions. The form fields must be of the short text type, and the field labels must be spelled the same as they are in the list below (i.e. the field for BodyText input must have BodyText for a label).
The values passed in from the email are:
- "Subject"
- "Sender Name"
- "Sender Address"
- "CC Addresses"
- "Date/Time"
- "Date"
- "Time"
- "BodyText”
- "BodyHTML"
- "Body"
- "Attachments"
You must configure the Form task’s prefill settings as shown below with Parent Process Data or the email’s data won’t be transferred to your input form.
Your forms must have questions with labels of these names to receive the desired data.
Here’s an example of a form with the required question types.
You can also edit your email monitors here.
In addition, you can check for new email by selecting the Envelope icon.
This will prompt you to select Yes or No.
