npm
send.ts
A successful
sendEmail response means BosonMail accepted the message for processing. It does not mean the message has been delivered to the recipient’s inbox. Use getEmailStatus to track delivery.What the SDK does
- Send plain-text and HTML transactional emails
- Address multiple recipients, CC, and BCC
- Attach files up to 10 MB each (20 MB total)
- Look up email submission and delivery status by message ID
- Return fully typed results with status codes, IDs, and error messages
- Time out requests cleanly after a configurable duration
Explore the docs
Quickstart
Go from zero to a sent email in under five minutes.
Installation
Package managers, requirements, and TypeScript setup.
Authentication
API keys, Bearer tokens, and security basics.
Sending emails
Recipients, subjects, text, HTML, and result handling.
Attachments
File uploads, size limits, and content types.
Email status
Track submission and delivery with message IDs.
Next.js guide
Send email from API routes and server actions.
API reference
Endpoints, request formats, and response envelopes.