Gmail

Overview of the Gmail integration.

The following documentation is for Gmail v2.11.0.

Overview

Gmail is Google's comprehensive email service providing powerful messaging, organization, and collaboration features. This integration enables automated email sending, inbox management, message filtering, and email workflow automation. Streamline communication processes and enhance productivity through intelligent email automation.

Setup

The following integrations need to be connected to your Kognitos workspace:

• Gmail

Steps

Follow these steps to connect the integration in Kognitos:

1

Navigate

Using the left navigation menu, go to Integrations → Explore Integrations.

2

Find

Search for the integration and click on it.

3

Connect

Click on Connect to add a connection to the integration.

4

Configure

Add a name for the connection. You'll be prompted for authentication details if needed. Then, click on Connect.

Authentication

Use one of the following authentication methods to connect this integration in Kognitos. Each method has its own configuration requirements.

Continue with Google

To connect to the Gmail book, click on Continue with Google. This will redirect you to Google's secure authentication page where you can sign in with your Google account and authorize the application. Once connected, the Kognitos agent will have access to your Gmail account while keeping your credentials secure.

Actions

The following actions are available in the Gmail integration:

1. Add a label to an email

Add a label to one or more emails.

2. Create a draft email

Create a draft email in Gmail without sending it.

3. Download an email's attachments

Get an email attachment as an IO object.

4. Forward an email

Forward an email to new recipients.

5. Get some label's emails

Get emails from a specified label in Gmail.

6. Get the vacation responder

Get the user's Gmail vacation responder (out-of-office auto-reply) configuration.

7. List labels

Get all labels from the user's Gmail account.

8. Remove a label from an email

Remove a label from one or more emails.

9. Reply an email

Reply to an email.

10. Send a draft email

Send an existing draft email.

11. Send an email

Send an email using Gmail API.

12. Update the vacation responder

Update the user's Gmail vacation responder (out-of-office auto-reply).

Concepts

Gmail email

A Gmail Email represents an email message in Gmail.

Field Name	Description	Type
id	The unique identifier for the email.	text
thread_id	The unique identifier for the thread containing the email.	text
labels	The list of labels applied to the email.	list of text
state	The state of the email (draft, unread, or read).	text
sender	The sender of the email.	text
recipients	The recipients of the email.	list of text
message_id	The unique identifier for the message.	optional[text]
cc_recipients	The cc recipients of the email.	optional[list of text]
bcc_recipients	The bcc recipients of the email.	optional[list of text]
attachments	The attachments of the email.	optional[list of gmail attachment reference]
draft_id	The draft ID, if this email is a draft.	optional[text]
subject	The subject of the email.	optional[text]
plain_body	The plain text body of the email.	optional[text]
html_body	The html body of the email.	optional[text]
sent_date_time	The date and time the email was sent.	optional[datetime]
received_date_time	The date and time the email was received.	optional[datetime]

Gmail attachment reference

A Gmail Attachment Reference represents a reference to a file attached to an email in Gmail.

Field Name	Description	Type
id	The unique identifier for the attachment.	text
email_id	The unique identifier for the email.	text
file_name	The name of the attachment.	text
file_size	The size of the file in bytes.	number

Gmail attachment

A Gmail Attachment represents a file with name.

Field Name	Description	Type
file_name	The name of the attachment.	text
content	The content of the attachment.	file

Vacation responder

The Gmail vacation responder (out-of-office auto-reply) configuration.

Field Name	Description	Type
enabled	Whether the auto-reply is currently turned on.	optional[boolean]
subject	The subject line of the auto-reply.	optional[text]
body	The plain-text body of the auto-reply.	optional[text]
html_body	The HTML body of the auto-reply.	optional[text]
restrict_to_contacts	Whether to send the auto-reply only to people in the user's contacts.	optional[boolean]
restrict_to_domain	Whether to send the auto-reply only to people in the user's domain.	optional[boolean]
start_time	When the auto-reply starts being active.	optional[datetime]
end_time	When the auto-reply stops being active.	optional[datetime]