Belgelere geç
API

Tek bir adres olarak oturum açma

Kendine ait bir parola, birinin OpenEmail'de tek bir adres olarak oturum açmasını ve yalnızca o adresin postasını okuyup göndermesini sağlar.

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

3 çağrıdan herhangi birini çalışma alanınızda çalıştırır.

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

Kendine ait bir parola, birinin OpenEmail'de tek bir adres olarak oturum açmasını ve yalnızca o adresin postasını okuyup göndermesini sağlar.

Oturum açma bilgisini okuma

Parola belirlemek gibi members:write gerektirir. Adresin parolası yoksa login null olur.

curl
curl "$OE/domains/b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f/addresses/5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18/login" -H "$AUTH"
Yanıt
{  "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"  }}

Belirli adreslerle ya da alan adlarıyla sınırlı bir anahtar 422 capability_unsupported ile reddedilir; bir üye adına çalışan bir uygulama ise yalnızca o üyenin erişebildiği bir adresin oturum açma bilgisine erişir.

Parolayı belirleme

members:write gerektirir. { password } ile PUT /domains/{id}/addresses/{addressId}/login adrese bir parola verir ya da mevcut parolasını değiştirir. created, oturum açmanın yeni olup olmadığını söyler.

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"'" }'
Yanıt
{  "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}

Parolanın küçük harf, büyük harf, rakam ve özel karakter içeren en az 8 karakter olması gerekir; yoksa çağrı password üzerinde 422 invalid_parameter olur. OpenEmail onu kimseye göndermez, bu yüzden kendiniz teslim edin.

Bir parolayı değiştirmek, eski parolayla oturum açmış herkesin oturumunu kapatır ve onların eklediği yönlendirme hedeflerini kaldırır.

Bir OpenEmail hesabının zaten oturum açtığı bir adres 409 account_exists ile, kapalı bir adres ise 409 address_unavailable ile reddedilir. Planında ekip erişimi olmayan bir çalışma alanındaki ilk parola 403 plan_required ile reddedilir.

Bir anahtarın ya da uygulamanın, tek bir adres için oturum açmanın kullanabileceği her kapsama sahip olması gerekir; yoksa 403 insufficient_authority ile reddedilir.

Bir OAuth erişim tokenı bu çağrı için bir doğrulama kodu gerektirir. Uygulama son 60 dakika içinde bir kod doğrulayana kadar çağrı 403 step_up_required yanıtını verir ve hiçbir şeyi değiştirmez. Bir API anahtarından asla istenmez. Kimlik doğrulama sayfası bir kodun nasıl isteneceğini ve doğrulanacağını gösterir.

Oturum açmayı kaldırma

members:write gerektirir. DELETE /domains/{id}/addresses/{addressId}/login parolayı kaldırır ve onu kullanan herkesin oturumunu kapatır. Adres ve postası kalır.

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

Parolası olmayan bir adres 404 verir.

Referans