Skip to main content
POST
/
mail-sender
/
test-transport-config
cURL
curl --request POST \
  --url http://127.0.0.1:3000/api/mail-sender/test-transport-config \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "to": "[email protected]",
  "transportConfig": {
    "sender": "<string>",
    "host": "<string>",
    "port": 123,
    "auth": {
      "user": "<string>",
      "pass": "<string>"
    },
    "senderName": "<string>",
    "secure": true
  },
  "message": "<string>"
}
'

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
to
string<email>
required
transportConfig
object
required
message
string

Response

200

Test mail transporter successfully.

Last modified on January 25, 2026