Gmail CustomInstall

Summary

Retrieve multiple Gmail messages from the authorized user's mailbox using optional Gmail search queries and filters.

Inputs

• Authentication (required) — Choose authentication method: Refresh Token with auto-refresh or Bearer Token manual input.
• Custom Refresh Token — Optionally override the refresh token from credentials when using Refresh Token authentication.
• Options — Optional parameters to customize the message retrieval, including:
• Include Spam Trash — Boolean flag to include messages from SPAM and TRASH folders.
• Max Results — Maximum number of messages to return (between 1 and 500; default is 50).
• Query — Gmail search query string to filter messages (e.g., "is:unread", "from:example@gmail.com").

Output shape

a list of message metadata objects

Returns an array of Gmail message objects containing summary info (ID and thread ID) for each message matching the query and options. Does not include full message bodies. Results are limited by the Max Results parameter. Errors will halt execution unless 'continueOnFail' is enabled, in which case errors for individual items are returned in the output.