DOC-1109: Update Gmail Trigger to high tier template (#2472)

This commit is contained in:
Kate Mueller 2024-09-27 13:41:57 -04:00 committed by GitHub
parent 90808297ab
commit 39cd974c1a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
7 changed files with 164 additions and 87 deletions

View File

@ -0,0 +1,58 @@
### Every Hour mode
Enter the **Minute** of the hour to trigger the poll, from `0` to `59`.
### Every Day mode
* Enter the **Hour** of the day to trigger the poll in 24-hour format, from `0` to `23`.
* Enter the **Minute** of the hour to trigger the poll, from `0` to `59`.
### Every Week mode
* Enter the **Hour** of the day to trigger the poll in 24-hour format, from `0` to `23`.
* Enter the **Minute** of the hour to trigger the poll, from `0` to `59`.
* Select the **Weekday** to trigger the poll.
### Every Month mode
* Enter the **Hour** of the day to trigger the poll in 24-hour format, from `0` to `23`.
* Enter the **Minute** of the hour to trigger the poll, from `0` to `59`.
* Enter the **Day of the Month** to trigger the poll, from `0` to `31`.
### Every X mode
* Enter the **Value** of measurement for how often to trigger the poll in either minutes or hours.
* Select the **Unit** for the value. Supported units are **Minutes** and **Hours**.
### Custom mode
Enter a custom **Cron Expression** to trigger the poll. Use these values and ranges:
* Seconds: `0` - `59`
* Minutes: `0` - `59`
* Hours: `0` - `23`
* Day of Month: `1` - `31`
* Months: `0` - `11` (Jan - Dec)
* Day of Week: `0` - `6` (Sun - Sat)
To generate a Cron expression, you can use [crontab guru](https://crontab.guru){:target=_blank .external-link}. Paste the Cron expression that you generated using crontab guru in the **Cron Expression** field in n8n.
#### Examples
If you want to trigger your workflow every day at 04:08:30, enter the following in the **Cron Expression** field.
```
30 8 4 * * *
```
If you want to trigger your workflow every day at 04:08, enter the following in the **Cron Expression** field.
```
8 4 * * *
```
#### Why there are six asterisks in the Cron expression
The sixth asterisk in the Cron expression represents seconds. Setting this is optional. The node will execute even if you don't set the value for seconds.
| * | * | * | * | * | * |
|:--:|:--:|:--:|:--:|:--:|:--:|
|second|minute|hour|day of month|month|day of week|

View File

@ -16,64 +16,7 @@ On this page, you'll find a list of operations the RSS Feed trigger node support
* **Poll Times**: Select a poll **Mode** to set how often to trigger the poll. Your **Mode** selection will add or remove relevant fields. Refer to the sections below to configure the parameters for each mode type.
* **Feed URL**: Enter the URL of the RSS feed to poll.
### Every Hour mode
Enter the **Minute** of the hour to trigger the poll, from `0` to `59`.
### Every Day mode
* Enter the **Hour** of the day to trigger the poll in 24-hour format, from `0` to `23`.
* Enter the **Minute** of the hour to trigger the poll, from `0` to `59`.
### Every Week mode
* Enter the **Hour** of the day to trigger the poll in 24-hour format, from `0` to `23`.
* Enter the **Minute** of the hour to trigger the poll, from `0` to `59`.
* Select the **Weekday** to trigger the poll.
### Every Month mode
* Enter the **Hour** of the day to trigger the poll in 24-hour format, from `0` to `23`.
* Enter the **Minute** of the hour to trigger the poll, from `0` to `59`.
* Enter the **Day of the Month** to trigger the poll, from `0` to `31`.
### Every X mode
* Enter the **Value** of measurement for how often to trigger the poll in either minutes or hours.
* Select the **Unit** for the value. Supported units are **Minutes** and **Hours**.
### Custom mode
Enter a custom **Cron Expression** to trigger the poll. Use these values and ranges:
* Seconds: `0` - `59`
* Minutes: `0` - `59`
* Hours: `0` - `23`
* Day of Month: `1` - `31`
* Months: `0` - `11` (Jan - Dec)
* Day of Week: `0` - `6` (Sun - Sat)
To generate a Cron expression, you can use [crontab guru](https://crontab.guru){:target=_blank .external-link}. Paste the Cron expression that you generated using crontab guru in the **Cron Expression** field in n8n.
#### Examples
If you want to trigger your workflow every day at 04:08:30, enter the following in the **Cron Expression** field.
```
30 8 4 * * *
```
If you want to trigger your workflow every day at 04:08, enter the following in the **Cron Expression** field.
```
8 4 * * *
```
#### Why there are six asterisks in the Cron expression
The sixth asterisk in the Cron expression represents seconds. Setting this is optional. The node will execute even if you don't set the value for seconds.
| * | * | * | * | * | * |
|:--:|:--:|:--:|:--:|:--:|:--:|
|second|minute|hour|day of month|month|day of week|
--8<-- "_snippets/integrations/builtin/poll-modes.md"
## Templates and examples

View File

@ -1,28 +0,0 @@
---
#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
title: Gmail trigger
description: Documentation for the Gmail trigger node in n8n, a workflow automation platform. Includes details of operations and configuration, and links to examples and credentials information.
contentType: integration
priority: high
---
# Gmail trigger
[Gmail](https://www.gmail.com) is an email service developed by Google.
/// note | Credentials
You can find authentication information for this node [here](/integrations/builtin/credentials/google/).
///
/// note | Examples and templates
For usage examples and templates to help you get started, refer to n8n's [Gmail Trigger integrations](https://n8n.io/integrations/gmail-trigger/){:target=_blank .external-link} page.
///
## Events
* Message Received
## Related resources
n8n provides an app node for Gmail. You can find the node docs [here](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/).

View File

@ -0,0 +1,30 @@
---
#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
title: Gmail Trigger node common issues
description: Documentation for common issues and questions in the Gmail Trigger node in n8n, a workflow automation platform. Includes details of the issue and suggested solutions.
contentType: integration
priority: _priority-from-main-node_
---
# Gmail Trigger node common issues
Here are some common errors and issues with the [Gmail Trigger node](/integrations/builtin/trigger-nodes/n8n-nodes-base.gmailtrigger/) and steps to resolve or troubleshoot them.
## 401 unauthorized error
The full text of the error looks like this:
<!--vale off-->
```
401 - {"error":"unauthorized_client","error_description":"Client is unauthorized to retrieve access tokens using this method, or client not authorized for any of the scopes requested."}
```
<!--vale on-->
This error occurs when there's an issue with the credential you're using and its scopes or permissions.
To resolve:
1. For [OAuth2](/integrations/builtin/credentials/google/oauth-single-service/) credentials, make sure you've enabled the Gmail API in **APIs & Services > Library**. Refer to [Google OAuth2 Single Service - Enable APIs](/integrations/builtin/credentials/google/oauth-single-service/#enable-apis) for more information.
2. For [Service Account](/integrations/builtin/credentials/google/service-account/) credentials:
1. [Enable domain-wide delegation](/integrations/builtin/credentials/google/service-account/#enable-domain-wide-delegation).
2. Make sure you add the Gmail API as part of the domain-wide delegation configuration.

View File

@ -0,0 +1,54 @@
---
#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
title: Gmail Trigger node documentation
description: Learn how to use the Gmail Trigger node in n8n. Follow technical documentation to integrate Gmail Trigger node into your workflows.
contentType: integration
priority: high
---
# Gmail Trigger node
[Gmail](https://www.gmail.com){:target=_blank .external-link} is an email service developed by Google. The Gmail Trigger node can start a workflow based on events in Gmail.
/// note | Credentials
You can find authentication information for this node [here](/integrations/builtin/credentials/google/).
///
/// note | Examples and templates
For usage examples and templates to help you get started, refer to n8n's [Gmail Trigger integrations](https://n8n.io/integrations/gmail-trigger/){:target=_blank .external-link} page.
///
## Events
* **Message Received**: The node triggers for new messages at the selected **Poll Time**.
## Node parameters
Configure the node with these parameters:
* **Credential to connect with**: Select or create a new Google credential to use for the trigger. Refer to [Google credentials](/integrations/builtin/credentials/google/) for more information on setting up a new credential.
* **Poll Times**: Select a poll **Mode** to set how often to trigger the poll. Your **Mode** selection will add or remove relevant fields. Refer to [Poll Mode options](/integrations/builtin/trigger-nodes/n8n-nodes-base.gmailtrigger/poll-mode-options/) to configure the parameters for each mode type.
* **Simplify**: Choose whether to return a simplified version of the response (turned on, default) or the raw data (turned off).
* The simplified version returns email message IDs, labels, and email headers, including: From, To, CC, BCC, and Subject.
## Node filters
Use these filters to further refine the node's behavior:
* **Include Spam and Trash**: Select whether the node should trigger on new messages in the Spam and Trash folders (turned on) or not (turned off).
* **Label Names or IDs**: Only trigger on messages with the selected labels added to them. Select the Label names you want to apply or enter an expression to specify IDs. The dropdown populates based on the **Credential** you selected.
* **Search**: Enter Gmail search refine filters, like `from:`, to trigger the node on the filtered conditions only. Refer to [Refine searches in Gmail](https://support.google.com/mail/answer/7190?hl=en){:target=_blank .external-link} for more information.
* **Read Status**: Choose whether to receive **Unread and read emails**, **Unread emails only** (default), or **Read emails only**.
* **Sender**: Enter an email or a part of a sender name to trigger only on messages from that sender.
## Related resources
n8n provides an app node for Gmail. You can find the node docs [here](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/).
View [example workflows and related content](https://n8n.io/integrations/gmail-trigger/){:target=_blank .external-link} on n8n's website.
Refer to [Google's Gmail API documentation](https://developers.google.com/gmail/api/guides){:target=_blank .external-link} for details about their API.
## Common issues
For common questions or issues and suggested solutions, refer to [Common issues](/integrations/builtin/trigger-nodes/n8n-nodes-base.gmailtrigger/common-issues/).

View File

@ -0,0 +1,17 @@
---
#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
title: Gmail Trigger node poll mode options documentation
description: Learn about the poll mode options available to the Gmail Trigger node in n8n and how to configure them.
contentType: howto
priority: high
---
# Gmail Trigger node Poll Mode options
Use the [Gmail Trigger node's](/integrations/builtin/trigger-nodes/n8n-nodes-base.gmailtrigger/) **Poll Time** parameter to set how often to trigger the poll. Your **Mode** selection will add or remove relevant fields.
## Poll mode options
Refer to the sections below for details on using each **Mode**.
--8<-- "_snippets/integrations/builtin/poll-modes.md"

View File

@ -735,7 +735,10 @@ nav:
- integrations/builtin/trigger-nodes/n8n-nodes-base.getresponsetrigger.md
- integrations/builtin/trigger-nodes/n8n-nodes-base.githubtrigger.md
- integrations/builtin/trigger-nodes/n8n-nodes-base.gitlabtrigger.md
- integrations/builtin/trigger-nodes/n8n-nodes-base.gmailtrigger.md
- Gmail Trigger:
- integrations/builtin/trigger-nodes/n8n-nodes-base.gmailtrigger/index.md
- Poll Mode options: integrations/builtin/trigger-nodes/n8n-nodes-base.gmailtrigger/poll-mode-options.md
- Common Issues: integrations/builtin/trigger-nodes/n8n-nodes-base.gmailtrigger/common-issues.md
- integrations/builtin/trigger-nodes/n8n-nodes-base.googlecalendartrigger.md
- integrations/builtin/trigger-nodes/n8n-nodes-base.googledrivetrigger.md
- integrations/builtin/trigger-nodes/n8n-nodes-base.googlesheetstrigger.md