Kalo te dokumentacioni
API

Hyni si një adresë

Një fjalëkalim i veçantë për adresën i lejon dikujt të hyjë në OpenEmail si një adresë e vetme dhe të lexojë e dërgojë vetëm postën e saj.

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

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

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

Një fjalëkalim i veçantë për adresën i lejon dikujt të hyjë në OpenEmail si një adresë e vetme dhe të lexojë e dërgojë vetëm postën e saj.

Lexoni hyrjen

Kërkon members:write, si caktimi i një fjalëkalimi. login është null kur adresa nuk ka fjalëkalim.

curl
curl "$OE/domains/b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f/addresses/5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18/login" -H "$AUTH"
Përgjigje
{  "object": "address_login",  "addressId": "5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18",  "address": "[email protected]",  "login": {    "userId": "W2xR8tLq5nYc3vKp9mBd7fHs1aJe4gZu",    "name": "Invoices",    "createdAt": "2026-09-20T09:30:00.000Z",    "createdBy": "Ana Lima",    "passwordSetAt": "2026-09-28T14:05:00.000Z",    "passwordSetBy": "Ana Lima",    "lastSignedInAt": "2026-10-01T07:58:12.000Z"  }}

Një çelës i kufizuar në adresa ose domene të caktuara refuzohet me 422 capability_unsupported, dhe një aplikacion që vepron për një anëtar arrin vetëm hyrjen e një adrese që ai anëtar e arrin.

Caktoni fjalëkalimin

Kërkon members:write. PUT /domains/{id}/addresses/{addressId}/login me { password } i jep adresës një fjalëkalim, ose zëvendëson atë që ka. created tregon nëse hyrja është e re.

curl
curl -X PUT "$OE/domains/b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f/addresses/5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18/login" -H "$AUTH" \  -H "Content-Type: application/json" \  -d '{ "password": "'"$INBOX_PASSWORD"'" }'
Përgjigje
{  "object": "address_login",  "addressId": "5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18",  "address": "[email protected]",  "login": {    "userId": "W2xR8tLq5nYc3vKp9mBd7fHs1aJe4gZu",    "name": "Invoices",    "createdAt": "2026-09-20T09:30:00.000Z",    "createdBy": "Ana Lima",    "passwordSetAt": "2026-09-28T14:05:00.000Z",    "passwordSetBy": "Ana Lima",    "lastSignedInAt": "2026-10-01T07:58:12.000Z"  },  "created": false}

Fjalëkalimi duhet të ketë të paktën 8 karaktere, me një shkronjë të vogël, një shkronjë të madhe, një numër dhe një karakter të veçantë, përndryshe thirrja është 422 invalid_parameter te password. OpenEmail nuk ia dërgon askujt, ndaj dorëzojeni vetë.

Zëvendësimi i një fjalëkalimi nxjerr nga llogaria të gjithë ata që hynë me të vjetrin dhe heq destinacionet e përcjelljes që shtuan ata.

Një adresë me të cilën hyn tashmë një llogari OpenEmail refuzohet me 409 account_exists, dhe një adresë e fikur me 409 address_unavailable. Fjalëkalimi i parë në një hapësirë pune plani i së cilës nuk përfshin anëtarë ekipi refuzohet me 403 plan_required.

Një çelës ose një aplikacion duhet të mbajë çdo fushëveprim që mund të përdorë një hyrje për një adresë, përndryshe refuzohet me 403 insufficient_authority.

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 hyrjen

Kërkon members:write. DELETE /domains/{id}/addresses/{addressId}/login e heq fjalëkalimin dhe nxjerr nga llogaria të gjithë ata që e përdorën. Adresa dhe posta e saj mbeten.

curl
curl -X DELETE "$OE/domains/b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f/addresses/5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18/login" -H "$AUTH"
Përgjigje
{  "object": "address_login",  "addressId": "5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18",  "address": "[email protected]",  "deleted": true}

Një adresë pa fjalëkalim është 404.

Referencë