Payment ReconcilerDocumentation
QFind anything/
API Reference

Tenant Email Transport

Configure per-tenant SMTP delivery — use platform mail or bring your own SMTP server with encrypted credentials.

What is tenant email transport?

Email transport controls how outbound email is delivered for a tenant. This is separate from email branding (from name, logo, notification toggles).

In v1, tenants can choose:

  • platform — shared platform SMTP (default)
  • smtp — tenant-provided SMTP server with encrypted password storage

Provider modes (SendGrid, SES, Mailgun) are reserved for a future release.

Settings are org-wide (per-tenant), not per-environment.

Transport fields

FieldDescription
modeplatform or smtp
fromEmailSender address when using custom SMTP (required for smtp mode)
smtp.hostSMTP hostname
smtp.portSMTP port (587 for STARTTLS, 465 for implicit TLS)
smtp.secureImplicit TLS (usually true for port 465)
smtp.requireTlsRequire STARTTLS (usually true for port 587)
smtp.usernameSMTP username
passwordWrite-only; never returned in API responses
verificationConnection test status: unverified, verified, or failed

Operations

OperationMethodEndpoint
Get transportGET/tenants/:id/email-settings/transport
Update transportPATCH/tenants/:id/email-settings/transport
Test SMTP connectionPOST/tenants/:id/email-settings/transport/test

Workflow

  1. PATCH transport with mode: smtp and SMTP credentials.
  2. POST .../transport/test to verify the connection (required before delivery).
  3. Outbound email for the tenant uses the verified tenant SMTP transporter.
  4. If SMTP is configured but not verified, delivery is blocked (no silent fallback to platform SMTP).

Environment variables (platform)

VariablePurpose
TENANT_SMTP_ENCRYPTION_KEYMin 32 chars; encrypts tenant SMTP passwords at rest (fail-closed if missing)
SMTP_HOST, SMTP_PORT, etc.Platform default SMTP (see Email Settings)