Skip to main content
Version: 8.3 Beta 🚧

Email Notification Profile

Inductive University

Email Notification Profile

Watch the video

Set up an Email Notification Profile so alarms can trigger email alerts, and optionally allow recipients to acknowledge alarms directly from their inbox.

To send notifications, Ignition must be able to connect to an SMTP server. Once the profile is created, you can use it in your Alarm Pipelines to notify users when alarms become active or cleared.

Create an Email Notification Profile​

This section walks you through creating a basic Email Notification Profile using the minimum required fields.

  1. In the Gateway, go to Services > Alarming > Notification.

  2. Click Create Profile +.

    Create Profile

  3. Select Email Notification and click Next.

    Select Email Notification profile type

    tip

    If Email Notification isn’t listed, make sure the Alarm Notification module is installed and running.
    Go to Platform > System > Modules to verify.

  4. Enter values for your device into the required fields. In this example, we used the following:

    Email Notification Profile setup

  5. Click Create Alarm Notification Profile.

  6. The profile appears in the list. You can now assign it to an alarm pipeline.

    Email Notification Profile Status

Email Notification Profile Settings​

The following tables describe all available configuration options for Email Notification Profiles.

Email Settings​

Property NameDescription
Use SMTP Profile?Use a Gateway-defined SMTP profile. If enabled, the Hostname, Port, SSL/TLS, Username, and Password fields are ignored.
SMTP ProfileName of the Gateway SMTP profile to use.
HostnameHostname of the SMTP server.
PortPort number for the SMTP service.
Enable SSL/TLSEnables a secure connection to the SMTP server.
UsernameSMTP server login username.
PasswordSMTP server login password. Accepts embedded or referenced passwords.

Two-Way Settings​

Property NameDescription
Two-way EnabledEnables acknowledgment links in the email body.
GatewayExternal address and port of the Gateway.
Send HTTPS LinkUse https:// in the email link.

POP3 Two-Way Settings​

Property NameDescription
Pop3 Two-way EnabledEnables acknowledgment from a POP3 mailbox.
Enable SSL/TLSEnables a secure connection to the POP3 server.
Delete On AcknowledgeDeletes the email after it is used to acknowledge an alarm.
HostnameHostname of the POP3 server.
PortPort for the POP3 server.
UsernamePOP3 login username.
PasswordPOP3 login password.
Custom MessageOptional message to include in the email body.
Polling IntervalFrequency (in ms) for checking the POP3 server.

Auditing​

Property NameDescription
Audit ProfileAudit profile to log email sends and acknowledgments.

Advanced​

Property NameDescription
SMTP TimeoutTimeout (in milliseconds) for SMTP communication.
Debug Mode EnabledLogs email session output to wrapper.log.
STARTTLS EnabledEnables STARTTLS if supported by the server. Ignored if SMTP Profile is used.