Programadores → Guias

Receba email na sua aplicação

Tickets de suporte, respostas a notificações, documentos enviados por email a um bot: o email enviado para um endereço do seu domínio chega ao seu endpoint HTTPS como um único POST JSON assinado, com o texto, o HTML e todos os anexos. Sem caixa de correio para consultar e sem IMAP.

O que precisa

  • Um domínio registado na NameOcean: o reencaminhamento e o email para webhook são gratuitos para estes domínios.
  • Um endpoint HTTPS num endereço público que responda em menos de 20 segundos.
  • A CLI nameocean, ou uma chave de API com email:write.

1. Ative o reencaminhamento para o domínio

nameocean
$ nameocean email forwards on example.com

Isto aponta o registo MX do domínio para os servidores de reencaminhamento de email da NameOcean. Se o domínio já tiver registos MX, para caixas de correio noutro lado, o comando para e lista-os: todo o email para o domínio passaria a vir para aqui. Adicione --replace-mx apenas se for isso que pretende.

2. Peça o email para webhook

O envio de email para um URL é ativado por conta após uma breve análise, para impedir relays de spam. Na página do domínio, em Dashboard → Email Forwarding, peça-o com uma linha a explicar para que o vai utilizar. Até lá, a API responde 403 not_approved.

3. Envie um endereço para o seu endpoint

nameocean
$ nameocean email inbound add example.com support https://app.example.com/hooks/mail
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": "support", "url": "https://app.example.com/hooks/mail"}'

A resposta contém o segredo de assinatura (whsec_…); guarde-o nas definições da sua aplicação. localpart * envia todos os endereços do domínio que não tenham um alias próprio. Um domínio pode ter até três destes webhooks.

4. Receba-o

Verifique a assinatura sobre o corpo em bruto e depois leia o JSON. Um pequeno recetor em Flask:

app.py
import base64, hashlib, hmac, json, os, time

from flask import Flask, abort, request

app = Flask(__name__)
SECRET = os.environ["NAMEOCEAN_WEBHOOK_SECRET"]  # whsec_...


def verified(header, body, tolerance=300):
    fields = dict(part.split("=", 1) for part in header.split(",") if "=" in part)
    ts = int(fields.get("t", "0"))
    if abs(time.time() - ts) > tolerance:
        return False
    expected = hmac.new(SECRET.encode(), f"{ts}.".encode() + body, hashlib.sha256).hexdigest()
    return hmac.compare_digest(expected, fields.get("v1", ""))


@app.post("/hooks/mail")
def mail():
    body = request.get_data()
    if not verified(request.headers.get("X-NameOcean-Signature", ""), body):
        abort(401)
    mail = json.loads(body)
    print(mail["envelope"]["from"], "→", mail["envelope"]["to"], mail["subject"])
    for a in mail["attachments"]:
        data = base64.b64decode(a["content_base64"])
        print("  attachment", a["filename"], a["content_type"], len(data), "bytes")
    return "", 204  # any 2xx: delivered

O que chega

POST https://app.example.com/hooks/mail
X-NameOcean-Event: email.received
X-NameOcean-Delivery: 6f1c2a4e-8b3d-4f5a-9c7e-1d2b3a4c5e6f
X-NameOcean-Signature: t=1794300000,v1=5f2b…

{
  "id": "6f1c2a4e-8b3d-4f5a-9c7e-1d2b3a4c5e6f",
  "event": "email.received",
  "received_at": "2026-11-11T09:30:12+00:00",
  "envelope": {"from": "alice@example.org", "to": "support@example.com"},
  "from": "Alice <alice@example.org>",
  "to": "support@example.com",
  "cc": null,
  "reply_to": null,
  "subject": "Order 1042",
  "date": "Wed, 11 Nov 2026 09:30:05 +0000",
  "message_id": "<…@example.org>",
  "in_reply_to": null,
  "references": null,
  "text": "Hi…",
  "html": "<p>Hi…</p>",
  "headers": [["From", "Alice <alice@example.org>"], …],
  "attachments": [{"filename": "invoice.pdf", "content_type": "application/pdf", "content_id": null,
                   "size": 48211, "content_base64": "JVBERi0…"}],
  "spam_score": 0.4,
  "size": 66120
}

O id mantém-se igual quando um email é enviado novamente, por isso utilize-o para ignorar duplicados. in_reply_to e references indicam a qual dos seus próprios emails alguém respondeu.

Quando o seu endpoint está em baixo

  • Uma resposta 2xx significa entregue. Um 408, 429, 5xx, um timeout (20 segundos) ou a ausência de ligação é repetido durante 6 horas.
  • Qualquer outro 4xx é definitivo: o email não volta a ser enviado automaticamente.
  • O email que não pôde ser enviado é guardado durante 30 dias. Encontre-o com nameocean email forwards log example.com (ou GET /email/forwarding/example.com/messages) e liberte-o: é enviado mais uma vez, com o mesmo id.
  • Até 500 emails por dia por domínio são enviados para webhooks; o email acima desse limite fica retido da mesma forma.