This section explains how to configure Qumulo Alerts to work with an email server.
Configuring Qumulo Alerts Integration with an Email Server
To configure Qumulo Alerts to integrate with an email server, you must edit QumuloEmailServer.json
, located in the config/consumers
directory, in the directory that you cloned from GitHub.
The following is an explanation of the JSON keys that configure integration with an email server.
The
login
, password
, and use
keys are optional depending on the type of SMTP email server that you use.Name | Description |
---|---|
default_language |
The recipient's language locale The consumer processes for email and ClickSend integrations translate messages into the recipient's native language. For more information, see What Language Locales Qumulo Alerts Supports. |
default_timezone |
The recipient's timezone For more information, see Converting Time Zones. |
from_addr |
The sender's email address |
login |
(Optional) The username for the SMTP email server |
password |
(Optional) The password for the SMTP email server |
port |
The port for the SMTP email server, commonly 587 for SSL or TLS |
server |
The fully qualified domain name (FQDN) or IP address of the SMTP email server |
to_addr |
The recipient's email address Important
This field is only for testing the email server. Normally, Qumulo Alerts uses the values from QumuloUsers.json . |
use |
(Optional) The security protocol to use: ssl or tls |
Using Gmail as an SMTP Relay
After May 2022, only organizations with access to the Google Admin Console can use SMTP relay. If your organization has this access, see Route outgoing SMTP relay messages through Google.
Example: Configured Email Server Integration
{
"from_addr": "robert@example.com",
"to_addr": "test@example.com",
"login": "robert@xyzcorp.com",
"password": "<password>",
"server": "smtp.xyzcorp.com",
"port": 587,
"use": "tls",
"default_language": "en_GB",
"default_timezone": "UTC"
}
To Test Integration with Your Email Server
-
To add execution permissions to the
test_email.macos-latest
andtest_email.ubuntu-latest
files, run the following command.chmod a+x test_email.*
-
To test the integration, run the executable for your operating system. For example:
./test_email.ubuntu-latest --config ./config/consumer/
The email server sends a test message to the email address specified in the
to_addr
key.