> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bosonware.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Frequently asked questions

> Answers to common questions about BosonMail, the SDK, pricing, runtime support, attachments, and delivery tracking.

This page answers the most common questions about BosonMail and its official Node.js SDK.

> [accordion] 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.

> [accordion] 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](https://bosonware.com/products/bosonmail).

> [accordion] 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+.

> [accordion] Does the SDK support TypeScript?
>
> Yes. The package ships its own TypeScript declarations in `dist/index.d.ts`. No `@types` package is required.

> [accordion] Can I use the SDK with CommonJS?
>
> The package is ESM-only. In CommonJS, use a dynamic import:
>
> ```javascript theme={null}
> const { default: BosonMailClient } = await import("@bosonware-ent/bosonmail");
> ```

> [accordion] 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.

> [accordion] 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.

> [accordion] 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.

> [accordion] 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](https://identity.bosonware.com/login) or contact [support@bosonware.com](mailto:support@bosonware.com) for assistance.

> [accordion] 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.

> [accordion] How do I check the delivery status of an email?
>
> Call `getEmailStatus` with the `messageId` returned from `sendEmail`:
>
> ```typescript theme={null}
> const result = await client.getEmailStatus(messageId);
> if (result.success) {
>   console.log(result.data.status);
>   console.log(result.data.delivery_status);
> }
> ```

> [accordion] What are the attachment limits?
>
> * Maximum 10 attachments per email
> * 10 MB per attachment
> * 20 MB total across all attachments

> [accordion] 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.

> [accordion] Does the SDK support webhooks for delivery events?
>
> No. The SDK does not provide webhooks. Delivery tracking is done by polling `getEmailStatus`.

> [accordion] 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.

> [accordion] 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.

> [accordion] Where can I get help?
>
> * Email: [support@bosonware.com](mailto:support@bosonware.com)
> * Contact form: [bosonware.com/contact](https://bosonware.com/contact?selection=bosonmail)
> * GitHub: [github.com/BosonWareOfficial](https://github.com/BosonWareOfficial)
> * X: [x.com/BosonWareENT](https://x.com/BosonWareENT)

## Next steps

> [card] [Quickstart](https://docs.bosonware.com/quickstart.md)
>
> Send your first email in under five minutes.

> [card] [Support](https://docs.bosonware.com/resources/support.md)
>
> All support channels and how to reach BosonWare.

> [card] [Troubleshooting](https://docs.bosonware.com/advanced/troubleshooting.md)
>
> Fixes for common errors and runtime issues.

> [card] [Changelog](https://docs.bosonware.com/resources/changelog.md)
>
> SDK release history and upgrade notes.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.