مرجع API
البريد الوارد
أنشئ العناوين وتعامل مع المحادثات المستلَمة.
لا توجد عمليات تطابق عامل التصفية هذا.
POST
مفتاح API/domains/:id/inbound/setupجهّز استقبال SES للبريد الوارد
جهّز استقبال SES للبريد الوارد
curl https://sendhq.cc/api/v1/domains/id_value/inbound/setup \
-X POST \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"domain": "inbound.example.com",
"status": "dns_pending",
"record": {
"type": "MX",
"name": "inbound.example.com",
"value": "10 inbound-smtp.us-east-1.amazonaws.com"
}
}POST
مفتاح API/domains/:id/inbound/verifyتحقق من توجيه MX للبريد الوارد
تحقق من توجيه MX للبريد الوارد
curl https://sendhq.cc/api/v1/domains/id_value/inbound/verify \
-X POST \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"domain": "inbound.example.com",
"status": "ready",
"record": {
"type": "MX"
}
}POST
مفتاح API/inboxesأنشئ عنوانًا واردًا
أنشئ عنوانًا واردًا
curl https://sendhq.cc/api/v1/inboxes \
-X POST \
-H "Authorization: Bearer $SENDHQ_API_KEY" \
-H "Content-Type: application/json" \
-d '{"domain_id":"dom_…","local_part":"support","name":"Support"}'{
"id": "inb_…",
"address": "support@inbound.example.com",
"status": "active"
}GET
مفتاح API/inboxesاعرض العناوين الواردة
اعرض العناوين الواردة
curl https://sendhq.cc/api/v1/inboxes \
-X GET \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"data": [],
"count": 0
}GET
مفتاح API/inboxes/:idاسترجع عنوانًا واردًا
استرجع عنوانًا واردًا
curl https://sendhq.cc/api/v1/inboxes/id_value \
-X GET \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"id": "inb_…",
"address": "support@example.com",
"status": "active"
}PATCH
مفتاح API/inboxes/:idأعد تسمية صندوق بريد أو فعّله أو عطّله
أعد تسمية صندوق بريد أو فعّله أو عطّله
curl https://sendhq.cc/api/v1/inboxes/id_value \
-X PATCH \
-H "Authorization: Bearer $SENDHQ_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"Customer support","status":"active"}'{
"id": "inb_…",
"status": "active"
}PUT
مفتاح API/inboxes/:id/forwardingأعد توجيه البريد المستلَم في صندوق بريد إلى عنوان آخر
اضبط `forward_to` على عنوان بريد إلكتروني، أو على null لإيقاف إعادة التوجيه. ويُفعَّل عنوان مالك الحساب نفسه فورًا؛ أما أي عنوان آخر فيتلقى رسالة تأكيد (تُرسَل من النطاق الموثَّق لصندوق البريد وتُحتسب مستلِمًا واحدًا) وتبقى إعادة التوجيه معلَّقة حتى يُؤكَّد الرابط. تُرسَل النسخ المعاد توجيهها من عنوان صندوق البريد مع المُرسِل الأصلي في Reply-To، وتراعي قوائم المنع وحدود الباقة، ولا يُعاد توجيهها مرة أخرى أبدًا.
curl https://sendhq.cc/api/v1/inboxes/id_value/forwarding \
-X PUT \
-H "Authorization: Bearer $SENDHQ_API_KEY" \
-H "Content-Type: application/json" \
-d '{"forward_to":"team@example.net"}'{
"id": "inb_…",
"address": "support@example.com",
"forwardTo": "team@example.net",
"forwardStatus": "pending"
}DELETE
مفتاح API/inboxes/:idاحذف صندوق بريد مع الاحتفاظ بالرسائل
احذف صندوق بريد مع الاحتفاظ بالرسائل
curl https://sendhq.cc/api/v1/inboxes/id_value \
-X DELETE \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"ok": true
}