What is BosonMail?
What is BosonMail?
BosonMail is a managed business email platform by BosonWare Enterprises (Kenya). It provides team inboxes, outbound sending, and email status tracking, priced per inbox per month.
Is the SDK free to use?
Is the SDK free to use?
The SDK is open source under the MIT license and has zero runtime dependencies. The BosonMail service itself is a paid product. See pricing details on bosonware.com.
Which Node.js versions are supported?
Which Node.js versions are supported?
Node.js 18 and newer. The SDK requires native
fetch, FormData, Blob, and AbortController, which are globals in Node.js 18+.Does the SDK support TypeScript?
Does the SDK support TypeScript?
Yes. The package ships its own TypeScript declarations in
dist/index.d.ts. No @types package is required.Can I use the SDK with CommonJS?
Can I use the SDK with CommonJS?
The package is ESM-only. In CommonJS, use a dynamic import:
Does the SDK work with Bun?
Does the SDK work with Bun?
Yes. The README lists
bun add @bosonware-ent/bosonmail as a supported installation method. Bun provides the required web-standard globals.Does the SDK work with Cloudflare Workers or other edge runtimes?
Does the SDK work with Cloudflare Workers or other edge runtimes?
The SDK only uses web-standard globals (
fetch, FormData, Blob, AbortController, setTimeout) and has no Node-specific imports. It is expected to work in runtimes that provide these APIs, but BosonWare has not officially verified compatibility with Cloudflare Workers, Deno, or other edge platforms.Can I use the SDK in a browser?
Can I use the SDK in a browser?
No. The SDK requires an API key, which must never be exposed in client-side code. Build a server endpoint that calls the SDK instead.
How do I get an API key?
How do I get an API key?
BosonWare has not published the exact dashboard steps for creating API keys. Sign up at identity.bosonware.com/login or contact support@bosonware.com for assistance.
Does a successful sendEmail mean the email was delivered?
Does a successful sendEmail mean the email was delivered?
No.
success: true means the API accepted the message for delivery. The initial status is typically "queued". Use getEmailStatus to track the message through the delivery pipeline.How do I check the delivery status of an email?
How do I check the delivery status of an email?
Call
getEmailStatus with the messageId returned from sendEmail:What are the attachment limits?
What are the attachment limits?
- Maximum 10 attachments per email
- 10 MB per attachment
- 20 MB total across all attachments
Can I set the From address?
Can I set the From address?
The SDK does not accept a
from parameter. The sender address is presumably determined by the inbox or account tied to the API key, but BosonWare has not confirmed how this is set.Does the SDK support webhooks for delivery events?
Does the SDK support webhooks for delivery events?
No. The SDK does not provide webhooks. Delivery tracking is done by polling
getEmailStatus.Does the SDK retry failed requests automatically?
Does the SDK retry failed requests automatically?
No. The SDK does not implement retries, backoff, or automatic polling. Build these in your application if needed.
Are there API rate limits?
Are there API rate limits?
BosonWare has not published API rate limits. Each inbox includes 500 outbound emails per month. Whether API sends count against this allowance requires confirmation from BosonWare.
Where can I get help?
Where can I get help?
- Email: support@bosonware.com
- Contact form: bosonware.com/contact
- GitHub: github.com/BosonWareOfficial
- X: x.com/BosonWareENT
Next steps
Quickstart
Send your first email in under five minutes.
Support
All support channels and how to reach BosonWare.
Troubleshooting
Fixes for common errors and runtime issues.
Changelog
SDK release history and upgrade notes.