batch_delete_messages
Remove multiple Gmail messages at once by specifying their IDs. Streamline email management with bulk deletion to keep your inbox organized.
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:534-545 (registration)Registration of the 'batch_delete_messages' tool, including schema (ids array of strings) and handler function that uses Gmail API's users.messages.batchDelete to permanently delete multiple messages by their IDs.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:539-544 (handler)The handler function for batch_delete_messages, which invokes the shared handleTool wrapper to authenticate and call the Gmail 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:536-538 (schema)Input schema for batch_delete_messages tool using Zod: requires 'ids' as array of message ID strings.{ ids: z.array(z.string()).describe("The IDs of the messages to delete") },
- src/index.ts:50-80 (helper)Shared helper function handleTool used by all Gmail tools, including batch_delete_messages, for OAuth authentication, client creation, and 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) { // Check for specific authentication errors if ( error.message?.includes("invalid_grant") || error.message?.includes("refresh_token") || error.message?.includes("invalid_client") || error.message?.includes("unauthorized_client") || error.code === 401 || error.code === 403 ) { return formatResponse({ error: `Authentication failed: ${error.message}. Please re-authenticate by running: npx @shinzolabs/gmail-mcp auth`, }); } return formatResponse({ error: `Tool execution failed: ${error.message}` }); } }
- src/index.ts:48-48 (helper)Helper function to format tool responses as MCP content objects with JSON stringified data.const formatResponse = (response: any) => ({ content: [{ type: "text", text: JSON.stringify(response) }] })