مرجع API

البريد الوارد

أنشئ العناوين وتعامل مع المحادثات المستلَمة.

POST/domains/:id/inbound/setup
مفتاح API

جهّز استقبال SES للبريد الوارد

جهّز استقبال SES للبريد الوارد

الطلب
curl https://sendhq.cc/api/v1/domains/id_value/inbound/setup \
  -X POST \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
الاستجابة 200
{
  "domain": "inbound.example.com",
  "status": "dns_pending",
  "record": {
    "type": "MX",
    "name": "inbound.example.com",
    "value": "10 inbound-smtp.us-east-1.amazonaws.com"
  }
}
POST/domains/:id/inbound/verify
مفتاح API

تحقق من توجيه MX للبريد الوارد

تحقق من توجيه MX للبريد الوارد

الطلب
curl https://sendhq.cc/api/v1/domains/id_value/inbound/verify \
  -X POST \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
الاستجابة 200
{
  "domain": "inbound.example.com",
  "status": "ready",
  "record": {
    "type": "MX"
  }
}
POST/inboxes
مفتاح API

أنشئ عنوانًا واردًا

أنشئ عنوانًا واردًا

الطلب
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"}'
الاستجابة 201
{
  "id": "inb_…",
  "address": "support@inbound.example.com",
  "status": "active"
}
GET/inboxes
مفتاح API

اعرض العناوين الواردة

اعرض العناوين الواردة

معاملات الاستعلامdomain_id
الطلب
curl https://sendhq.cc/api/v1/inboxes \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
الاستجابة 200
{
  "data": [],
  "count": 0
}
GET/inboxes/:id
مفتاح API

استرجع عنوانًا واردًا

استرجع عنوانًا واردًا

الطلب
curl https://sendhq.cc/api/v1/inboxes/id_value \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
الاستجابة 200
{
  "id": "inb_…",
  "address": "support@example.com",
  "status": "active"
}
PATCH/inboxes/:id
مفتاح API

أعد تسمية صندوق بريد أو فعّله أو عطّله

أعد تسمية صندوق بريد أو فعّله أو عطّله

الطلب
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"}'
الاستجابة 200
{
  "id": "inb_…",
  "status": "active"
}
PUT/inboxes/:id/forwarding
مفتاح API

أعد توجيه البريد المستلَم في صندوق بريد إلى عنوان آخر

اضبط `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"}'
الاستجابة 200
{
  "id": "inb_…",
  "address": "support@example.com",
  "forwardTo": "team@example.net",
  "forwardStatus": "pending"
}
DELETE/inboxes/:id
مفتاح API

احذف صندوق بريد مع الاحتفاظ بالرسائل

احذف صندوق بريد مع الاحتفاظ بالرسائل

الطلب
curl https://sendhq.cc/api/v1/inboxes/id_value \
  -X DELETE \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
الاستجابة 200
{
  "ok": true
}