Send test email | Neon Docs

POST/projects/{project_id}/branches/{branch_id}/auth/send_test_emailSend 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.

Parameters

project_idstringpathrequired

The Neon project ID

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

branch_idstringpathrequired

The Neon branch ID

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

Request body

required

application/json

objectSendNeonAuthTestEmailRequest

hoststringrequired

Hostname of the email server.

passwordstringrequired

Password for authenticating with the SMTP server.

portintegerrequired

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

recipient_emailstring · emailrequired

The email address to send the test email to.

maxLength 256 · minLength 1

sender_emailstringrequired

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

sender_namestringrequired

Display name shown as the sender in outgoing emails.

usernamestringrequired

Username for authenticating with the SMTP server.

Example request

{
  "host": "string",
  "password": "",
  "port": 0,
  "recipient_email": "user@example.com",
  "sender_email": "string",
  "sender_name": "string",
  "username": "string"
}

Responses

objectSendNeonAuthTestEmailResponse

error_messagestring

The error message from the email server.

successbooleanrequired

Whether the test email was sent successfully.

Example response

{
  "error_message": "string",
  "success": true
}

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. application/json

objectGeneralError

codestringrequired

default ""

messagestringrequired

Error message

request_idstring

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.

Example response

{
  "code": "",
  "message": "string",
  "request_id": "string"
}

Examples

project_idrequiredpath parameter

branch_idrequiredpath parameter

curl -X POST 'https://console.neon.tech/api/v2/projects/string/branches/string/auth/send_test_email' \
  -H 'Content-Type: application/json' \
  -d '{"host":"string","password":"[REDACTED]","port":0,"recipient_email":"user@example.com","sender_email":"string","sender_name":"string","username":"string"}'

const response = await fetch('https://console.neon.tech/api/v2/projects/string/branches/string/auth/send_test_email', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"host":"string","password":"[REDACTED]","port":0,"recipient_email":"user@example.com","sender_email":"string","sender_name":"string","username":"string"}),
});
const data = await response.json();

const response = await fetch('https://console.neon.tech/api/v2/projects/string/branches/string/auth/send_test_email', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"host\":\"string\",\"password\":\"\",\"port\":0,\"recipient_email\":\"user@example.com\",\"sender_email\":\"string\",\"sender_name\":\"string\",\"username\":\"string\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "https://console.neon.tech/api/v2/projects/string/branches/string/auth/send_test_email",
    headers={"Content-Type": "application/json"},
    data='{"host":"string","password":"[REDACTED]","port":0,"recipient_email":"user@example.com","sender_email":"string","sender_name":"string","username":"string"}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"host":"string","password":"[REDACTED]","port":0,"recipient_email":"user@example.com","sender_email":"string","sender_name":"string","username":"string"}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "https://console.neon.tech/api/v2/projects/string/branches/string/auth/send_test_email", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://console.neon.tech/api/v2/projects/string/branches/string/auth/send_test_email");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"host\":\"string\",\"password\":\"\",\"port\":0,\"recipient_email\":\"user@example.com\",\"sender_email\":\"string\",\"sender_name\":\"string\",\"username\":\"string\"}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://console.neon.tech/api/v2/projects/string/branches/string/auth/send_test_email"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"host\":\"string\",\"password\":\"\",\"port\":0,\"recipient_email\":\"user@example.com\",\"sender_email\":\"string\",\"sender_name\":\"string\",\"username\":\"string\"}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://console.neon.tech/api/v2/projects/string/branches/string/auth/send_test_email")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"host\":\"string\",\"password\":\"\",\"port\":0,\"recipient_email\":\"user@example.com\",\"sender_email\":\"string\",\"sender_name\":\"string\",\"username\":\"string\"}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://console.neon.tech/api/v2/projects/string/branches/string/auth/send_test_email");
request.Content = new StringContent("{\"host\":\"string\",\"password\":\"\",\"port\":0,\"recipient_email\":\"user@example.com\",\"sender_email\":\"string\",\"sender_name\":\"string\",\"username\":\"string\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "error_message": "string",
  "success": true
}

{
  "code": "",
  "message": "string",
  "request_id": "string"
}