بازارسال یک نشانی
نامه‌های یک نشانی جز صندوق پستی‌اش به کجا می‌روند. هر مقصد پیش از دریافت هر چیزی با ایمیل تأیید می‌کند.
هر کدام از 5 فراخوانی را روی فضای کاری شما اجرا می‌کند.
GET /domains/{id}/addresses/{addressId}/forwards
نامه‌های یک نشانی جز صندوق پستی‌اش به کجا می‌روند. هر مقصد پیش از دریافت هر چیزی با ایمیل تأیید می‌کند.
فهرست مقصدها
به domains:read نیاز دارد. همهٔ مقصدهای نشانی، قدیمی‌ترین اول. destination می‌گوید نشانی یک نسخه را اینجا هم نگه می‌دارد (mailbox) یا فقط بازارسال می‌کند (forward)، و max شمار مقصدهایی است که یک نشانی می‌تواند داشته باشد.
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 با { emails }، از 1 تا 10 نشانی. برای هر مقصد تازه ایمیلی فرستاده می‌شود که از آن می‌خواهد تأیید کند، پس با pending شروع می‌شود.
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 -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 -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 -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 هرگز خواسته نمی‌شود. صفحهٔ احراز هویت نشان می‌دهد چطور کد بخواهید و آن را تأیید کنید.
مرجع
/domains/{id}/addresses/{addressId}/forwardsمرجع کامل/domains/{id}/addresses/{addressId}/forwardsمرجع کامل/domains/{id}/addresses/{addressId}/forwards/{forwardId}مرجع کامل/domains/{id}/addresses/{addressId}/forwards/{forwardId}مرجع کامل/domains/{id}/addresses/{addressId}/forwards/{forwardId}/resendمرجع کامل