Gmail
Send, read, search, and move Gmail messages or trigger workflows from Gmail events
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.
Send emails using Gmail. Returns API-aligned fields only.
| Parameter | Type | Required | Description |
|---|
to | string | Yes | No description |
subject | string | No | No description |
body | string | Yes | No description |
contentType | string | No | No description |
threadId | string | No | No description |
replyToMessageId | string | No | Gmail message ID to reply to - use the "id" field from Gmail Read results (not the RFC "messageId") |
cc | string | No | No description |
bcc | string | No | No description |
attachments | file[] | No | No description |
| Parameter | Type | Description |
|---|
id | string | Gmail message ID |
threadId | string | Gmail thread ID |
labelIds | array | Email labels |
Draft emails using Gmail. Returns API-aligned fields only.
| Parameter | Type | Required | Description |
|---|
to | string | Yes | No description |
subject | string | No | No description |
body | string | Yes | No description |
contentType | string | No | No description |
threadId | string | No | No description |
replyToMessageId | string | No | Gmail message ID to reply to - use the "id" field from Gmail Read results (not the RFC "messageId") |
cc | string | No | No description |
bcc | string | No | No description |
attachments | file[] | No | No description |
| Parameter | Type | Description |
|---|
draftId | string | Draft ID |
messageId | string | Gmail message ID for the draft |
threadId | string | Gmail thread ID |
labelIds | array | Email labels |
Read emails from Gmail. Returns API-aligned fields only.
| Parameter | Type | Required | Description |
|---|
messageId | string | No | No description |
folder | string | No | Folder/label to read emails from (e.g., INBOX, SENT, DRAFT, TRASH, SPAM, or custom label name) |
unreadOnly | boolean | No | No description |
maxResults | number | No | No description |
includeAttachments | boolean | No | No description |
| Parameter | Type | Description |
|---|
id | string | Gmail message ID |
threadId | string | Gmail thread ID |
labelIds | array | Email labels |
from | string | Sender email address |
to | string | Recipient email address |
subject | string | Email subject |
date | string | Email date |
body | string | Email body text (best-effort plain text) |
hasAttachments | boolean | Whether the email has attachments |
attachmentCount | number | Number of attachments |
attachments | file[] | Downloaded attachments (if enabled) |
results | json | Summary results when reading multiple messages |
Search emails in Gmail. Returns API-aligned fields only.
| Parameter | Type | Required | Description |
|---|
query | string | Yes | No description |
maxResults | number | No | No description |
| Parameter | Type | Description |
|---|
results | json | Array of search results |
Move emails between labels/folders in Gmail. Returns API-aligned fields only.
| Parameter | Type | Required | Description |
|---|
messageId | string | Yes | No description |
addLabelIds | string | Yes | No description |
removeLabelIds | string | No | No description |
| Parameter | Type | Description |
|---|
id | string | Gmail message ID |
threadId | string | Gmail thread ID |
labelIds | array | Email labels |
Mark a Gmail message as read. Returns API-aligned fields only.
| Parameter | Type | Required | Description |
|---|
messageId | string | Yes | No description |
| Parameter | Type | Description |
|---|
id | string | Gmail message ID |
threadId | string | Gmail thread ID |
labelIds | array | Updated email labels |
Mark a Gmail message as unread. Returns API-aligned fields only.
| Parameter | Type | Required | Description |
|---|
messageId | string | Yes | No description |
| Parameter | Type | Description |
|---|
id | string | Gmail message ID |
threadId | string | Gmail thread ID |
labelIds | array | Updated email labels |
Archive a Gmail message (remove from inbox). Returns API-aligned fields only.
| Parameter | Type | Required | Description |
|---|
messageId | string | Yes | No description |
| Parameter | Type | Description |
|---|
id | string | Gmail message ID |
threadId | string | Gmail thread ID |
labelIds | array | Updated email labels |
Unarchive a Gmail message (move back to inbox). Returns API-aligned fields only.
| Parameter | Type | Required | Description |
|---|
messageId | string | Yes | No description |
| Parameter | Type | Description |
|---|
id | string | Gmail message ID |
threadId | string | Gmail thread ID |
labelIds | array | Updated email labels |
Delete a Gmail message (move to trash). Returns API-aligned fields only.
| Parameter | Type | Required | Description |
|---|
messageId | string | Yes | No description |
| Parameter | Type | Description |
|---|
id | string | Gmail message ID |
threadId | string | Gmail thread ID |
labelIds | array | Updated email labels |
Add label(s) to a Gmail message. Returns API-aligned fields only.
| Parameter | Type | Required | Description |
|---|
messageId | string | Yes | No description |
labelIds | string | Yes | No description |
| Parameter | Type | Description |
|---|
id | string | Gmail message ID |
threadId | string | Gmail thread ID |
labelIds | array | Updated email labels |
Remove label(s) from a Gmail message. Returns API-aligned fields only.
| Parameter | Type | Required | Description |
|---|
messageId | string | Yes | No description |
labelIds | string | Yes | No description |
| Parameter | Type | Description |
|---|
id | string | Gmail message ID |
threadId | string | Gmail thread ID |
labelIds | array | Updated email labels |