batch_modify_messages
Add or remove labels from multiple Gmail messages simultaneously to organize your inbox efficiently.
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:533-546 (registration)Registration of the 'batch_modify_messages' tool, including input schema (Zod validation for ids, addLabelIds, removeLabelIds) and handler function that authenticates via handleTool and calls Gmail API users.messages.batchModify to modify labels on multiple messages.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:540-546 (handler)Handler function for batch_modify_messages tool: invokes handleTool for OAuth2 authentication and Gmail client creation, then executes gmail.users.messages.batchModify with provided ids, addLabelIds, and removeLabelIds, formats and returns the API response.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:535-539 (schema)Input schema (Zod) for batch_modify_messages tool defining required 'ids' array and optional 'addLabelIds'/'removeLabelIds' arrays for label modifications.{ 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:50-66 (helper)Shared helper function 'handleTool' used by batch_modify_messages (and other tools) to handle OAuth2 authentication, Gmail client creation, and API call execution with error handling.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}` } }