فهرست نامه‌های دریافتی

نامه‌های صندوق با پوشه، دسته، جستجو و صفحه‌بندی.

GEThttps://api.irnoti.com/v1/email/messages

scope: email.read

folder: inbox|sent|drafts|spam|trash|archive|all. category: primary|otp|updates|promotions|social. پاسخ {items, next}.

پارامترها

نام	محل	نوع	توضیح
mailboxId	query	string	یک صندوق (پیش‌فرض: همهٔ صندوق‌ها).
folder	query	string	پیش‌فرض `inbox`.
category	query	string	دستهٔ صندوق ورودی.
q	query	string	جستجو در همهٔ پوشه‌ها.
unread	query	boolean	فقط خوانده‌نشده.
starred	query	boolean	فقط ستاره‌دار.
hasAttachment	query	boolean	فقط با پیوست.
before	query	string	صفحهٔ بعد.
limit	query	number	تا ۱۰۰.

خطاهای خاص این endpoint

401	unauthorized	کلید API نامعتبر یا منقضی است.
403	feature_disabled	قابلیت ایمیل (یا دامنهٔ دسترسی لازم) برای کلید/حساب شما فعال نیست.

اجرای زنده (محیط تست)

باز کردن در کنسول کامل ←

این endpoint در محیط تست پشتیبانی نمی‌شود؛ برای اجرا، کلید واقعی را در حالت «اجرای واقعی» وارد کنید.

→ قبلی

انتظار برای کد تأیید جدید

بعدی ←

خواندن یک نامه

curl -X GET 'https://api.irnoti.com/v1/email/messages?category=otp&mailboxId=12' \
  -H "Authorization: Bearer $IRNOTI_KEY"

پاسخ نمونه200 OK

{
  "next": null,
  "items": [
    {
      "id": "9001",
      "folder": "inbox",
      "isRead": false,
      "otpCode": "905566",
      "snippet": "Your GitHub code: 905566",
      "subject": "GitHub launch code",
      "category": "otp",
      "fromAddr": "noreply@github.com",
      "fromName": "GitHub",
      "isStarred": false,
      "mailboxId": "12",
      "receivedAt": "2026-10-21T10:00:00.000Z",
      "hasAttachments": false
    }
  ]
}