SDK | QQueue Docs

TypeScript SDK for the self-hosted QQueue email API.

License

The QQueue SDK is licensed under the MIT License. See the SDK license.

Install

npm install qqueue-sdk

Usage

import { QQueueClient } from "qqueue-sdk";

const qqueue = new QQueueClient({
  apiKey: process.env.QQUEUE_API_KEY!,
  baseUrl: "https://mail.example.com/api/v1"
});

const email = await qqueue.sendEmail({
  to: "user@example.com",
  subject: "Welcome",
  html: "<p>Hello from QQueue.</p>",
  text: "Hello from QQueue."
});

console.log(email.id, email.status);

Templates

await qqueue.sendEmail({
  to: "user@example.com",
  templateId: "tpl_123",
  variables: {
    firstName: "Ada",
    resetUrl: "https://app.example.com/reset/token"
  }
});

The API key determines the QQueue organization, so SDK calls do not include an organizationId.

Errors

import { QQueueClient, QQueueError } from "qqueue-sdk";

try {
  await qqueue.sendEmail({
    to: "user@example.com",
    subject: "Welcome",
    text: "Hello"
  });
} catch (error) {
  if (error instanceof QQueueError) {
    console.error(error.status, error.code, error.message);
  }
}

Self-Hosting

Point baseUrl at your QQueue API URL. For example, if QQueue is hosted at https://mail.example.com, use:

const qqueue = new QQueueClient({
  apiKey: process.env.QQUEUE_API_KEY!,
  baseUrl: "https://mail.example.com/api/v1"
});

Releases

See the Changelog for public version history and Release Notes for beta release notes and upgrade checks.