ورود با یک نشانی
یک گذرواژهٔ اختصاصی به کسی اجازه می‌دهد با یک نشانی وارد OpenEmail شود و فقط نامه‌های همان نشانی را بخواند و از آن بفرستد.
هر کدام از 3 فراخوانی را روی فضای کاری شما اجرا می‌کند.
GET /domains/{id}/addresses/{addressId}/login
یک گذرواژهٔ اختصاصی به کسی اجازه می‌دهد با یک نشانی وارد OpenEmail شود و فقط نامه‌های همان نشانی را بخواند و از آن بفرستد.
خواندن ورود
مانند تنظیم گذرواژه، به members:write نیاز دارد. وقتی نشانی گذرواژه ندارد، login برابر null است.
curl "$OE/domains/b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f/addresses/5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18/login" -H "$AUTH"{ "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" }}کلیدی که به نشانی‌ها یا دامنه‌های مشخصی محدود است با 422 capability_unsupported رد می‌شود، و برنامه‌ای که از طرف یک عضو کار می‌کند فقط به ورود نشانی‌ای می‌رسد که آن عضو به آن می‌رسد.
تنظیم گذرواژه
به members:write نیاز دارد. PUT /domains/{id}/addresses/{addressId}/login با { password } به نشانی گذرواژه می‌دهد، یا گذرواژه‌ای را که دارد جایگزین می‌کند. created می‌گوید ورود تازه است یا نه.
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"'" }'{ "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}گذرواژه باید دست‌کم 8 نویسه داشته باشد که یک حرف کوچک، یک حرف بزرگ، یک عدد و یک نویسهٔ ویژه در آن باشد، وگرنه فراخوانی 422 invalid_parameter روی password است. OpenEmail آن را برای کسی نمی‌فرستد، پس خودتان آن را به دست شخص برسانید.
جایگزین کردن گذرواژه همهٔ کسانی را که با گذرواژهٔ قبلی وارد شده‌اند خارج می‌کند و مقصدهای بازارسالی را که افزوده‌اند حذف می‌کند.
نشانی‌ای که یک حساب OpenEmail از پیش با آن وارد می‌شود با 409 account_exists رد می‌شود، و نشانی‌ای که خاموش است با 409 address_unavailable. نخستین گذرواژه در فضای کاری‌ای که طرحش دسترسی تیمی ندارد با 403 plan_required رد می‌شود.
کلید یا برنامه باید همهٔ اسکوپ‌هایی را که ورود برای یک نشانی ممکن است به کار ببرد داشته باشد، وگرنه با 403 insufficient_authority رد می‌شود.
توکن دسترسی OAuth برای این فراخوانی کد تأیید هویت لازم دارد. تا برنامه در 60 دقیقهٔ گذشته کدی را تأیید نکرده، فراخوانی 403 step_up_required برمی‌گرداند و چیزی را تغییر نمی‌دهد. از کلید API هرگز خواسته نمی‌شود. صفحهٔ احراز هویت نشان می‌دهد چطور کد بخواهید و آن را تأیید کنید.
حذف ورود
به members:write نیاز دارد. DELETE /domains/{id}/addresses/{addressId}/login گذرواژه را برمی‌دارد و همهٔ کسانی را که از آن استفاده کرده‌اند خارج می‌کند. نشانی و نامه‌هایش می‌مانند.
curl -X DELETE "$OE/domains/b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f/addresses/5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18/login" -H "$AUTH"{ "object": "address_login", "addressId": "5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18", "address": "[email protected]", "deleted": true}نشانی‌ای که گذرواژه ندارد 404 می‌گیرد.