Modes
Email configuration has 3 modes: SMTP, SES, and Logging.SMTP
| 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 |
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.
SES
| Field Name | Description | Example |
|---|---|---|
| AWS Region | Optional override for AWS SES region. The default is us-west-2. | us-east-1 |
Ensure nucleus-dispatcher has access to a policy with the
ses:SendRawEmail permission.