API

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.

Example Request:

POST api/emails/your-api-key/[email protected]/newuser/newexample.com

Example Response:

{rn    "status": true,rn    "data": {rn        "email": "[email protected]",rn        "domain": "newexample.com",rn        "ip": "127.0.0.1",rn        "fingerprint": "eef780ab2ec7535e66c1405c0bff1c64",rn        "expire_at": "2026-01-01T00:00:00.000000Z",rn        "created_at": "2026-01-01T00:00:00.000000Z",rn        "id": 2,rn        "email_token": "email_token"rn    }rn}

Delete Email

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

Parameters:

• apiKey - Your API key.
• email - The email address to delete.

Example Request:

POST api/emails/your-api-key/[email protected]

Example Response:

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

Get Messages

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

Parameters:

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

Example Request:

GET api/messages/your-api-key/[email protected]

Example Response:

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

Get Message

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

Parameters:

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

Example Request:

GET api/messages/your-api-key/message/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1

Example Response:

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

Delete Message

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

Parameters:

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

Example Request:

POST api/messages/your-api-key/message/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1

Example Response:

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

Download Attachment

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

Parameters:

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

Example Request:

GET api/d/abc123/filename.pdf

Example Response:

The file will be downloaded directly.

Token to Email

GET /token/{email_token}

Parameters:

• email_token - Your email token

Description:

Send your visitors to a site with a token to create the same email.

Example Response:

The user will be redirected to a page where the email associated with the token is created or displayed.