पता फ़ॉरवर्ड करें
किसी पते की मेल उसके मेलबॉक्स के अलावा कहाँ जाती है। हर गंतव्य कुछ भी पाने से पहले ईमेल से पुष्टि करता है।
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पूरा रेफ़रेंस