Send a test email via SMTP | Runtype Documentation

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

AuthorizationBearer

API key or Clerk session token

surfaceIdstringRequired

This endpoint expects an object.

fromAddressstringRequiredformat: "email"

smtpHoststringRequired>=1 character

smtpPasswordstringRequired>=1 character

smtpUsernamestringRequired>=1 character

tostringRequiredformat: "email"

fromNamestringOptional

smtpPortintegerOptional1-65535Defaults to 587

smtpSecurebooleanOptional

Test email sent

successboolean

messageIdstring

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

$	curl -X POST https://api.runtype.com/v1/messaging/imap/surfaceId/test-send \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"fromAddress": "no-reply@example.com",
>	"smtpHost": "smtp.example.com",
>	"smtpPassword": "S3cureP@ssw0rd!",
>	"smtpUsername": "smtp_user",
>	"to": "user@example.org"
>	}'

$	curl -X POST https://api.runtype.com/v1/messaging/imap/surfaceId/test-send \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"fromAddress": "no-reply@example.com",
>	"smtpHost": "smtp.example.com",
>	"smtpPassword": "S3cureP@ssw0rd!",
>	"smtpUsername": "smtp_user",
>	"to": "user@example.org"
>	}'