e2a

module
v1.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 21, 2026 License: Apache-2.0

README

e2a

Give your AI agents a real, authenticated email address.

Receive inbound over webhook · WebSocket · REST · MCP. Send through an HTTP API. Every sender — human or agent — identity-verified.

Tests Build image License PyPI e2a

Hosted (e2a.dev) · Quickstart · Concepts · API · SDKs · MCP · Deploy · FAQ


[!IMPORTANT] The /v1 API and SDKs are release candidates and are not yet stable. GA is planned by July 31, 2026; stable compatibility guarantees begin only with the explicitly announced GA release tag. Existing v1.0.x application/cherry-pick tags predate the API freeze and are not /v1 compatibility baselines. Pin your SDK versions and watch Releases.

e2a is an authenticated email gateway for AI agents. It receives inbound mail, evaluates SPF, every DKIM signature, and DMARC, and delivers structured authentication evidence over whichever channel fits your runtime. Outbound goes back out through an HTTP API, with an optional human-in-the-loop approval gate.

Four ways to plug an agent in:

  • MCP — point any MCP-aware runtime at the hosted server (https://api.e2a.dev/mcp) and your agent gets an inbox toolset (list_messages, send_message, reply_to_message, …). The fastest path for agent frameworks. → MCP server
  • SDKs — TypeScript (@e2a/sdk) and Python (e2a) clients with one-call webhook verification and a WebSocket listen() stream. → SDKs
  • Raw delivery — subscribe a webhook, open a WebSocket, or poll the REST API directly. → Delivery channels
  • CLIe2a listen bridges inbound mail to a local HTTP handler (including an OpenAI Responses auto-reply mode). → CLI

What you get on top of bare SMTP:

  • Authenticated inbound identity — normalized SPF, DKIM, and DMARC evidence, with an explicit aligned DMARC verdict
  • No public URL required — WebSocket, REST polling, and MCP all work from a laptop or behind a firewall
  • Outbound API — agents send to other agents (SMTP relay) or humans (upstream SMTP, e.g. SES, Resend)
  • Human in the loop — opt-in approval gate that holds outbound mail until a reviewer approves via dashboard, magic-link email, the MCP tools, or the API
  • Inbound threat screening — opt-in content scan flags prompt-injection payloads (hidden HTML, Unicode-tag smuggling, encoded text) — and, with the LLM detector, phishing — then routes each message to allow · review · block, feeding the same review queue as HITL → Content screening
  • Conversation threading — a stable conversation_id that survives the email ↔ structured-data boundary
  • Email templates (beta) — reusable {{variable}} templates rendered server-side at send time, plus a pre-built starter catalog → docs/templates.md

Quickstart

The fastest path is to give your AI agent an inbox directly. Install the e2a plugin — it registers the hosted MCP server and an operate-well skill, so your agent can send, receive, reply in-thread, and hold mail for review out of the box. On first tool use it runs an OAuth flow in your browser — no API key to paste.

Claude Code

claude plugin marketplace add tokencanopy/e2a
claude plugin install e2a@e2a

Codex

codex plugin marketplace add tokencanopy/e2a

Then launch codex, run /plugins, and install e2a.

Cursor — add the MCP server directly. Put this in .cursor/mcp.json (or ~/.cursor/mcp.json to get it in every project); Cursor opens your browser to authorize on first use, no API key to paste:

{
  "mcpServers": {
    "e2a": { "url": "https://api.e2a.dev/mcp" }
  }
}

Other MCP clients (Zed, Goose, Windsurf, Claude Desktop, raw mcp.json) — point straight at https://api.e2a.dev/mcp; ready-to-paste configs are in plugins/e2a/clients/. See plugins/e2a/README.md for the full per-client guide.

Use it

You can either use the hosted instance or self-host.

  • Hosted — sign up at e2a.dev. Includes the shared agents.e2a.dev domain for instant slug-based onboarding (no DNS setup), a dashboard, the hosted MCP server, and managed deliverability.
  • Self-host — see Self-host (Docker) and Deployment. Every feature works the same; the shared-domain slug shortcut just needs you to point a mail domain at your relay and set shared_domain in config.yaml.

How it works

   Human (Gmail/Outlook)  ·  another e2a agent
          │   ▲
  inbound │   │ outbound
    SMTP  ▼   │ upstream SMTP (to humans) / relay (to agents)
   ┌───────────────┐
   │   e2a relay   │  ← MX for your agent domain points here
   │               │
   │   inbound  ↓  │  ← evaluate SPF/DKIM/DMARC · deliver
   │   outbound ↑  │  ← optional HITL hold · send
   └───────────────┘
          │   ▲
  deliver │   │ send · reply · forward (HTTP API)
          ▼   │
   ┌───────────────┐
   │   your agent  │  ← webhook / WebSocket / REST poll / MCP · SDK · CLI
   └───────────────┘

Inbound flow: SMTP → SPF/DKIM/DMARC evaluation → agent lookup → webhook / WebSocket / REST / MCP delivery.

Outbound flow: API call → optional HITL hold → SMTP relay (agent-to-agent) or upstream SMTP (agent-to-human).

Concepts

Delivery channels

Inbound mail reaches you several complementary ways — chosen per integration, not set on the agent. There is no delivery "mode" on the agent record; any agent the caller owns can be consumed over any of these:

Channel How Public URL needed?
Webhooks Account-level subscriptions (POST /v1/webhooks) — HTTPS POST per event, filterable by agent / conversation / event type Yes
WebSocket Per-agent real-time notification stream (/v1/agents/{email}/ws) + REST fetch No
REST polling Pull messages via GET /v1/agents/{email}/messages — the default path for MCP-based agents No
MCP tools The e2a MCP server's inbox tools (list_messages, get_message, get_attachment, list_conversations, …) layered over the REST API No

Notifications carry lightweight metadata (message id, sender, subject); you fetch the full body + attachments over REST when you want them. A disconnected WebSocket client accumulates "unread" messages; on reconnect, the server drains them as notifications.

Webhooks are an account-level resource (/v1/webhooks), chosen per integration rather than configured on the agent.

Inbound authentication

Inbound messages expose header_from (the parsed RFC 5322 From address), envelope_from (SMTP MAIL FROM), verified_domain (a nullable DMARC-pass convenience projection), and—on detail responses—authentication (SPF, every DKIM signature, and the aligned DMARC result). Reply-To remains separate and never replaces header_from.

For list and review decisions, a non-null verified_domain means DMARC passed for that RFC 5322 From domain. On detail responses, the equivalent check is authentication?.dmarc.status === "pass". Neither field authenticates the mailbox local part, a person, or message content. authentication is null for outbound messages and providerless local loopback delivery.

Before trusting any webhook field, verify the delivery envelope's X-E2A-Signature with the webhook's whsec_… signing secret. The envelope signature covers the complete structured payload, including authentication.

The one-call shortcut parses and verifies a delivery, returning a typed event — use it instead of trusting any field on an unverified payload:

from e2a.v1 import construct_event, E2AWebhookSignatureError

# raw request body + the X-E2A-Signature header + your whsec_… secret
try:
    event = construct_event(request_body, signature_header, webhook_secret)
except E2AWebhookSignatureError:
    abort(400)  # bad signature — reject the delivery
if event.type == "email.received":
    email = await client.inbound.from_event(event)
    print(email.envelope_from, email.verified, email.reply_targets)
    result = await email.reply({"text": "Got it"})
    if result.status == "pending_review":
        notify_human(result.message_id)
import { constructEvent, E2AWebhookSignatureError } from "@e2a/sdk/v1";

let event;
try {
  event = constructEvent(req.body, req.header("X-E2A-Signature")!, webhookSecret);
} catch (err) {
  if (err instanceof E2AWebhookSignatureError) return res.status(400).end(); // bad signature
  throw err;
}
if (event.type === "email.received") {
  const email = await client.inbound.fromEvent(event);
  console.log(email.envelopeFrom, email.verified, email.replyTargets);
  const result = await email.reply({ text: "Got it" });
  if (result.status === "pending_review") notifyHuman(result.messageId);
}

construct_event / constructEvent checks that the HMAC matches the canonical signing string and the timestamp is within a 5-minute replay window. Pass an array of secrets to accept either during a rotation: constructEvent(body, header, [oldSecret, newSecret]).

Messages fetched over an authenticated channel — client.messages.get(address, id) or the client.listen(...) stream — are already trusted (the bearer token authenticated the call), so no verify step is needed there.

Conversation threading

Both send and reply accept an optional opaque conversation_id (server-minted when omitted). e2a propagates it to the recipient on delivery via payload.conversation_id, surfaced in this priority order:

  1. X-E2A-Conversation-Id header — authoritative for e2a-to-e2a traffic. Only honored when the SMTP envelope MAIL FROM originates from this relay, so external senders cannot forge it.
  2. In-Reply-To / References lookup — standard RFC 5322 threading, scoped to the recipient agent's own messages. Covers humans replying from Gmail/Outlook.

First contact from a human arrives with conversation_id: null — the inbound relay assigns no thread id by design. You don't have to mint one yourself: when the agent replies with conversation_id omitted, e2a auto-generates a stable conv_… anchor that later replies thread onto, and replies within an existing thread inherit the referenced message's id. An explicit conversation_id you pass always takes precedence; a forward starts a new thread.

Content screening

Inbound email is a prime indirect prompt-injection vector — a message can smuggle instructions aimed at your agent's LLM (hidden HTML, zero-width / Unicode-tag text, encoded payloads) or phish the human behind it. Opt in per agent and e2a inspects message content — subject, plaintext, and both visible and hidden HTML — before your agent ever sees it.

A built-in, dependency-free heuristics detector flags prompt-injection, jailbreak, obfuscation, and data-exfiltration patterns (mapped to OWASP LLM01 / MITRE ATLAS); an optional LLM detector adds semantic injection and phishing classification. Each message gets a verdict — allow · review · block — set by the agent's scan sensitivity (off · low · medium · high): review routes it into the shared HITL queue, block drops it before delivery. Screening is fail-safe — if a detector times out or degrades, the message fails to review, never to a silent allow — and every verdict is written to protection_events for audit and threshold tuning.

Turn it on with PUT /v1/agents/{email}/protection (the same sub-resource as HITL holds), which carries the inbound/outbound × gate/scan posture.

Human in the loop (HITL)

When an agent's protection config holds an outbound message for review, send and reply calls do not dispatch immediately. The message is stored with status pending_review and the API returns HTTP 202 Accepted. A reviewer must approve it before delivery; otherwise, after a configurable TTL, the protection config's holds.on_expiry decides the terminal: approve (the message just goes out, terminal status sent — for outbound, approving is sending) or reject (discard, review_expired_rejected). (Inbound messages can be held for review too — there, the auto-approve terminal is review_expired_approved, releasing the message to the inbox.)

Reviewers can approve or reject via:

  • Dashboard / API — the account-scoped review queue POST /v1/reviews/{id}/approve or /reject (id-addressed, no inbox email needed; lists held items across all the account's inboxes via GET /v1/reviews). This is the only approve/reject path — a review's id is the held message's id.
  • MCP toolsapprove_review / reject_review (with list_reviews / get_review to find them).
  • Magic-link email — sent automatically when a hold fires; one-click GET /v1/approve?t=… and /v1/reject?t=… URLs (requires E2A_PUBLIC_URL and outbound SMTP configured).

Enable review holds on an agent via PUT /v1/agents/{email}/protection: set the outbound gate action to review (or turn on the content scan), plus the hold TTL (holds.ttl_seconds) and its expiry behavior (holds.on_expiry = approve or reject). Posture lives entirely on the protection sub-resource.

API

All endpoints are under /v1 unless noted. Auth is Authorization: Bearer <api_key> except for /api/health, /v1/info, /api/feedback, and the HITL magic-link routes. Path parameters containing @ (agent emails) must be URL-encoded.

The surface covers domain registration + verification, agent CRUD, inbound/outbound messages, webhook subscriptions, HITL approve/reject (API key or signed magic-link token), GDPR-style export and deletion, and a WebSocket channel for real-time inbound delivery.

See docs/api.md for the full endpoint reference, or api/openapi.yaml for the machine-readable spec.

MCP server

The fastest way to give an AI-agent runtime an inbox. e2a runs a hosted Model Context Protocol server — point any MCP-aware host (Claude Desktop, Cursor, Cline, Google ADK, LangChain, OpenAI Agents SDK, …) at the Streamable HTTP endpoint:

https://api.e2a.dev/mcp

Authenticate either with OAuth 2.1 (add e2a as a connector and authorize in the browser) or a Bearer API key (Authorization: Bearer <e2a API key>). An agent-scoped credential resolves its agent server-side; account-scoped callers pass the agent email per tool call.

The toolset covers the full agent loop — inbox (list_messages, get_message, get_attachment, list_conversations, get_conversation, update_message_labels), outbound (send_message, reply_to_message, forward_message), HITL review (list_reviews, get_review, approve_review, reject_review), plus agent/domain/webhook management. Inbound is consumed by polling (list_messages) or a create_webhook subscription.

The hosted server is the primary path; npm publishing of @e2a/mcp-server is retired (frozen at 0.4.0). See mcp/README.md for per-framework setup and the full tool reference.

CLI

npm install -g @e2a/cli
e2a login

The CLI covers both scripting (send/reply/messages/whoami, with a stable exit-code contract) and account management (agents, keys, protection). Drive agents interactively over the MCP tools or the SDKs instead; manage domains/webhooks in the web dashboard.

Command Description
e2a login Open a browser login and save an account-scoped API key to ~/.e2a/config.json (does not set a default agent — use e2a config set agent_email or --agent)
e2a whoami Show the key identity: user, scope, bound agent, plan
e2a agents list|create|get Manage inboxes (requires an account-scoped key)
e2a keys create|list|delete Mint, list, and revoke API keys (requires an account-scoped key)
e2a protection get|set Show or update an agent's HITL screening/review config
e2a send / e2a reply Send an email as the agent, or reply in-thread
e2a messages list|get List or fetch messages for an agent
e2a listen --agent <email> Stream inbound email for an agent over WebSocket (real-time; --json for raw, --forward <url> to bridge to a local HTTP handler)
e2a config [list|get|set] View or update the local config

When the --forward <url> endpoint path ends in /v1/responses, listen switches to OpenAI Responses API forwarding: each inbound email is formatted as a Responses payload and the model's output is sent back as an auto-reply. Add --forward-token <token> to attach a bearer token to the forwarded request:

e2a listen --forward http://localhost:18789/v1/responses --forward-token <token>

See cli/README.md for full reference.

SDKs

Python

pip install e2a            # webhook mode
pip install 'e2a[ws]'      # adds WebSocket support
from e2a.v1 import AsyncE2AClient, construct_event

client = AsyncE2AClient()                                       # reads E2A_API_KEY
event = construct_event(request_body, signature_header, webhook_secret)  # parse + HMAC-verify
if event.type == "email.received":
    email = await client.inbound.from_event(event)
    print(email.envelope_from, email.verified, email.reply_targets)
    result = await email.reply({"text": "Got it!"})
    if result.status == "pending_review":
        print("awaiting approval", result.message_id)

WebSocket (no public URL needed):

from e2a.v1 import AsyncE2AClient

async with AsyncE2AClient(api_key="e2a_…") as client:
    async for event in client.listen("bot@your-domain.com"):
        if event.type != "email.received":
            continue  # tolerate future event kinds
        email = await client.inbound.from_event(event)
        result = await email.reply({"text": "Got it!"})
        if result.status == "pending_review":
            print("awaiting approval", result.message_id)

See sdks/python/README.md.

TypeScript

npm install @e2a/sdk

See sdks/typescript/README.md.

Deployment

Three audiences each configure a different surface:

Audience What they configure Where
Server operator — runs the Go backend DB, signing key, SMTP, OAuth, optional shared domain config.yaml + E2A_* env
CLI user — drives an inbox from a terminal Deployment URL + login E2A_URL + e2a login
SDK / MCP user — calls /v1 from code API host + key E2A_API_URL + E2A_API_KEY
Web dashboard deployer — hosts the Next.js dashboard Public site URL + branding NEXT_PUBLIC_* build-time env

The Go binary runs on any container host; storage is plain Postgres 14+; outbound mail goes through standard SMTP. Most workers coordinate via SELECT … FOR UPDATE SKIP LOCKED, so multi-replica is safe — the two real horizontal-scaling caveats are in-memory WebSocket fan-out and per-process rate limits.

See docs/deployment.md for the full env-var reference, shared-domain DNS setup, and scaling/limitation notes.

Security

  • Identity — agent registration requires DNS TXT verification of domain ownership (custom domains)
  • Domain auth — SPF and DKIM checked on every inbound message
  • Header signatures — HMAC-SHA256 over canonical auth-header string; reject if timestamp older than 5 minutes
  • SSRF protection — webhook URLs must be HTTPS (in production), resolve to public IPs, use domain names (no raw IPs, no private/loopback ranges)
  • OAuth CSRF — single-use, time-limited nonce in the state parameter
  • Production mode (env: production in config.yaml) enforces the above where development mode is more permissive

Report security issues privately — see SECURITY.md for the disclosure process and what's in scope. Do not file public GitHub issues for vulnerabilities.

Data handling

Live inbound and outbound message data is retained indefinitely; soft-deleted messages and inboxes are purged after 30 days by default. Outbound bodies and attachments remain retained through terminal review and delivery transitions. API keys are stored as hashes; attachments go in JSONB rows (no S3/GCS). Application logs include sender/recipient addresses (standard MTA practice) but never bodies, attachments, raw keys, or HMAC secrets. Users can self-export (GET /v1/account/export) and self-delete (DELETE /v1/account?confirm=DELETE) for GDPR Art. 15 / Art. 17 / CCPA.

See docs/data-handling.md for the full retention table, log fields, user-rights endpoints, and the operator-side responsibilities (backups, TLS, at-rest encryption, log redaction, compliance).

FAQ

Why not just use SendGrid / Resend / Postmark for sending and their inbound parsing for receiving?

Four things that aren't possible to bolt on without significant rework:

  1. Inbound with no public URL. Agents authenticate with their API key and consume inbound mail over a WebSocket to /v1/agents/{email}/ws, by polling the REST API, or through the MCP tools — no webhook URL, no ngrok, no port forward. Useful for agents on developer laptops, edge devices, or behind corporate firewalls. SendGrid/Resend are webhook-only by design.

  2. Conversation threading on every reply. Whether a human replies from Gmail or another e2a agent replies via the API, the inbound message arrives at the agent with a stable conversation_id already mapped to the original thread. For human senders, the relay does standard In-Reply-To / References lookup scoped to the recipient agent's own messages. For agent-to-agent where both sides are on e2a, it also trusts an X-E2A-Conversation-Id header it controls (envelope-from is its own domain), which survives clients that rewrite threading headers. SendGrid/Resend never see inbound mail — they aren't receivers — so neither path is available without you building both yourself.

  3. Slug provisioning on a shared domain. Operators set shared_domain: agents.e2a.dev and users POST {"email": "my-agent@agents.e2a.dev"} to immediately register an agent on the shared domain with no DNS configuration. Possible because e2a is the SMTP relay claiming the domain — Resend / SendGrid are providers, not platforms, and can't multi-tenant a shared address space without you running the relay yourself.

  4. Built-in review hold + auto-expiration. A per-agent protection policy (outbound gate action review, or the content scan) holds mail in pending_review state. Reviewers approve via dashboard, magic-link email, the MCP tools, or the API; a background worker auto-acts on expired holds based on the holds.on_expiry config. Magic-link tokens are HMAC-encoded — stateless, no session backend. With Resend / SendGrid you'd hold the message in your own DB, build the timer, the approval UI, and the stateless review tokens.

You can absolutely use SES / Resend / SendGrid as e2a's outbound SMTP for delivery to humans — that's what outbound_smtp in config.yaml is for. They complement e2a; they don't replace the inbound receiver, agent abstraction, or any of the layers above transport.

Why email at all? Why not webhooks, gRPC, or MCP between agents?

Email is the only protocol where every human already has an address and a working client. Webhooks / gRPC / MCP are great inside systems you control, but they don't reach Gmail or Outlook. If you want an agent that talks to humans (or to other organizations' agents) without forcing everyone to install a new client, email is the universal substrate.

e2a doesn't replace webhooks or MCP — your agent receives email through them. It bridges email's universal addressability to the structured-data world the agent code already lives in.

What stops an attacker from spoofing authentication results?

The relay discards any sender-supplied authentication claims and evaluates SPF, DKIM, and DMARC itself. For webhooks, verify X-E2A-Signature with the subscription's whsec_ secret before trusting the structured result; a forged POST then fails verification regardless of its claimed DMARC status.

Receivers verify with the SDK — construct_event(body, header, secret) / constructEvent(body, header, secret) does parse + HMAC verify in one call (or verify_webhook_signature(...) / verifyWebhookSignature(...) if you only need the boolean check). No API call back to e2a needed. If a signing secret leaks, rotate it via the dashboard; the previous secret keeps verifying through a 24h grace window, then stops. If it is stolen from the relay itself, treat the relay as compromised rather than trusting any webhook headers it emits.

Isn't this just SMTP with extra steps?

Yes — and the extra steps are the point. Concretely:

  • SPF/DKIM verdict normalization so receivers don't reimplement domain auth
  • Structured SPF/DKIM/DMARC evidence with explicit identifier alignment
  • WebSocket / REST / MCP transport for agents without public URLs
  • HITL approval flow with auto-expiration and stateless magic-link review
  • Conversation-Id threading that survives the email ↔ structured-data boundary
  • Slug-based agent provisioning on a shared domain
  • Per-agent webhook routing, rate limits, and HITL config

Building those on top of bare Postfix is a real project. e2a is that project, open source.

How does this compare to running Postfix or Postal myself?

If you want a full MTA, run an MTA — Postfix and Postal are great. e2a isn't trying to replace them at the SMTP transport level (it uses go-smtp for receiving and dial-out for sending). The value is the layer above transport: the auth model, agent abstraction, signed delivery contract, retry policy for webhook failures, HITL approval flow, SDKs and CLI. If you're comfortable operating an MTA and only need email plumbing, e2a may be more than you want. If you want the agent abstraction and signed identity layer prebuilt, that's what this is.

Why open source if there's a hosted version?

Two reasons:

  1. Auditability. Identity infrastructure for your agents should be readable code, not a vendor black box. You can verify the cosign signature on ghcr.io/tokencanopy/e2a, reproduce the build, and confirm what's actually running.
  2. Self-host as a real option. The hosted instance at e2a.dev runs the same ghcr.io/tokencanopy/e2a image you can pull right now. Convenience features on the hosted side (the shared agents.e2a.dev domain, managed deliverability) are config + DNS, not closed-source extras.

The hosted version at e2a.dev has paid tiers (a free tier plus paid plans); billing is opt-in on the hosted side — config (settable via env) points the OSS server at an external limits/billing sidecar, and the OSS code path stays unchanged. Self-hosting runs on generous default limits with no billing.

Development

make build               # go build -o bin/e2a ./cmd/e2a
make run                 # build + run (cp config.example.yaml config.yaml first)
make test                # all Go tests (needs Postgres on :5433)
make test-unit           # Go unit tests only (no DB)
make test-integration    # integration tests (needs Postgres)
make test-e2e            # e2e tests (needs Postgres)
make cover-check         # tests + per-package coverage floors (needs Postgres)
docker compose up -d postgres mailpit  # local Postgres + Mailpit only
make migrate             # apply SQL migrations to local DB

See CLAUDE.md for the full developer guide (architecture, tests, code generation, conventions).

Self-host (Docker)

Requires Docker.

git clone https://github.com/tokencanopy/e2a.git
cd e2a
docker compose up -d

Postgres comes up first (migrations run automatically), then the API server, then the dashboard. Four host ports:

  • :8080 — HTTP API
  • :2525 — SMTP relay
  • :3000 — Dashboard (Caddy + Next.js, proxies /api/* to the API server)
  • :8765 — Local MCP HTTP endpoint (what claude mcp add expects)

Health check:

curl http://localhost:8080/api/health
# {"status":"ok"}

Open http://localhost:3000 in a browser to view the dashboard. Sign-in requires Google OAuth credentials configured in config.yaml; for an API-only smoke test you can skip the dashboard and use the bootstrap flow below.

Create your first user and API key (no OAuth required):

docker compose exec e2a e2a -config /etc/e2a/config.yaml -bootstrap-email you@example.com
# User:    you@example.com (id=...)
# API key: e2a_...

Save the key — it's only shown once. Register an agent and confirm it works:

KEY=e2a_...
curl -X POST http://localhost:8080/v1/agents \
  -H "Authorization: Bearer $KEY" -H "Content-Type: application/json" \
  -d '{"email":"my-bot@agents.e2a.dev"}'   # an email on the deployment shared domain (or a domain you've verified)

curl -H "Authorization: Bearer $KEY" http://localhost:8080/v1/agents

To receive real inbound mail, point a domain's MX record at your relay host:

  • A: your-domain.com → server IP
  • MX: your-domain.comyour-domain.com (priority 10)

Then register and verify the domain through the API (see Domains). Without DNS, the API still works for testing — but external email won't reach your relay.

Upgrades and migrations. The e2a binary embeds migrations/*.sql and auto-applies any pending ones at startup (tracked in a schema_migrations table). When you upgrade e2a, restarting the container applies new schema migrations automatically — no manual step. E2A_MIGRATION_MODE controls this: auto (default, applies pending), verify (refuse startup and report pending), or skip (emergency surgery). Migrations are idempotent and non-destructive, so re-applying is safe.

(The compose file also mounts migrations/ into Postgres' init directory, but that path only runs on first start with an empty data volume — the binary's startup auto-apply is what keeps an upgraded deployment current.)

Contributing

By submitting a pull request, you certify the Developer Certificate of Origin for your contribution. Sign your commits with git commit -s.

License

Apache 2.0 — see LICENSE and NOTICE.

Directories

Path Synopsis
cmd
e2a command
e2a-openapi-codegen-normalize command
e2a-openapi-codegen-normalize adapts valid OpenAPI 3.1 nullable object references to the OpenAPI Generator 7.16 dialect.
e2a-openapi-codegen-normalize adapts valid OpenAPI 3.1 nullable object references to the OpenAPI Generator 7.16 dialect.
e2a-openapi-normalize command
e2a-openapi-normalize prepares old and new e2a OpenAPI documents for semantic comparison.
e2a-openapi-normalize prepares old and new e2a OpenAPI documents for semantic comparison.
e2a-openapi-sdk-check command
e2a-openapi-sdk-check protects generated SDK names that wire-level OpenAPI compatibility tools do not compare.
e2a-openapi-sdk-check protects generated SDK names that wire-level OpenAPI compatibility tools do not compare.
e2a-openapi-security-check command
e2a-openapi-security-check protects security-scheme fields that oasdiff does not currently compare.
e2a-openapi-security-check protects security-scheme fields that oasdiff does not currently compare.
e2a-prober command
Command e2a-prober runs the e2a critical-path self-test (internal/selftest) against a live instance, four ways:
Command e2a-prober runs the e2a critical-path self-test (internal/selftest) against a live instance, four ways:
piguard-eval command
piguard-eval is an offline evaluation harness for the piguard heuristics detector.
piguard-eval is an offline evaluation harness for the piguard heuristics detector.
internal
agentauth
Package agentauth is the auth.md agent-identity layer (api-v1-redesign §5 / Slice 5b).
Package agentauth is the auth.md agent-identity layer (api-v1-redesign §5 / Slice 5b).
apiserver
Package apiserver builds the process HTTP handler: the typed Huma /v1 surface (internal/httpapi) wrapping the legacy gorilla/mux fallback.
Package apiserver builds the process HTTP handler: the typed Huma /v1 surface (internal/httpapi) wrapping the legacy gorilla/mux fallback.
approvaltoken
Package approvaltoken signs and verifies the short-lived HMAC tokens embedded in HITL notification-email magic links.
Package approvaltoken signs and verifies the short-lived HMAC tokens embedded in HITL notification-email magic links.
delivery
Package delivery implements outbound delivery feedback (decision 9 / Slice 4b): the async delivery lifecycle SES reports per message and per recipient, plus a per-tenant suppression list.
Package delivery implements outbound delivery feedback (decision 9 / Slice 4b): the async delivery lifecycle SES reports per message and per recipient, plus a per-tenant suppression list.
dkim
Package dkim wraps github.com/emersion/go-msgauth/dkim for the per-domain signing path.
Package dkim wraps github.com/emersion/go-msgauth/dkim for the per-domain signing path.
emailtemplate
Package emailtemplate is the hand-rolled variable-interpolation engine for user email templates (beta).
Package emailtemplate is the hand-rolled variable-interpolation engine for user email templates (beta).
eventpayload
Package eventpayload defines the canonical typed `data` payloads for the STABLE webhook/WS event types (the pre-GA contract freeze, PR-2 of the event/webhook contract audit).
Package eventpayload defines the canonical typed `data` payloads for the STABLE webhook/WS event types (the pre-GA contract freeze, PR-2 of the event/webhook contract audit).
eventpayload/goldenassert
Package goldenassert is the shared TEST helper for the golden-payload fixtures under internal/eventpayload/testdata — the cross-channel drift lock for the stable event `data` payloads.
Package goldenassert is the shared TEST helper for the golden-payload fixtures under internal/eventpayload/testdata — the cross-channel drift lock for the stable event `data` payloads.
hitlnotify
Package hitlnotify sends the approval notification email that fires whenever a new outbound message enters pending_review.
Package hitlnotify sends the approval notification email that fires whenever a new outbound message enters pending_review.
hitlworker
Package hitlworker runs the periodic sweep that finalizes pending_review holds whose TTL has elapsed.
Package hitlworker runs the periodic sweep that finalizes pending_review holds whose TTL has elapsed.
httpapi
Package httpapi is the e2a v1 HTTP contract layer, built on Huma + chi.
Package httpapi is the e2a v1 HTTP contract layer, built on Huma + chi.
idempotency
Package idempotency implements the storage backing the Idempotency-Key header on the outbound send endpoints.
Package idempotency implements the storage backing the Idempotency-Key header on the outbound send endpoints.
inboundpolicy
Package inboundpolicy evaluates a per-agent inbound trust policy (api-v1-redesign decision 10 / Slice 7).
Package inboundpolicy evaluates a per-agent inbound trust policy (api-v1-redesign decision 10 / Slice 7).
inboundprocess
Package inboundprocess is Layer 3 of the queue-first inbound pipeline (docs/design/inbound-message-pipeline-river.md): the River execution stage that takes an accepted inbound_intake row and runs the full processing chain — parse, SPF/DKIM/DMARC, ingestion gate, content screening, persist, and event publish — off the SMTP critical path.
Package inboundprocess is Layer 3 of the queue-first inbound pipeline (docs/design/inbound-message-pipeline-river.md): the River execution stage that takes an accepted inbound_intake row and runs the full processing chain — parse, SPF/DKIM/DMARC, ingestion gate, content screening, persist, and event publish — off the SMTP critical path.
janitor
Package janitor runs the low-urgency hourly cleanup sweep as a River periodic on QueueMaintenance.
Package janitor runs the low-urgency hourly cleanup sweep as a River periodic on QueueMaintenance.
jobs
Package jobs is the single River composition root for e2a's background work.
Package jobs is the single River composition root for e2a's background work.
limits
Package limits enforces per-user resource caps at the agent-create, domain-register, and message-send paths.
Package limits enforces per-user resource caps at the agent-create, domain-register, and message-send paths.
loopback
Package loopback delivers agent-to-self messages without touching the upstream SMTP relay.
Package loopback delivers agent-to-self messages without touching the upstream SMTP relay.
mailfrom
Package mailfrom defines the custom MAIL FROM subdomain convention shared by sender-identity provisioning (which configures it in SES and emits its DNS records) and the outbound sender (which uses it as the aligned Return-Path).
Package mailfrom defines the custom MAIL FROM subdomain convention shared by sender-identity provisioning (which configures it in SES and emits its DNS records) and the outbound sender (which uses it as the aligned Return-Path).
mailparse
Package mailparse produces the "parsed view" of a raw RFC 5322 message — inbound mail and the retained copy of sent outbound mail (decision 9 / Slice 4b-3).
Package mailparse produces the "parsed view" of a raw RFC 5322 message — inbound mail and the retained copy of sent outbound mail (decision 9 / Slice 4b-3).
oauth
Package oauth wires the e2a authorization server using ory/fosite as the protocol layer.
Package oauth wires the e2a authorization server using ory/fosite as the protocol layer.
openapicompat
Package openapicompat contains normalization used only by the OpenAPI compatibility gate.
Package openapicompat contains normalization used only by the OpenAPI compatibility gate.
outboundsend
Package outboundsend is Layer 3 of the outbound pipeline (docs/design/async-message-pipeline.md): the River execution stage that submits an accepted message to the upstream provider (SES) and records the terminal outcome.
Package outboundsend is Layer 3 of the outbound pipeline (docs/design/async-message-pipeline.md): the River execution stage that submits an accepted message to the upstream provider (SES) and records the terminal outcome.
piguard
Package piguard ("prompt-injection guard") is the content-screening seam for inbound and outbound agent email.
Package piguard ("prompt-injection guard") is the content-screening seam for inbound and outbound agent email.
selftest
Package selftest defines the e2a critical-path self-test: a small battery of scenarios that exercise the real product paths (liveness, authenticated read, the inbound SMTP→webhook round-trip with HMAC verification, and a self-send loopback) against a running instance.
Package selftest defines the e2a critical-path self-test: a small battery of scenarios that exercise the real product paths (liveness, authenticated read, the inbound SMTP→webhook round-trip with HMAC verification, and a self-send loopback) against a running instance.
senderidentity
Package senderidentity manages the per-domain SES sending identity that lets outbound mail use the agent's OWN address as the From header (decision 4 / Slice 4).
Package senderidentity manages the per-domain SES sending identity that lets outbound mail use the agent's OWN address as the From header (decision 4 / Slice 4).
sendramp
Package sendramp implements durable, per-domain recipient-volume ramping for the asynchronous outbound delivery worker.
Package sendramp implements durable, per-domain recipient-volume ramping for the asynchronous outbound delivery worker.
startertemplates
Package startertemplates ships the pre-built starter email template masters that seed a new account's template library.
Package startertemplates ships the pre-built starter email template masters that seed a new account's template library.
telemetry
Package telemetry defines the metrics interface for the e2a backend.
Package telemetry defines the metrics interface for the e2a backend.
unsubscribe
Package unsubscribe derives opaque, stable identifiers for managed unsubscribe scopes and their database lookup keys.
Package unsubscribe derives opaque, stable identifiers for managed unsubscribe scopes and their database lookup keys.
webhookdelivery
Package webhookdelivery is Layer 3 of the webhook pipeline (docs/design/webhook-delivery-river-migration.md): the River execution stage that POSTs a webhook_subscriber_deliveries (Layer 2) row to the customer endpoint and retries it.
Package webhookdelivery is Layer 3 of the webhook pipeline (docs/design/webhook-delivery-river-migration.md): the River execution stage that POSTs a webhook_subscriber_deliveries (Layer 2) row to the customer endpoint and retries it.
webhookpub
Package webhookpub publishes events from the e2a core (relay, outbound sender, HITL flow) to subscribers registered via the /v1/webhooks resource, using a durable three-layer pipeline:
Package webhookpub publishes events from the e2a core (relay, outbound sender, HITL flow) to subscribers registered via the /v1/webhooks resource, using a durable three-layer pipeline:
ws
Package migrations embeds every numbered .sql file in this directory so the e2a binary can self-apply schema changes on startup.
Package migrations embeds every numbered .sql file in this directory so the e2a binary can self-apply schema changes on startup.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL