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 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.
Refer to the Gmail API Method: users.messages.modify documentation for more information.
Delete a message#
Use this operation to immediately and permanently delete a message.
Permanent deletion
This operation can't be undone. For recoverable deletions, use the Thread Trash operation 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 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 tometadata
, which returns email message IDs, labels, and email headers, including: From, To, CC, BCC, and Subject.
- This is the same as setting the
Refer to the Gmail API Method: users.messages.get documentation for more information.
Get Many messages#
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 tometadata
, which returns email message IDs, labels, and email headers, including: From, To, CC, BCC, and Subject.
- This is the same as setting the
Get Many messages filters#
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 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 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 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 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.
Refer to the Gmail API Method: users.messages.modify documentation for more information.
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.
Refer to the Gmail API Method: users.messages.modify documentation for more information.
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.
Refer to the Gmail API Method: users.messages.modify documentation for more information.
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 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 documentation for more information.
Common issues#
For common errors or issues and suggested resolution steps, refer to Common Issues.