Prerequisites
- You are a Super Admin (Email Configuration is Super Admin–only; see RBAC).
- Your mail provider allows SMTP from the EKB host (firewall / IP allowlists as needed).
- You know the provider’s host, port, and whether it expects TLS (STARTTLS) or SSL (implicit TLS).
- For on-premises password reset and system mail, at least one healthy configuration should be marked Default.
Where to find it
Open Super Admin → Email Configuration. Two sub-tabs:
The SMTP Settings layout is a list of configurations on the left and a detail form on the right. Badges show Default and Active when applicable. Use New SMTP to start a blank form.
Field reference
Required to save: Name, Host, and Sender email.
Passwords are stored encrypted when platform email encryption is configured.
Common provider patterns
Always follow your provider’s current documentation for host, port, and authentication.
Add or edit a configuration
- Go to Super Admin → Email Configuration → SMTP Settings.
- Click New SMTP, or select an existing config from the list.
- Fill in the fields in the field reference.
- Click Save. Success confirms the configuration is stored.
- Prefer Send test email before marking a new config as default or assigning it to teams.
Send a test email
- Select a saved configuration (not an unsaved new form).
- Open the test-email action and enter a recipient address you can check.
- Confirm the message arrives from the expected Sender email / Sender name.
Platform default
Exactly one active configuration can be the platform default.- Select the config you want as default.
- Choose Make default and confirm.
Assign SMTP per team
- Open Super Admin → Teams → select the team → Settings → Edit Settings.
- Under SMTP Configuration, choose:
- Platform default (currently <name>) — inherit the current default and follow future default changes, or
- A specific named configuration — pin that team to that sender even if the platform default changes.
- Save team settings.
Resolution order
- If the team has a pinned
smtp_config_idand that config is still active → use it. - Otherwise → use the platform default.
- If a pinned config is missing or deactivated → fall back to the platform default.
Deactivate a configuration
Deactivating soft-deactivates the config (it leaves the active list; it is not a hard purge of history).- Prefer switching teams and the platform default before deactivating a sender that is still in use.
- Keep at least one healthy Default when you rely on platform email.
Email templates
On the Templates tab you can edit platform email templates (subject and body). Preview and reset-to-default actions are available per template where supported. Templates render through the SMTP path resolved for the relevant team (or the platform default).Password reset (on-premises)
Password reset emails are sent through the configured SMTP path, with reset links routed through the backend so they work correctly in on-premises deployments. If SMTP is missing or misconfigured, reset mail fails (callers may see a service-unavailable style error). Configure and test SMTP before relying on self-service reset in on-prem.Typical setups
Troubleshooting
Related
- Teams — team settings, including SMTP override
- RBAC — Email Configuration is Super Admin–only
- Workflow failure notifications — requires SMTP for the team (on-premises)