Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.
Mirrored from https://github.com/Camo67/composio.git
Synced Nov 21, 06:00 UTC
| 1 | --- |
| 2 | type: "reference" |
| 3 | title: "Gmail" |
| 4 | description: "Public support knowledge for Gmail." |
| 5 | category: "auth-config" |
| 6 | visibility: "public" |
| 7 | timestamp: "2026-07-14T00:00:00Z" |
| 8 | tags: |
| 9 | - "gmail" |
| 10 | --- |
| 11 | # Gmail |
| 12 | |
| 13 | ## Use `latest` or v3.1 for newer Gmail settings tools |
| 14 | |
| 15 | The v3 execute endpoint can default to base toolkit version `00000000_00` when no version is specified. For newer Gmail tools like `GMAIL_PATCH_SEND_AS`, `GMAIL_LIST_SEND_AS`, and `GMAIL_GET_VACATION_SETTINGS`, pass `version: "latest"` in the execute body or use the v3.1 endpoint, which defaults to latest. |
| 16 | |
| 17 | ## Create Gmail custom OAuth auth config, then initiate a connection with callback URL |
| 18 | |
| 19 | Create the Gmail auth config first with the custom OAuth credentials, then initiate a connected account using that auth config. The callback URL is supplied during connection initiation, while the OAuth client ID/secret and redirect URI live on the auth config. |
| 20 | |
| 21 | ## Creating Gmail filters requires `gmail.settings.basic` |
| 22 | |
| 23 | Gmail filter creation maps to the Gmail API `users.settings.filters.create` endpoint: `POST /gmail/v1/users/{userId}/settings/filters`. Google lists `https://www.googleapis.com/auth/gmail.settings.basic` as the required OAuth scope for this endpoint, and the current Composio `GMAIL_CREATE_FILTER` action declares the same single required scope. |
| 24 | |
| 25 | Google must approve this scope for the OAuth app used by the connection. If the consent screen blocks an unverified scope, use an OAuth app that is verified for `gmail.settings.basic` and reconnect. |
| 26 | |
| 27 | ## `gmail.send` is granular but sensitive; `mail.google.com` gives full access |
| 28 | |
| 29 | `https://www.googleapis.com/auth/gmail.send` can send messages, but it is a granular sensitive scope and requires Google verification. The broader `https://mail.google.com/` scope gives full mailbox access and can cover send use cases, but it is broader than many customers want. |
| 30 | |
| 31 | ## Configure Gmail scopes on managed auth config as a comma-joined scopes string |
| 32 | |
| 33 | When creating the Gmail auth config, pass the desired Gmail scopes in `credentials.scopes`, typically as a comma-joined string. Example scopes include `gmail.send`, `gmail.readonly`, `gmail.compose`, `gmail.modify`, and `gmail.labels`. |
| 34 | |
| 35 | ## Avoid `gmail.metadata` when fetching full Gmail email content |
| 36 | |
| 37 | The Gmail metadata scope cannot be used when requesting full email content. Remove `https://www.googleapis.com/auth/gmail.metadata` and use a scope that allows message content access, such as `https://mail.google.com/`, when full payload/body data is needed. |
| 38 | |
| 39 | ## Use `me` for Gmail `user_id` in tool calls |
| 40 | |
| 41 | For Gmail tool calls, `me` can be used as the `user_id` to refer to the authenticated connected account. |
| 42 | |
| 43 | ## `GMAIL_SEND_EMAIL` accepts at least one of `to`, `cc`, or `bcc` |
| 44 | |
| 45 | `GMAIL_SEND_EMAIL` no longer needs a single required recipient field. At least one recipient channel such as `to` / `recipient_email`, `cc`, or `bcc` can be supplied, which keeps the tool flexible for different email composition flows. |
| 46 | |
| 47 | For hosted MCP / Tool Router calls through `COMPOSIO_MULTI_EXECUTE_TOOL`, put recipient fields inside the nested tool `arguments` object. Prefer `recipient_email` for the first To recipient and `extra_recipients` for additional To recipients unless the current schema explicitly exposes another shape. |
| 48 | |
| 49 | If the connection is active but the action returns `At least one of 'to' (or 'recipient_email'), 'cc', or 'bcc' must be provided`, the tool did not receive a recipient channel and failed before Gmail API execution. Retry with the exact nested `recipient_email` shape; if it still fails, provide a fresh request ID for investigation. |
| 50 | |
| 51 | ## For Gmail attachments over MCP, upload files before tool execution |
| 52 | |
| 53 | Temporary S3/file instances are short-lived. Use `files.upload` before tool execution via the SDK or MCP flow, then pass the resulting `FileUploadable`/uploaded file object to the agent/tool call. |
| 54 | |
| 55 | ## Gmail attachment sends can outlast a client timeout; verify before retrying |
| 56 | |
| 57 | `GMAIL_SEND_EMAIL` accepts attachments as uploaded Composio file references, not signed URLs or JSON strings. The action downloads the uploaded file, builds the MIME message, base64-url encodes it, and posts it to Gmail. Attachment sends can therefore take materially longer than small text-only sends. |
| 58 | |
| 59 | Current Python and TypeScript SDKs do not automatically retry non-idempotent tool executions. However, a client timeout can still occur after Gmail accepted the message. If a customer reports `GMAIL_SEND_EMAIL` hanging or duplicate sends with attachments: |
| 60 | |
| 61 | - If the log is a fast 400 validation error, verify the `attachment` argument is an object/list with `name`, `mimetype`, and `s3key`. |
| 62 | - If the client timed out, inspect the Composio execution log or Gmail Sent folder before retrying manually. |
| 63 | - If the client is older than Python SDK 0.16.0 or TypeScript SDK 0.14.0, upgrade before investigating SDK-level automatic retries. |
| 64 | |
| 65 | ## Reduce Gmail fetch payload size with `include_payload=false`, `verbose=false`, `only_ids`, query, and limits |
| 66 | |
| 67 | For Gmail fetch/list flows, reduce payload by setting `include_payload=false` and `verbose=false` where supported. For very lightweight flows, use `only_ids=true` and then fetch selected messages separately. Also use `max_results` and Gmail `query` filters to keep result sets small. |
| 68 | |
| 69 | ## Use `from_email` to select Gmail send-as alias |
| 70 | |
| 71 | Use the `from_email` parameter on `GMAIL_SEND_EMAIL` to choose the Gmail send-as alias. |
| 72 | |
| 73 | ## Use Gmail label IDs, not label names, for label operations |
| 74 | |
| 75 | For Gmail label operations and trigger label filters that require IDs, pass the label ID rather than the display name. Use `GMAIL_LIST_LABELS` to retrieve IDs. |
| 76 | |
| 77 | ## Patch Gmail label colors with `background_color` and accepted color values |
| 78 | |
| 79 | To patch a label color, use the label ID and pass background color as an object field such as `{ "background_color": "#FFFF0000" }`. Gmail only accepts specific label color values from the Gmail API reference. |
| 80 | |
| 81 | ## Filter Gmail new-message trigger by label/query instead of label IDs |
| 82 | |
| 83 | For Gmail new-message trigger setup, use a Gmail query such as `label:sent OR label:category_personal` to filter matching messages. This avoids depending on label IDs for that trigger path. |
| 84 | |
| 85 | ## Use `googlesuper` for one Google auth across Gmail, Calendar, Drive-style use cases |
| 86 | |
| 87 | Google Super owns the canonical multi-service authentication guidance. See [Google Super is a unified Google Workspace toolkit](../googlesuper/public.md#google-super-is-a-unified-google-workspace-toolkit). |