Email configuration

The email configuration page allows a SysAdmin to quickly configure a deployment to send emails.

To access the email settings page, go to the Admin portal > Platform settings > Email.

Modes

Email configuration has 3 modes: SMTP, SES, and Logging.

Field Name Description Example

Field Name	Description	Example
Host Name	The host of the SMTP server.	`email-smtp.us-west-2.amazonaws.com`
Port	The port of the SMTP server.	`465`
Username	Username to authenticate against the SMTP server.	`AKIAIOSFODNN7EXAMPLE`
Password	Password to authenticate against the SMTP server.	`wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY`
Secure Communication Protocol	SMTP Security method.	`Plaintext`, `TLS`, `STARTTLS`

Host Name

The host of the SMTP server.

email-smtp.us-west-2.amazonaws.com

Port

The port of the SMTP server.

465

Username

Username to authenticate against the SMTP server.

AKIAIOSFODNN7EXAMPLE

Password

Password to authenticate against the SMTP server.

wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

Secure Communication Protocol

SMTP Security method.

Plaintext, TLS, STARTTLS

Note	SMTP configuration will be synced to the deployment’s Keycloak instance upon saving. This removes the need to log in to Keycloak to update SMTP settings.

Field Name Description Example

Field Name	Description	Example
AWS Region	Optional override for AWS SES region. The default is `us-west-2`.	`us-east-1`

AWS Region

Optional override for AWS SES region. The default is us-west-2.

us-east-1

Note	Ensure nucleus-dispatcher has access to a policy with the `ses:SendRawEmail` permission.

Logs email sending attempts when debug logging is enabled.

This required field is the email address that will appear in the from field of emails sent from the deployment.