Email sender

Description

The email sender sends 1Gateway messages as email messages through SMTP. Supports attachments.

Prerequisites

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 session property. Email server to connect to
Port number	Any integer	Email session property. Port number
Authenticate	True / false	Email session property. Defines if to authenticate when connecting to the email server with username and password.
Email user	Any valid email address	Email with which to log in to
Password	Any string	Password of the email user
Origin email address	Any valid email address	Origin email address
Default destination email address	Any valid email address	Default destination email for the message.*
Protocol	TLS, SSL, No encryption	Email session property. Protocol used to send emails
Properties filename	Valid filename	(Advanced) if custom properties are needed to create email connection, define them in this file

*Destination email:

If the message doesn't contain a "destemail" field, the messages will be sent to this address.

Multiple email addresses can be provided by separating them with a comma, like so: abc@abc.com,abc@def.com,ghi@abc.com

Advanced configuration

The properties file is used in cases where the fields in the configuration are insufficient. Define the properties filename and create a file with the desired properties. Example of a properties file:

The properties in the properties file will override the properties defined in the configuration. These fields are:

Email server (mail.smtp.host)
Port number (mail.smtp.port)
Authenticate (mail.smtp.auth)
Protocol (mail.smtp.starttls.enable, mail.smtp.ssl.enable)

Make sure to define these fields in the email properties file.