وثائق API
مرجع TempMail API v1
عنوان URL الأساسي
https://mail.taohuaxin.topالمصادقة
جميع نقاط النهاية باستثناء /config تتطلب المصادقة.
أضف الترويسة التالية إلى جميع الطلبات:
x-api-key: tm_your_token_hereاحصل على الرمز المميز: لوحة التحكم → الإعدادات → مفاتيح API
نقاط النهاية
| الطريقة | المسار | الوصف |
|---|---|---|
| GET | /api/v1/config | إعدادات الخادم (عام — لا يتطلب مصادقة) |
| GET | /api/v1/me | جلب الرسائل عبر جميع صناديق البريد (استقصاء طويل) |
| GET | /api/v1/inbox/:address | جلب الرسائل لصندوق بريد واحد (استقصاء طويل) |
| DELETE | /api/v1/inbox/:address | مسح جميع الرسائل في صندوق البريد |
| GET | /api/v1/email/:id | الحصول على بريد إلكتروني محلل بالكامل (نص + HTML + مرفقات) |
| GET | /api/v1/email/:id/rendered | الحصول على نص البريد المعروض |
| GET | /api/v1/email/:id/attachments/:attachmentId | تنزيل مرفق واحد حسب المعرف |
| DELETE | /api/v1/email/:id | حذف بريد إلكتروني واحد |
| GET | /api/v1/domains | عرض نطاقاتك المخصصة |
| POST | /api/v1/domains | إضافة نطاق مخصص |
| DELETE | /api/v1/domains/:id | إزالة نطاق مخصص |
docs.examples
/api/v1/configإعدادات الخادم (عام — لا يتطلب مصادقة)
curl https://mail.taohuaxin.top/api/v1/configdocs.response
{
"domains": ["taohuaxin.top"],
"smtpPort": 25,
"smtpsPort": 465,
"mxPort": 25,
"version": "1.0.0"
}/api/v1/meجلب الرسائل عبر جميع صناديق البريد (استقصاء طويل)
curl -H "x-api-key: tm_your_token_here" \
"https://mail.taohuaxin.top/api/v1/me?count=1&limit=20"docs.response
{
"emails": [
{
"id": "cmcg2a1b40001xyz",
"fromAddress": "[email protected]",
"subject": "Your verification code",
"isRead": false,
"receivedAt": "2026-07-10T08:30:00.000Z",
"mailbox": { "address": "alice", "domain": "taohuaxin.top" }
}
],
"nextSince": "cmcg2a1b40001xyz"
}/api/v1/inbox/:addressجلب الرسائل لصندوق بريد واحد (استقصاء طويل)
curl -H "x-api-key: tm_your_token_here" \
"https://mail.taohuaxin.top/api/v1/inbox/[email protected]?since=cmcg2a1b40001xyz&count=1"docs.response
{
"emails": [
{
"id": "cmcg9f2c80002abc",
"fromAddress": "[email protected]",
"subject": "Welcome!",
"isRead": false,
"receivedAt": "2026-07-10T09:00:00.000Z"
}
],
"nextSince": "cmcg9f2c80002abc"
}/api/v1/inbox/:addressمسح جميع الرسائل في صندوق البريد
curl -X DELETE -H "x-api-key: tm_your_token_here" \
"https://mail.taohuaxin.top/api/v1/inbox/[email protected]"docs.response
{ "success": true }/api/v1/email/:idالحصول على بريد إلكتروني محلل بالكامل (نص + HTML + مرفقات)
curl -H "x-api-key: tm_your_token_here" \
"https://mail.taohuaxin.top/api/v1/email/cmcg2a1b40001xyz"docs.response
{
"id": "cmcg2a1b40001xyz",
"fromAddress": "[email protected]",
"toAddress": "[email protected]",
"subject": "Your verification code",
"bodyHtml": "<p>Your code is <b>123456</b></p>",
"bodyText": "Your code is 123456",
"isRead": true,
"receivedAt": "2026-07-10T08:30:00.000Z",
"attachments": [
{ "id": "att_01", "filename": "invoice.pdf", "mimeType": "application/pdf", "size": 24580 }
]
}/api/v1/email/:id/renderedالحصول على نص البريد المعروض
curl -H "x-api-key: tm_your_token_here" \
"https://mail.taohuaxin.top/api/v1/email/cmcg2a1b40001xyz/rendered"docs.response
From: [email protected]
To: [email protected]
Subject: Your verification code
Date: Fri, 10 Jul 2026 08:30:00 GMT
<p>Your code is <b>123456</b></p>/api/v1/email/:id/attachments/:attachmentIdتنزيل مرفق واحد حسب المعرف
curl -OJ -H "x-api-key: tm_your_token_here" \
"https://mail.taohuaxin.top/api/v1/email/cmcg2a1b40001xyz/attachments/att_01"docs.response
HTTP/1.1 200 OK
Content-Type: application/pdf
Content-Disposition: attachment; filename="invoice.pdf"
Content-Length: 24580
<binary file stream>/api/v1/email/:idحذف بريد إلكتروني واحد
curl -X DELETE -H "x-api-key: tm_your_token_here" \
"https://mail.taohuaxin.top/api/v1/email/cmcg2a1b40001xyz"docs.response
{ "success": true }/api/v1/domainsعرض نطاقاتك المخصصة
curl -H "x-api-key: tm_your_token_here" \
"https://mail.taohuaxin.top/api/v1/domains"docs.response
[
{
"id": "dom_01",
"domain": "mail.example.com",
"verified": true,
"receiveMode": "inherit",
"createdAt": "2026-07-01T00:00:00.000Z"
}
]/api/v1/domainsإضافة نطاق مخصص
curl -X POST -H "x-api-key: tm_your_token_here" \
-H "Content-Type: application/json" \
-d '{"domain":"mail.example.com","receiveMode":"inherit"}' \
"https://mail.taohuaxin.top/api/v1/domains"docs.response
{
"id": "dom_02",
"domain": "mail.example.com",
"verified": false,
"receiveMode": "inherit",
"createdAt": "2026-07-10T10:00:00.000Z"
}/api/v1/domains/:idإزالة نطاق مخصص
curl -X DELETE -H "x-api-key: tm_your_token_here" \
"https://mail.taohuaxin.top/api/v1/domains/dom_02"docs.response
{ "success": true }الاستقصاء الطويل
تدعم نقاط نهاية صندوق البريد الاستقصاء الطويل. اتصل مرة واحدة ويظل الخادم محظوراً حتى وصول البريد (حتى 25 ثانية). يُعيد 204 إذا لم يصل أي بريد قبل انتهاء المهلة.
معاملات الاستعلام
| المعامل | الوصف |
|---|---|
| since | مؤشر من الاستجابة السابقة؛ يتم إرجاع البريد بعد هذه النقطة فقط |
| count | العودة عند وصول N رسائل جديدة (الافتراضي 1، الحد الأقصى 50) |
| limit | الحد الأقصى للرسائل لكل نص استجابة (الافتراضي 20، الحد الأقصى 50) |
| from | تصفية — إرجاع البريد الذي يحتوي حقل "من" على هذه السلسلة الفرعية فقط |
| subject | تصفية — إرجاع البريد الذي يحتوي حقل "الموضوع" على هذه السلسلة الفرعية فقط |
سلوك الحذف
جميع عمليات DELETE هي حذف ناعم: العناصر المحذوفة مخفية عن المستخدمين ولكنها تظل متاحة للمسؤولين لأغراض التدقيق.