
A resposta curta: a API gere o e-mail das hospedagens activas da sua conta: caixas, senhas, quotas, reencaminhadores, respostas automáticas e a conta geral, e mostra o estado do SPF, DKIM e DMARC. Lê com email:read e altera com email:write. Tudo corre na hospedagem indicada em {id}, que encontra em GET /v1/services.
Caixas de correio
| Operação | O que faz |
| GET .../email/mailboxes | Lista as caixas, com o espaço usado e a quota. |
| POST .../email/mailboxes | Cria uma caixa: address, password e, se quiser, quota_mb. |
| PUT .../mailboxes/{address}/password | Muda a senha. |
| PUT .../mailboxes/{address}/quota | Muda a quota. |
| DELETE .../mailboxes/{address} | Apaga a caixa e as mensagens. Precisa do endereço em confirm. |
curl https://api.mozout.com/v1/services/123/email/mailboxes -X POST \
-H "Authorization: Bearer $RLX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"address": "info@yourcompany.com", "password": "...", "quota_mb": 1024}'
A senha tem de 12 a 128 caracteres, com pelo menos 3 tipos entre minúsculas, maiúsculas, números e símbolos, sem o nome da conta nem o da caixa. A API nunca a guarda nem a devolve. A quota vai de 1 MB ao espaço do plano; sem limite não é aceite. Nomes de sistema do servidor, como _mainaccount, não são aceites.
| Nos pedidos com senha, a Idempotency-Key não tem efeito: repetir o pedido volta a executá-lo. Se a ligação cair ao mudar uma senha, confirme antes de repetir. |
Reencaminhadores, respostas automáticas e conta geral
| O quê | Operações | Notas |
| Reencaminhadores | GET, POST, DELETE .../email/forwarders | Só para endereços de e-mail, nunca para programas. A lista mostra um domínio de cada vez, em ?domain=; sem ele, o principal. |
| Respostas automáticas | GET, PUT, DELETE .../email/autoresponders | PUT cria ou substitui. |
| Conta geral | GET e PUT .../email/default-address | O que acontece ao correio para endereços que não existem. |
| SPF, DKIM e DMARC | GET .../email/authentication | Mostra o estado dos três registos de um domínio. Para os alterar, use o DNS. |
Na conta geral, action pode ser fail (devolve), forward (reencaminha), discard (deita fora) ou main_account (entrega na conta principal da hospedagem). Recomendamos fail, para receber menos spam.
O domínio do e-mail da conta
Quem controla o e-mail com que se entra na conta pode ficar com a conta, porque é lá que chegam a reposição da senha e o código de entrada. Por isso, no domínio desse e-mail, e no do e-mail de cada utilizador da conta, a API não cria, não apaga nem altera caixas, não cria nem apaga reencaminhadores e não muda a conta geral. Responde 409 account_email_domain, também em Sandbox. As leituras e as respostas automáticas continuam a funcionar. Faça essas alterações no My MozOut.
Limites e o que ainda não existe
As alterações têm um limite de 20 por minuto, por hospedagem, e as senhas de 10 por minuto. Os filtros de e-mail e o registo de entregas fazem-se no cPanel. Um serviço que não esteja activo responde 409, como na hospedagem.
| Uma ideia prática: quando entra um colaborador novo no seu sistema de recursos humanos, o mesmo programa cria a caixa com uma senha forte e uma quota à medida; quando sai, muda a senha e põe uma resposta automática. Os registos SPF, DKIM e DMARC alteram-se pela API de DNS. |
|
Quer criar caixas de e-mail a partir do seu sistema? Veja a página da API e teste com uma chave Sandbox. Ver a página da API |
PRODUTO RECOMENDADO E-mail profissional no seu domínio Caixas com o nome da sua empresa, sem publicidade, com filtro de spam. desde 396,00 MT/mês (plano de 3 anos, com cupão) Ver planos |











