bavimail

Official TypeScript SDK for the Bavimail API.

Install

npm install bavimail

Usage

API key auth (legacy/default server usage)

import { Bavimail } from "bavimail";

const client = new Bavimail({
  apiKey: process.env.BAVIMAIL_API_KEY!,
});

Bearer auth

import { Bavimail } from "bavimail";

const client = new Bavimail({
  baseUrl: import.meta.env.VITE_BAVIMAIL_API_BASE_URL,
  auth: {
    mode: "bearer",
    getBearerToken: () => localStorage.getItem("bavimail_jwt"),
  },
});

Notes

• x-api-key is only sent in apiKey mode.
• User-Agent is set only in non-browser runtimes.
• Response payloads remain camelCase in SDK models.
• Current resource coverage: domains, aliases, attachments, analytics, emails, inboundEmails, conversations, suppressions, tags, and webhooks.

Migration Notes (0.3.0)

• session and sessionOrBearer auth modes are no longer part of the public SDK.
• Use bearer mode for browser/front-end usage.
• Session-cookie auth is considered an internal platform concern and is intentionally not exposed via the npm SDK.