Skip to navigation
Runtype APIEmail IMAP

Send a test email via SMTP

Sends a test email through the supplied SMTP configuration to confirm delivery works.

Authentication

AuthorizationBearer
API key or Clerk session token

Path parameters

surfaceIdstringRequired

Request

This endpoint expects an object.
fromAddressstringRequiredformat: "email"
smtpHoststringRequired>=1 character
smtpPasswordstringRequired>=1 character
smtpUsernamestringRequired>=1 character
tostringRequiredformat: "email"
fromNamestringOptional
smtpPortintegerOptional1-65535Defaults to 587
smtpSecurebooleanOptional

Response

Test email sent
successboolean
messageIdstringOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error
503
Service Unavailable Error