E-post-API

Før du begynner

Opprett en API-nøkkel med email:read, og email:write for å gjøre endringer. Alle endepunkter finnes i API-referansen og OpenAPI-filen. Kjøp, oppgradering og fornyelse av en e-postplan bruker kontokreditt og gjøres i kontrollpanelet.

Postbokser

Planen for et e-postdomene har en lagringsstørrelse som postboksene deler. Oppretter du en postboks uten passord, genereres det ett; svaret er den eneste gangen API-et returnerer det.

$ 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…"}

Gratis videresending

Domener registrert hos NameOcean som bruker våre navnetjenere, kan videresende e-posten sin gratis. Når du slår det på, skrives MX-posten; hvis sonen har MX-poster fra en annen leverandør, send replace_mx: true for å fjerne dem.

$ 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"}'

En ny måladresse får en e-post med en lenke og en 6-sifret kode, og e-post videresendes når eieren har bekreftet (lenken, eller POST /email/forwarding/targets/{id}/verify med koden). * videresender alle adresser som ikke har et eget alias. GET /email/forwarding/{domain}/messages viser e-post fra de siste 30 dagene med status; tilbakeholdt e-post (spam, over den daglige grensen) kan videresendes med /release.

Innkommende e-post til webhook

I stedet for videresending kan en adresse sende hver e-post den mottar til ditt HTTPS-endepunkt som JSON: innhold, headere og vedlegg i base64. Funksjonen åpnes etter en kort gjennomgang av hva du skal bruke den til; spør på siden for e-postvideresending for et domene.

$ 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"}'

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
}

Signaturen fungerer som for kontowebhookene: se verifisering av en signatur.

Hendelser

Webhooks for kontoen kan abonnere på email.*: email.mailbox.created, email.mailbox.deleted, email.forwarding.enabled og email.forwarding.disabled (sendes også når et domene ikke lenger kvalifiserer for gratis videresending, med årsaken).

Fra terminalen

$ 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

Alle kommandoer støtter --json. Installasjon og alle kommandoer: CLI.

Fra din KI

Via MCP kan en assistent liste opp e-postdomenene dine, sjekke DNS-oppsettet deres, opprette postbokser og aliaser og slå på videresending. Passord til postbokser sendes aldri til AI-en: Du finner dem i kontrollpanelet.