update_pop
Configure POP email settings to control which messages are accessible and what happens to them after retrieval, including setting access windows and message disposition actions.
Instructions
Updates POP settings
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| accessWindow | Yes | The range of messages which are accessible via POP | |
| disposition | Yes | The action that will be executed on a message after it has been fetched via POP |
Implementation Reference
- src/index.ts:896-908 (registration)Registration of the MCP tool 'update_pop', including description, Zod input schema for accessWindow and disposition parameters, and inline handler function. The handler uses the shared handleTool utility to handle OAuth2 authentication and calls the Gmail API method gmail.users.settings.updatePop to update POP settings.server.tool("update_pop", "Updates POP settings", { accessWindow: z.enum(['disabled', 'allMail', 'fromNowOn']).describe("The range of messages which are accessible via POP"), disposition: z.enum(['archive', 'trash', 'leaveInInbox']).describe("The action that will be executed on a message after it has been fetched via POP") }, async (params) => { return handleTool(config, async (gmail: gmail_v1.Gmail) => { const { data } = await gmail.users.settings.updatePop({ userId: 'me', requestBody: params }) return formatResponse(data) }) } )
- src/index.ts:902-907 (handler)The handler function for the 'update_pop' tool, which invokes handleTool for authentication and executes the Gmail API call to update POP settings, formatting the response.async (params) => { return handleTool(config, async (gmail: gmail_v1.Gmail) => { const { data } = await gmail.users.settings.updatePop({ userId: 'me', requestBody: params }) return formatResponse(data) }) }
- src/index.ts:898-901 (schema)Zod schema defining the input parameters for the 'update_pop' tool: accessWindow (enum: disabled, allMail, fromNowOn) and disposition (enum: archive, trash, leaveInInbox).{ accessWindow: z.enum(['disabled', 'allMail', 'fromNowOn']).describe("The range of messages which are accessible via POP"), disposition: z.enum(['archive', 'trash', 'leaveInInbox']).describe("The action that will be executed on a message after it has been fetched via POP") },
- src/index.ts:49-65 (helper)Shared helper function 'handleTool' used by 'update_pop' and other tools for OAuth2 client creation, credential validation, Gmail client initialization, and executing the provided API call 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}` } }