Gmail

Quick Start

Install the plugin:

pnpm install @corsair-dev/gmail

Add the Gmail plugin to your Corsair instance:

import { createCorsair } from "corsair";
import { gmail } from "@corsair-dev/gmail";

export const corsair = createCorsair({
    plugins: [
        gmail({
            authType: "oauth_2",
        }),
    ],
});

Once configured, you can access the Gmail API through your Corsair instance:

const messages = await corsair.gmail.api.messages.list({
    maxResults: 10,
});

Authentication

Supported Auth Types

The Gmail plugin uses OAuth 2.0 authentication exclusively.

• oauth_2 (default) - OAuth 2.0 authentication

OAuth 2.0 Setup

Store your OAuth app credentials, then start the flow:

pnpm corsair setup --gmail client_id=your-client-id client_secret=your-client-secret
pnpm corsair auth --plugin=gmail

The CLI will print an authorization URL — open it in a browser. Once you approve, tokens are saved automatically.

See Get Credentials for step-by-step instructions on setting up OAuth 2.0.

See Authentication for details on managing credentials.

Options

The Gmail plugin accepts the following configuration options:

For complete documentation on getting credentials, see the Plugin Credentials Guide.