Email Listeners

New
  • 2 minute(s) read
Prev Next

Email Listeners allow you to automatically trigger workflows when an email is received. This is particularly useful for automating an Email Start Event.

An Email Start Event listens for incoming emails based on pre-configured criteria, and once matched, it initiates a new request in the associated process. This configuration removes the need for manual form submissions and enhances real-time process automation.

View Email Listeners

Permissions

Your user account or group membership must have the "Settings: View Settings" permission to view email listeners unless your user account has the Make this user a Super Admin setting selected.

See the Settings permissions or ask your Administrator for assistance.

Follow these steps to view the email server default settings:

  1. Ensure that you are logged on to ProcessMaker Platform.

  2. Click the Admin option from the top menu. The Users page displays.

  3. Click the Email Listeners icon from the left sidebar to view the following details:

    • Email Address: Displays the email account configured to receive and process incoming requests. This is the address monitored by the listener.

    • Scheduler: Indicates how frequently the system checks the configured inbox for new emails (e.g., every 5 minutes, hourly).

    • Status: Shows whether the email listener is currently active or inactive. An active listener is currently monitoring emails according to the defined schedule.

Edit an Email Listener

Click the Edit icon to change an email listener. For more information, see Create an Email Listener.

Remove an Email Listener

Click the Trash icon to remove an email listener.

Create an Email Listener

Permissions

Your user account or group membership must have the "Settings: View Settings" permission to create an email listener unless your user account has the Make this user a Super Admin setting selected.

See the Settings permissions or ask your Administrator for assistance.

Follow these steps to create or edit an email server configuration:

  1. View your email listeners. The Email Listeners displays.

  2. Click on the +Listener button at the top-right of the Email Listeners panel. The Email Settings section displays.

  3. Enable the SSL option to ensure a secure connection with IMAP email providers that support encrypted access.

  4. In the IMAP server, enter the IMAP email host provider. (e.g., imap.gmail.com , imap.mail.yahoo.com )

  5. In the Port, enter the IMAP provider port that typically is 993 for IMAP with SSL.

  6. In the User Email, enter the email.

  7. In the Password, enter the email password.

  8. In the Scheduling Options section in the Start date, select the date to start listening emails.

  9. In the Repeat every, specify how often the listener should run by entering a number and selecting the desired time unit (day, week, month, or year).

  10. Ends: Choose one of the following options to define when the email listener should stop:

    • Never – The listener will run indefinitely without an end date.

    • On – Select a specific date when the email listener will stop running.

    • After – Enter the number of occurrences after which the listener should stop.

  11. If the email listener is already active and scheduled, click Disable Schedule to deactivate it.

  12. Click Test Connection to verify the configuration and ensure the IMAP email provider is working correctly.

  13. Click Update Listener to save and finalize your changes.