Skip to content

SMTP

Endpoints

PUT /api/v1/options    { key, value }            upsert any smtp_* key
POST /api/v1/options/test/smtp { testTo? }       send a test message

Configuration

KeyPurpose
smtp_hostSMTP server hostname (required).
smtp_port1–65535 — typically 587 for STARTTLS, 465 for TLS.
smtp_userUsername.
smtp_passPassword.
smtp_fromFrom-address. Defaults to smtp_user if empty.

These keys override the corresponding SMTP_* ENV variables when set. Use ENV for the bootstrapped first-boot config and the admin panel for ongoing changes (no restart required — the email transporter is invalidated on save).

Test

POST /options/test/smtp accepts an optional testTo address (defaults to the current admin's email) and dispatches a single test message. Failures surface the underlying nodemailer error inline so you can diagnose auth failures, port blocks, or DNS issues quickly.

See also

For why SMTP is required (OTP signup), provider-specific examples, and SPF/DKIM/DMARC setup, see Self-Hosting → SMTP.