Skip to content

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.

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

Per-tenant config keys, set via the tenant-admin UI or a seed. 🔒 = encrypted at rest.

KeyTypeDefaultScopeWho can writeWho can read
auth-usertext""tenantTenantAdmin, SystemAdminTenantAdmin, SystemAdmin
fromtext""tenantTenantAdmin, SystemAdminTenantAdmin, SystemAdmin
hosttext""tenantTenantAdmin, SystemAdminTenantAdmin, SystemAdmin
portnumber (1–65535)587tenantTenantAdmin, SystemAdminall
securebooleanfalsetenantTenantAdmin, SystemAdminall
SecretScopeHint
mail-transport-smtp:secret:smtp-passwordtenantLogin password at the SMTP server. Brevo/Postmark/SES call it ‘API key’ or ‘SMTP credentials’.
  • Registers extension: mailTransportsmtp