Email Agent Configuration

Owned by Yeok Hong Ng (Deactivated)
Last updated: Apr 26, 2024
2 min read

You open the Email Agent configuration dialog from a workflow configuration: click the agent icon and select Configuration, or double-click the agent icon.

Connection Tab

The Connection tab contains configuration settings related to connecting to the email server.

The Email Agent configuration dialog - Connection tab

Setting

Description

Protocol

Select either IMAP or POP3 depending on what your email server supports. 

Folder

From which folder emails will be processed.

Note!

If using POP3 it will automatically read from the Inbox.

Host

The URL of the host.

Port

The ports the email server accepts connections for the chosen protocol.

Internal Batch Size

The number of messages the agent fetches all contents for at a time.

Security Tab

The Security tab includes settings that control the security aspects of connecting to an email server.

The Email Agent configuration dialog - Security tab

Setting

Description

TLS

Select if using TLS. If left unchecked it is configured to trust all hosts.

Keystore Path

If TLS is checked. The path to a file that can contain both the keystore and truststore.

Keystore Password

if TLS is checked. Enter the password of the keystore/truststore file.

Email Username

Username of the email account which the agent will connect to.

Email Password

Password of the email account which the agent till connect to.

Rules Tab

The Rules tab includes settings that control the which emails to read and what will happen to them after processing.

The Email agent configuration dialog - Rules tab

Setting

Description

Emails to process

Select if you want to process all emails in the selected folder, only unread or only read.

Filter on subject

Optional parameter that will filter all unprocessed emails on the string input. It will match as long as the subject contains the string.

Example: 

Subject: "Hello world!"

Filter on subject: "ell" → matches

Filter on subject: "Hello" → matches

Filter on subject: "!" → matches

Note!

This filtering can only be done after fetching emails from the email server, meaning that the MIMs defined might be untrustworthy.

Seen

Optional parameter that mark the email as read on the email server.

Note!

If using POP3 it is not possible to set the Seen flag.

Deleted

Optional parameter that deletes the email on the email server.

Flagged

Optional parameter that mark the email as flagged on the email server.