get_imap
Retrieve IMAP configuration settings for Gmail accounts to enable email client setup and server access.
Instructions
Gets IMAP settings
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/index.ts:842-851 (registration)Registration of the 'get_imap' tool, including inline handler function that fetches IMAP settings from Gmail API using the shared handleTool wrapper for authentication and error handling.
server.tool("get_imap", "Gets IMAP settings", {}, async () => { return handleTool(config, async (gmail: gmail_v1.Gmail) => { const { data } = await gmail.users.settings.getImap({ userId: 'me' }) return formatResponse(data) }) } ) - src/index.ts:842-851 (handler)The handler function for 'get_imap' tool, which calls Gmail API's users.settings.getImap to retrieve IMAP settings after authentication via handleTool.
server.tool("get_imap", "Gets IMAP settings", {}, async () => { return handleTool(config, async (gmail: gmail_v1.Gmail) => { const { data } = await gmail.users.settings.getImap({ userId: 'me' }) return formatResponse(data) }) } ) - src/index.ts:844-844 (schema)Input schema for 'get_imap' tool: no parameters required.
{}, - src/index.ts:50-80 (helper)Shared helper function handleTool used by 'get_imap' for OAuth authentication, Gmail client creation, API call execution, and error handling including auth-specific errors.
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)Shared helper to format API responses as MCP content.
const formatResponse = (response: any) => ({ content: [{ type: "text", text: JSON.stringify(response) }] })