Gmail Connector
Manage Messages in Google's email service
Connections
OAuth2
OAuth2 Connection
This connection uses OAuth 2.0, a common authentication mechanism for integrations. Read about how OAuth 2.0 works here.
| Input | Comments | Default |
|---|---|---|
| Scopes | Space delimited listing of scopes. See https://developers.google.com/gmail/api/auth/scopes | https://mail.google.com/ |
| Client ID | Your Gmail app's Client ID | |
| Client Secret | Your Gmail app's Client Secret |
Service Account
Service Account Connection
| Input | Comments | Default |
|---|---|---|
| Service Account Key File | The Key File for your Google Service Account. | |
| Scopes | Space delimited listing of scopes. See https://developers.google.com/gmail/api/auth/scopes | https://mail.google.com/ |
Triggers
Push Notification Webhook
Receive and validate webhook requests from Gmail for webhooks you configure.
Actions
Create Push Notification (Watch Request)
Enables the ability to send update notifications like new messages received.
| Input | Comments | Default |
|---|---|---|
| Connection | The Connection to use for authorization. | |
| Gmail User ID (optional) | A user whose account to query (defaults to currently authenticated user) | |
| Topic Name | ||
| Label ID | System labels typically correspond to pre-defined elements in the Gmail web interface such as the inbox. |
Delete Push Notification (Stop Mailbox Updates)
Calls a stop notification.
| Input | Comments | Default |
|---|---|---|
| Connection | The Connection to use for authorization. | |
| Gmail User ID (optional) | A user whose account to query (defaults to currently authenticated user) |
Get Current User
Get metadata about the authenticated user
| Input | Comments | Default |
|---|---|---|
| Connection | The Connection to use for authorization. |
Get Event History
Fetch events that have occurred in the mailbox since the specified startHistoryId.
| Input | Comments | Default |
|---|---|---|
| Connection | The Connection to use for authorization. | |
| Gmail User ID (optional) | A user whose account to query (defaults to currently authenticated user) | |
| History ID | The history ID to start history from. |
Get Label by Name
Get a label (including ID) by its name
| Input | Comments | Default |
|---|---|---|
| Connection | The Connection to use for authorization. | |
| Label Name | ||
| Gmail User ID (optional) | A user whose account to query (defaults to currently authenticated user) |
Get Message
Get a message by ID
| Input | Comments | Default |
|---|---|---|
| Connection | The Connection to use for authorization. | |
| Message ID | ||
| Gmail User ID (optional) | A user whose account to query (defaults to currently authenticated user) |
List Labels
List all labels within this account
| Input | Comments | Default |
|---|---|---|
| Connection | The Connection to use for authorization. | |
| Gmail User ID (optional) | A user whose account to query (defaults to currently authenticated user) |
List Messages
Get a list of messages
| Input | Comments | Default |
|---|---|---|
| Connection | The Connection to use for authorization. | |
| Gmail User ID (optional) | A user whose account to query (defaults to currently authenticated user) | |
| Page Token | If you're looping over pages of results, this is the page token from the result of the previous 'list messages' step. | |
| Fetch All | Turn this On to fetch all pages of results. | false |
| Query String | Only return messages matching the specified query. Supports the same query format as the Gmail search box. | |
| Max Results | The maximum number of results to return. | |
| Labels | Show only messages with labels that match these label IDs | |
| Add Metadata | Turn this On to add metadata to the messages. This will slow down the response time. | false |
Raw Request
Send raw HTTP request to Google Gmail
| Input | Comments | Default |
|---|---|---|
| Connection | The Connection to use for authorization. | |
| URL | Input the path only (/v1/users/{userId}/messages), The base URL is already included (https://gmail.googleapis.com/gmail). For example, to connect to https://gmail.googleapis.com/gmail/v1/users/{userId}/messages, only /v1/users/{userId}/messages is entered in this field. | |
| Method | The HTTP method to use. | |
| Data | The HTTP body payload to send to the URL. | |
| Form Data | The Form Data to be sent as a multipart form upload. | |
| File Data | File Data to be sent as a multipart form upload. | |
| File Data File Names | File names to apply to the file data inputs. Keys must match the file data keys above. | |
| Query Parameter | A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2. | |
| Header | A list of headers to send with the request. | |
| Response Type | The type of data you expect in the response. You can request json, text, or binary data. | json |
| Timeout | The maximum time that a client will await a response to its request | |
| Debug Request | Enabling this flag will log out the current request. | false |
| Retry Delay (ms) | The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled. | 0 |
| Retry On All Errors | If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors. | false |
| Max Retry Count | The maximum number of retries to attempt. Specify 0 for no retries. | 0 |
| Use Exponential Backoff | Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored. | false |
Send Message
Send a new message
| Input | Comments | Default |
|---|---|---|
| Connection | The Connection to use for authorization. | |
| To | ||
| From | Alias of the sender email address. This is the email address that will be used to send the email. | |
| CC | ||
| BCC | ||
| Subject | ||
| Plain text body | For email clients that do not support HTML | |
| HTML body | For email clients that support HTML | |
| Attachments | Specify a file name as the key (i.e. 'my-file.pdf'), and the file as the value | |
| Dynamic Attachments | An array of objects with 'key' and 'value' properties, where 'key' is the file name and 'value' is the binary file data. Typically used as a reference from a previous step. Ex. [{key: "my-attachment.pdf", value: | |
| Gmail User ID (optional) | A user whose account to query (defaults to currently authenticated user) |
Trash Message
Send a message to the trash
| Input | Comments | Default |
|---|---|---|
| Connection | The Connection to use for authorization. | |
| Message ID | ||
| Gmail User ID (optional) | A user whose account to query (defaults to currently authenticated user) |
Untrash Message
Remove a message from the trash
| Input | Comments | Default |
|---|---|---|
| Connection | The Connection to use for authorization. | |
| Message ID | ||
| Gmail User ID (optional) | A user whose account to query (defaults to currently authenticated user) |
Update Message Labels
Add or remove labels from a message
| Input | Comments | Default |
|---|---|---|
| Connection | The Connection to use for authorization. | |
| Message ID | ||
| Gmail User ID (optional) | A user whose account to query (defaults to currently authenticated user) | |
| Labels to Add | A list of labels to add (optional) | |
| Labels to Remove | A list of labels to add (optional) |