batch_delete_messages
Delete multiple Gmail messages simultaneously by specifying their IDs to manage inbox clutter efficiently.
Instructions
Delete multiple messages
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ids | Yes | The IDs of the messages to delete |
Implementation Reference
- src/index.ts:520-531 (registration)Tool registration for 'batch_delete_messages', including input schema (array of message IDs) and handler that performs batch deletion via Gmail API using shared handleTool.server.tool("batch_delete_messages", "Delete multiple messages", { ids: z.array(z.string()).describe("The IDs of the messages to delete") }, async (params) => { return handleTool(config, async (gmail: gmail_v1.Gmail) => { const { data } = await gmail.users.messages.batchDelete({ userId: 'me', requestBody: { ids: params.ids } }) return formatResponse(data) }) } )
- src/index.ts:525-531 (handler)Handler function executes the batch deletion of messages by IDs using Gmail's batchDelete API.async (params) => { return handleTool(config, async (gmail: gmail_v1.Gmail) => { const { data } = await gmail.users.messages.batchDelete({ userId: 'me', requestBody: { ids: params.ids } }) return formatResponse(data) }) } )
- src/index.ts:522-524 (schema)Input schema defines 'ids' as an array of strings representing message IDs to delete.{ ids: z.array(z.string()).describe("The IDs of the messages to delete") },
- src/index.ts:50-66 (helper)Shared helper function handleTool that manages OAuth2 authentication, client creation, and executes the Gmail API call.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}` } }