Neon API (unofficial showcase)
POST/projects/{project_id}/branches/{branch_id}/auth/send_test_emailDeprecated

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.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 parameters · 7 body fields
project_idstringrequired
The Neon project ID
branch_idstringrequired
The Neon branch ID
hoststringrequired
Hostname of the email server.
portintegerrequired
TCP port of the SMTP server. Common values: 25 (SMTP), 465 (SMTPS), 587 (submission).
usernamestringrequired
Username for authenticating with the SMTP server.
passwordstringrequired
Password for authenticating with the SMTP server.
sender_emailstringrequired
Email address used as the From address on outgoing auth emails.
sender_namestringrequired
Display name shown as the sender in outgoing emails.
recipient_emailstringrequired
The email address to send the test email to.

2 status codes
200Response with the result of the test email send
successbooleanrequired
Whether the test email was sent successfully.
error_messagestringoptional
The error message from the email server.
defaultGeneral Error. The request may or may not be safe to retry, depending on the HTTP method, response status code, and whether a response was received. - If no response is returned from the API, a network error or timeout likely occurred. - In some cases, the request may have reached the server and been successfully processed, but the response failed to reach the client. As a result, retrying non-idempotent requests can lead to unintended results. The following HTTP methods are considered non-idempotent: `POST`, `PATCH`, `DELETE`, and `PUT`. Retrying these methods is generally **not safe**. The following methods are considered idempotent: `GET`, `HEAD`, and `OPTIONS`. Retrying these methods is **safe** in the event of a network error or timeout. Any request that returns a `503 Service Unavailable` response is always safe to retry. Any request that returns a `423 Locked` response is safe to retry. `423 Locked` indicates that the resource is temporarily locked, for example, due to another operation in progress.
request_idstringoptional
Unique identifier for the request, useful for debugging. You can set this value manually by including an `X-Request-ID` header in the request. If not provided, the value will be generated automatically.
codestringrequired
Machine-readable code classifying the error type. See `message` for a human-readable explanation.
Default:
messagestringrequired
Error message

Error handling

Any other status is an error: General Error.

The request may or may not be safe to retry, depending on the HTTP method, response status code, and whether a response was received.

  • If no response is returned from the API, a network error or timeout likely occurred.
  • In some cases, the request may have reached the server and been successfully processed, but the response failed to reach the client. As a result, retrying non-idempotent requests can lead to unintended results.

The following HTTP methods are considered non-idempotent: POST, PATCH, DELETE, and PUT. Retrying these methods is generally not safe. The following methods are considered idempotent: GET, HEAD, and OPTIONS. Retrying these methods is safe in the event of a network error or timeout.

Any request that returns a 503 Service Unavailable response is always safe to retry.

Any request that returns a 423 Locked response is safe to retry. 423 Locked indicates that the resource is temporarily locked, for example, due to another operation in progress.