صناديق البريد
إنشاء صندوق
POSThttps://api.temporam.com/v3/mailboxes
| الحقل | النوع | مطلوب | الوصف |
|---|
| domain | string | نعم | نطاق أرجعته نقطة النطاقات |
| local_part | string | لا | الجزء المحلي، ويُنشأ عند حذفه |
- 1curl -X POST https://api.temporam.com/v3/mailboxes \
- 2 -H "Authorization: Bearer YOUR_API_KEY" \
- 3 -H "Content-Type: application/json" \
- 4 -d '{"domain":"temporam.com","local_part":"demo"}'
| حقل الاستجابة | النوع | الوصف |
|---|
| data.id | string | معرّف صندوق البريد |
| data.address | string | عنوان صندوق البريد الكامل |
| data.local_part | string | الجزء المحلي من العنوان |
| data.domain | string | نطاق العنوان |
| data.status | string | حالة صندوق البريد |
| data.created_at | string | وقت الإنشاء |
| meta.remaining | integer | الحصة المتبقية ذات الصلة عند توفرها |
عرض الصناديق
GEThttps://api.temporam.com/v3/mailboxes
| المعلمة | الموقع | النوع | مطلوب | الافتراضي | الوصف |
|---|
| page | query | integer | لا | 1 | رقم الصفحة |
| limit | query | integer | لا | 20 | عدد العناصر في الصفحة |
| حقل الاستجابة | النوع | الوصف |
|---|
| data | array | صناديق البريد بالحقول الموضحة أعلاه |
| meta.total | integer | العدد الإجمالي لصناديق البريد |
| meta.page | integer | الصفحة الحالية |
| meta.limit | integer | عدد العناصر في الصفحة |
| meta.remaining | integer | الحصة المتبقية ذات الصلة عند توفرها |
الاستعلام عن صندوق
GEThttps://api.temporam.com/v3/mailboxes/{id}
| المعلمة | الموقع | النوع | مطلوب | الوصف |
|---|
| id | path | string | نعم | معرّف صندوق البريد |
| حقل الاستجابة | النوع | الوصف |
|---|
| data | object | تفاصيل صندوق البريد بالحقول الموضحة أعلاه |
| meta.remaining | integer | الحصة المتبقية ذات الصلة عند توفرها |
حذف صندوق
DELETEhttps://api.temporam.com/v3/mailboxes/{id}
| المعلمة | الموقع | النوع | مطلوب | الوصف |
|---|
| id | path | string | نعم | معرّف صندوق البريد |
| حقل الاستجابة | النوع | الوصف |
|---|
| data.deleted | boolean | تكون دائمًا true عند نجاح الحذف |
| meta.remaining | integer | الحصة المتبقية ذات الصلة عند توفرها |