Email Connector Guide

Back Next

Event source properties

You can configure an event source in an Email connection to read email messages sent by an email server. The Email connection uses the IMAP protocol to read unseen email messages.

For AWS PODs, you can configure an event source on both the Cloud Server and Secure Agent, while in other PODs, you configure an event source on the Secure Agent only. After configuring the event source, publish the connection to the selected runtime environment. You can then access the event source in a process and deploy it to the same runtime environment to consume the events generated by the event source.

Perform the following steps to create an event source in an Email connection:

Go to the

Event Sources

tab.

Click

Add Event Source

Select the event source type as

Email Listener

You can add only one event source for each connection.

The following image shows the event source properties:

The list of event source properties you can configure in an Email connection.

The following table describes the event source properties:

Property	Description
Name	Required. Enter a unique name for the event source. The name must start with an alphabet and can contain only alphabets, numbers, and hyphens (-).
Description	Optional. A description for the event source.
Enabled	Select Yes to make the event source available immediately after it is published. Select No to disable the event source until you are ready to use it. Default is Yes .

The following table describes the advanced event source properties that you can configure for IMAP Settings:

Property	Description
Host	Required. Enter the DNS name or IP address of the email server.
IMAP port	Required. Enter the port for communication between the email client and the IMAP server to listen to incoming emails using the IMAP protocol. Default is 993.

You can't use TLS with Gmail and Yahoo when configuring an event source. Use SSL with port 993 instead. For more information, see Google documentation.

The following table describes the advanced event source properties that you can configure for IMAP operation settings:

Property	Description
Copy To	Enter the folder name to copy the email message to after processing.
Move To	Enter the folder name to move the email message to after processing.
Delete	Required. Deletes the email message after processing. Default is false .
Other Attributes	Enter a list of additional consumer properties in the URL-encoded format, separated by an ampersand (&). By default, you read emails from the INBOX folder. The unseen property is always set to true .