mail-debugger-api
v0.3.2
Published
Slim SMTP + REST API build of Mail Debugger. Same wire protocol as mail-debugger, without the web UI — meant for CI/E2E where a small footprint matters.
Maintainers
Readme
mail-debugger-api
Slim SMTP + REST API build of Mail Debugger. Same wire protocol as mail-debugger, but without the bundled web UI — meant for CI/E2E where install time and footprint matter.
Usage
pnpx mail-debugger-apiThis starts an SMTP server on port 2525 and an API server on port 3000 with Swagger UI at http://localhost:3000/swagger.
# Custom ports with persistent storage
pnpx mail-debugger-api --smtp-port 1025 --api-port 8080 --persistCLI Options
| Option | Default | Description |
| -------------------- | ------- | --------------------------------------------------------- |
| --smtp-port <port> | 2525 | SMTP server port |
| --api-port <port> | 3000 | REST API server port |
| --persist | false | Enable persistent SQLite storage (mail-debugger.sqlite) |
| --tls <mode> | none | TLS mode: none, starttls, or implicit |
API Reference
| Method | Endpoint | Description |
| -------- | ----------------- | -------------------------------- |
| GET | /api/emails | List emails (supports filtering) |
| GET | /api/emails/:id | Get full email details |
| DELETE | /api/emails/:id | Delete a single email |
| DELETE | /api/emails | Delete all emails |
| GET | /api/health | Health check and server info |
| GET | /swagger | OpenAPI/Swagger UI |
Need the web UI? Install the full mail-debugger package. Want the interactive terminal client? Install mail-debugger-cli.
License
MIT
