Iniciar sessão como um só endereço
Uma palavra-passe própria permite a alguém iniciar sessão no OpenEmail como um só endereço, e ler e enviar apenas o correio dele.
Executa qualquer uma das 3 chamadas no seu espaço de trabalho.
GET /domains/{id}/addresses/{addressId}/login
Uma palavra-passe própria permite a alguém iniciar sessão no OpenEmail como um só endereço, e ler e enviar apenas o correio dele.
Ler o início de sessão
Requer members:write, tal como definir uma palavra-passe. login é null quando o endereço não tem palavra-passe.
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" }}Uma chave limitada a determinados endereços ou domínios é recusada com 422 capability_unsupported, e uma app que age por um membro só alcança o início de sessão de um endereço que esse membro alcance.
Definir a palavra-passe
Requer members:write. PUT /domains/{id}/addresses/{addressId}/login com { password } dá uma palavra-passe ao endereço, ou substitui a que tem. created diz se o início de sessão é novo.
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}A palavra-passe precisa de pelo menos 8 caracteres com uma letra minúscula, uma letra maiúscula, um algarismo e um carácter especial, caso contrário a chamada é um 422 invalid_parameter em password. O OpenEmail não a envia a ninguém, por isso entregue-a pessoalmente.
Substituir uma palavra-passe termina a sessão de todos os que iniciaram sessão com a antiga e remove os destinos de reencaminhamento que adicionaram.
Um endereço com que uma conta OpenEmail já inicia sessão é recusado com 409 account_exists, e um endereço desligado com 409 address_unavailable. A primeira palavra-passe num espaço de trabalho cujo plano não inclui acesso de equipa é recusada com 403 plan_required.
Uma chave ou uma app tem de deter todos os âmbitos que um início de sessão para um só endereço pode usar, caso contrário é recusada com 403 insufficient_authority.
Um token de acesso OAuth precisa de um código de verificação para esta chamada. Até a aplicação ter verificado um nos últimos 60 minutos, a chamada responde 403 step_up_required e não altera nada. A uma chave de API nunca é pedido. A página Autenticação mostra como pedir um código e verificá-lo.
Remover o início de sessão
Requer members:write. DELETE /domains/{id}/addresses/{addressId}/login retira a palavra-passe e termina a sessão de todos os que a usaram. O endereço e o seu correio ficam.
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}Um endereço sem palavra-passe é um 404.