Gmail

Send, read, search, and move Gmail messages or trigger workflows from Gmail events

Usage Instructions

Integrate Gmail into the workflow. Can send, read, search, and move emails. Can be used in trigger mode to trigger a workflow when a new email is received.

Tools

`gmail_send`

Send emails using Gmail

Input

Parameter	Type	Required	Description
`to`	string	Yes	Recipient email address
`subject`	string	No	Email subject
`body`	string	Yes	Email body content
`contentType`	string	No	Content type for the email body (text or html)
`threadId`	string	No	Thread ID to reply to (for threading)
`replyToMessageId`	string	No	Gmail message ID to reply to - use the "id" field from Gmail Read results (not the RFC "messageId")
`cc`	string	No	CC recipients (comma-separated)
`bcc`	string	No	BCC recipients (comma-separated)
`attachments`	file[]	No	Files to attach to the email

Output

Parameter	Type	Description
`content`	string	Success message
`metadata`	object	Email metadata

`gmail_draft`

Draft emails using Gmail

Input

Parameter	Type	Required	Description
`to`	string	Yes	Recipient email address
`subject`	string	No	Email subject
`body`	string	Yes	Email body content
`contentType`	string	No	Content type for the email body (text or html)
`threadId`	string	No	Thread ID to reply to (for threading)
`replyToMessageId`	string	No	Gmail message ID to reply to - use the "id" field from Gmail Read results (not the RFC "messageId")
`cc`	string	No	CC recipients (comma-separated)
`bcc`	string	No	BCC recipients (comma-separated)
`attachments`	file[]	No	Files to attach to the email draft

Output

Parameter	Type	Description
`content`	string	Success message
`metadata`	object	Draft metadata

`gmail_read`

Read emails from Gmail

Input

Parameter	Type	Required	Description
`messageId`	string	No	ID of the message to read
`folder`	string	No	Folder/label to read emails from
`unreadOnly`	boolean	No	Only retrieve unread messages
`maxResults`	number	No	Maximum number of messages to retrieve (default: 1, max: 10)
`includeAttachments`	boolean	No	Download and include email attachments

Output

Parameter	Type	Description
`content`	string	Text content of the email
`metadata`	json	Metadata of the email
`attachments`	file[]	Attachments of the email

`gmail_search`

Search emails in Gmail

Input

Parameter	Type	Required	Description
`query`	string	Yes	Search query for emails
`maxResults`	number	No	Maximum number of results to return

Output

Parameter	Type	Description
`content`	string	Search results summary
`metadata`	object	Search metadata

`gmail_move`

Move emails between Gmail labels/folders

Input

Parameter	Type	Required	Description
`messageId`	string	Yes	ID of the message to move
`addLabelIds`	string	Yes	Comma-separated label IDs to add (e.g., INBOX, Label_123)
`removeLabelIds`	string	No	Comma-separated label IDs to remove (e.g., INBOX, SPAM)

Output

Parameter	Type	Description
`content`	string	Success message
`metadata`	object	Email metadata

`gmail_mark_read`

Mark a Gmail message as read

Input

Parameter	Type	Required	Description
`messageId`	string	Yes	ID of the message to mark as read

Output

Parameter	Type	Description
`content`	string	Success message
`metadata`	object	Email metadata

`gmail_mark_unread`

Mark a Gmail message as unread

Input

Parameter	Type	Required	Description
`messageId`	string	Yes	ID of the message to mark as unread

Output

Parameter	Type	Description
`content`	string	Success message
`metadata`	object	Email metadata

`gmail_archive`

Archive a Gmail message (remove from inbox)

Input

Parameter	Type	Required	Description
`messageId`	string	Yes	ID of the message to archive

Output

Parameter	Type	Description
`content`	string	Success message
`metadata`	object	Email metadata

`gmail_unarchive`

Unarchive a Gmail message (move back to inbox)

Input

Parameter	Type	Required	Description
`messageId`	string	Yes	ID of the message to unarchive

Output

Parameter	Type	Description
`content`	string	Success message
`metadata`	object	Email metadata

`gmail_delete`

Delete a Gmail message (move to trash)

Input

Parameter	Type	Required	Description
`messageId`	string	Yes	ID of the message to delete

Output

Parameter	Type	Description
`content`	string	Success message
`metadata`	object	Email metadata

`gmail_add_label`

Add label(s) to a Gmail message

Input

Parameter	Type	Required	Description
`messageId`	string	Yes	ID of the message to add labels to
`labelIds`	string	Yes	Comma-separated label IDs to add (e.g., INBOX, Label_123)

Output

Parameter	Type	Description
`content`	string	Success message
`metadata`	object	Email metadata

`gmail_remove_label`

Remove label(s) from a Gmail message

Input

Parameter	Type	Required	Description
`messageId`	string	Yes	ID of the message to remove labels from
`labelIds`	string	Yes	Comma-separated label IDs to remove (e.g., INBOX, Label_123)

Output

Parameter	Type	Description
`content`	string	Success message
`metadata`	object	Email metadata

Triggers

`gmail_poller`

Triggers when new emails are received in Gmail (requires Gmail credentials)

Output

Parameter	Type	Description
`email.id`	string	Gmail message ID
`email.threadId`	string	Gmail thread ID
`email.subject`	string	Email subject line
`email.from`	string	Sender email address
`email.to`	string	Recipient email address
`email.cc`	string	CC recipients
`email.date`	string	Email date in ISO format
`email.bodyText`	string	Plain text email body
`email.bodyHtml`	string	HTML email body
`email.labels`	string	Email labels array
`email.hasAttachments`	boolean	Whether email has attachments
`email.attachments`	file[]	Array of email attachments as files (if includeAttachments is enabled)
`timestamp`	string	Event timestamp

Notes

Category: tools
Type: gmail

Gmail

On this page