Skip to content

SMTP

SMTP#

Overview#

This integration sends out notifications to email recipients.

Prerequisites#

  • For on-premise instances, an SMTP server needs to be setup first.

  • For SaaS instances, the SMTP server is not available during trials.

Configure the channel#

Go in Configuration Management

image

Go in Alert Channel, and hit the + button.

image

Select the smtp template . Select the Analytic Engine on which you want this configuration to be deployed; and provide a Configuration Name that is meaningful for you. The Description is optional.

[smtp]
  enabled = true
  host = "localhost"
  port = 25
  username = "username"
  password = "passw0rd"
  from = "me@example.com"
  to = ["me@example.com", "you@example.com"]
  no-verify = false
  idle-timeout = "30s"
  global = false
  state-changes-only = false

Enter the correct settings: * host: Your SMTP host * port: Your SMTP port * username: Your SMTP username * password: Your SMTP password * from: The “From” address for outgoing mail. * to: List of default “To” addresses.

Other configuration options are possible, such as: * Global: When this option is set to true, emails will be sent for all alerts, even if not explicitely specified in the alert configuration.

Once done, click Apply. Your Channel is ready.

Configure your Alert Definitions#

Go in Alert Definitions, and edit the configuration(s) for which you want email notification.

image

Add the list of email recipients: 

.email().to('email@example.com').to('email2@example.com')

Once done, click Apply. Your Alert definition is ready to send email notification.