list_drafts
Retrieve draft emails from Gmail with options to filter by search query, limit results, and include content from spam/trash folders.
Instructions
List drafts in the user's mailbox
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| maxResults | No | Maximum number of drafts to return. Accepts values between 1-500 | |
| q | No | Only return drafts matching the specified query. Supports the same query format as the Gmail search box | |
| includeSpamTrash | No | Include drafts from SPAM and TRASH in the results | |
| includeBodyHtml | No | Whether to include the parsed HTML in the return for each body, excluded by default because they can be excessively large |
Implementation Reference
- src/index.ts:327-354 (handler)Handler function for the 'list_drafts' tool. Fetches drafts from Gmail API with pagination, processes message payloads to decode bodies and filter headers, and returns formatted response.async (params) => { return handleTool(config, async (gmail: gmail_v1.Gmail) => { let drafts: Draft[] = [] const { data } = await gmail.users.drafts.list({ userId: 'me', ...params }) drafts.push(...data.drafts || []) while (data.nextPageToken) { const { data: nextData } = await gmail.users.drafts.list({ userId: 'me', ...params, pageToken: data.nextPageToken }) drafts.push(...nextData.drafts || []) } if (drafts) { drafts = drafts.map(draft => { if (draft.message?.payload) { draft.message.payload = processMessagePart( draft.message.payload, params.includeBodyHtml ) } return draft }) } return formatResponse(drafts) }) }
- src/index.ts:322-326 (schema)Input schema for 'list_drafts' tool using Zod validation: parameters for maxResults, query (q), includeSpamTrash, and includeBodyHtml.maxResults: z.number().optional().describe("Maximum number of drafts to return. Accepts values between 1-500"), q: z.string().optional().describe("Only return drafts matching the specified query. Supports the same query format as the Gmail search box"), includeSpamTrash: z.boolean().optional().describe("Include drafts from SPAM and TRASH in the results"), includeBodyHtml: z.boolean().optional().describe("Whether to include the parsed HTML in the return for each body, excluded by default because they can be excessively large"), },
- src/index.ts:319-355 (registration)Registration of the 'list_drafts' tool on the MCP server, including name, description, input schema, and handler function.server.tool("list_drafts", "List drafts in the user's mailbox", { maxResults: z.number().optional().describe("Maximum number of drafts to return. Accepts values between 1-500"), q: z.string().optional().describe("Only return drafts matching the specified query. Supports the same query format as the Gmail search box"), includeSpamTrash: z.boolean().optional().describe("Include drafts from SPAM and TRASH in the results"), includeBodyHtml: z.boolean().optional().describe("Whether to include the parsed HTML in the return for each body, excluded by default because they can be excessively large"), }, async (params) => { return handleTool(config, async (gmail: gmail_v1.Gmail) => { let drafts: Draft[] = [] const { data } = await gmail.users.drafts.list({ userId: 'me', ...params }) drafts.push(...data.drafts || []) while (data.nextPageToken) { const { data: nextData } = await gmail.users.drafts.list({ userId: 'me', ...params, pageToken: data.nextPageToken }) drafts.push(...nextData.drafts || []) } if (drafts) { drafts = drafts.map(draft => { if (draft.message?.payload) { draft.message.payload = processMessagePart( draft.message.payload, params.includeBodyHtml ) } return draft }) } return formatResponse(drafts) }) } )
- src/index.ts:80-94 (helper)Helper function used by list_drafts to process message parts: decodes base64 bodies for text/plain or html(if specified), recursively processes parts, and filters headers.const processMessagePart = (messagePart: MessagePart, includeBodyHtml = false): MessagePart => { if ((messagePart.mimeType !== 'text/html' || includeBodyHtml) && messagePart.body) { messagePart.body = decodedBody(messagePart.body) } if (messagePart.parts) { messagePart.parts = messagePart.parts.map(part => processMessagePart(part, includeBodyHtml)) } if (messagePart.headers) { messagePart.headers = messagePart.headers.filter(header => RESPONSE_HEADERS_LIST.includes(header.name || '')) } return messagePart }
- src/index.ts:50-66 (helper)Shared helper function for all Gmail tools, including list_drafts: handles OAuth2 authentication, client creation, and executes the 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}` } }