batch_modify_messages
Modify labels on multiple Gmail messages simultaneously to organize your inbox efficiently. Add or remove labels from selected messages in bulk.
Instructions
Modify the labels on multiple messages
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ids | Yes | The IDs of the messages to modify | |
| addLabelIds | No | A list of label IDs to add to the messages | |
| removeLabelIds | No | A list of label IDs to remove from the messages |
Implementation Reference
- src/index.ts:540-545 (handler)Handler function for the 'batch_modify_messages' tool. It uses handleTool to execute the Gmail API call to batchModify messages with specified label additions/removals.async (params) => { return handleTool(config, async (gmail: gmail_v1.Gmail) => { const { data } = await gmail.users.messages.batchModify({ userId: 'me', requestBody: { ids: params.ids, addLabelIds: params.addLabelIds, removeLabelIds: params.removeLabelIds } }) return formatResponse(data) }) }
- src/index.ts:536-539 (schema)Zod schema defining input parameters for the batch_modify_messages tool: ids (required array of strings), addLabelIds and removeLabelIds (optional arrays).ids: z.array(z.string()).describe("The IDs of the messages to modify"), addLabelIds: z.array(z.string()).optional().describe("A list of label IDs to add to the messages"), removeLabelIds: z.array(z.string()).optional().describe("A list of label IDs to remove from the messages") },
- src/index.ts:533-546 (registration)Registration of the 'batch_modify_messages' tool on the MCP server, including name, description, input schema, and handler function.server.tool("batch_modify_messages", "Modify the labels on multiple messages", { ids: z.array(z.string()).describe("The IDs of the messages to modify"), addLabelIds: z.array(z.string()).optional().describe("A list of label IDs to add to the messages"), removeLabelIds: z.array(z.string()).optional().describe("A list of label IDs to remove from the messages") }, async (params) => { return handleTool(config, async (gmail: gmail_v1.Gmail) => { const { data } = await gmail.users.messages.batchModify({ userId: 'me', requestBody: { ids: params.ids, addLabelIds: params.addLabelIds, removeLabelIds: params.removeLabelIds } }) return formatResponse(data) }) } )
- src/index.ts:50-66 (helper)Shared helper function used by batch_modify_messages (and other tools) to handle OAuth2 authentication, client creation, and execution of Gmail API calls.const handleTool = async (queryConfig: Record<string, any> | undefined, apiCall: (gmail: gmail_v1.Gmail) => Promise<any>) => { try { const oauth2Client = queryConfig ? createOAuth2Client(queryConfig) : defaultOAuth2Client if (!oauth2Client) throw new Error('OAuth2 client could not be created, please check your credentials') const credentialsAreValid = await validateCredentials(oauth2Client) if (!credentialsAreValid) throw new Error('OAuth2 credentials are invalid, please re-authenticate') const gmailClient = queryConfig ? google.gmail({ version: 'v1', auth: oauth2Client }) : defaultGmailClient if (!gmailClient) throw new Error('Gmail client could not be created, please check your credentials') const result = await apiCall(gmailClient) return result } catch (error: any) { return `Tool execution failed: ${error.message}` } }