mailbox

Ein lokaler Entwicklungs-Mail-Sink: Betreiben Sie einen SMTP-Server plus eine HTTP-API für Ihre gesamte Maschine und richten Sie jedes Projekt darauf aus. E-Mails verlassen Ihr Gerät nie — stattdessen landen sie in einem einsehbaren Posteingang mit einer Weboberfläche, einem CLI und einem MCP-Server für KI-Agenten.

Eine gemeinsame Instanz beseitigt Portkollisionen pro Projekt: Starten Sie sie einmal, verbinden Sie viele.

Install

pnpm add -D @sdk-e/mailbox   # or npm i -D / yarn add -D

Oder führen Sie es ad hoc aus:

npx @sdk-e/mailbox

Quick start

mailbox            # SMTP on :11025, inbox UI on http://localhost:11090

Senden Sie E-Mails an smtp://127.0.0.1:11025 von jeder App (nodemailer, Resend-Entwicklungsmodus usw.), dann:

open http://localhost:11090   # or: mailbox-cli open

Bins

CLI examples

mailbox-cli list
mailbox-cli read 3
mailbox-cli wait "verification code" --timeout 10   # blocks until a new matching message arrives
mailbox-cli clear

wait matcht nur Nachrichten, die nach dem Start eintreffen — starten Sie es, bevor Sie den Versand auslösen.

Library use

import { startMailbox } from "@sdk-e/mailbox";

const mailbox = await startMailbox({ smtpPort: 0, httpPort: 0 }); // 0 = ephemeral
console.log(mailbox.smtpPort, mailbox.url);
await mailbox.close();

Ideal für Integrationstests, die einen isolierten Wegwerf-Posteingang benötigen.

HTTP API (stable wire protocol)

Configuration

Umgebungsvariablen (eine .env.local, dann .env, im Arbeitsverzeichnis werden geladen, falls vorhanden):

Richten Sie den Mailer Ihrer App lokal auf smtp://127.0.0.1:$MAIL_SMTP_PORT aus; in Produktion verwenden Sie weiterhin Ihren echten Anbieter. Der Server weigert sich zu starten, wenn NODE_ENV=production ist.

Why high ports?

1025/1080 (klassische MailHog-Standardwerte) kollidieren häufig. mailbox verwendet standardmäßig 11025/11090, sodass mehrere SDK-E-Projekte eine einzelne Instanz gemeinsam nutzen können, ohne sich gegenseitig oder mit anderen lokalen Tools zu überschneiden.

Development

Erfordert Node >= 20 und pnpm >= 11.

pnpm install
pnpm verify     # format, lint, typecheck, test, build

Siehe CONTRIBUTING.md.

License

MIT