Mail client library for the Eliware mail platform.
- Features
- Requirements
- Setup
- Usage
- Development
- Testing
- Troubleshooting
- Security
- API
- Packaging
- Examples
- Support
- Links
- License
Call the mail-server API from Node.js and browser applications. Receive WebSocket events and preserve server response envelopes.
Use Node.js 26 or later. Browser applications require Fetch, Headers, AbortSignal, and URL APIs.
Install the package with npm install @eliware/mail-client. Follow the usage guide to configure the API address and bearer-token provider.
Follow the usage guide. Find client methods in the API reference and version changes in the release notes.
Read AGENTS.md and specifications before changing files. Find maintained guides in documentation.
Run npm test for aggregate validation. Run npm run smoke to check an HTTP and WebSocket connection.
Read the troubleshooting guide for common API and connection problems.
Keep long-lived API tokens in server-side secret stores. Do not expose them to browser code or logs.
Read the API reference for client options, methods, events, logging, and errors.
Read package details for runtime support, package contents, and version rules. Read release notes for package changes.
Read examples/README.md for prerequisites, commands, and expected output.
For help, questions, or to chat with the author and community, visit:
