Temp Mail API

The YelMail Temp Mail API is a REST API for disposable inboxes. Create a temporary email address from your test suite, sign up like a real user, then read the verification code or magic link it receives.

Every response is JSON in the shape { data } or { error: { code, message } }. API keys come with Premium. New to email testing? Follow the step-by-step Playwright guide.

Get an API key OpenAPI spec

Authentication

Send your Premium API key as a bearer token. Rate limits are returned in X-RateLimit-Remaining. Guest clients such as the browser extension can instead pass the token returned by POST /inboxes in an X-Inbox-Token header.

# Create an inbox
curl -X POST https://yelmail.com/api/v1/inboxes \
  -H "Authorization: Bearer tm_your_key" \
  -H "Content-Type: application/json" -d '{}'

# Read its messages
curl https://yelmail.com/api/v1/inboxes/INBOX_ID/messages \
  -H "Authorization: Bearer tm_your_key"

Endpoints

GET

/domains

List domains you can create addresses on

POST

/inboxes

Create an inbox (random, or custom with localPart + domainId)

GET

/inboxes

List your active inboxes

GET

/inboxes/{id}

Get one inbox

PATCH

/inboxes/{id}

Update label or forwarding target

DELETE

/inboxes/{id}

Delete an inbox and its emails

GET

/inboxes/{id}/messages

List messages (newest first, cursor pagination)

GET

/inboxes/{id}/stream

Server-Sent Events stream of new messages

GET

/messages/{id}

Get a message with text, sanitized HTML and attachments

DELETE

/messages/{id}

Delete a message

GET

/messages/{id}/attachments/{attachmentId}

Download an attachment

GET

/me

Current user and plan entitlements

DELETE

/me/session

Sign out the bearer session token sent with the request (apps, extension)

POST

/extension/token

Browser extension sign-in: trade a connect code and PKCE verifier for a session token

Need higher limits? Contact us.