Velocity Mail TypeScript SDK

This library provides convenient access to the Velocity Mail REST API from JavaScript and TypeScript.

The REST API documentation can be found on api.velocitymail.io.

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add velocitymail

PNPM

pnpm add velocitymail

Bun

bun add velocitymail

Yarn

yarn add velocitymail

[!NOTE] This package is published as an ES Module (ESM) only. For applications using CommonJS, use await import("velocitymail") to import and use this package.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { VelocityMailClient } from "velocitymail";

const velocityMailClient = new VelocityMailClient({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await velocityMailClient.inboxes.list();

  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name | Type | Scheme | | -------- | ------ | ------- | | apiKey | apiKey | API key |

To authenticate with the API the apiKey parameter must be set when initializing the SDK client instance. For example:

import { VelocityMailClient } from "velocitymail";

const velocityMailClient = new VelocityMailClient({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await velocityMailClient.inboxes.list();

  console.log(result);
}

run();

Available Resources and Operations

Inboxes

• list - List inboxes
• create - Create an inbox
• get - Get an inbox
• delete - Delete an inbox
• deleteMessages - Delete inbox messages

Messages

• search - Search messages
• getMatch - Get a matching message
• waitForLatest - Wait for the latest message
• waitForMatch - Wait for a matching message
• get - Get a message
• delete - Delete a message
• getAnalysis - Get message analysis
• getAttachment - Download an attachment

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

• inboxesCreate - Create an inbox
• inboxesDelete - Delete an inbox
• inboxesDeleteMessages - Delete inbox messages
• inboxesGet - Get an inbox
• inboxesList - List inboxes
• messagesDelete - Delete a message
• messagesGet - Get a message
• messagesGetAnalysis - Get message analysis
• messagesGetAttachment - Download an attachment
• messagesGetMatch - Get a matching message
• messagesSearch - Search messages
• messagesWaitForLatest - Wait for the latest message
• messagesWaitForMatch - Wait for a matching message

Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the returned response object will also be an async iterable that can be consumed using the for await...of syntax.

Here's an example of one such pagination call:

import { VelocityMailClient } from "velocitymail";

const velocityMailClient = new VelocityMailClient({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await velocityMailClient.messages.search({
    inboxId: "9fe0c27f-f907-4a9d-b5d5-74c62e233766",
    q: "verification code",
    from: "[email protected]",
    to: "[email protected]",
    subject: "Confirm your order",
    matchMode: "exact",
    receivedAfter: new Date("2026-05-23T12:00:00.000Z"),
    receivedBefore: new Date("2026-05-24T12:00:00.000Z"),
    limit: 25,
  });

  for await (const page of result) {
    console.log(page);
  }
}

run();

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { VelocityMailClient } from "velocitymail";

const velocityMailClient = new VelocityMailClient({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await velocityMailClient.inboxes.list({
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { VelocityMailClient } from "velocitymail";

const velocityMailClient = new VelocityMailClient({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await velocityMailClient.inboxes.list();

  console.log(result);
}

run();

Error Handling

VelocityMailError is the base class for all HTTP error responses. It has the following properties:

| Property | Type | Description | | ------------------- | ---------- | --------------------------------------------------------------------------------------- | | error.message | string | Error message | | error.statusCode | number | HTTP response status code eg 404 | | error.headers | Headers | HTTP response headers | | error.body | string | HTTP body. Can be empty string if no body is returned. | | error.rawResponse | Response | Raw HTTP response | | error.data$ | | Optional. Some errors may contain structured data. See Error Classes. |

Example

import { VelocityMailClient } from "velocitymail";
import * as errors from "velocitymail/models/errors";

const velocityMailClient = new VelocityMailClient({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  try {
    const result = await velocityMailClient.inboxes.list();

    console.log(result);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.VelocityMailError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);

      // Depending on the method different errors may be thrown
      if (error instanceof errors.ApiError) {
        console.log(error.data$.error); // errors.ErrorT
      }
    }
  }
}

run();

Error Classes

Primary errors:

• VelocityMailError: The base class for HTTP error responses.
  • ApiError: Generic error.

Network errors:

• ConnectionError: HTTP client was unable to make a request to a server.
• RequestTimeoutError: HTTP request timed out due to an AbortSignal signal.
• RequestAbortedError: HTTP request was aborted by the client.
• InvalidRequestError: Any input used to create a request is invalid.
• UnexpectedClientError: Unrecognised or unexpected error.

Inherit from VelocityMailError:

• ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.