mail-transport-smtp
Registers itself as the "smtp" provider for mail-foundation and owns the per-tenant config keys (host, port, secure, from, authUser) and the encrypted smtp.password secret. Tenants set mail-foundation’s provider config key to "smtp" to activate it; set the SMTP credentials via the admin UI or a seed handler before sending the first mail.
How it fits
Section titled “How it fits”What this feature needs to run (Requires, top) and the write commands it provides (Provides, bottom).
flowchart TB
n_mail_transport_smtp["mail-transport-smtp"]
subgraph how_reqs["Requires"]
n_config["config"]
n_secrets["secrets"]
n_mail_foundation["mail-foundation"]
end
n_config --> n_mail_transport_smtp
n_secrets --> n_mail_transport_smtp
n_mail_foundation --> n_mail_transport_smtp
Dependencies
Section titled “Dependencies”- Requires:
config,secrets,mail-foundation - Activation: always on (not toggleable)
Configuration
Section titled “Configuration”Per-tenant config keys, set via the tenant-admin UI or a seed. 🔒 = encrypted at rest.
| Key | Type | Default | Scope | Who can write | Who can read |
|---|---|---|---|---|---|
auth-user | text | "" | tenant | TenantAdmin, SystemAdmin | TenantAdmin, SystemAdmin |
from | text | "" | tenant | TenantAdmin, SystemAdmin | TenantAdmin, SystemAdmin |
host | text | "" | tenant | TenantAdmin, SystemAdmin | TenantAdmin, SystemAdmin |
port | number (1–65535) | 587 | tenant | TenantAdmin, SystemAdmin | all |
secure | boolean | false | tenant | TenantAdmin, SystemAdmin | all |
Secrets
Section titled “Secrets”| Secret | Scope | Hint |
|---|---|---|
mail-transport-smtp:secret:smtp-password | tenant | Login password at the SMTP server. Brevo/Postmark/SES call it ‘API key’ or ‘SMTP credentials’. |
Extensions & cross-feature APIs
Section titled “Extensions & cross-feature APIs”- Registers extension:
mailTransport→smtp