Programadores → Email

API de e-mail

Faça a gestão do e-mail dos seus domínios a partir do código: caixas de correio no alojamento de e-mail pago, reencaminhamento gratuito para domínios registados na NameOcean e correio recebido enviado para a sua aplicação em JSON.

Antes de começar

Crie uma chave de API com email:read e email:write para fazer alterações. Todos os endpoints estão na referência da API e no ficheiro OpenAPI. A compra, atualização e renovação de um plano de e-mail consomem crédito da conta e são feitas no painel.

Caixas de correio

O plano de um domínio de e-mail tem um espaço de armazenamento partilhado pelas suas caixas de correio. Se criar uma caixa de correio sem palavra-passe, é gerada uma; a resposta é a única vez que a API a devolve.

curl
$ curl -X POST https://nameocean.net/api/v1/email/domains/example.com/mailboxes \
    -H "Authorization: Bearer $NAMEOCEAN_API_KEY" -H "Content-Type: application/json" \
    -d '{"username": "info", "full_name": "Info", "quota_gb": 2}'

{"address": "info@example.com", "username": "info", "full_name": "Info", "quota_gb": 2,
 "used_gb": "0.00", "aliases": [], "password": "Qm7…"}
GET /email/domains/{domain}Caixas de correio, aliases, listas e as definições IMAP/SMTP
PATCH /email/domains/{domain}/mailboxes/{username}Alterar o nome ou a quota
POST /email/domains/{domain}/mailboxes/{username}/passwordDefinir uma palavra-passe ou gerar uma
POST /email/domains/{domain}/aliasesEntregar outro endereço numa caixa de correio
POST /email/domains/{domain}/listsUma lista de correio com as caixas de correio do domínio
GET /email/domains/{domain}/dns-checkNS, MX, SPF, DKIM e DMARC, em tempo real, com os valores esperados

Reencaminhamento grátis

Os domínios registados na NameOcean que utilizam os nossos servidores de nomes podem reencaminhar o seu correio gratuitamente. Ao ativá-lo, é criado o registo MX; se a zona tiver registos MX de outro fornecedor, envie replace_mx: true para os remover.

curl
$ curl -X POST https://nameocean.net/api/v1/email/forwarding/example.com \
    -H "Authorization: Bearer $NAMEOCEAN_API_KEY"
$ curl -X POST https://nameocean.net/api/v1/email/forwarding/example.com/aliases \
    -H "Authorization: Bearer $NAMEOCEAN_API_KEY" -H "Content-Type: application/json" \
    -d '{"localpart": "hello", "to": "me@gmail.com"}'

Um novo endereço de destino recebe um e-mail com uma ligação e um código de 6 dígitos, e o correio é reencaminhado assim que o titular confirmar (através da ligação ou de POST /email/forwarding/targets/{id}/verify com o código). * reencaminha todos os endereços que não tenham alias próprio. GET /email/forwarding/{domain}/messages lista o correio dos últimos 30 dias com o respetivo estado; o correio retido (spam, acima do limite diário) pode ser reencaminhado com /release.

Correio recebido para webhook

Em vez de reencaminhar, um endereço pode enviar cada mensagem que recebe para o seu endpoint HTTPS em JSON: corpos, cabeçalhos e anexos em base64. Fica disponível após uma breve análise da utilização prevista; solicite-o na página de Reencaminhamento de e-mail de um domínio.

curl
$ curl -X POST https://nameocean.net/api/v1/email/forwarding/example.com/webhooks \
    -H "Authorization: Bearer $NAMEOCEAN_API_KEY" -H "Content-Type: application/json" \
    -d '{"localpart": "inbound", "url": "https://example.com/hooks/mail"}'
POST https://example.com/hooks/mail
X-NameOcean-Event: email.received
X-NameOcean-Signature: t=1794300000,v1=5f2b…

{
  "id": "6f1c2a4e-8b3d-4f5a-9c7e-1d2b3a4c5e6f",
  "event": "email.received",
  "envelope": {"from": "alice@example.org", "to": "inbound@example.com"},
  "from": "Alice <alice@example.org>",
  "subject": "Order 1042",
  "text": "Hi…",
  "html": "<p>Hi…</p>",
  "headers": [["From", "Alice <alice@example.org>"], …],
  "attachments": [{"filename": "invoice.pdf", "content_type": "application/pdf", "size": 48211,
                   "content_base64": "JVBERi0…"}],
  "spam_score": 0.4,
  "size": 66120
}

A assinatura funciona como nos webhooks da conta: consulte verificar uma assinatura.

Eventos

Os webhooks da conta podem subscrever email.*: email.mailbox.created, email.mailbox.deleted, email.forwarding.enabled e email.forwarding.disabled (também enviado quando um domínio deixa de ser elegível para o reencaminhamento gratuito, com o motivo).

A partir do terminal

nameocean
$ nameocean email mailboxes add example.com info --name "Info"
$ nameocean email aliases add example.com sales info
$ nameocean email check example.com
$ nameocean email forwards on example.com
$ nameocean email forwards add example.com hello me@gmail.com
$ nameocean email inbound add example.com support https://example.com/hooks/mail

Todos os comandos aceitam --json. Instalação e todos os comandos: CLI.

A partir da sua IA

Através do MCP, um assistente pode listar os seus domínios de e-mail, verificar o DNS deles, criar caixas de correio e aliases e ativar o reencaminhamento. As palavras-passe das caixas de correio nunca são enviadas à IA: pode consultá-las no painel de controlo.