Overview - Corsair

Use Gmail through Corsair: one client, typed API calls, local DB sync, and incoming webhooks. What you get:

25 typed API operations
4 synced entities (drafts, labels, messages, threads) for fast .search() / .list()
1 incoming webhook event types

Setup

Install

npm install corsair @corsair-dev/gmail

yarn add corsair @corsair-dev/gmail

pnpm install corsair @corsair-dev/gmail

bun add corsair @corsair-dev/gmail

Add the plugin

corsair.ts

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

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

Multi-tenancy is the default — scope calls with corsair.withTenant(id). See Quick start for KEK + Hub keys, and Multi-tenancy for account isolation.

Choose authentication

OAuth 2.0 (Recommended)

Open hub.corsair.dev, navigate to your project, and enter the client ID and client secret from your Gmail OAuth app.Provider walkthrough: Get Credentials.

gmail()

More: OAuth 2.0

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: 'gmail',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl

Example API calls

List messages

const tenant = corsair.withTenant('acme');
await tenant.gmail.api.messages.list({});

Send an email

const tenant = corsair.withTenant('acme');
await tenant.gmail.api.messages.send({ raw: 'RnJvbTogbWVAZXhhbXBsZS5jb20NClRvOiB0ZWFtbWF0ZUBleGFtcGxlLmNvbQ0KU3ViamVjdDogSGVsbG8gZnJvbSBDb3JzYWlyDQpDb250ZW50LVR5cGU6IHRleHQvcGxhaW47IGNoYXJzZXQ9dXRmLTgNCg0KSGVsbG8gZnJvbSBDb3JzYWly' });

See the full list on the API page.

Query synced data

Search synced messages without hitting Gmail.

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

Synced entities: drafts, labels, messages, threads. See Database for filters and operators.

Webhooks

Fires when a Gmail message is received, deleted, or has its labels changed.

gmail({
    webhookHooks: {
        messageChanged: {
            after: async (ctx, result) => {
                console.log('Gmail event:', result.data);
            }
        },
    },
})

Mount your framework handler once (see Frameworks), then point the provider at that URL. Full event list: Webhooks. Concepts: Webhooks, Hooks.

What’s next

API reference

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

Database

Synced entities, search filters, and operators.

Webhooks

Event paths, payloads, and webhookHooks examples.

Connect / OAuth

createLink, Hub delivery, and tenant connect flows.

Use with agents

Expose this plugin’s operations as MCP tools.

Get credentials

Provider-console walkthrough for keys and OAuth apps.

​Setup

​Example API calls

​Query synced data

​Webhooks

​What’s next

API reference

Database

Webhooks

Connect / OAuth

Use with agents

Get credentials

Setup

Example API calls

Query synced data

Webhooks

What’s next