SMTP

Send Aegis email through your own mail server.

Aegis sends email for notifications, invitations and reminders. The SMTP connector tells it which mail server to use, which account to log in with and which sender address to show. SMTP (Simple Mail Transfer Protocol) is the standard way programs hand email to a mail server.

At a glance

Direction Out of Aegis.
What it sends The email Aegis sends — notifications, invitations, reminders — when your instance has no system mail server.
Where it lands The recipients' mailboxes, from the sender address and name you set.
Credentials and permissions The server, port, username, password and encryption (none, tls or ssl) of an account allowed to send as the sender address.
Owner of imported records Not applicable: nothing is imported.
When it runs At the moment an email is sent.
Set it up /connectors/smtp, by a Manager or Admin, when the SMTP connector module is enabled for your organisation. The status stays Disconnected until a connection test succeeds.

Who uses it

The connector page is for Manager and Admin. A Contributor or Viewer who opens /connectors/smtp gets a 403 Access denied page with a Go to Dashboard button; there is no read-only view. Reading, saving, testing and deleting the configuration are each checked separately on the server, and all of them also need the SMTP connector module to be enabled for your organisation.

What's on this screen

The page opens from the SMTP tile in the Connectors catalogue. This guide has no screenshot of the configuration form; the Connectors chapter shows the access-denied page a Contributor gets here. From top to bottom, the page shows:

Setting up the connector

  1. Enter your mail server in SMTP Host and its Port. Both are required; an empty one stops the save with SMTP host is required or SMTP port is required. The host must be a host name or an IP address, and the port a number from 1 to 65535.
  2. Choose the Encryption. STARTTLS starts plain and then switches to an encrypted connection, usually on port 587. SSL/TLS is encrypted from the first byte, usually on port 465. None sends everything, password included, unencrypted; use it only on a network you trust.
  3. Fill in Username and Password if your server needs a login. Leave both empty for a server that accepts mail without one. On a later visit, leave the password as it is to keep the saved one.
  4. Enter the From Address recipients will see, and optionally a From Name. An empty address stops the save with From address is required. The account above must be allowed to send as that address, or your server may refuse the mail.
  5. Select Save Configuration. The button reads Saving..., then a green “Configuration saved successfully.” message appears above the form and the status banner reads Status: Disconnected. Every save sets the status back to Disconnected, so test again after any change.

If the server refuses the settings, the page shows only Failed to save configuration. That happens, for example, with a host such as localhost, a port above 65535, a From Address that is not a valid email address, or a Username or From Name longer than 255 characters. Check each field against the rules above and save again.

Moving the server means re-entering the password

Changing the server or port asks you to enter the password again: a stored password is only sent to the server it was entered for. The same applies when you switch Encryption to None: the stored password is only sent over the protection it was entered with. Until you type the password, the save is refused with a message saying so.

Testing the connection

Test Connection appears only after a configuration is saved, and it tests the saved settings, not unsaved edits in the form.

  1. Select Test Connection. The button reads Testing... while Aegis connects to your server and waits up to ten seconds for it to answer as a mail server. Save and test are both locked until it finishes.
  2. Read the result above the form. A green “SMTP connection successful” sets the status to Connected. A red message sets it to Error, and the reason is recorded under the status banner.

Failure messages are deliberately short: SMTP host blocked when the server resolves to a network Aegis will not connect to, and Connection failed for anything else, such as a wrong port, a timeout or something other than a mail server answering. Every test, whatever its outcome, is written to the audit log.

What the test does not check

The test confirms that a mail server answers at the host and port. It does not log in, check the server's certificate or send an email. A wrong password or a sender address the account may not use only shows when Aegis sends real mail, so send yourself a notification after setting up.

Deleting the configuration

  1. Select Delete Configuration, bottom left. A dialog asks “Are you sure you want to delete this connector configuration?”
  2. Confirm. The server, login and sender settings are removed, the deletion is recorded in the audit log, and you return to the connectors catalogue.

Tips and limits

Where this connects

All connectors are listed in Connectors. What triggers an email is described in Notifications; notification preferences are in Settings. To send events to another system over HTTP instead, see Webhook. Saves, tests and deletions appear in the audit log.