API Documentation

Integrate temporary email functionality into your applications with our simple REST API.

POST /api/email/generate

Public

Generate a new temporary email address.

Response

{
  "address": "user-1234@shazamail.com"
}

GET /api/email/:address/messages

Public

Retrieve messages for a specific email address.

Parameters

address: The email address to fetch messages for.

Response

{
  "messages": [
    {
      "id": "uuid",
      "sender": "sender@example.com",
      "subject": "Hello",
      "body_text": "Text content",
      "body_html": "<p>HTML content</p>",
      "received_at": "2024-01-01T00:00:00.000Z",
      "is_read": false
    }
  ]
}

POST /api/inbound/webhook

Internal

Webhook endpoint for receiving incoming emails from SMTP providers.

Payload

{
  "recipient": "user-1234@shazamail.com",
  "sender": "sender@example.com",
  "subject": "Subject line",
  "body_text": "Plain text body",
  "body_html": "HTML body"
}