Setting Up a Flow to Handle Email Events (IMAP)

Last Updated: 12/03/2015 Introduced in Verision: 2.0

An email event is a change in state on an email server, such as when the server receives or relays an email. The system can be configured to handle email events for a Post Office Protocol (POP3) server or an Internet Message Access Protocol (IMAP) server.

A POP3 server requires that clients download emails from the server to access them. An IMAP server allows a client to access emails directly on the server.

During the setup process, configure the mail server name, and the user name and password of the account with events to handle.

To set up a flow to handle email events, navigate to the folder System > Jobs and Events > Events, then use the wizard to set up the flow. Once the set up is complete, continue configuring the flow in the Flow Designer so that the event information can be displayed.



In the example, the Event Setup wizard is used to set up a flow to handle email events.

To begin, navigate to the folder System > Jobs and Events > Events and click the Add Event button.



In the Please Select Events step, select Email Event and click Next.



In the Email Server Information step, in the Mail Type drop-down list, select Imap and enter a mail server name.

Enter the user name and password for the account with email events to handle. If required, you could also enter a port. Select Next.



In the Event Info step, enter a name for the event in the  Name field, a description, and click Next.



In the Simple Calendar step, a list of common intervals for event handling displays.

To select an interval that is not listed, you could select the Advanced option, click Next, then set up the custom interval.

In this example select Every Hour and click Next.



Once you received the Event is created message you can now edit the flow. Select Done.
Select the new event from the entity list and click Edit Flow from the entity actions menu.



The Flow Designer opens with the flow for this event. Note that in the Properties panel, under the Flow Data section, for the Flow Input Data field, the data element email_data (EmailData[ ]) appears.



The properties of this data element match those we entered when creating the event. You could add an appropriate component to the flow; for example you could add a Send Email Notification component to the flow .



Then select the Show Mapping Editor link in the Properties panel to map it to the “email_data” element




Need more help with:

Setting Up a Flow to Handle Email Events (IMAP)?


Contact us at

Additional Resources