Email configuration

The SOAR Platform sends email messages to users for notifications, such as when a new user becomes a member or when the platform assigns a user a task. Therefore, the SOAR Platform must use an SMTP server to send these messages. After you install the platform, stay in the SSH client you use and enter the following command with the options you want to use to edit the SMTP configuration: 

sudo resutil smtpedit
This command has the following options and defaults:
  • -help prints the SMTP edit configuration help. The default is false.
  • -email provides the email address in the From field of the email message.
  • -host provides the hostname of the mail server.
  • -name provides the name in the From field of the email message.
  • -nostarttls provides the option to not issue a StartTLS when the system connects to the mail server.
  • -port provides the port of the mail server.
  • -user provides the user of the mail server. The system prompts you for the password if you use this option.
  • -wlhost specifies the hostname when it is different from the certificate common name to avoid certificate name mismatch errors.

The following example shows how to configure the system so that email messages sent from the SOAR Platform appear to be from SOAR Incident Management <user@example.com>. In this example, the SMTP server is <smtp.example.com> and the port is 2525. The SMTP server requires authentication in this example and the account that is used is the SOAR account. If your SMTP server does not require authentication, you can omit the –user . 

sudo resutil smtpedit -email user@example.com -name "SOAR Incident 
Management" -host smtp.example.com -port 2525 -user soar
Enter the password for the user: <SMTPpassword>

Confirm the password for the user: <SMTPpassword>

Successfully edited the SMTP configuration
SMTP Host: smtp.example.com
SMTP Port: 2525
SMTP User: soar
SMTP Password: hidden
SMTP From Email: user@example.com
SMTP From Name: SOAR Incident Management

If you want to use an encrypted connection, you must ensure that the SMTP server’s certificate is trusted. If unsure, you can follow the instructions in the Importing Untrusted Certificates section.

After you configure email, you can test the configuration by entering the following command with the options you want to use.


sudo resutil smtptest

This command has the following options and defaults:

  • -help prints the SMTP test configuration help. The default is false.
  • -email provides the email address where you want to send the test email message.

The following example shows how to use -email.

sudo resutil smtptest -email joe@example.com
Successfully sent the test email to joe@example.com