API v2

البداية أنواع API إنشاء صندوق الوارد جلب الرسائل الإلكترونية إعداد النطاقات المخصصة إنشاء عنوان نطاق مخصص Webhooks خاصة Webhooks قياسية

API v3 NEW

v3 Overview Scoped API Keys Create & Manage Inboxes Emails & Raw .eml Wait for Email Webhooks & Deliveries Custom Domains TempMail Domains Usage & Quota

البداية

مرحباً بك في TempMail Developer API. لدينا بعض الميزات الرائعة مثل...

لا حاجة لمفتاح API للتسجيل (لفئة Basic المجانية)
النطاقات المخصصة لمستخدمي Plus وUltra
والمزيد! تحقق من صفحة الأسعار لمزيد من المعلومات.

إذا لم تكن تستخدم مكتبة، يجب أن تحتوي جميع طلبات POST على ترويسة Content-Type مضبوطة على application/json!

اختر مكتبتك

Python

NodeJS

Java

HTTP

$ pip3 install tempmail-lol

أنواع API

بريد إلكتروني

كائن البريد الإلكتروني، الذي يتم إرجاعه عند التحقق من صندوق الوارد.

الاسم	النوع	الوصف
from	string	مرسل البريد الإلكتروني
to	string	المستلم (بريدك المؤقت)
subject	string	موضوع البريد الإلكتروني
body	string	نص عادي، قد يكون فارغاً
html	?string	HTML البريد الإلكتروني (قد يكون فارغاً)
date	number	الطابع الزمني Unix لاستلام البريد الإلكتروني

صندوق الوارد

كائن صندوق الوارد، يحتوي على عنوان البريد الإلكتروني ورمز الوصول.

الاسم	النوع	الوصف
address	string	عنوان البريد الإلكتروني الذي تم إنشاؤه
token	string	رمز الوصول المستخدم لعرض صندوق الوارد

عمر صندوق الوارد

تختلف أعمار صناديق الوارد بناءً على فئة الاشتراك.

فئة الاشتراك	العمر
مجاني (بدون اشتراك)	ساعة واحدة
TempMail Plus	عشر ساعات
TempMail Ultra	ثلاثون ساعة

يمكن تمديد عمر صناديق الوارد (فقط للنطاقات المخصصة) ببساطة عن طريق طلب طريقة إنشاء صندوق الوارد مرة أخرى.

إنشاء صندوق الوارد

يمكن استخدام طريقة إنشاء صندوق الوارد باستخدام GET أو POST. يتيح لك طريقة POST تخصيص الخيارات، مثل البادئة والنطاق الخاص بصندوق الوارد.

طريقة GET موجودة حالياً لأسباب قديمة.

from TempMail import TempMail
tmp = TempMail("optional-api-key")

inb = tmp.createInbox()

# Or... use a prefix
inb = tmp.createInbox(prefix = "joe")

# You can use a setup custom domain here
inb = tmp.createInbox(domain = "mycustomdomain.com", prefix = "optional")

النص

المعلمة	النوع	الوصف	الافتراضي
domain	?string	نطاق صندوق الوارد، أو عشوائي. يمكن أن يكون نطاق مخصص.	null
prefix	?string	بادئة صندوق الوارد، أو عشوائي.	null

الاستجابة (201)

الاسم	النوع	الوصف
address	string	عنوان البريد الإلكتروني لصندوق الوارد.
token	string	رمز صندوق الوارد.

جلب الرسائل الإلكترونية

جلب الرسائل الإلكترونية باستخدام الرمز المستلم عند إنشاء البريد الإلكتروني. إذا فقدت الرمز، لن تتمكن من الوصول إلى البريد الإلكتروني مرة أخرى، إلا إذا كان نطاق مخصص (يرجى عدم الاتصال بالدعم حول هذا الأمر، لا يمكننا إعطائك عنوان البريد الإلكتروني لأسباب قانونية).

from TempMail import TempMail
tmp = TempMail("optional-api-key")

inb = tmp.createInbox()

emails = tmp.getEmails(inb.token)

print("Emails:")

for email in emails:
    print("\tSender: " + email.sender)
    print("\tRecipient: " + email.recipient)
    print("\tSubject: " + email.subject)
    print("\tBody: " + email.body)
    print("\tHTML: " + str(email.html)) # may be None
    print("\tDate: " + str(email.date)) # Unix timestamp in milliseconds

استعلام

المعلمة	النوع	الوصف	الافتراضي
token	string	الرمز المستخدم للوصول إلى صندوق الوارد	null

الاستجابة (200)

الاسم	النوع	الوصف
emails	Email[]	مجموعة الرسائل الإلكترونية المستلمة من الخادم
expired	boolean	صحيح إذا انتهت صلاحية صندوق الوارد (راجع عمر صندوق الوارد)

إعداد النطاقات المخصصة

قبل استخدام نطاق مخصص على TempMail، يجب إعداد بعض السجلات. يوصى بالقيام بذلك على صفحة الحسابات، ولكن يمكنك القيام بذلك عبر API أيضاً.

تتطلب النطاقات المخصصة اشتراك TempMail Plus أو Ultra.

النص

المعلمة	النوع	الوصف	الافتراضي
domain	string	النطاق للتسجيل على TempMail	null

Response (200)

الاسم	النوع	الوصف
uuid	string	UUID لإعداد سجلك (راجع أدناه)

أضف هذا السجل إلى نطاقك تحت [uuid].yourdomain.com وضبط القيمة إلى tm-custom-domain-verification.

إذا كنت تستخدم نطاق فرعي بدلاً من ذلك، قم بضبطه على [uuid].subdomain.yourdomain.com.

الاستجابة (4xx)

الاسم	النوع	الوصف
error	string	الخطأ الذي يشرح سبب عدم إمكانية إعداد النطاق.

إنشاء عنوان نطاق مخصص

إنشاء صندوق بريد للنطاق المخصص بنفس طريقة إنشاء صناديق البريد العادية، ولكن باستخدام نطاقك!

ملاحظات:

يجب استخدام نفس الحساب الذي تم استخدامه لإنشاء UUID للنطاق
سيقوم معامل prefix بضبط البادئة العادية بدون أرقام مسبوقة

from TempMail import TempMail
tmp = TempMail("API Key required for custom domains")

inb = tmp.createInbox()

inb = tmp.createInbox(domain = "mycustomdomain.com", prefix = "optional")

النص

المعلمة	النوع	الوصف	الافتراضي
domain	string	نطاقك المخصص.	null
prefix	?string	عنوان البريد الإلكتروني (قبل @) لصندوق الوارد، أو عشوائي.	null

الاستجابة (201)

الاسم	النوع	الوصف
address	string	عنوان البريد الإلكتروني لصندوق الوارد.
token	string	رمز صندوق الوارد.

إذا فقدت رمز صندوق الوارد، قم باستدعاء الطريقة مرة أخرى بنفس البادئة. سيتم تمديد عمر صندوق الوارد بناءً على اشتراكك. يمكنك تمديد عدد غير محدود من المرات.

تحقق من صندوق الوارد باستخدام الطريقة في جلب الرسائل الإلكترونية.

Webhooks خاصة

تعيين Webhooks خاصة بحيث يتم توجيه جميع الرسائل الإلكترونية لنطاقك إلى Webhook الخاص بك.

يتطلب اشتراك TempMail Ultra نشط.

يجب أن يكون لديك نطاقك معد بالفعل للنطاقات المخصصة ([uuid].domain.com).

Body

المعلمة	النوع	الوصف	الافتراضي
domain	string	النطاق لتعيين Webhook الخاص بك عليه	null
url	string	عنوان URL لـ Webhook الذي سيتم إعادة توجيه الرسائل الإلكترونية إليه	null

الاستجابة (200)

الاسم	النوع	الوصف
success	true	دائماً صحيح
message	string	رسالة معلومات النجاح

الاستجابة (4xx)

الاسم	النوع	الوصف
error	string	رسالة تحتوي على تفاصيل الخطأ

يمكنك أيضاً حذف /private_webhook مع النطاق كمعلمة استعلام لإزالته.

Webhooks قياسية

تعيين Webhooks قياسية على كل بريد إلكتروني قياسي تقوم بإنشائه. سيتم إعادة توجيه الرسائل الإلكترونية إلى Webhook الخاص بك.

يتطلب اشتراك TempMail Ultra نشط.

لن يتم تطبيق هذا بأثر رجعي على الرسائل الإلكترونية الحالية.

النص

المعلمة	النوع	الوصف	الافتراضي
url	string	عنوان URL لـ Webhook الذي سيتم إعادة توجيه الرسائل الإلكترونية إليه	null

الاستجابة (200)

الاسم	النوع	الوصف
success	true	دائماً صحيح

الاستجابة (4xx)

الاسم	النوع	الوصف
error	string	رسالة تحتوي على تفاصيل الخطأ

يمكنك أيضاً حذف /webhook لإزالته من حسابك.

API v3 Overview NEW

API v3 is the new, consistent TempMail API. It adds account-level inbox management, a wait-for-email long poll, raw .eml downloads, per-inbox webhooks with automatic retries and delivery logs, custom domain management, a list of TempMail's own domains, scoped API keys, and a usage endpoint.

What changed from v2:

Fetches consume exactly what they return. Emails you receive in a response are deleted; emails excluded by your filters (since, from, limit) stay in the inbox. v2 wipes the whole inbox on every read.
Errors are consistent. Every error is { "error": { "code", "message" } } with a matching HTTP status-never a 200.
Rate limits are visible. Responses carry x-ratelimit-limit, x-ratelimit-remaining and x-ratelimit-reset headers (reset is a unix timestamp in seconds). 429 responses include retry-after.
v2 stays supported. Inboxes are shared between versions; v3 has its own create and fetch endpoints, but tokens work on both.

Base URL:  https://api.tempmail.lol/v3

# account endpoints accept either key type:
Authorization: Bearer tempmail.20260101.abcdef...   # primary key
Authorization: Bearer tempmail.sk.abcdef...          # scoped key

# error envelope (here: HTTP 403)
{
  "error": {
    "code": "insufficient_scope",
    "message": "This API key does not have the required scope: domains:read",
    "required_scope": "domains:read"
  }
}

Scoped API Keys

Create additional API keys that can only do specific things, so your CI pipeline or a third-party integration never holds your full account credential. The key secret is returned once on creation and only a hash is stored.

Keys are managed with your primary API key (or the website), a scoped key can never manage keys.

Scopes

Scope	Grants
inboxes:create	Create inboxes (works on v1/v2 create endpoints too)
inboxes:read	List your inboxes
webhooks:read	Read webhook config and delivery logs
webhooks:write	Set/remove per-inbox webhooks
domains:read	List/inspect custom domains
domains:write	Register/verify/remove custom domains
usage:read	Read usage & quota

GET/v3/keyslist keys

POST/v3/keyscreate a key

PATCH/v3/keys/:idrename / re-scope / revoke

DELETE/v3/keys/:iddelete a key

curl -X POST https://api.tempmail.lol/v3/keys \
  -H "Authorization: Bearer $PRIMARY_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "ci key", "scopes": ["inboxes:create", "inboxes:read"]}'

# 201 -> { "key": "tempmail.sk....", "id": "...", "scopes": [...], ... }
#        the "key" field is shown ONCE. store it now

Create & Manage Inboxes

Create inboxes anonymously (free tier, per-IP limits) or with an API key (per-account limits, longer lifespans, account ownership). Inboxes created with a key belong to your account and can be listed with the inboxes:read scope; per-inbox endpoints are authorized by the inbox token itself.

POST /v3/inboxes - body (all optional)

Parameter	Type	Description	Default
prefix	?string	Local part prefix (a-z, 0-9, _, -)	random
domain	?string	A TempMail domain (see TempMail Domains), or a custom domain verified to your account. Plus/Ultra accounts draw random domains from their own premium pool.	random
community	?boolean	Prefer a community domain	false

GET /v3/inboxes - query

Parameter	Type	Description	Default
limit	?number	Page size (max 200)	50
cursor	?string	`next_cursor` from the previous page	null
include_expired	?boolean	Also return expired inboxes	false

POST/v3/inboxescreate an inbox

GET/v3/inboxeslist your inboxes

GET/v3/inboxes/:tokenmetadata + email count

DELETE/v3/inboxes/:tokendelete inbox + its emails

curl -X POST https://api.tempmail.lol/v3/inboxes \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"prefix": "ci-run-42"}'

# 201
{
  "address": "[email protected]",
  "token": "...",
  "created_at": "2026-07-16T00:22:22.000Z",
  "expires_at": 1784269342568,
  "expired": false,
  "webhook_configured": false
}

Fetch Emails & Raw .eml

Fetching emails consumes what it returns: emails in the response are deleted, while emails excluded by since or limit stay in the inbox (v2 deletes everything on read).

Raw RFC822 source is a TempMail Ultra feature. For Ultra-owned inboxes each fetched email includes a raw field with the exact MIME source received over SMTP (null if it was not captured). The standalone /raw endpoint downloads a .eml for an email that has NOT been consumed yet - useful with the email_id from webhook delivery logs. If the verbatim source is unavailable, a reconstructed .eml is served (marked with x-tempmail-reconstructed: true).

GET /v3/inboxes/:token/emails - query

Parameter	Type	Description	Default
since	?number	Only emails with `date >=` this unix ms timestamp	0
limit	?number	Max emails returned (max 200)	100

GET/v3/inboxes/:token/emailsfetch + consume

DELETE/v3/inboxes/:token/emails/:iddelete without reading

GET/v3/inboxes/:token/emails/:id/rawdownload .eml (Ultra)

curl -OJ https://api.tempmail.lol/v3/inboxes/$TOKEN/emails/$ID/raw

# -> Content-Type: message/rfc822
#    Content-Disposition: attachment; filename="<id>.eml"
#    x-tempmail-reconstructed: false

# without Ultra -> 403
# { "error": { "code": "tier_required", "required_tier": "ultra", ... } }

Wait for Email (long poll)

Blocks until an email matching your filters arrives, or the timeout passes - one request instead of a polling loop. Perfect for signup flows and CI: request the OTP, then wait for it.

Matched emails are returned and consumed; emails that do not match the from/since filters stay in the inbox untouched.

Query

Parameter	Type	Description	Default
timeout	?number	Seconds to wait (max 60)	30
from	?string	Sender filter, wildcards allowed (`*@example.com`)	null
since	?number	Ignore emails older than this unix ms timestamp	0

At most 2 concurrent /wait requests per inbox. A timeout is still HTTP 200, with "timed_out": true and an empty emails array.

curl "https://api.tempmail.lol/v3/inboxes/$TOKEN/wait?\
from=*@example.com&timeout=30"

# matched emails are consumed on return
{
  "emails": [{
    "id": "6a58244f...",
    "from": "[email protected]",
    "subject": "Your verification code is 482913",
    "body": "Code: 482913",
    "raw": "From: [email protected]\r\n...",  // Ultra only
    ...
  }],
  "timed_out": false,
  "waited_ms": 2311
}

Per-Inbox Webhooks & Delivery Logs

Attach a webhook to a single inbox (TempMail Ultra): new mail to that inbox is POSTed to your URL. Failed deliveries are retried automatically with backoff - 30s, 5m, 30m, 2h after the initial attempt (5 attempts total).

Every delivery and each attempt (status code, error, duration) is logged for 7 days and queryable - this covers account-wide (v2) webhooks, private domain webhooks, and per-inbox webhooks alike.

GET /v3/webhooks/deliveries - query

Parameter	Type	Description
status	?string	`pending` \| `success` \| `failed`
address / domain	?string	Filter by recipient inbox or domain
limit / cursor	?number / ?string	Pagination (max 200)

PUT/v3/inboxes/:token/webhookset webhook (Ultra)

GET/v3/inboxes/:token/webhookread webhook

DELETE/v3/inboxes/:token/webhookremove webhook

GET/v3/webhooks/deliveriesdelivery log

{
  "deliveries": [{
    "url": "https://example.com/hook",
    "event": "email.received",
    "address": "[email protected]",
    "status": "success",
    "attempt_count": 2,
    "attempts": [
      { "at": "...", "status_code": 500, "error": "HTTP 500", "duration_ms": 12 },
      { "at": "...", "status_code": 200, "error": null, "duration_ms": 45 }
    ],
    "created_at": "..."
  }],
  "next_cursor": null
}

Custom Domains

Register a custom domain to your account, get the exact DNS records to create, and re-run verification whenever you like - with structured per-record results instead of a single pass/fail. Requires TempMail Plus or Ultra.

DNS records returned by the API

Type	Name	Value
TXT	`<hash>.yourdomain.com`	`tm-custom-domain-verification`
A	`mx.yourdomain.com`	(returned by the API)
MX	`yourdomain.com`	`mx.yourdomain.com` (priority 10, must be the only MX)

The exact TXT name/value pair is account-specific - always read it from the API response.

POST /v3/domains/verify re-checks up to 100 of your domains in one call, least recently checked first, and returns the same per-domain results. It can run once every 10 minutes per account; calling it sooner returns 429 rate_limited with a retry-after header.

GET/v3/domainslist your domains

POST/v3/domainsregister + verify

GET/v3/domains/:domaindetails + DNS records

POST/v3/domains/:domain/verifyre-run verification

POST/v3/domains/verifyre-verify all (once per 10 min)

DELETE/v3/domains/:domainunregister

{
  "domain": { "domain": "yourdomain.com", "verified": true, ... },
  "checks": {
    "txt": { "pass": true,  "detail": "Ownership TXT record found." },
    "mx":  { "pass": false, "records": [...],
             "expected": "mx.yourdomain.com",
             "detail": "Expected a single MX record..." }
  },
  "dns": { "ownership_txt_options": [...], "mail_records": [...] }
}

TempMail Domains

List every domain TempMail itself serves, split into the premium pool that only Plus/Ultra accounts can create inboxes on and the free pool that any tier can use. Pass any of them as domain when creating an inbox. Requires TempMail Plus or Ultra and the domains:read scope; free accounts get a tier_required error.

Response fields

Field	Type	Description
domains_premium	string[]	The premium pool. Random Plus/Ultra inboxes are drawn from here.
domains_free	string[]	The free pool, including community domains. Usable by every tier.

An entry starting with *. is a wildcard: both the bare domain and any subdomain of it are accepted, so *.example.com lets you create [email protected] or [email protected]. The lists change over time as domains are rotated in and out, so re-fetch them rather than caching them for long.

GET/v3/domains/poollist TempMail domains (Plus/Ultra)

curl https://api.tempmail.lol/v3/domains/pool \
  -H "Authorization: Bearer tempmail.sk...."

{
  "domains_premium": [
    "*.plusonly.example",
    "premium.example"
  ],
  "domains_free": [
    "*.free.example",
    "community.example"
  ]
}

Usage & Quota

See your tier, how much of the inbox-creation window you have used, and counts of your active inboxes, keys, and domains. Requires the usage:read scope.

{
  "tier": "ultra",
  "inbox_creation": {
    "window_seconds": 300,
    "limit": 5000,
    "used": 2,
    "remaining": 4998,
    "resets_at": 1784161500000,
    "limited_by": "account"
  },
  "inboxes_active": 2,
  "api_keys_active": 1,
  "custom_domains": 0,
  "webhook_deliveries_last_7d": 14
}

مساعدة API

تحتاج إلى مساعدة بخصوص API؟ انضم إلى خادم Discord الخاص بنا! يسعدنا مساعدتك، لذا دعنا نعرف إذا كانت لديك مشكلة، أو إذا كنت بحاجة إلى مساعدة في فهم شيء ما بخصوص API الخاص بنا.