update_imap
Configure IMAP access for Gmail accounts 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 input schema validation with Zod and the handler function that uses handleTool to authenticate and call the Gmail API to update IMAP settings.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:876-880 (handler)The handler function for the 'update_imap' tool, which invokes the shared handleTool utility to manage OAuth2 authentication and execute the Gmail users.settings.updateImap API call with the provided parameters.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)Input schema for the 'update_imap' tool defined using Zod, specifying parameters for enabling IMAP, expunge behavior, and maximum folder size.{ 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 'update_imap' (and other tools) to handle OAuth2 client creation, credential validation, Gmail client instantiation, 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}` } }