Send test email

Sends a test email using the SMTP server settings supplied in the request body to verify connectivity and credentials.
The request body must include the full SMTP server settings
(host, port, username, password, sender_email, sender_name) and the recipient_email address.

Deprecated: to test a branch's already-saved configuration, use sendNeonAuthEmailProviderTest, which
reuses the stored SMTP password server-side so the caller never has to re-supply (or be able to read) it.
This endpoint remains available for testing an unsaved full configuration and for non-Better-Auth providers.

Path Params
string
required
^[a-z0-9-]{1,60}$

The Neon project ID

string
required
^[a-z0-9-]{1,60}$

The Neon branch ID

Body Params
string
required

Hostname of the email server.

integer
required

TCP port of the SMTP server. Common values: 25 (SMTP), 465 (SMTPS), 587 (submission).

string
required

Username for authenticating with the SMTP server.

string
required

Password for authenticating with the SMTP server.

string
required

Email address used as the From address on outgoing auth emails.

string
required

Display name shown as the sender in outgoing emails.

string
required
length between 1 and 256

The email address to send the test email to.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json