Setting up e-mail configuration in Elvis 6

Elvis 6 Server contains a built-in e-mail functionality to send out e-mails, for example by using the E-mail API.

This article describes how to configure the e-mail settings in Elvis.

Configuration

Configuration is done in the cluster-config.properties.txt file.

E-mail addresses

Several "from" addresses can be configured.

By default all addresses point to the serverAdminEmail address. Each address is used for a different purpose.

#
# Email address that will receive server warnings.
#
serverAdminEmail=johndoe@somecompany.com
 
#
# Email address from which email notifications are sent to users
#
notificationEmailFrom=${serverAdminEmail}
 
#
# Email address from which API emails are sent
#
email.api.from=${serverAdminEmail}

Settings

E-mails can either be sent using SMTP or Amazon SES (an option in case you run Elvis on Amazon Web Services - AWS).

SMTP settings

#
# To improve reliability of emails, you may have to configure your SMTP server.
# Otherwise mails might get marked as SPAM. Setting the host is usually enough. If needed, credentials can be specified.
#
# @RestartRequired
smtpHost=
 
#
# To use SMTPS over SSL, configure: smtpProtocol=smtps
#
smtpProtocol=
 
#
# Port to use for connecting to smtpHost. Use port 465 or 587 for secure SMTPS.
#
smtpPort=25
 
#
# Username used to connect to smtpHost.
#
smtpUsername=
 
#
# Password used to connect to smtpHost.
#
smtpPassword=

Amazon SES settings

#
# Send emails using Amazon SES instead of using SMTP.
#
# Your server instances must be allowed to use SES.
# Make sure you also configure the correct ses.aws.region
#
ses.enabled=false
 
#
# The AWS-region in which SES is set up
#
ses.aws.region=eu-west-1