Test sending an email message

This endpoint allows you to send a test email using the configured SMTP integration settings. It is used to verify that the provided SMTP credentials (such as host, port, username, and password) are working correctly and can be used to send emails.

Use this endpoint to ensure that your SMTP integration is properly set up before enabling real transactional or notification emails in your application.

Test sending an email message

post

Query parameters

api-versionstringOptional

Header parameters

BrandUrlstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

AuthkeystringRequired

This is used to authenticate the request. If the request is not authenticated, the server will return a 401 Unauthorized response.

Example: YOUR_AUTH_KEY

Body

application/jsontext/jsonapplication/*+json

hoststring · min: 1Required

The SMTP server hostname or IP (e.g., smtp.gmail.com).

portinteger · int32Required

The port number for the SMTP server (typically 587 or 465).

usernamestring · min: 1Required

The username/email address for SMTP authentication.

passwordstring · min: 1Required

The password for SMTP authentication.

useTlsbooleanRequired

Whether to enable SSL for SMTP connection.

emailAddressFromstring · min: 1Required

The sender email address.

emailAddressTostring · min: 1Required

The recipient email address.

subjectstring · min: 1Required

The subject of the test email.

bodystring · min: 1Required

The body content of the test email.

Responses

200

The request was successful.

application/json

401

The user is not authorized to access the requested resource. The request is missing the required AuthKey header.

application/json

403

The user's access was denied.

application/json

429

The user has exceeded the rate limit.

application/json

post

HTTPcURLJavaScriptPython

POST /api/app-integrations/smtp/test HTTP/1.1
Host: protocol.jframework.dev
BrandUrl: text
Authkey: text
Content-Type: application/json
Accept: */*
Content-Length: 155

{
  "host": "text",
  "port": 1,
  "username": "text",
  "password": "text",
  "useTls": true,
  "emailAddressFrom": "text",
  "emailAddressTo": "text",
  "subject": "text",
  "body": "text"
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": true,
  "errors": []
}