list_drafts
Retrieve draft emails from your Gmail mailbox with customizable filters for search queries, result limits, and content inclusion.
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:308-335 (handler)The handler function for the 'list_drafts' tool. It uses the Gmail API to list drafts with pagination support, processes each draft's message payload (decoding bodies and filtering headers), and returns a 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:302-307 (schema)Zod schema defining the input parameters for the 'list_drafts' tool.{ 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:300-336 (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:49-65 (helper)Helper function 'handleTool' used by 'list_drafts' to manage OAuth2 authentication, Gmail client creation, and error handling around 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:79-93 (helper)Helper function 'processMessagePart' used to decode message bodies, recursively process parts, and filter headers in drafts.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 }