Kalo te dokumentacioni
API

Përcillni një adresë

Ku shkon posta e një adrese përveç kutisë së saj postare. Çdo destinacion konfirmon me email para se të marrë diçka.

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

Ekzekuton cilëndo nga 5 thirrjet në hapësirën tuaj të punës.

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

Ku shkon posta e një adrese përveç kutisë së saj postare. Çdo destinacion konfirmon me email para se të marrë diçka.

Listoni destinacionet

Kërkon domains:read. Çdo destinacion i adresës, më të vjetrit të parët. destination tregon nëse adresa mban edhe një kopje këtu (mailbox) apo vetëm përcjell (forward), dhe max është sa destinacione mund të ketë një adresë.

curl
curl "$OE/domains/b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f/addresses/5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18/forwards" -H "$AUTH"
Përgjigje
{  "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 është live sapo destinacioni të ketë konfirmuar se e do postën, pending derisa nuk është përgjigjur, refused kur ka thënë jo dhe paused ndërsa është i fikur. Vetëm një destinacion live merr diçka.

Shtoni destinacione

Kërkon domains:write. POST /domains/{id}/addresses/{addressId}/forwards me { emails }, nga 1 deri në 10 adresa. Çdo destinacioni të ri i dërgohet një email që i kërkon të konfirmojë, ndaj ai nis si 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]"] }'
Përgjigje
{  "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."    }  ]}

Një adresë e strehuar këtu, një që është tashmë në listë, një që do të krijonte një lak, një përtej kufirit prej 10 dhe një që e ka refuzuar postën nga kjo hapësirë pune emërtohen te skipped me arsyen, dhe të tjerat shtohen gjithsesi.

Një adresë e fikur refuzohet me 409 address_disabled.

Një çelës i kufizuar në adresa ose domene të caktuara duhet ta mbajë të gjithë domenin, dhe një aplikacion që vepron për një anëtar mund të përcjellë vetëm një adresë që ai anëtar e arrin.

Një token qasjeje OAuth ka nevojë për një kod verifikimi për këtë thirrje. Derisa aplikacioni të ketë verifikuar një në 60 minutat e fundit, thirrja përgjigjet me 403 step_up_required dhe nuk ndryshon asgjë. Një çelësi API nuk i kërkohet kurrë. Faqja Autentikimi tregon si të kërkoni një kod dhe ta verifikoni.

Pezulloni ose ndizni një destinacion

Kërkon domains:write. PATCH /domains/{id}/addresses/{addressId}/forwards/{forwardId} me { enabled }. Një destinacion i pezulluar e ruan konfirmimin e vet, ndaj për ta ndezur sërish nuk duhet asnjë konfirmim.

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 }'
Përgjigje
{  "object": "address_forward",  "id": "9a4c1e7b-2d3f-4b5a-8c6d-0e1f2a3b4c5d",  "addressId": "5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18",  "email": "[email protected]",  "enabled": false,  "status": "paused",  "destination": "mailbox"}

Kur pezullohet destinacioni i fundit i ndezur, adresa e mban sërish postën e saj këtu, dhe destination e tregon këtë.

Një token qasjeje OAuth ka nevojë për një kod verifikimi për këtë thirrje. Derisa aplikacioni të ketë verifikuar një në 60 minutat e fundit, thirrja përgjigjet me 403 step_up_required dhe nuk ndryshon asgjë. Një çelësi API nuk i kërkohet kurrë. Faqja Autentikimi tregon si të kërkoni një kod dhe ta verifikoni.

Hiqni një destinacion

Kërkon domains:write. DELETE /domains/{id}/addresses/{addressId}/forwards/{forwardId}. Asgjë nuk i përcillet më.

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"
Përgjigje
{  "object": "address_forward",  "id": "9a4c1e7b-2d3f-4b5a-8c6d-0e1f2a3b4c5d",  "addressId": "5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18",  "email": "[email protected]",  "deleted": true,  "destination": "mailbox"}

Kur ai ishte destinacioni i fundit i ndezur, adresa e mban sërish postën e saj këtu.

Një token qasjeje OAuth ka nevojë për një kod verifikimi për këtë thirrje. Derisa aplikacioni të ketë verifikuar një në 60 minutat e fundit, thirrja përgjigjet me 403 step_up_required dhe nuk ndryshon asgjë. Një çelësi API nuk i kërkohet kurrë. Faqja Autentikimi tregon si të kërkoni një kod dhe ta verifikoni.

Kërkojini një destinacioni të konfirmojë sërish

Kërkon domains:write. POST /domains/{id}/addresses/{addressId}/forwards/{forwardId}/resend e dërgon edhe një herë emailin e konfirmimit.

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"
Përgjigje
{  "object": "address_forward_consent",  "id": "9a4c1e7b-2d3f-4b5a-8c6d-0e1f2a3b4c5d",  "addressId": "5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18",  "email": "[email protected]",  "status": "sent"}

status është sent, already-confirmed kur destinacionit nuk i duhet asgjë, too-soon kur emaili i fundit u dërgua para pak çastesh, revoked kur destinacioni e ka refuzuar postën nga kjo hapësirë pune, ose send-failed kur emaili nuk mund të dërgohej.

Një token qasjeje OAuth ka nevojë për një kod verifikimi për këtë thirrje. Derisa aplikacioni të ketë verifikuar një në 60 minutat e fundit, thirrja përgjigjet me 403 step_up_required dhe nuk ndryshon asgjë. Një çelësi API nuk i kërkohet kurrë. Faqja Autentikimi tregon si të kërkoni një kod dhe ta verifikoni.

Referencë