Gmail
Reference
Gmail is a widely used email service by Google, offering free and feature-rich communication, organization, and storage capabilities accessible through web browsers and mobile apps.
Categories: [communication]
Version: 1
Connections
Version: 1
OAuth2 Authorization Code
Properties
| Name | Type | Control Type | Description |
|---|---|---|---|
| Client Id | STRING | TEXT | |
| Client Secret | STRING | TEXT |
Triggers
New Email
Triggers when new mail is found in your Gmail inbox.
Type: STATIC_WEBHOOK
Properties
| Name | Type | Control Type | Description |
|---|---|---|---|
| Topic Name | STRING | TEXT | Must be 3-255 characters, start with a letter, and contain only the following characters: |
| letters, numbers, dashes (-), periods (.), underscores (_), tildes (~), percents (%) or | |||
| plus signs (+). Cannot start with goog. |
Output
Type: ARRAY
Properties
| Type | Control Type |
|---|---|
| {STRING(id), STRING(threadId), [STRING](labelIds), STRING(snippet), STRING(historyId), NUMBER(internalDate), {STRING(partId), STRING(mimeType), STRING(filename), [{STRING(name), STRING(value)}](headers), {STRING(attachmentId), INTEGER(size), STRING(data)}(body), [](parts)}(payload), INTEGER(sizeEstimate), STRING(raw)} | OBJECT_BUILDER |
New Email Polling
Periodically checks your Gmail inbox for any new incoming emails.
Type: POLLING
Properties
| Name | Type | Control Type | Description |
|---|---|---|---|
| null |
Output
Type: ARRAY
Properties
| Type | Control Type |
|---|---|
| {STRING(id), STRING(threadId)} | OBJECT_BUILDER |
Actions
Add Labels
Add labels to an email in your Gmail account
Properties
| Name | Type | Control Type | Description |
|---|---|---|---|
| Message ID | STRING | SELECT | ID of the message to add labels |
| Labels | [STRING($label)] | ARRAY_BUILDER | Labels to add to this message. You can add up to 100 labels with each update. |
Output
Type: OBJECT
Properties
| Type | Control Type |
|---|---|
| STRING | TEXT |
| [STRING] | ARRAY_BUILDER |
| STRING | TEXT |
Delete Mail
Delete an email from your Gmail account permanently via Id
Properties
| Name | Type | Control Type | Description |
|---|---|---|---|
| Message ID | STRING | SELECT | The ID of the message to delete. |
Get Mail
Get an email from your Gmail account via Id
Properties
| Name | Type | Control Type | Description |
|---|---|---|---|
| Message ID | STRING | SELECT | The ID of the message to retrieve. |
| Format | STRING | SELECT | The format to return the message in. |
| Metadata headers | [STRING] | ARRAY_BUILDER | When given and format is METADATA, only include headers specified. |
Get Thread
Gets the specified thread.
Properties
| Name | Type | Control Type | Description |
|---|---|---|---|
| Thread ID | STRING | SELECT | The ID of the thread to retrieve. |
| Format | STRING | SELECT | The format to return the message in. |
| Metadata headers | [STRING] | ARRAY_BUILDER | When given and format is METADATA, only include headers specified. |
Reply to Email
Send a reply to an email message.
Properties
| Name | Type | Control Type | Description |
|---|---|---|---|
| Message ID | STRING | SELECT | The ID of the message to reply to. |
| To | [STRING($email)] | ARRAY_BUILDER | Recipients email addresses. |
| Bcc | [STRING($email)] | ARRAY_BUILDER | Bcc recipients email addresses. |
| Cc | [STRING($email)] | ARRAY_BUILDER | Cc recipients email addresses. |
| Body | STRING | TEXT | Body text of the email |
| Attachments | [FILE_ENTRY] | ARRAY_BUILDER | A list of attachments to send with the email. |
Output
Type: OBJECT
Properties
| Type | Control Type |
|---|---|
| STRING | TEXT |
| [STRING] | ARRAY_BUILDER |
| STRING | TEXT |
Search Email
Lists the messages in the user’s mailbox.
Properties
| Name | Type | Control Type | Description |
|---|---|---|---|
| Max Results | NUMBER | NUMBER | Maximum number of messages to return. |
| Page Token | STRING | TEXT | Page token to retrieve a specific page of results in the list. |
| From | STRING | TEXT | The address sending the mail |
| To | STRING | TEXT | The address receiving the new mail |
| Subject | STRING | TEXT | Words in the subject line |
| Category | STRING | SELECT | Messages in a certain category |
| Labels | [STRING] | ARRAY_BUILDER | Only return messages with labels that match all of the specified label IDs. Messages in a thread might have labels that other messages in the same thread don’t have. |
| Include Spam Trash | BOOLEAN | SELECT | Include messages from SPAM and TRASH in the results. |
Output
Type: OBJECT
Properties
| Type | Control Type |
|---|---|
| [{STRING(id), STRING(threadId)}] | ARRAY_BUILDER |
| STRING | TEXT |
| NUMBER | NUMBER |
Send Email
Sends the specified message to the recipients in the To, Cc, and Bcc headers.
Properties
| Name | Type | Control Type | Description |
|---|---|---|---|
| To | [STRING($email)] | ARRAY_BUILDER | Recipients email addresses. |
| Subject | STRING | TEXT | Subject of the email. |
| Bcc | [STRING($email)] | ARRAY_BUILDER | Bcc recipients email addresses. |
| Cc | [STRING($email)] | ARRAY_BUILDER | Cc recipients email addresses. |
| Reply To | [STRING($email)] | ARRAY_BUILDER | Reply-to email addresses. |
| Body | STRING | TEXT | Body text of the email |
| Attachments | [FILE_ENTRY] | ARRAY_BUILDER | A list of attachments to send with the email. |
Output
Type: OBJECT
Properties
| Type | Control Type |
|---|---|
| STRING | TEXT |
| [STRING] | ARRAY_BUILDER |
| STRING | TEXT |
Additional instructions
CONNECTION
Turning on GMail API