# BosonMail SDK

> Official documentation for the BosonMail Node.js and TypeScript SDK by BosonWare Enterprises. Send transactional email, attachments, and check delivery status.

- [BosonMail SDK documentation](https://docs.bosonware.com/index.md): Official Node.js and TypeScript SDK for sending transactional email through BosonMail by BosonWare Enterprises.
- [What is BosonMail?](https://docs.bosonware.com/what-is-bosonmail.md): Overview of BosonMail, the managed business email platform by BosonWare Enterprises, and how the official SDK fits into your application.
- [Installation](https://docs.bosonware.com/installation.md): Install the official BosonMail SDK for Node.js and TypeScript via npm, Bun, pnpm, or Yarn. Requirements and troubleshooting included.
- [Quickstart](https://docs.bosonware.com/quickstart.md): Send your first transactional email with the BosonMail SDK in minutes. Covers installation, environment setup, sending, and status lookup.
- [Authentication](https://docs.bosonware.com/authentication.md): Authenticate with the BosonMail API using a Bearer token passed to the SDK constructor. Covers API keys, scopes, environment variables, and security practices.
- [Configuration](https://docs.bosonware.com/configuration.md): Configure the BosonMail SDK with API keys, custom base URLs, timeouts, and environment-specific settings for production and development.
- [BosonMailClient](https://docs.bosonware.com/sdk/client.md): Complete reference for the BosonMailClient class: import, constructor, readonly properties, methods, and exported TypeScript types.
- [Client configuration](https://docs.bosonware.com/sdk/client-configuration.md): Configure the BosonMailClient with apiKey, baseUrl, and timeoutMs. Learn defaults, validation rules, and timeout behavior.
- [Sending emails](https://docs.bosonware.com/sdk/sending-emails.md): Full reference for sendEmail: parameters, client-side validation, JSON vs multipart transport, Result fields, and TypeScript and JavaScript examples.
- [HTML emails](https://docs.bosonware.com/sdk/html-emails.md): How to send HTML emails with the BosonMail SDK, why you should include a text alternative, and practical tips for email-client compatibility.
- [Multiple recipients](https://docs.bosonware.com/sdk/multiple-recipients.md): Send email to multiple recipients with the to array, learn how addresses are serialized, and when to send individual emails for privacy.
- [CC and BCC](https://docs.bosonware.com/sdk/cc-and-bcc.md): Use CC and BCC fields in sendEmail to copy or blind-copy recipients. Learn serialization, privacy implications, and practical examples.
- [Attachments](https://docs.bosonware.com/sdk/attachments.md): Attach files to emails with the BosonMail SDK. Supported content types, size limits, multipart transport, and security best practices.
- [Email status](https://docs.bosonware.com/sdk/email-status.md): Check delivery status with getEmailStatus. Understand status values, the submission-to-delivery lifecycle, and how to poll for updates.
- [Error handling](https://docs.bosonware.com/sdk/error-handling.md): How the BosonMail SDK reports errors through result objects. Learn to classify constructor, validation, API, network, and timeout failures.
- [Sending your first email](https://docs.bosonware.com/guides/first-email.md): Set up a new Node.js project, install the BosonMail SDK, and send your first email with full error handling and status checking.
- [Sending HTML emails](https://docs.bosonware.com/guides/html-emails.md): Build a reusable order-confirmation email with typed HTML rendering, inline styles, and a plain-text fallback using the BosonMail SDK.
- [Sending emails with attachments](https://docs.bosonware.com/guides/attachments.md): Attach files from disk, generated CSVs, and HTTP uploads to BosonMail emails with automatic multipart encoding and size validation.
- [Sending emails to multiple recipients](https://docs.bosonware.com/guides/multiple-recipients.md): Compare strategies for sending to multiple recipients with To, CC, BCC, and individual personalized emails using the BosonMail SDK.
- [Monitoring email delivery](https://docs.bosonware.com/guides/monitoring-delivery.md): Poll for delivery status with backoff, persist message IDs, and build a reconciliation workflow to track BosonMail emails from queued to terminal state.
- [Integrating with Next.js](https://docs.bosonware.com/guides/nextjs.md): Add BosonMail email sending to a Next.js App Router project using route handlers, server actions, and environment-safe configuration.
- [Integrating with Express.js](https://docs.bosonware.com/guides/express.md): Add BosonMail email sending to an Express application using ESM, TypeScript, multer for attachments, and structured error handling.
- [Integrating with Hono](https://docs.bosonware.com/guides/hono.md): Add BosonMail email sending to Hono on Node.js and Cloudflare Workers, with environment bindings, validation, and attachment handling.
- [Using BosonMail with Bun](https://docs.bosonware.com/guides/bun.md): Send email from Bun scripts and HTTP servers using the BosonMail SDK, with native file reading and environment loading.
- [Production best practices](https://docs.bosonware.com/guides/production-best-practices.md): Secure, monitor, and scale your BosonMail integration with key management, retries, logging, and endpoint protection.
- [API reference](https://docs.bosonware.com/advanced/api-reference.md): REST API endpoints used by the BosonMail SDK: send emails and check delivery status. Includes curl examples and request/response envelopes.
- [Authentication and API keys](https://docs.bosonware.com/advanced/api-keys.md): How to manage BosonMail API keys securely: scopes, storage, rotation, and incident response for leaked credentials.
- [Request and response formats](https://docs.bosonware.com/advanced/request-response-formats.md): Exact serialization rules for BosonMail JSON and multipart requests, response parsing, and how the SDK maps results.
- [Rate limits](https://docs.bosonware.com/advanced/rate-limits.md): What BosonWare publishes about sending limits, plan allowances, and defensive practices when API rate limits are not documented.
- [Error codes](https://docs.bosonware.com/advanced/error-codes.md): Complete catalog of BosonMail SDK error codes and messages: constructor throws, client-side validation, API responses, and network failures.
- [Troubleshooting](https://docs.bosonware.com/advanced/troubleshooting.md): Fix common BosonMail SDK problems: ESM imports, missing globals, validation errors, timeouts, attachment issues, and delivery questions.
- [Security best practices](https://docs.bosonware.com/advanced/security.md): Secure your BosonMail integration: server-side key storage, PII handling, input sanitization, attachment safety, and dependency hygiene.
- [Frequently asked questions](https://docs.bosonware.com/resources/faq.md): Answers to common questions about BosonMail, the SDK, pricing, runtime support, attachments, and delivery tracking.
- [Changelog](https://docs.bosonware.com/resources/changelog.md): Release history for the BosonMail SDK: new features, fixes, and upgrade guidance for each version.
- [NPM package](https://docs.bosonware.com/resources/npm-package.md): The @bosonware-ent/bosonmail package on npm.
- [BosonWare website](https://docs.bosonware.com/resources/bosonware-website.md): BosonWare Enterprises, the company behind BosonMail.
- [Support](https://docs.bosonware.com/resources/support.md): How to get help with BosonMail: support channels, what to include in a request, and where to find additional resources.


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