update_pop
Configure POP email retrieval settings to control which messages are accessible and what happens to them after fetching.
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:929-941 (registration)Registration of the 'update_pop' MCP tool. Defines the input schema using Zod and the handler function which uses handleTool to call 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:935-940 (handler)The handler function for the 'update_pop' tool. It invokes the shared handleTool utility, which authenticates and executes the Gmail API call to update POP settings, then formats 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:931-934 (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:50-80 (helper)Shared helper function handleTool used by all tools including update_pop. Handles OAuth2 authentication, client creation, API call execution, error handling (especially auth errors), and response formatting.
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}` }); } }