APIリファレンス

メール受信

アドレスを作成し、受信した会話を扱います。

メール受信のエンドポイントを絞り込む

POST/domains/:id/inbound/setup

APIキー

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のルーティングを検証する

リクエスト

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を設定して転送をオフにします。アカウント所有者自身のアドレスは直ちに有効になります。それ以外のアドレスには確認メール（インボックスの検証済みドメインから送信され、受信者1件としてカウントされます）が送られ、リンクが確認されるまで転送は保留状態になります。転送されたコピーは、元の送信者を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
}