Search In: Doc:Documentation: Altium Infrastructure Server
Altium DesignerAltium 365Altium MCAD CoDesignerAltium CircuitMakerCompany DashboardAltium On-Prem Enterprise ServerAltium Infrastructure Server
Close
Search Search on Documentation

Configuring Email Notifications

Created: May 06, 2017 | Updated: January 19, 2018
 

Parent page: Browser-based Access & Management

The Altium Infrastructure Server provides the ability to configure email notifications from the Infrastructure Server - flagging various general events to key stakeholders. This feature works in addition to the event notifications presented to relevant users on the STREAM page of the Infrastructure Server's browser-based interface - accessed by clicking the Inbox control, at the top-right of the interface.

Enabling & Configuring the Feature

The feature to send notification emails from your Altium Infrastructure Server is enabled and configured on the Email Notifications page - part of the Settings area of the Infrastructure Server's browser-based interface. This page is an element of the interface that can only be accessed by Administrative users of the Infrastructure Server - those who are part of the Administrators role. Access is through the dedicated ADMIN menu (ADMIN » SETTINGS), located to the far right of the standard USER page header.

The Altium Infrastructure Server supports mail notifications using SMTP (Simple Mail Transfer Protocol) only, since the majority of email systems that send mail over the internet use this protocol.

The Email Notifications page of the ADMIN - SETTINGS area provides the interface for enabling and configuring the Infrastructure Server's email notifications functionality.The Email Notifications page of the ADMIN - SETTINGS area provides the interface for enabling and configuring the Infrastructure Server's email notifications functionality.

By default, the Infrastructure Server email notifications feature is disabled. Enable the Send Mail Enabled option to turn it on.

Configure the fields of the page (detailed below) to set up the feature for your organization:

  • Email From - the email account from which the emails will originate, appearing in the From field of an email (for example mycompanynotifications@gmail.com, for sending notifications through Gmail).
  • Smtp User Name - this is the full originating email address, from which the notification emails are sent (for example mycompanynotifications@gmail.com, for sending notifications through Gmail).
  • Smtp User Password - this is the password portion of the email access credentials.
  • Smtp Host - the SMTP server address (for example smtp.gmail.com when sending mail through Gmail).
  • Smtp Port - the SMTP port (typically 25, or 587 when sending mail through Gmail).
  • Smtp SSL Enabled - used to enable SMTP communications. Check the box if your SMTP server uses TLS/SSL.
  • Interval to check notification (ms) - the periodic checking interval for standard notifications (in the STREAM), specified in milliseconds. By default this is set to 20000ms.
It is recommended to set this interval to a value greater than 10000.
  • Send email notifications interval (ms) - the periodic checking interval for mail, specified in milliseconds. By default this is set to 35000ms.
It is recommended to set this interval to a value greater than 30000.

Example email configuration, when using SMTP to send email notifications from a defined Gmail account.Example email configuration, when using SMTP to send email notifications from a defined Gmail account.

Once enabled and configured as required, click the  button to test sending of emails from the nominated account. The Check Email Settings dialog will appear, use this to enter a target email address and click . The dialog will show progress of Checking... and, if the sending account has been configured correctly, the final message of Sent Successful.

In case there are issues with using a Google account, try allowing access to less secure applications. For example, with this setting OFF, you may encounter the following issue when running the email test check: The SMTP server requires a secure connection or the client was not authenticated. The server response was: 5.5.1 Authentication Required.

Checking the email notifications setup, by sending a test email to a target account. Hover over the image to see the successful result of the check.Checking the email notifications setup, by sending a test email to a target account. Hover over the image to see the successful result of the check.

And of course, checking the target email will yield a Notifications Service Test Email, from the sending email account.

Test email from the Infrastructure Server's notifications service, as received by the target email supplied for the check.Test email from the Infrastructure Server's notifications service, as received by the target email supplied for the check.

With the notifications email configured and tested successfully, be sure to click the  button at the top-right of the page.
If you find an issue, select the text/image and pressCtrl + Enterto send us your feedback.
Content