Skip to content

Add Gmail adapter documentation#250

Draft
maximelb wants to merge 3 commits into
masterfrom
docs/gmail-adapter
Draft

Add Gmail adapter documentation#250
maximelb wants to merge 3 commits into
masterfrom
docs/gmail-adapter

Conversation

@maximelb
Copy link
Copy Markdown
Contributor

@maximelb maximelb commented Jun 3, 2026

Summary

Adds a documentation page for the new Gmail USP adapter (paired with refractionPOINT/usp-adapters#287).

The page covers:

  • Overview of the adapter and the opt-in capabilities, with a table mapping each collect_* flag to its event type(s) and its BEC (Business Email Compromise) relevance — message telemetry plus filters, forwarding, send-as, delegates, IMAP/POP, vacation responder, and mailbox history.
  • Granting Access — a step-by-step guide for both authentication modes:
    • OAuth 2.0 refresh token (single mailbox): enable the Gmail API, configure the consent screen, create an OAuth client, and obtain a refresh token via the OAuth Playground.
    • Service account + domain-wide delegation (Google Workspace): create the service account/key and authorize its client id for the gmail.readonly scope in the Admin console. Required for collect_delegates.
    • A least-privilege note on gmail.readonly vs gmail.metadata.
  • Deployment Configurationsclient_options, adapter-specific auth options, and full capability-toggle / collection-knob tables.
  • CLI and Infrastructure-as-Code deployment examples.
  • How it works and Error handling summaries.

Added to the Collaboration adapters group in the nav, right after Google Workspace.

No PII: all identifiers in examples are placeholders (mailbox@yourdomain.com, xxxxxxxx-..., YOUR_LC_INSTALLATION_KEY_GMAIL).

🤖 Generated with Claude Code

maximelb and others added 3 commits June 3, 2026 12:40
Documents the Gmail USP adapter: incoming-email telemetry plus the
opt-in BEC capabilities (filters, forwarding, send-as, delegates,
imap/pop, vacation, history). Includes a step-by-step access-granting
guide for both auth modes (OAuth refresh token, and service account
with domain-wide delegation), config tables, and CLI/IaC deployment
examples. Adds the page to the Collaboration adapters nav.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
markdownlint MD036 flagged the bold "Step N — ..." pseudo-headings;
convert them to #### headings.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant