Documentation
Mailpit API and WebSocket Clients
TypeScript clients for interacting with Mailpit. Ideal for automating your email testing. Works in Node.js, browser, and any modern JS runtime.
Packages
| Package | Description | Docs |
|---|---|---|
mailpit-api |
REST API client - zero dependencies | API Reference |
mailpit-ws |
WebSocket client for real-time events | API Reference |
Quick Start
# REST API only (zero dependencies)
npm install mailpit-api
# REST API + real-time events
npm install mailpit-api mailpit-ws
Documentation
Detailed documentation covering all available methods and type definitions for both packages.
Upgrading from v1? See the upgrade guide.