ドキュメント本文へスキップ
API

アドレスを転送する

メールボックスのほかに、アドレスのメールが届く先です。すべての転送先は、何かを受け取る前にメールで承認します。

GET/domains/{id}/addresses/{addressId}/forwards

5件の呼び出しをワークスペースに対して実行します。

GET /domains/{id}/addresses/{addressId}/forwards

メールボックスのほかに、アドレスのメールが届く先です。すべての転送先は、何かを受け取る前にメールで承認します。

転送先を一覧する

domains:read が必要です。アドレスのすべての転送先を古い順に返します。destination は、アドレスがここにもコピーを残す(mailbox)か、転送だけを行う(forward)かを示し、max は 1 つのアドレスが持てる転送先の数です。

curl
curl "$OE/domains/b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f/addresses/5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18/forwards" -H "$AUTH"
レスポンス
{  "object": "list",  "address": "[email protected]",  "destination": "mailbox",  "max": 10,  "data": [    {      "object": "address_forward",      "id": "9a4c1e7b-2d3f-4b5a-8c6d-0e1f2a3b4c5d",      "addressId": "5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18",      "email": "[email protected]",      "enabled": true,      "status": "live",      "confirmedAt": "2026-09-26T08:12:40.000Z",      "askedAt": "2026-09-26T08:02:11.000Z",      "lastRelayAt": "2026-09-30T16:45:03.000Z",      "lastError": null,      "failures": 0,      "createdAt": "2026-09-26T08:02:11.000Z"    }  ]}

status は、転送先がメールを受け取ると承認した後は live、応答していない間は pending、断った場合は refused、オフになっている間は paused です。何かを受け取るのは live の転送先だけです。

転送先を追加する

domains:write が必要です。POST /domains/{id}/addresses/{addressId}/forwards に、1 から 10 個のアドレスを { emails } で送ります。新しい転送先にはそれぞれ承認を求めるメールが送られるため、最初は pending になります。

curl
curl -X POST "$OE/domains/b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f/addresses/5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18/forwards" -H "$AUTH" \  -H "Content-Type: application/json" \  -d '{ "emails": ["[email protected]", "[email protected]"] }'
レスポンス
{  "object": "address_forwards",  "added": [    {      "object": "address_forward",      "id": "9a4c1e7b-2d3f-4b5a-8c6d-0e1f2a3b4c5d",      "addressId": "5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18",      "email": "[email protected]",      "enabled": true,      "status": "pending",      "confirmedAt": null,      "askedAt": "2026-09-26T08:02:11.000Z",      "lastRelayAt": null,      "lastError": null,      "failures": 0,      "createdAt": "2026-09-26T08:02:11.000Z"    }  ],  "skipped": [    {      "email": "[email protected]",      "reason": "[email protected] is hosted here, so it cannot be a forwarding destination. Share the address with that person instead."    }  ]}

ここでホストされているアドレス、すでに一覧にあるアドレス、ループを生むアドレス、上限の 10 を超えるアドレス、このワークスペースからのメールを拒否したアドレスは、理由とともに skipped に挙げられ、残りはそのまま追加されます。

オフになっているアドレスは 409 address_disabled で拒否されます。

特定のアドレスやドメインに限定されたキーはドメイン全体を持っている必要があり、メンバーの代わりに動くアプリが転送できるのは、そのメンバーが届くアドレスだけです。

OAuth アクセストークンでこの呼び出しを行うには確認コードが必要です。アプリが直近 60 分以内にコードを確認するまで、呼び出しは 403 step_up_required を返し、何も変更しません。API キーが求められることはありません。コードの求め方と確認方法は「認証」ページにあります。

転送先を一時停止する、またはオンにする

domains:write が必要です。PATCH /domains/{id}/addresses/{addressId}/forwards/{forwardId} に { enabled } を送ります。一時停止した転送先は承認を保ったままなので、再びオンにするときに承認は要りません。

curl
curl -X PATCH "$OE/domains/b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f/addresses/5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18/forwards/9a4c1e7b-2d3f-4b5a-8c6d-0e1f2a3b4c5d" -H "$AUTH" \  -H "Content-Type: application/json" \  -d '{ "enabled": false }'
レスポンス
{  "object": "address_forward",  "id": "9a4c1e7b-2d3f-4b5a-8c6d-0e1f2a3b4c5d",  "addressId": "5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18",  "email": "[email protected]",  "enabled": false,  "status": "paused",  "destination": "mailbox"}

オンになっている最後の転送先を一時停止すると、アドレスはメールをここに残す状態に戻り、destination もそれを示します。

OAuth アクセストークンでこの呼び出しを行うには確認コードが必要です。アプリが直近 60 分以内にコードを確認するまで、呼び出しは 403 step_up_required を返し、何も変更しません。API キーが求められることはありません。コードの求め方と確認方法は「認証」ページにあります。

転送先を削除する

domains:write が必要です。DELETE /domains/{id}/addresses/{addressId}/forwards/{forwardId}。以後、その転送先には何も転送されません。

curl
curl -X DELETE "$OE/domains/b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f/addresses/5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18/forwards/9a4c1e7b-2d3f-4b5a-8c6d-0e1f2a3b4c5d" -H "$AUTH"
レスポンス
{  "object": "address_forward",  "id": "9a4c1e7b-2d3f-4b5a-8c6d-0e1f2a3b4c5d",  "addressId": "5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18",  "email": "[email protected]",  "deleted": true,  "destination": "mailbox"}

それがオンになっている最後の転送先だった場合、アドレスはメールをここに残す状態に戻ります。

OAuth アクセストークンでこの呼び出しを行うには確認コードが必要です。アプリが直近 60 分以内にコードを確認するまで、呼び出しは 403 step_up_required を返し、何も変更しません。API キーが求められることはありません。コードの求め方と確認方法は「認証」ページにあります。

転送先にもう一度承認を求める

domains:write が必要です。POST /domains/{id}/addresses/{addressId}/forwards/{forwardId}/resend は、承認を求めるメールをもう一度送ります。

curl
curl -X POST "$OE/domains/b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f/addresses/5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18/forwards/9a4c1e7b-2d3f-4b5a-8c6d-0e1f2a3b4c5d/resend" -H "$AUTH"
レスポンス
{  "object": "address_forward_consent",  "id": "9a4c1e7b-2d3f-4b5a-8c6d-0e1f2a3b4c5d",  "addressId": "5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18",  "email": "[email protected]",  "status": "sent"}

status は sent、転送先に何も必要ない場合は already-confirmed、前回のメールが送られたばかりの場合は too-soon、転送先がこのワークスペースからのメールを拒否した場合は revoked、メールを送れなかった場合は send-failed です。

OAuth アクセストークンでこの呼び出しを行うには確認コードが必要です。アプリが直近 60 分以内にコードを確認するまで、呼び出しは 403 step_up_required を返し、何も変更しません。API キーが求められることはありません。コードの求め方と確認方法は「認証」ページにあります。

リファレンス