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:828-837 (handler)The handler function for the 'get_imap' tool, which calls the Gmail API to retrieve IMAP settings via handleTool wrapper.
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:828-837 (registration)Registration of the 'get_imap' tool on the MCP server, including schema (empty input) and handler.
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:50-66 (helper)Shared helper function used by 'get_imap' and other tools to handle OAuth2 authentication and Gmail API calls.
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}` } } - src/index.ts:48-48 (helper)Helper function used to format API responses for MCP tools, including 'get_imap'.
const formatResponse = (response: any) => ({ content: [{ type: "text", text: JSON.stringify(response) }] })