API Documentation

API Documentation
API Documentation

📘 API Documentation

Get Domains

GET /api/domains/{apiKey}/{type}

Parameters:
apiKey - Your API key.
type - Type of domains to fetch (free, premium, all).

{
  "status": true,
  "data": {
    "domains": [
      { "domain": "free.com", "type": "Free" },
      { "domain": "lobage.com", "type": "Free" },
      { "domain": "premium.com", "type": "Premium" }
    ]
  }
}

Create Email

POST /api/emails/{apiKey}

Parameters:
apiKey - Your API key.

{
  "status": true,
  "data": {
    "email": "random@example.com",
    "domain": "example.com",
    "ip": "127.0.0.1",
    "fingerprint": "eef780ab2ec7535e66c1405c0bff1c64",
    "expire_at": "2025-01-01T00:00:00.000000Z",
    "created_at": "2025-01-01T00:00:00.000000Z",
    "id": 1,
    "email_token": "email_token"
  }
}

Update Email

POST /api/emails/{apiKey}/{email}/{username}/{domain}

Parameters:
apiKey - Your API key.
email - The current email address.
username - The new username.
domain - The new domain.

{
  "status": true,
  "data": {
    "email": "newuser@newexample.com",
    "domain": "newexample.com",
    "ip": "127.0.0.1",
    "fingerprint": "eef780ab2ec7535e66c1405c0bff1c64",
    "expire_at": "2025-01-01T00:00:00.000000Z",
    "created_at": "2025-01-01T00:00:00.000000Z",
    "id": 2,
    "email_token": "email_token"
  }
}

Delete Email

POST /api/emails/{apiKey}/{email}

Parameters:
apiKey - Your API key.
email - The email address to delete.

{
  "status": true,
  "message": "Email has been successfully deleted."
}

Get Messages

GET /api/messages/{apiKey}/{email}

Parameters:
apiKey - Your API key.
email - The email address to fetch messages for.

{
  "status": true,
  "mailbox": "example@example.com",
  "messages": [
    {
      "is_seen": true,
      "subject": "Test Subject",
      "from": "John Doe",
      "from_email": "john@example.com",
      "to": "example@example.com",
      "receivedAt": "2025-01-01 00:00:38",
      "id": "ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1",
      "html": true,
      "content": "Test content",
      "attachments": [
        {
          "name": "file.txt",
          "extension": "txt",
          "size": 91,
          "url": "http://yoursite.com/api/d/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1/file.txt"
        }
      ]
    }
  ]
}

Get Message

GET /api/messages/{apiKey}/message/{messageId}

Parameters:
apiKey - Your API key.
messageId - The ID of the message to fetch.

{
  "status": true,
  "data": {
    "is_seen": true,
    "subject": "Test Subject",
    "from": "John Doe",
    "from_email": "john@example.com",
    "to": "example@example.com",
    "receivedAt": "2024-12-28 00:00:38",
    "id": "ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1",
    "html": true,
    "content": "Test content",
    "attachments": [
      {
        "name": "file.txt",
        "extension": "txt",
        "size": 91,
        "url": "http://yoursite.com/api/d/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1/file.txt"
      }
    ]
  }
}

Delete Message

POST /api/messages/{apiKey}/message/{messageId}

Parameters:
apiKey - Your API key.
messageId - The ID of the message to delete.

{
  "status": true,
  "message": "Message was deleted successfully."
}

Download Attachment

GET /api/d/{hash_id}/{file?}

Parameters:
hash_id - The hash ID of the message.
file - (optional) The name of the file to download.

GET /api/d/abc123/filename.pdf

Response: File will be downloaded directly.

Token to Email

GET /token/{email_token}

Parameters:
email_token - Your email token.

Description: Redirects the visitor to a page where the email associated with the token is created or displayed.

Do you accept cookies?

We use cookies to enhance your browsing experience. By using this site, you consent to our cookie policy.

More