centersl/n8n-docs
1
0
Fork 0
mirror of https://github.com/n8n-io/n8n-docs.git synced 2026-03-27 09:28:43 +07:00
Code Issues Packages Projects Releases Wiki Activity

DOC-1099: Update Gmail node to high tier template (#2470)

Browse Source
This commit is contained in:
Kate Mueller
2024-09-24 12:00:19 -04:00
committed by GitHub
parent e7d38593f4
commit 7833f930fb
10 changed files with 708 additions and 67 deletions
Download Patch File Download Diff File Expand all files Collapse all files

63
docs/integrations/builtin/app-nodes/n8n-nodes-base.gmail.md
View File

@@ -1,63 +0,0 @@
---
#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
title: Gmail node documentation
description: Learn how to use the Gmail node in n8n. Follow technical documentation to integrate Gmail node into your workflows.
contentType: integration
priority: high
---
# Gmail node
Use the Gmail node to automate work in Gmail, and integrate Gmail with other applications. n8n has built-in support for a wide range of Gmail features, including creating, updating, deleting, and getting drafts, messages, labels, thread.
On this page, you'll find a list of operations the Gmail node supports and links to more resources.
/// note | Credentials
Refer to [Google credentials](/integrations/builtin/credentials/google/) for guidance on setting up authentication.
///
## Operations
* Draft
* Create
* Delete
* Get
* Get Many
* Label
* Create
* Delete
* Get
* Get Many
* Message
* Add Label
* Delete
* Get
* Get Many
* Mark as Read
* Mark as Unread
* Remove Label
* Reply
* Send
* Thread
* Add Label
* Delete
* Get
* Get Many
* Remove Label
* reply
* Trash
* Untrash
## Templates and examples
<!-- see https://www.notion.so/n8n/Pull-in-templates-for-the-integrations-pages-37c716837b804d30a33b47475f6e3780 -->
[[ templatesWidget(page.title, 'gmail') ]]
## Related resources
Refer to Google's [Gmail API documentation](https://developers.google.com/gmail/api) for detailed information about the API that this node integrates with.
n8n provides a trigger node for Gmail. You can find the trigger node docs [here](/integrations/builtin/trigger-nodes/n8n-nodes-base.gmailtrigger/).
--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md"

61
docs/integrations/builtin/app-nodes/n8n-nodes-base.gmail/common-issues.md Normal file
View File

@@ -0,0 +1,61 @@
---
#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
title: Gmail node common issues
description: Documentation for common issues and resolutions in the Gmail node in n8n, a workflow automation platform. Includes details of the issue and suggested resolutions.
contentType: integration
priority: critical
---
# Common issues (Gmail node)
Here are some common errors and issues with the [Gmail node](/integrations/builtin/app-nodes/n8n-nodes--base.gmail/) and steps to resolve or troubleshoot them.
## Remove the n8n attribution from sent messages
If you're using the node to [send a message](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/message-operations/#send-a-message) or [reply to a message](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/message-operations/#reply-to-a-message), the node appends this statement to the end of the email:
> This email was sent automatically with n8n
To remove this attribution:
1. In the node's **Options** section, select **Add option**.
2. Select **Append n8n attribution**.
3. Turn the toggle off.
Refer to [Send options](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/message-operations/#send-options) and [Reply options](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/message-operations/#reply-options) for more information.
## Forbidden - perhaps check your credentials
This error displays next to certain dropdowns in the node, like the **Label Names or IDs** dropdown. The full text looks something like this:
```
There was a problem loading the parameter options from server: "Forbidden - perhaps check your credentials?"
```
The error most often displays when you're using a Google Service Account as the credential and the credential doesn't have **Impersonate a User** turned on.
Refer to [Google Service Account: Finish your n8n credential](/integrations/builtin/credentials/google/service-account/#finish-your-n8n-credential) for more information.
## 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.
## Bad request - please check your parameters
This error most often occurs if you enter a Message ID, Thread ID, or Label ID that doesn't exist.
Try a **Get** operation with the ID to confirm it exists.

102
docs/integrations/builtin/app-nodes/n8n-nodes-base.gmail/draft-operations.md Normal file
View File

@@ -0,0 +1,102 @@
---
#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
title: Gmail node Draft Operations documentation
description: Learn how to use the Draft Operations of the Gmail node in n8n. Follow technical documentation to integrate Draft Operations into your workflows.
contentType: integration
priority: high
---
# Gmail node Draft Operations
Use the Draft operations to create, delete, or get a draft or list drafts in Gmail. Refer to the [Gmail node](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/) for more information on the Gmail node itself.
## Create a draft
Use this operation to create a new draft.
Enter these parameters:
* Select the **Credential to connect with** or create a new one.
* **Resource**: Select **Draft**.
* **Operation**: Select **Create**.
* **Subject**: Enter the subject line.
* Select the **Email Type**. Choose from **Text** or **HTML**.
* **Message**: Enter the email message body.
### Create draft options
Use these options to further refine the node's behavior:
* **Attachments**: Select **Add Attachment** to add an attachment. Enter the **Attachment Field Name (in Input)** to identify which field from the input node contains the attachment.
* For multiple properties, enter a comma-separated list.
* **BCC**: Enter one or more email addresses for blind copy recipients. Separate multiple email addresses with a comma, for example `jay@gatsby.com, jon@smith.com`.
* **CC**: Enter one or more email addresses for carbon copy recipients. Separate multiple email addresses with a comma, for example `jay@gatsby.com, jon@smith.com`.
* **From Alias Name or ID**: Select an alias to send the draft from. This field populates based on the credential you selected in the parameters.
* **Send Replies To**: Enter an email address to set as the reply to address.
* **Thread ID**: If you want this draft attached to a thread, enter the ID for that thread.
* **To Email**: Enter one or more email addresses for recipients. Separate multiple email addresses with a comma, for example `jay@gatsby.com, jon@smith.com`.
Refer to the [Gmail API Method: users.drafts.create](https://developers.google.com/gmail/api/reference/rest/v1/users.drafts/create){:target=_blank .external-link} documentation for more information.
## Delete a draft
Use this operation to delete a draft.
Enter these parameters:
* Select the **Credential to connect with** or create a new one.
* **Resource**: Select **Draft**.
* **Operation**: Select **Delete**.
* **Draft ID**: Enter the ID of the draft you wish to delete.
Refer to the [Gmail API Method: users.drafts.delete](https://developers.google.com/gmail/api/reference/rest/v1/users.drafts/delete){:target=_blank .external-link} documentation for more information.
## Get a draft
Use this operation to get a single draft.
Enter these parameters:
* Select the **Credential to connect with** or create a new one.
* **Resource**: Select **Draft**.
* **Operation**: Select **Get**.
* **Draft ID**: Enter the ID of the draft you wish to get information about.
### Get draft options
Use these options to further refine the node's behavior:
* **Attachment Prefix**: Enter a prefix for the name of the binary property the node should write any attachments to. n8n adds an index starting with `0` to the prefix. For example, if you enter `attachment_' as the prefix, the first attachment saves to 'attachment_0'.
* **Download Attachments**: Select whether the node should download the draft's attachments (turned on) or not (turned off).
Refer to the [Gmail API Method: users.drafts.get](https://developers.google.com/gmail/api/reference/rest/v1/users.drafts/get){:target=_blank .external-link} documentation for more information.
<!-- vale off -->
## Get Many drafts
<!-- vale on -->
Use this operation to get two or more drafts.
Enter these parameters:
* Select the **Credential to connect with** or create a new one.
* **Resource**: Select **Draft**.
* **Operation**: Select **Get Many**.
* **Return All**: Choose whether the node returns all drafts (turned on) or only up to a set limit (turned off).
* **Limit**: Enter the maximum number of drafts to return. Only used if you've turned off **Return All**.
<!-- vale off -->
### Get Many drafts options
<!-- vale on -->
Use these options to further refine the node's behavior:
* **Attachment Prefix**: Enter a prefix for the name of the binary property the node should write any attachments to. n8n adds an index starting with `0` to the prefix. For example, if you enter `attachment_' as the prefix, the first attachment saves to 'attachment_0'.
* **Download Attachments**: Select whether the node should download the draft's attachments (turned on) or not (turned off).
* **Include Spam and Trash**: Select whether the node should get drafts in the Spam and Trash folders (turned on) or not (turned off).
Refer to the [Gmail API Method: users.drafts.list](https://developers.google.com/gmail/api/reference/rest/v1/users.drafts/list){:target=_blank .external-link} documentation for more information.
## Common issues
For common errors or issues and suggested resolution steps, refer to [Common Issues](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/common-issues/).

66
docs/integrations/builtin/app-nodes/n8n-nodes-base.gmail/index.md Normal file
View File

@@ -0,0 +1,66 @@
---
#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
title: Gmail node documentation
description: Learn how to use the Gmail node in n8n. Follow technical documentation to integrate Gmail node into your workflows.
contentType: integration
priority: high
---
# Gmail node
Use the Gmail node to automate work in Gmail, and integrate Gmail with other applications. n8n has built-in support for a wide range of Gmail features, including creating, updating, deleting, and getting drafts, messages, labels, thread.
On this page, you'll find a list of operations the Gmail node supports and links to more resources.
/// note | Credentials
Refer to [Google credentials](/integrations/builtin/credentials/google/) for guidance on setting up authentication.
///
## Operations
* **Draft**
* [**Create**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/draft-operations/#create-a-draft) a draft
* [**Delete**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/draft-operations/#delete-a-draft) a draft
* [**Get**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/draft-operations/#get-a-draft) a draft
* [**Get Many**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/draft-operations/#get-many-drafts) drafts
* **Label**
* [**Create**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/label-operations/#create-a-label) a label
* [**Delete**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/label-operations/#delete-a-label) a label
* [**Get**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/label-operations/#get-a-label) a label
* [**Get Many**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/label-operations/#get-many-labels) labels
* **Message**
* [**Add Label**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/message-operations/#add-label-to-a-message) to a message
* [**Delete**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/message-operations/#delete-a-message) a message
* [**Get**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/message-operations/#get-a-message) a message
* [**Get Many**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/message-operations/#get-many-messages) messages
* [**Mark as Read**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/message-operations/#mark-as-read)
* [**Mark as Unread**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/message-operations/#mark-as-unread)
* [**Remove Label**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/message-operations/#remove-label-from-a-message) from a message
* [**Reply**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/message-operations/#reply-to-a-message) to a message
* [**Send**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/message-operations/#send-a-message) a message
* **Thread**
* [**Add Label**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/thread-operations/#add-label-to-a-thread) to a thread
* [**Delete**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/thread-operations/#delete-a-thread) a thread
* [**Get**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/thread-operations/#get-a-thread) a thread
* [**Get Many**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/thread-operations/#get-many-threads) threads
* [**Remove Label**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/thread-operations/#remove-label-from-a-thread) from thread
* [**Reply**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/thread-operations/#reply-to-a-message) to a message
* [**Trash**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/thread-operations/#trash-a-thread) a thread
* [**Untrash**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/thread-operations/#untrash-a-thread) a thread
## Templates and examples
<!-- see https://www.notion.so/n8n/Pull-in-templates-for-the-integrations-pages-37c716837b804d30a33b47475f6e3780 -->
[[ templatesWidget(page.title, 'gmail') ]]
## Related resources
Refer to Google's [Gmail API documentation](https://developers.google.com/gmail/api) for detailed information about the API that this node integrates with.
n8n provides a trigger node for Gmail. You can find the trigger node docs [here](/integrations/builtin/trigger-nodes/n8n-nodes-base.gmailtrigger/).
--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md"
## Common issues
For common errors or issues and suggested resolution steps, refer to [Common Issues](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/common-issues/).

80
docs/integrations/builtin/app-nodes/n8n-nodes-base.gmail/label-operations.md Normal file
View File

@@ -0,0 +1,80 @@
---
#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
title: Gmail node Label Operations documentation
description: Learn how to use the Label Operations of the Gmail node in n8n. Follow technical documentation to integrate Label Operations into your workflows.
contentType: integration
priority: high
---
# Gmail node Label Operations
Use the Label operations to create, delete, or get a label or list labels in Gmail. Refer to the [Gmail node](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/) for more information on the Gmail node itself.
## Create a label
Use this operation to create a new label.
Enter these parameters:
* Select the **Credential to connect with** or create a new one.
* **Resource**: Select **Label**.
* **Operation**: Select **Create**.
* **Name**: Enter a display name for the label.
### Create label options
Use these options to further refine the node's behavior:
* **Label List Visibility**: Sets the visibility of the label in the label list in the Gmail web interface. Choose from:
* **Hide**: Don't show the label in the label list.
* **Show** (default): Show the label in the label list.
* **Show if Unread**: Show the label if there are any unread messages with that label.
* **Message List Visibility**: Sets the visibility of messages with this label in the message list in the Gmail web interface. Choose whether to **Show** or **Hide** messages with this label.
Refer to the [Gmail API Method: users.labels.create](https://developers.google.com/gmail/api/reference/rest/v1/users.labels/create){:target=_blank .external-link} documentation for more information.
## Delete a label
Use this operation to delete an existing label.
Enter these parameters:
* Select the **Credential to connect with** or create a new one.
* **Resource**: Select **Label**.
* **Operation**: Select **Delete**.
* **Label ID**: Enter the ID of the label you want to delete.
Refer to the [Gmail API Method: users.labels.delete](https://developers.google.com/gmail/api/reference/rest/v1/users.labels/delete){:target=_blank .external-link} documentation for more information.
## Get a label
Use this operation to get an existing label.
Enter these parameters:
* Select the **Credential to connect with** or create a new one.
* **Resource**: Select **Label**.
* **Operation**: Select **Get**.
* **Label ID**: Enter the ID of the label you want to get.
Refer to the [Gmail API Method: users.labels.get](https://developers.google.com/gmail/api/reference/rest/v1/users.labels/get){:target=_blank .external-link} documentation for more information.
<!-- vale off -->
## Get Many labels
<!-- vale on -->
Use this operation to get two or more labels.
Enter these parameters:
* Select the **Credential to connect with** or create a new one.
* **Resource**: Select **Label**.
* **Operation**: Select **Get Many**.
* **Return All**: Choose whether the node returns all labels (turned on) or only up to a set limit (turned off).
* **Limit**: Enter the maximum number of labels to return. Only used if you've turned off **Return All**.
Refer to the [Gmail API Method: users.labels.list](https://developers.google.com/gmail/api/reference/rest/v1/users.labels/list){:target=_blank .external-link} documentation for more information.
## Common issues
For common errors or issues and suggested resolution steps, refer to [Common Issues](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/common-issues/).

197
docs/integrations/builtin/app-nodes/n8n-nodes-base.gmail/message-operations.md Normal file
View File

@@ -0,0 +1,197 @@
---
#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
title: Gmail node Message Operations documentation
description: Learn how to use the Message Operations of the Gmail node in n8n. Follow technical documentation to integrate Message Operations into your workflows.
contentType: integration
priority: high
---
# Gmail node Message Operations
Use the Message operations to send, reply to, delete, mark read or unread, add a label to, remove a label from, or get a message or get a list of messages in Gmail. Refer to the [Gmail node](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/) for more information on the Gmail node itself.
## Add Label to a message
Use this operation to add one or more labels to a message.
Enter these parameters:
* Select the **Credential to connect with** or create a new one.
* **Resource**: Select **Message**.
* **Operation**: Select **Add Label**.
* **Message ID**: Enter the ID of the message you want to add the label to.
* **Label Names or IDs**: Select the Label names you want to add or enter an expression to specify IDs. The dropdown populates based on the **Credential** you selected.
<!-- vale off -->
Refer to the [Gmail API Method: users.messages.modify](https://developers.google.com/gmail/api/reference/rest/v1/users.messages/modify){:target=_blank .external-link} documentation for more information.
<!-- vale on -->
## Delete a message
Use this operation to immediately and permanently delete a message.
/// note | Permanent deletion
This operation can't be undone. For recoverable deletions, use the [Thread Trash operation](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/thread-operations/#trash-a-thread) instead.
///
Enter these parameters:
* Select the **Credential to connect with** or create a new one.
* **Resource**: Select **Message**.
* **Operation**: Select **Delete**.
* **Message ID**: Enter the ID of the message you want to delete.
Refer to the [Gmail API Method: users.messages.delete](https://developers.google.com/gmail/api/reference/rest/v1/users.messages/delete){:target=_blank .external-link} documentation for more information.
## Get a message
Use this operation to get a single message.
Enter these parameters:
* Select the **Credential to connect with** or create a new one.
* **Resource**: Select **Message**.
* **Operation**: Select **Get**.
* **Message ID**: Enter the ID of the message you wish to retrieve.
* **Simplify**: Choose whether to return a simplified version of the response (turned on) or the raw data (turned off). Default is on.
* This is the same as setting the `format` for the API call to `metadata`, which returns email message IDs, labels, and email headers, including: From, To, CC, BCC, and Subject.
Refer to the [Gmail API Method: users.messages.get](https://developers.google.com/gmail/api/reference/rest/v1/users.messages/get){:target=_blank .external-link} documentation for more information.
<!-- vale off -->
## Get Many messages
<!-- vale on -->
Use this operation to get two or more messages.
Enter these parameters:
* Select the **Credential to connect with** or create a new one.
* **Resource**: Select **Message**.
* **Operation**: Select **Get Many**.
* **Return All**: Choose whether the node returns all messages (turned on) or only up to a set limit (turned off).
* **Limit**: Enter the maximum number of messages to return. Only used if you've turned off **Return All**.
* **Simplify**: Choose whether to return a simplified version of the response (turned on) or the raw data (turned off). Default is on.
* This is the same as setting the `format` for the API call to `metadata`, which returns email message IDs, labels, and email headers, including: From, To, CC, BCC, and Subject.
<!-- vale off -->
### Get Many messages filters
<!-- vale on -->
Use these filters to further refine the node's behavior:
* **Include Spam and Trash**: Select whether the node should get messages in the Spam and Trash folders (turned on) or not (turned off).
* **Label Names or IDs**: Only return 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 filter the messages returned. 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**.
* **Received After**: Return only those emails received after the specified date and time. Use the date picker to select the day and time or enter an expression to set a date as a string in ISO format or a timestamp in milliseconds. Refer to [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601){:target=_blank .external-link} for more information on formatting the string.
* **Received Before**: Return only those emails received before the specified date and time. Use the date picker to select the day and time or enter an expression to set a date as a string in ISO format or a timestamp in milliseconds. Refer to [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601){:target=_blank .external-link} for more information on formatting the string.
* **Sender**: Enter an email or a part of a sender name to return messages from only that sender.
Refer to the [Gmail API Method: users.messages.list](https://developers.google.com/gmail/api/reference/rest/v1/users.messages/list){:target=_blank .external-link} documentation for more information.
## Mark as Read
Use this operation to mark a message as read.
Enter these parameters:
* Select the **Credential to connect with** or create a new one.
* **Resource**: Select **Message**.
* **Operation**: Select **Mark as Read**.
* **Message ID**: Enter the ID of the message you wish to mark as read.
<!-- vale off -->
Refer to the [Gmail API Method: users.messages.modify](https://developers.google.com/gmail/api/reference/rest/v1/users.messages/modify){:target=_blank .external-link} documentation for more information.
<!-- vale on -->
## Mark as Unread
Use this operation to mark a message as unread.
Enter these parameters:
* Select the **Credential to connect with** or create a new one.
* **Resource**: Select **Message**.
* **Operation**: Select **Mark as Unread**.
* **Message ID**: Enter the ID of the message you wish to mark as unread.
<!-- vale off -->
Refer to the [Gmail API Method: users.messages.modify](https://developers.google.com/gmail/api/reference/rest/v1/users.messages/modify){:target=_blank .external-link} documentation for more information.
<!-- vale on -->
## Remove Label from a message
Use this operation to remove one or more labels from a message.
Enter these parameters:
* Select the **Credential to connect with** or create a new one.
* **Resource**: Select **Message**.
* **Operation**: Select **Remove Label**.
* **Message ID**: Enter the ID of the message you want to remove the label from.
* **Label Names or IDs**: Select the Label names you want to remove or enter an expression to specify IDs. The dropdown populates based on the **Credential** you selected.
<!-- vale off -->
Refer to the [Gmail API Method: users.messages.modify](https://developers.google.com/gmail/api/reference/rest/v1/users.messages/modify){:target=_blank .external-link} documentation for more information.
<!-- vale on -->
## Reply to a message
Use this operation to send a message as a reply to an existing message.
Enter these parameters:
* Select the **Credential to connect with** or create a new one.
* **Resource**: Select **Message**.
* **Operation**: Select **Reply**.
* **Message ID**: Enter the ID of the message you want to reply to.
* Select the **Email Type**. Choose from **Text** or **HTML**.
* **Message**: Enter the email message body.
### Reply options
Use these options to further refine the node's behavior:
* **Append n8n attribution**: By default, the node appends the statement `This email was sent automatically with n8n` to the end of the email. To remove this statement, turn this option off.
* **Attachments**: Select **Add Attachment** to add an attachment. Enter the **Attachment Field Name (in Input)** to identify which field from the input node contains the attachment.
* For multiple properties, enter a comma-separated list.
* **BCC**: Enter one or more email addresses for blind copy recipients. Separate multiple email addresses with a comma, for example `jay@gatsby.com, jon@smith.com`.
* **CC**: Enter one or more email addresses for carbon copy recipients. Separate multiple email addresses with a comma, for example `jay@gatsby.com, jon@smith.com`.
* **Sender Name**: Enter the name you want displayed in your recipients' email as the sender.
* **Reply to Sender Only**: Choose whether to reply all (turned off) or reply to the sender only (turned on).
Refer to the [Gmail API Method: users.messages.send](https://developers.google.com/gmail/api/reference/rest/v1/users.messages/send){:target=_blank .external-link} documentation for more information.
## Send a message
Use this operation to send a message.
Enter these parameters:
* Select the **Credential to connect with** or create a new one.
* **Resource**: Select **Message**.
* **Operation**: Select **Send**.
* **To**: Enter the email address you want the email sent to.
* **Subject**: Enter the subject line.
* Select the **Email Type**. Choose from **Text** or **HTML**.
* **Message**: Enter the email message body.
### Send options
Use these options to further refine the node's behavior:
* **Append n8n attribution**: By default, the node appends the statement `This email was sent automatically with n8n` to the end of the email. To remove this statement, turn this option off.
* **Attachments**: Select **Add Attachment** to add an attachment. Enter the **Attachment Field Name (in Input)** to identify which field from the input node contains the attachment.
* For multiple properties, enter a comma-separated list.
* **BCC**: Enter one or more email addresses for blind copy recipients. Separate multiple email addresses with a comma, for example `jay@gatsby.com, jon@smith.com`.
* **CC**: Enter one or more email addresses for carbon copy recipients. Separate multiple email addresses with a comma, for example `jay@gatsby.com, jon@smith.com`.
* **Sender Name**: Enter the name you want displayed in your recipients' email as the sender.
* **Send Replies To**: Enter an email address to set as the reply to address.
* **Reply to Sender Only**: Choose whether to reply all (turned off) or reply to the sender only (turned on).
Refer to the [Gmail API Method: users.messages.send](https://developers.google.com/gmail/api/reference/rest/v1/users.messages/send){:target=_blank .external-link} documentation for more information.
## Common issues
For common errors or issues and suggested resolution steps, refer to [Common Issues](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/common-issues/).

167
docs/integrations/builtin/app-nodes/n8n-nodes-base.gmail/thread-operations.md Normal file
View File

@@ -0,0 +1,167 @@
---
#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
title: Gmail node Thread Operations documentation
description: Learn how to use the Thread Operations of the Gmail node in n8n. Follow technical documentation to integrate Thread Operations into your workflows.
contentType: integration
priority: high
---
# Gmail node Thread Operations
Use the Thread operations to delete, reply to, trash, untrash, add/remove labels, get one, or list threads. Refer to the [Gmail node](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/) for more information on the Gmail node itself.
## Add Label to a thread
Use this operation to create a new draft.
Enter these parameters:
* Select the **Credential to connect with** or create a new one.
* **Resource**: Select **Thread**.
* **Operation**: Select **Add Label**.
* **Thread ID**: Enter the ID of the thread you want to add the label to.
* **Label Names or IDs**: Select the Label names you want to apply or enter an expression to specify IDs. The dropdown populates based on the **Credential** you selected.
<!-- vale off -->
Refer to the [Gmail API Method: users.threads.modify](https://developers.google.com/gmail/api/reference/rest/v1/users.threads/modify){:target=_blank .external-link} documentation for more information.
<!-- vale on -->
## Delete a thread
Use this operation to immediately and permanently delete a thread and all its messages.
/// note | Permanent deletion
This operation can't be undone. For recoverable deletions, use the [Trash operation](#trash-a-thread) instead.
///
Enter these parameters:
* Select the **Credential to connect with** or create a new one.
* **Resource**: Select **Thread**.
* **Operation**: Select **Delete**.
* **Thread ID**: Enter the ID of the thread you want to delete.
Refer to the [Gmail API Method: users.threads.delete](https://developers.google.com/gmail/api/reference/rest/v1/users.threads/delete){:target=_blank .external-link} documentation for more information.
## Get a thread
Use this operation to get a single thread.
Enter these parameters:
* Select the **Credential to connect with** or create a new one.
* **Resource**: Select **Thread**.
* **Operation**: Select **Get**.
* **Thread ID**: Enter the ID of the thread you wish to retrieve.
* **Simplify**: Choose whether to return a simplified version of the response (turned on) or the raw data (turned off). Default is on.
* This is the same as setting the `format` for the API call to `metadata`, which returns email message IDs, labels, and email headers, including: From, To, CC, BCC, and Subject.
### Get thread options
Use these options to further refine the node's behavior:
* **Return Only Messages**: Choose whether to return only thread messages (turned on).
Refer to the [Gmail API Method: users.threads.get](https://developers.google.com/gmail/api/reference/rest/v1/users.threads/get){:target=_blank .external-link} documentation for more information.
<!-- vale off -->
## Get Many threads
<!-- vale on -->
Use this operation to get two or more threads.
Enter these parameters:
* Select the **Credential to connect with** or create a new one.
* **Resource**: Select **Thread**.
* **Operation**: Select **Get Many**.
* **Return All**: Choose whether the node returns all threads (turned on) or only up to a set limit (turned off).
* **Limit**: Enter the maximum number of threads to return. Only used if you've turned off **Return All**.
<!-- vale off -->
### Get Many threads filters
<!-- vale on -->
Use these filters to further refine the node's behavior:
* **Include Spam and Trash**: Select whether the node should get threads in the Spam and Trash folders (turned on) or not (turned off).
* **Label Names or IDs**: Only return threads 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 filter the threads returned. 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**.
* **Received After**: Return only those emails received after the specified date and time. Use the date picker to select the day and time or enter an expression to set a date as a string in ISO format or a timestamp in milliseconds. Refer to [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601){:target=_blank .external-link} for more information on formatting the string.
* **Received Before**: Return only those emails received before the specified date and time. Use the date picker to select the day and time or enter an expression to set a date as a string in ISO format or a timestamp in milliseconds. Refer to [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601){:target=_blank .external-link} for more information on formatting the string.
Refer to the [Gmail API Method: users.threads.list](https://developers.google.com/gmail/api/reference/rest/v1/users.threads/list){:target=_blank .external-link} documentation for more information.
## Remove label from a thread
Use this operation to remove a label from a thread.
Enter these parameters:
* Select the **Credential to connect with** or create a new one.
* **Resource**: Select **Thread**.
* **Operation**: Select **Remove Label**.
* **Thread ID**: Enter the ID of the thread you want to remove the label from.
* **Label Names or IDs**: Select the Label names you want to remove or enter an expression to specify their IDs. The dropdown populates based on the **Credential** you selected.
<!-- vale off -->
Refer to the [Gmail API Method: users.threads.modify](https://developers.google.com/gmail/api/reference/rest/v1/users.threads/modify){:target=_blank .external-link} documentation for more information.
<!-- vale on -->
## Reply to a message
Use this operation to reply to a message.
Enter these parameters:
* Select the **Credential to connect with** or create a new one.
* **Resource**: Select **Thread**.
* **Operation**: Select **Reply**.
* **Thread ID**: Enter the ID of the thread you want to reply to.
* **Message Snippet or ID**: Select the Message you want to reply to or enter an expression to specify its ID. The dropdown populates based on the **Credential** you selected.
* Select the **Email Type**. Choose from **Text** or **HTML**.
* **Message**: Enter the email message body.
### Reply options
Use these options to further refine the node's behavior:
* **Attachments**: Select **Add Attachment** to add an attachment. Enter the **Attachment Field Name (in Input)** to identify which field from the input node contains the attachment.
* For multiple properties, enter a comma-separated list.
* **BCC**: Enter one or more email addresses for blind copy recipients. Separate multiple email addresses with a comma, for example `jay@gatsby.com, jon@smith.com`.
* **CC**: Enter one or more email addresses for carbon copy recipients. Separate multiple email addresses with a comma, for example `jay@gatsby.com, jon@smith.com`.
* **Sender Name**: Enter the name you want displayed in your recipients' email as the sender.
* **Reply to Sender Only**: Choose whether to reply all (turned off) or reply to the sender only (turned on).
Refer to the [Gmail API Method: users.messages.send](https://developers.google.com/gmail/api/reference/rest/v1/users.messages/send){:target=_blank .external-link} documentation for more information.
## Trash a thread
Use this operation to move a thread and all its messages to the trash.
Enter these parameters:
* Select the **Credential to connect with** or create a new one.
* **Resource**: Select **Thread**.
* **Operation**: Select **Trash**.
* **Thread ID**: Enter the ID of the thread you want to move to the trash.
Refer to the [Gmail API Method: users.threads.trash](https://developers.google.com/gmail/api/reference/rest/v1/users.threads/trash){:target=_blank .external-link} documentation for more information.
## Untrash a thread
Use this operation to recover a thread and all its messages from the trash.
Enter these parameters:
* Select the **Credential to connect with** or create a new one.
* **Resource**: Select **Thread**.
* **Operation**: Select **Untrash**.
* **Thread ID**: Enter the ID of the thread you want to move to the trash.
Refer to the [Gmail API Method: users.threads.untrash](https://developers.google.com/gmail/api/reference/rest/v1/users.threads/untrash){:target=_blank .external-link} documentation for more information.
## Common issues
For common errors or issues and suggested resolution steps, refer to [Common Issues](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/common-issues/).

9
docs/integrations/builtin/credentials/google/index.md
View File

@@ -11,7 +11,7 @@ This section contains:
* [OAuth2 single service](/integrations/builtin/credentials/google/oauth-single-service/): Create an OAuth2 credential for a specific service node, such as the Gmail node.
* [OAuth2 generic](/integrations/builtin/credentials/google/oauth-generic/): Create an OAuth2 credential for use with [custom operations](/integrations/custom-operations/).
* [Service Account](/integrations/builtin/credentials/google/service-account/): Create a [Service Account](https://cloud.google.com/iam/docs/service-account-overview){:target=_blank .external-link} credential for some specific service nodes, such as the Gmail node.
* [Service Account](/integrations/builtin/credentials/google/service-account/): Create a [Service Account](https://cloud.google.com/iam/docs/service-account-overview){:target=_blank .external-link} credential for some specific service nodes.
* [Google PaLM and Gemini](/integrations/builtin/credentials/google/googleai/): Get your API key to work with Google PaLM and Google Gemini nodes.
@@ -33,7 +33,7 @@ Once configured, you can use your credentials to authenticate the following node
| :--- | :---: | :-------------: |
| [G Suite Admin](/integrations/builtin/app-nodes/n8n-nodes-base.gsuiteadmin/) | :white_check_mark: | :x: |
| [Google Ads](/integrations/builtin/app-nodes/n8n-nodes-base.googleads/) | :white_check_mark: | :x: |
| [Gmail](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/) | :white_check_mark: | :white_check_mark: |
| [Gmail](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/) | :white_check_mark: | :warning: |
| [Google Analytics](/integrations/builtin/app-nodes/n8n-nodes-base.googleanalytics/) | :white_check_mark: | :x: |
| [Google BigQuery](/integrations/builtin/app-nodes/n8n-nodes-base.googlebigquery/) | :white_check_mark: | :white_check_mark: |
| [Google Books](/integrations/builtin/app-nodes/n8n-nodes-base.googlebooks/) | :white_check_mark: | :white_check_mark: |
@@ -54,3 +54,8 @@ Once configured, you can use your credentials to authenticate the following node
| [Google Translate](/integrations/builtin/app-nodes/n8n-nodes-base.googletranslate/) | :white_check_mark: | :white_check_mark: |
| [YouTube](/integrations/builtin/app-nodes/n8n-nodes-base.youtube/) | :white_check_mark: | :x: |
/// warning | Gmail and Service Accounts
Google technically supports Service Accounts for use with Gmail, but it requires enabling domain-wide delegation, which Google discourages, and its behavior can be inconsistent.
n8n recommends using OAuth2 with the Gmail node.
///

23
docs/integrations/builtin/credentials/google/service-account.md
View File

@@ -69,7 +69,8 @@ With the Google project and credentials fully configured, finish the n8n credent
If you're running an n8n version older than 0.156.0, replace all instances of `\n` in the JSON file with new lines.
///
4. **Optional**: Choose if you want to [**Impersonate a User**](https://developers.google.com/identity/protocols/oauth2/service-account#delegatingauthority){:target=_blank .external-link}(turned on).
4. **Optional**: Choose if you want to [**Impersonate a User**](https://developers.google.com/identity/protocols/oauth2/service-account#delegatingauthority){:target=_blank .external-link} (turned on).
1. To use this option, you must [Enable domain-wide delegation](#enable-domain-wide-delegation) for the service account as a Google Workspace super admin.
1. Enter the **Email** of the user you want to impersonate.
5. If you plan to use this credential with the [HTTP Request](/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/) node, turn on **Set up for use in HTTP Request node**.
1. With this setting turned on, you'll need to add **Scope(s)** for the node. n8n prepopulates some scopes. Refer to [OAuth 2.0 Scopes for Google APIs](https://developers.google.com/identity/protocols/oauth2/scopes){:target=_blank .external-link} for more information.
@@ -95,3 +96,23 @@ A Service Account can't access Google Drive files and folders that weren't share
4. Paste your Service Account email into **Add People and groups**.
5. Select **Editor** for read-write access or **Viewer** for read-only access.
### Enable domain-wide delegation
To impersonate a user with a service account, you must enable domain-wide delegation for the service account.
/// warning | Not recommended
Google recommends you [avoid using domain-wide delegation](https://cloud.google.com/iam/docs/best-practices-service-accounts#domain-wide-delegation){:target=_blank .external-link}, as it allows impersonation of any user (including super admins) and can pose a security risk.
///
To delegate domain-wide authority to a service account, you must be a super administrator for the Google Workspace domain. Then:
1. From your Google Workspace domain's [Admin console](https://admin.google.com/){:target=_blank .external-link}, select the hamburger menu, then select **Security > Access and data control > API Controls**.
2. In the **Domain wide delegation** pane, select **Manage Domain Wide Delegation**.
3. Select **Add new**.
4. In the **Client ID** field, enter the service account's **Client ID**. To get the Client ID:
* Open your Google Cloud Console project, then open the [Service Accounts](https://console.cloud.google.com/iam-admin/serviceaccounts){:target=_blank .external-link} page.
* Copy the **OAuth 2 Client ID** and use this as the **Client ID** for the **Domain Wide Delegation**.
5. In the **OAuth scopes** field, enter a list of comma-separate scopes to grant your application access. For example, if your application needs domain-wide full access to the Google Drive API and the Google Calendar API, enter: `https://www.googleapis.com/auth/drive, https://www.googleapis.com/auth/calendar`.
6. Select **Authorize**.
It can take from 5 minutes up to 24 hours before you can impersonate all users in your Workspace.

7
mkdocs.yml
View File

@@ -488,7 +488,12 @@ nav:
- Ghost: integrations/builtin/app-nodes/n8n-nodes-base.ghost.md
- GitHub: integrations/builtin/app-nodes/n8n-nodes-base.github.md
- GitLab: integrations/builtin/app-nodes/n8n-nodes-base.gitlab.md
- Gmail: integrations/builtin/app-nodes/n8n-nodes-base.gmail.md
- Gmail:
- Gmail: integrations/builtin/app-nodes/n8n-nodes-base.gmail/index.md
- Draft operations: integrations/builtin/app-nodes/n8n-nodes-base.gmail/draft-operations.md
- Label operations: integrations/builtin/app-nodes/n8n-nodes-base.gmail/label-operations.md
- Message operations: integrations/builtin/app-nodes/n8n-nodes-base.gmail/message-operations.md
- Thread operations: integrations/builtin/app-nodes/n8n-nodes-base.gmail/thread-operations.md
- Google Ads: integrations/builtin/app-nodes/n8n-nodes-base.googleads.md
- Google Analytics: integrations/builtin/app-nodes/n8n-nodes-base.googleanalytics.md
- Google BigQuery: integrations/builtin/app-nodes/n8n-nodes-base.googlebigquery.md