Skip to main content
POST
/
api
/
ext
/
generic
/
email
/
smtp-email-test
Test SMTP email sending
curl --request POST \
  --url https://app.spotzee.com/api/ext/generic/email/smtp-email-test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data hostname_ip=smtp.gmail.com \
  --data port=587 \
  --data security=tls \
  --data username=user@example.com \
  --data password=password123 \
  --data from_email=sender@example.com \
  --data to_email=recipient@example.com
{
  "status": "success",
  "data": {
    "connection": "success",
    "details": {
      "hostname": "<string>",
      "port": 123,
      "security": "<string>",
      "response": "220 smtp.example.com ESMTP ready",
      "features": [
        "STARTTLS",
        "AUTH LOGIN",
        "AUTH PLAIN",
        "SIZE 35882577"
      ]
    },
    "error": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication. Use format: Bearer YOUR_API_KEY

Body

application/x-www-form-urlencoded
​
hostname_ip
string
required

SMTP server hostname or IP address

Example:

"smtp.gmail.com"

​
port
number
required

SMTP server port number

Required range: 1 <= x <= 65535
Example:

587

​
security
enum<string>
required

SMTP security protocol

Available options:
none,
tls,
ssl
Example:

"tls"

​
username
string
required

SMTP authentication username

Example:

"user@example.com"

​
password
string
required

SMTP authentication password

Example:

"password123"

​
from_email
string
required

Sender email address

Example:

"sender@example.com"

​
to_email
string
required

Recipient email address

Example:

"recipient@example.com"

Response

Successfully tested email sending

​
status
enum<string>
required

Indicates successful operation

Available options:
success
​
data
object
required