مرجع API
ایمیل ورودی
نشانی بسازید و با گفتگوهای دریافتی کار کنید.
هیچ عملیاتی با این فیلتر مطابقت ندارد.
POST
کلید API/domains/:id/inbound/setupProvision inbound receiving
Provision inbound receiving
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
}