# Gmail

```json
{
  "name": "Gmail",
  "slug": "gmail",
  "url": "https://composio.dev/toolkits/gmail",
  "markdown_url": "https://composio.dev/toolkits/gmail.md",
  "logo_url": "https://logos.composio.dev/api/gmail",
  "categories": [
    "collaboration & communication"
  ],
  "is_composio_managed": true,
  "updated_at": "2026-05-06T08:13:39.350Z"
}
```

![Gmail logo](https://logos.composio.dev/api/gmail)

## Description

Securely connect your AI agents and chatbots (Claude, ChatGPT, Cursor, etc) with Gmail MCP or direct API to read, send, search, and label emails through natural language.

## Summary

Gmail is Google's email service with powerful spam protection, search, and G Suite integration.
It keeps your inbox organized and makes communication fast and reliable.

## Categories

- collaboration & communication

## Toolkit Details

- Tools: 23
- Triggers: 2
- Managed auth: Managed by Composio

## Images

- Logo: https://logos.composio.dev/api/gmail

## Authentication

- **Oauth2**
  - Type: `oauth2`
  - Description: Oauth2 authentication for Gmail.
  - Setup:
    - Configure Oauth2 credentials for Gmail.
    - Use the credentials when creating an auth config in Composio.

## Suggested Prompts

- Summarize unread emails from this morning
- Create draft replies to urgent messages
- Fetch contact details for recent senders
- Add 'Follow Up' label to flagged emails

## Supported Tools

| Tool slug | Name | Description |
|---|---|---|
| `GMAIL_ADD_LABEL_TO_EMAIL` | Modify email labels | Adds and/or removes specified gmail labels for a message; ensure `message id` and all `label ids` are valid (use 'listlabels' for custom label ids). |
| `GMAIL_CREATE_EMAIL_DRAFT` | Create email draft | Creates a gmail email draft, supporting to/cc/bcc, subject, plain/html body (ensure `is html=true` for html), attachments, and threading. |
| `GMAIL_CREATE_LABEL` | Create label | Creates a new label with a unique name in the specified user's gmail account. |
| `GMAIL_DELETE_DRAFT` | Delete Draft | Permanently deletes a specific gmail draft using its id; ensure the draft exists and the user has necessary permissions for the given `user id`. |
| `GMAIL_DELETE_MESSAGE` | Delete message | Permanently deletes a specific email message by its id from a gmail mailbox; for `user id`, use 'me' for the authenticated user or an email address to which the authenticated user has delegated access. |
| `GMAIL_FETCH_EMAILS` | Fetch emails | Fetches a list of email messages from a gmail account, supporting filtering, pagination, and optional full content retrieval. |
| `GMAIL_FETCH_MESSAGE_BY_MESSAGE_ID` | Fetch message by message ID | Fetches a specific email message by its id, provided the `message id` exists and is accessible to the authenticated `user id`. |
| `GMAIL_FETCH_MESSAGE_BY_THREAD_ID` | Fetch Message by Thread ID | Retrieves messages from a gmail thread using its `thread id`, where the thread must be accessible by the specified `user id`. |
| `GMAIL_GET_ATTACHMENT` | Get Gmail attachment | Retrieves a specific attachment by id from a message in a user's gmail mailbox, requiring valid message and attachment ids. |
| `GMAIL_GET_CONTACTS` | Get contacts | Fetches contacts (connections) for the authenticated google account, allowing selection of specific data fields and pagination. |
| `GMAIL_GET_PEOPLE` | Get People | Retrieves either a specific person's details (using `resource name`) or lists 'other contacts' (if `other contacts` is true), with `person fields` specifying the data to return. |
| `GMAIL_GET_PROFILE` | Get Profile | Retrieves key gmail profile information (email address, message/thread totals, history id) for a user. |
| `GMAIL_LIST_DRAFTS` | List drafts | Retrieves a paginated list of email drafts from a user's gmail account. use verbose=true to get full draft details including subject, body, sender, and timestamp. |
| `GMAIL_LIST_LABELS` | List Gmail labels | Retrieves a list of all system and user-created labels for the specified gmail account. |
| `GMAIL_LIST_THREADS` | List threads | Retrieves a list of email threads from a gmail account, identified by `user id` (email address or 'me'), supporting filtering and pagination. |
| `GMAIL_MODIFY_THREAD_LABELS` | Modify thread labels | Adds or removes specified existing label ids from a gmail thread, affecting all its messages; ensure the thread id is valid. |
| `GMAIL_MOVE_TO_TRASH` | Move to Trash | Moves an existing, non-deleted email message to the trash for the specified user. |
| `GMAIL_PATCH_LABEL` | Patch Label | Patches the specified label. |
| `GMAIL_REMOVE_LABEL` | Remove label | Permanently deletes a specific, existing user-created gmail label by its id for a user; cannot delete system labels. |
| `GMAIL_REPLY_TO_THREAD` | Reply to email thread | Sends a reply within a specific gmail thread using the original thread's subject, requiring a valid `thread id` and correctly formatted email addresses. supports attachments via the `attachment` parameter with valid `s3key`, `mimetype`, and `name`. |
| `GMAIL_SEARCH_PEOPLE` | Search People | Searches contacts by matching the query against names, nicknames, emails, phone numbers, and organizations, optionally including 'other contacts'. |
| `GMAIL_SEND_DRAFT` | Send Draft | Sends the specified, existing draft to the recipients in the to, cc, and bcc headers. |
| `GMAIL_SEND_EMAIL` | Send Email | Sends an email via gmail api using the authenticated user's google profile display name, requiring `is html=true` if the body contains html and valid `s3key`, `mimetype`, `name` for any attachment. |

## Supported Triggers

| Trigger slug | Name | Description |
|---|---|---|
| `GMAIL_EMAIL_SENT_TRIGGER` | Email Sent | Triggers when a Gmail message is sent by the authenticated user. It polls the 'SENT' label and emits metadata including sender, recipients, subject, timestamp, and thread ID. |
| `GMAIL_NEW_GMAIL_MESSAGE` | New Gmail Message Received Trigger | Triggers when a new message is received in Gmail. |

## Installation and MCP Setup

### Path 1: SDK Installation

#### Path 1, Step 1: Install Composio

Install the Composio SDK
```python
pip install composio_openai
```

```typescript
npm install @composio/openai
```

#### Path 1, Step 2: Initialize Composio and Create Tool Router Session

Import and initialize Composio client, then create a Tool Router session
```python
from openai import OpenAI
from composio import Composio
from composio_openai import OpenAIResponsesProvider

composio = Composio(provider=OpenAIResponsesProvider())
openai = OpenAI()
session = composio.create(user_id='your-user-id')
```

```typescript
import OpenAI from 'openai';
import { Composio } from '@composio/core';
import { OpenAIResponsesProvider } from '@composio/openai';

const composio = new Composio({
  provider: new OpenAIResponsesProvider(),
});
const openai = new OpenAI({});
const session = await composio.create('your-user-id');
```

#### Path 1, Step 3: Execute Gmail Tools via Tool Router with Your Agent

Get tools from Tool Router session and execute Gmail actions with your Agent
```python
tools = session.tools
response = openai.responses.create(
  model='gpt-4.1',
  tools=tools,
  input=[{
    'role': 'user',
    'content': 'Summarize unread emails from this morning'
  }]
)
result = composio.provider.handle_tool_calls(
  response=response,
  user_id='your-user-id'
)
print(result)
```

```typescript
const tools = session.tools;
const response = await openai.responses.create({
  model: 'gpt-4.1',
  tools: tools,
  input: [{
    role: 'user',
    content: 'Summarize unread emails from this morning'
  }],
});
const result = await composio.provider.handleToolCalls(
  'your-user-id',
  response.output
);
console.log(result);
```

### Path 2: MCP Server Setup

#### Path 2, Step 1: Install Composio

Install the Composio SDK and Claude Agent SDK
```python
pip install composio claude-agent-sdk
```

```typescript
npm install @composio/core ai @ai-sdk/openai @ai-sdk/mcp
```

#### Path 2, Step 2: Create Tool Router Session

Initialize the Composio client and create a Tool Router session
```python
from composio import Composio
from claude_agent_sdk import ClaudeSDKClient, ClaudeAgentOptions

composio = Composio(api_key='your-composio-api-key')
session = composio.create(user_id='your-user-id')
url = session.mcp.url
```

```typescript
import { Composio } from '@composio/core';

const composio = new Composio({ apiKey: 'your-api-key' });

console.log("Creating Tool Router session...");
const { mcp } = await composio.create('your-user-id');
console.log(`Tool Router session created: ${mcp.url}`);
```

#### Path 2, Step 3: Connect to AI Agent

Use the MCP server with your AI agent
```python
import asyncio

options = ClaudeAgentOptions(
    permission_mode='bypassPermissions',
    mcp_servers={
        'tool_router': {
            'type': 'http',
            'url': url,
            'headers': {
                'x-api-key': 'your-composio-api-key'
            }
        }
    },
    system_prompt='You are a helpful assistant with access to Gmail tools.',
    max_turns=10
)

async def main():
    async with ClaudeSDKClient(options=options) as client:
        await client.query('Summarize unread emails from this morning')
        async for message in client.receive_response():
            if hasattr(message, 'content'):
                for block in message.content:
                    if hasattr(block, 'text'):
                        print(block.text)

asyncio.run(main())
```

```typescript
import { openai } from '@ai-sdk/openai';
import { experimental_createMCPClient as createMCPClient } from '@ai-sdk/mcp';
import { generateText, stepCountIs } from 'ai';

const client = await createMCPClient({
  transport: {
    type: 'http',
    url: mcp.url,
    headers: { 'x-api-key': 'your-composio-api-key' }
  }
});

const tools = await client.tools();

const { text } = await generateText({
  model: openai('gpt-4o'),
  tools,
  messages: [{ role: 'user', content: 'Summarize unread emails from this morning' }],
  stopWhen: stepCountIs( 5 )
});

console.log(`Agent: ${text}`);
```

## Why Use Composio?

### 1. AI Native Gmail Integration

- Supports both Gmail MCP and direct API based integrations
- Structured, LLM-friendly schemas for reliable tool execution
- Rich coverage for reading, writing, and querying your Gmail data

### 2. Managed Auth

- Built-in OAuth handling with automatic token refresh and rotation
- Central place to manage, scope, and revoke Gmail access
- Per user and per environment credentials instead of hard-coded keys

### 3. Agent Optimized Design

- Tools are tuned using real error and success rates to improve reliability over time
- Comprehensive execution logs so you always know what ran, when, and on whose behalf

### 4. Enterprise Grade Security

- Fine-grained RBAC so you control which agents and users can access Gmail
- Scoped, least privilege access to Gmail resources
- Full audit trail of agent actions to support review and compliance

## Use Gmail with any AI Agent Framework

Choose a framework you want to connect Gmail with:

- [ChatGPT](https://composio.dev/toolkits/gmail/framework/chatgpt)
- [OpenAI Agents SDK](https://composio.dev/toolkits/gmail/framework/open-ai-agents-sdk)
- [Claude Agent SDK](https://composio.dev/toolkits/gmail/framework/claude-agents-sdk)
- [Claude Code](https://composio.dev/toolkits/gmail/framework/claude-code)
- [Claude Cowork](https://composio.dev/toolkits/gmail/framework/claude-cowork)
- [Codex](https://composio.dev/toolkits/gmail/framework/codex)
- [Cursor](https://composio.dev/toolkits/gmail/framework/cursor)
- [VS Code](https://composio.dev/toolkits/gmail/framework/vscode)
- [OpenCode](https://composio.dev/toolkits/gmail/framework/opencode)
- [OpenClaw](https://composio.dev/toolkits/gmail/framework/openclaw)
- [Hermes](https://composio.dev/toolkits/gmail/framework/hermes-agent)
- [CLI](https://composio.dev/toolkits/gmail/framework/cli)
- [Google ADK](https://composio.dev/toolkits/gmail/framework/google-adk)
- [LangChain](https://composio.dev/toolkits/gmail/framework/langchain)
- [Vercel AI SDK](https://composio.dev/toolkits/gmail/framework/ai-sdk)
- [Mastra AI](https://composio.dev/toolkits/gmail/framework/mastra-ai)
- [LlamaIndex](https://composio.dev/toolkits/gmail/framework/llama-index)
- [CrewAI](https://composio.dev/toolkits/gmail/framework/crew-ai)
- [Pydantic AI](https://composio.dev/toolkits/gmail/framework/pydantic-ai)
- [AutoGen](https://composio.dev/toolkits/gmail/framework/autogen)

## Related Toolkits

- [Outlook](https://composio.dev/toolkits/outlook) - Outlook is Microsoft's email and calendaring platform for unified communications and scheduling. It helps users stay organized with powerful email, contacts, and calendar management.
- [Slack](https://composio.dev/toolkits/slack) - Slack is a channel-based messaging platform for teams and organizations. It helps people collaborate in real time, share files, and connect all their tools in one place.
- [Gong](https://composio.dev/toolkits/gong) - Gong is a platform for video meetings, call recording, and team collaboration. It helps teams capture conversations, analyze calls, and turn insights into action.
- [Microsoft teams](https://composio.dev/toolkits/microsoft_teams) - Microsoft Teams is a collaboration platform that combines chat, meetings, and file sharing within Microsoft 365. It keeps distributed teams connected and productive through seamless virtual communication.
- [Slackbot](https://composio.dev/toolkits/slackbot) - Slackbot is a conversational automation tool for Slack that handles reminders, notifications, and automated responses. It boosts team productivity by streamlining onboarding, answering FAQs, and managing timely alerts—all right inside Slack.
- [2chat](https://composio.dev/toolkits/_2chat) - 2chat is an API platform for WhatsApp and multichannel text messaging. It streamlines chat automation, group management, and real-time messaging for developers.
- [Agent mail](https://composio.dev/toolkits/agent_mail) - Agent mail provides AI agents with dedicated email inboxes for sending, receiving, and managing emails. It empowers agents to communicate autonomously with people, services, and other agents—no human intervention needed.
- [Basecamp](https://composio.dev/toolkits/basecamp) - Basecamp is a project management and team collaboration tool by 37signals. It helps teams organize tasks, share files, and communicate efficiently in one place.
- [Chatwork](https://composio.dev/toolkits/chatwork) - Chatwork is a team communication platform with group chats, file sharing, and task management. It helps businesses boost collaboration and streamline productivity.
- [Clickmeeting](https://composio.dev/toolkits/clickmeeting) - ClickMeeting is a cloud-based platform for running online meetings and webinars. It helps businesses and individuals host, manage, and engage virtual audiences with ease.
- [Confluence](https://composio.dev/toolkits/confluence) - Confluence is Atlassian's team collaboration and knowledge management platform. It helps your team organize, share, and update documents and project content in one secure workspace.
- [Dailybot](https://composio.dev/toolkits/dailybot) - DailyBot streamlines team collaboration with chat-based standups, reminders, and polls. It keeps work flowing smoothly in your favorite messaging platforms.
- [Dialmycalls](https://composio.dev/toolkits/dialmycalls) - Dialmycalls is a mass notification service for sending voice and text messages to contacts. It helps teams and organizations quickly broadcast urgent alerts and updates.
- [Dialpad](https://composio.dev/toolkits/dialpad) - Dialpad is a cloud-based business phone and contact center system for teams. It unifies voice, video, messaging, and meetings across your devices.
- [Discord](https://composio.dev/toolkits/discord) - Discord is a real-time messaging and VoIP platform for communities and teams. It lets users chat, share media, and collaborate across public and private channels.
- [Discordbot](https://composio.dev/toolkits/discordbot) - Discordbot is an automation tool for Discord servers that handles moderation, messaging, and user engagement. It helps communities run smoothly by automating routine and complex tasks.
- [Echtpost](https://composio.dev/toolkits/echtpost) - Echtpost is a secure digital communication platform for encrypted document and message exchange. It ensures confidential data stays private and protected during transmission.
- [Egnyte](https://composio.dev/toolkits/egnyte) - Egnyte is a cloud-based platform for secure file sharing, storage, and governance. It helps teams collaborate efficiently while maintaining data compliance and security.
- [Google Meet](https://composio.dev/toolkits/googlemeet) - Google Meet is a secure video conferencing platform for virtual meetings, chat, and screen sharing. It helps teams connect, collaborate, and communicate seamlessly from anywhere.
- [Heartbeat](https://composio.dev/toolkits/heartbeat) - Heartbeat is a plug-and-play platform for building and managing online communities. It helps you organize users, channels, events, and discussions in one place.

## Frequently Asked Questions

### Do I need my own developer credentials to use Gmail with Composio?

No, you can get started immediately using Composio's built-in Gmail app. For production, we recommend configuring your own OAuth credentials.

### Can I use multiple toolkits together?

Yes! Composio's Tool Router enables agents to use multiple toolkits. [Learn more](https://docs.composio.dev/tool-router/overview).

### Is Composio secure?

Composio is SOC 2 and ISO 27001 compliant with all data encrypted in transit and at rest. [Learn more](https://trust.composio.dev).

### What if the API changes?

Composio maintains and updates all toolkit integrations automatically, so your agents always work with the latest API versions.

---
[See all toolkits](https://composio.dev/toolkits) · [Composio docs](https://docs.composio.dev/llms.txt)