update_imap
Configure IMAP access for your Gmail account by enabling or disabling the protocol, setting message deletion behavior, and managing folder size limits.
Instructions
Updates IMAP settings
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| enabled | Yes | Whether IMAP is enabled for the account | |
| expungeBehavior | No | The action that will be executed on a message when it is marked as deleted and expunged from the last visible IMAP folder | |
| maxFolderSize | No | An optional limit on the number of messages that can be accessed through IMAP |
Implementation Reference
- src/index.ts:868-881 (registration)Registration of the update_imap MCP tool, including description, input schema (enabled, expungeBehavior, maxFolderSize), and inline handler that uses handleTool to update IMAP settings via Gmail API.server.tool("update_imap", "Updates IMAP settings", { enabled: z.boolean().describe("Whether IMAP is enabled for the account"), expungeBehavior: z.enum(['archive', 'trash', 'deleteForever']).optional().describe("The action that will be executed on a message when it is marked as deleted and expunged from the last visible IMAP folder"), maxFolderSize: z.number().optional().describe("An optional limit on the number of messages that can be accessed through IMAP") }, async (params) => { return handleTool(config, async (gmail: gmail_v1.Gmail) => { const { data } = await gmail.users.settings.updateImap({ userId: 'me', requestBody: params }) return formatResponse(data) }) } )
- src/index.ts:875-880 (handler)Handler function executing the core logic: authenticates via handleTool, calls Gmail API users.settings.updateImap with input params, formats response.async (params) => { return handleTool(config, async (gmail: gmail_v1.Gmail) => { const { data } = await gmail.users.settings.updateImap({ userId: 'me', requestBody: params }) return formatResponse(data) }) }
- src/index.ts:870-874 (schema)Zod schema defining input parameters for update_imap tool.{ enabled: z.boolean().describe("Whether IMAP is enabled for the account"), expungeBehavior: z.enum(['archive', 'trash', 'deleteForever']).optional().describe("The action that will be executed on a message when it is marked as deleted and expunged from the last visible IMAP folder"), maxFolderSize: z.number().optional().describe("An optional limit on the number of messages that can be accessed through IMAP") },
- src/index.ts:49-65 (helper)Shared helper function handleTool used by all tools, including update_imap, for OAuth2 authentication, Gmail 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) { return `Tool execution failed: ${error.message}` } }