Vibex Academy
Vibex Academy

API Documentationv1.0

HTTP endpoints & bot integration for Outlook mailboxes

Strict Token-Scoped Access & Security Model

Vibex Mail Reader's API is strictly isolated per mailbox. Every request requires a valid uuid access token — the same token from your private mail link. There is no global list, no anonymous browsing, and only holders of a specific token can access that individual mailbox. All mailbox credentials remain encrypted on the backend, tokens are stored only as hashes, and every request is rate-limited and audit-logged.

API Endpoints

GET/api/public/otp

Scans both Inbox + Spam for the given mailbox and returns the latest verification code directly as a plain text string. If no code has arrived yet, returns an empty response.

Parameters
NameRequiredDescription
uuidYesThe access token from your private mail link (/mail/TOKEN).
Example
curl "https://mailreader.click/api/public/otp?uuid=YOUR_ACCESS_TOKEN"
RESPONSE (TEXT/PLAIN)
849201
GET/api/public/latest

Returns the latest email object with sender, subject, date, plain-text body, detected links, and the automatically parsed OTP code in a structured JSON payload.

Parameters
NameRequiredDescription
uuidYesThe access token from your private mail link (/mail/TOKEN).
Example
curl "https://mailreader.click/api/public/latest?uuid=YOUR_ACCESS_TOKEN"
RESPONSE (APPLICATION/JSON)
{
  "email": "user@outlook.com",
  "otp": "849201",
  "subject": "Your verification code",
  "from": "Service Team",
  "from_address": "no-reply@service.com",
  "date": "2026-10-17T10:24:11Z",
  "preview": "Your code is 849201...",
  "body_text": "Your code is 849201...",
  "links": [{ "text": "Verify", "url": "https://service.com/verify?token=..." }],
  "message_id": "AAMk..."
}
GET/api/public/read_code

Returns the most recent messages across Inbox + Spam, each with its parsed OTP code and links. Useful when you need to pick a code from a specific sender or subject.

Parameters
NameRequiredDescription
uuidYesThe access token from your private mail link (/mail/TOKEN).
limitNoNumber of messages to return (default 5, max 20).
Example
curl "https://mailreader.click/api/public/read_code?uuid=YOUR_ACCESS_TOKEN&limit=5"
RESPONSE (APPLICATION/JSON)
{
  "email": "user@outlook.com",
  "folder": "inbox+junk",
  "message_count": 5,
  "counts": { "inbox": 4, "junk": 1 },
  "messages": [
    {
      "index": 0,
      "folder": "inbox",
      "id": "AAMk...",
      "subject": "Your verification code",
      "from": "Service Team",
      "from_address": "no-reply@service.com",
      "date": "2026-10-17T10:24:11Z",
      "is_read": false,
      "preview": "Your code is 849201...",
      "otp": "849201",
      "links": [{ "text": "Verify", "url": "https://service.com/verify?token=..." }]
    }
  ]
}

Tools

API Playground

Live

Paste a private mail link token and run a real request against the live API — the response appears below.

AI Integration Code Generator

AI-powered

Describe what your OTP automation should do and pick your programming language — AI will write ready-to-run integration code for this API.

Notes

  • Both Inbox and Spam/Junk folders are scanned — codes landing in spam are never missed.
  • Responses are never cached (Cache-Control: no-store) — you always get live data.
  • Disabled or expired links return an error response; regenerate the link from the admin panel to restore access.
  • Keep your token secret — anyone with the token can read that mailbox.