Benchmark Email plugin

Use Benchmark Email through Corsair: one client, typed API calls, local DB sync. What you get:

298 typed API operations
3 synced entities (campaigns, contactLists, contacts) for fast .search() / .list()

Setup

Install

npm install corsair @corsair-dev/benchmarkemail better-sqlite3
npm install --save-dev @types/better-sqlite3

yarn add corsair @corsair-dev/benchmarkemail better-sqlite3
yarn add --dev @types/better-sqlite3

pnpm install corsair @corsair-dev/benchmarkemail better-sqlite3
pnpm install --save-dev @types/better-sqlite3

bun add corsair @corsair-dev/benchmarkemail better-sqlite3
bun add --dev @types/better-sqlite3

Add the plugin

corsair.ts

import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { benchmarkemail } from '@corsair-dev/benchmarkemail';

export const corsair = createCorsair({
	plugins: [
		benchmarkemail(),
	],
	database: new Database('corsair.db'),
	kek: process.env.CORSAIR_KEK!,
	multiTenancy: true,
	hub: {
		projectApiKey: process.env.CORSAIR_API_KEY!,
		signingSecret: process.env.CORSAIR_SIGNING_SECRET!,
	},
});

With multiTenancy: true, scope calls with corsair.withTenant(id). See Quick start for KEK + Hub keys, and Multi-tenancy for account isolation.

Choose authentication

API Key (Recommended)

Store the Benchmark Email API key before the first call: pnpm corsair setup --plugin=benchmarkemail --tenant=acme api_key=<your-key> (leave out --tenant without multiTenancy), or pass it as key in the plugin options. With Hub, each tenant enters their own key on the connect page. See API key auth.

benchmarkemail()

More: API Key

Connect a tenant

Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see Connect / OAuth.

const { connectUrl } = await corsair.manage.connect.createLink({
	plugin: 'benchmarkemail',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl

Example API calls

List contact lists

const tenant = corsair.withTenant('acme');
await tenant.benchmarkemail.api.lists.getContactLists({});

Find a contact by email

const tenant = corsair.withTenant('acme');
await tenant.benchmarkemail.api.contacts.searchContactDetailsByEmail({ search: 'you@example.com' });

See the full list on the API page.

Query synced data

These tables exist, but Benchmark Email calls don’t fill them yet. This returns only rows you have written yourself.

const tenant = corsair.withTenant('acme');
const rows = await tenant.benchmarkemail.db.contacts.search({
	data: {},
	limit: 50,
});

Synced entities: campaigns, contactLists, contacts. See Database for filters and operators.

What’s next

API reference

Every benchmarkemail.api.* operation with input and output types.

Database

Synced entities, search filters, and operators.

Connect / OAuth

createLink, Hub delivery, and tenant connect flows.

Use with agents

Expose this plugin’s operations as MCP tools.

Overview

Plugins