مرجع 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

فهرست نشانی‌های ورودی

فهرست نشانی‌های ورودی

پارامترهای querydomain_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
}