How to add an SMTP provider configuration
Fill in the "Add an SMTP provider configuration" form to register a mail server for an environment.
Have questions or need step-by-step guidance on this topic?
Step-by-Step Procedure
Open the form
On /admin/communications/email-engine/providers scroll to "Add an SMTP provider configuration".
Enter identity and server
"Display name" (required), "Environment" (development, staging or production; default production), "SMTP host" (required), "Port" (default 587).
Enter sender details
"From address" (required email), "From display name" and "Reply-to" (both optional).
Set limits
"Rate limit / minute (optional)", "Max attempts" (default 5) and "Retry base delay (ms)" (default 30000).
Set the toggles
Tick "TLS (secure)" if the server needs TLS, "Default for this environment" (ticked by default) and "Enabled" (ticked by default).
Choose credentials
See the credentials guide, then click "Create provider configuration". A green message reads Created "<display name>". and the form resets.
The new configuration appears under "Configured providers" as "Unverified" until you run a health check.
Troubleshooting & Failure Modes
Was this guide helpful?
Help us refine our platform documentation