Email Listener

Description

The Email listener reads email messages from a configured email account through IMAP or POP3 and sends them to 1Gateway. Supports attachments.

Prerequisites

(Optional) Create a directory where to move the emails to after they are read.
If needed, enable POP3 protocol on the email server

Installation

Make sure you have the 1gateway zip file that includes the plugin files and valid licences information ready. This file has been provided to you with the installation files.

Login to 1gateway, and make sure you are in "Advanced mode". If this is the first time you log in, the default user and password are both 'admin' (without the quotes).

2 - System Maintenance

Click on the menu icon and choose the option "System maintenance"

3 - Upload file

In the System maintenance view you can either drag and drop the downloaded zip file or select it by clicking the "choose file" button.

4 - Restart

After the upload installation will be confirmed. Restart 1Gateway to ensure any locked files are updated.

Configuration

Open the main menu and click on "New plugin"

Select the plugin you want to configure. Use the Filter field if needed.

Field name	Supported values	Description
Email server	Any string	Email server to connect to
Email user	Any valid email address	Email address which to obtain emails from
Password	Any string	Password of the email user
Server type	POP3, IMAP, POP3 with SSL, IMAP with SSL/TLS	Type of connection to the email server
Polling interval	Any string	Polling interval in seconds (default is 300)
Action to take after reading emails	Mark as seen, Delete, Move to write folder	Defines what to do with an email after its read. If POP3 protocol is selected, the email can't be moved to a different directory
Read folder	Any string	Name of the directory from which to read emails.
Write folder	Any string	Directory to move the emails to after they are read (only used if the "Move to write folder" option is selected)
Email content format	TEXT, JSON, XML, DELIMITED	Format of the content of the email
Delimiter between fields	"Newline" or any character	Defines the delimiter between fields to use in the message (only used if the DELIMITED format is selected)
Delimiter between key and value	Any character or string	Defines the delimiter between the key and value of the message fields (only used if the DELIMITED format is selected)

If the delimited format is selected, the delimiters need to be configured.

For example. for the following email each line is a message field and the key and value pairs are divided by a colon and a <space>.

Image 2. Sample delimited email and its configuration in 1Gateway