Gmail
App Vendor: Google
App Category: Email Gateway
Connector Version: 1.0.5
API Version: 1.0.0
Note
Before upgrading a Orchestrate instance to the 3.2.1.0 version, you must upgrade this app to the latest supported version and validate the functioning of the associated Playbooks.
About App
Gmail is a free email service provided by Google. The Gmail app enables security teams to integrate with the Gmail enterprise version to perform email related operations, such as read email, move email from one folder to another, delete email, and so on.
The Gmail app is configured with the Orchestrate application to perform the following actions:
Action Name | Description |
|---|---|
Delete Emails with Specific Email ID | This action deletes all emails with a specific sender email ID. |
Delete Emails with Specific Subject | This action deletes all emails having a specific subject. |
Get All Labels from Mailbox | This action retrieves the list of all labels from the mailbox. |
Get Details of all Unseen Emails from Inbox | This action retrieves the details of all unseen emails from the inbox. |
Get Unseen Emails of a User | This action retrieves the list of all unseen mails of a user. |
Move Email from One Folder to Another | This action moves emails from one folder to another. |
Read Emails by Query Filter from Specific Folder | This action filters emails from a folder specified by the user. |
Read Inbox Email with Subject | This action reads inbox emails with the subject provided. |
Configuration Parameters
The following configuration parameters are required for the Gmail app to communicate with the Gmail enterprise application. The parameters can be configured by creating instances in the app.
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
User Email ID | Enter the email ID. | Text | Required | |
Password | Enter the password. | Text | Required |
Action: Delete Emails with Specific Email ID
This action deletes all emails with a specific sender email ID.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Input Sender Email ID | Enter the email ID of the sender. | Text | Required | |
Input Folder Name | Enter the folder name. | Text | Optional | Default value: "inbox" |
Action: Delete Emails with Specific Subject
This action deletes all emails having a specific subject.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Input Email Subject | Enter the subject of the email. | Text | Required | |
Input Folder Name | Enter the folder name. | Text | Optional | Default value: "inbox" |
Action: Get All Labels from Mailbox
This action retrieves the list of all labels from the mailbox.
Action Input Parameters
This action does not require any input parameter.
Action: Get Details of all Unseen Emails from Inbox
This action retrieves the details of all unseen emails from the inbox.
Action Input Parameters
This action does not require any input parameter.
Action: Get Unseen Emails of a User
This action retrieves the list of all unseen mails of a user.
Action Input Parameters
This action does not require any input parameter.
Action: Move Email from One Folder to Another
This action moves emails from one folder to another.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Input Sender Email ID to Filter the Emails | Enter the email ID of the sender. | Text | Required | |
Input Source Folder Name to Get the Email | Enter the source folder name. | Text | Optional | Default value: "inbox" |
Input Destination Folder Name | Enter the source folder name. | Text | Optional | Default value: "trash" |
Action: Read Emails by Query Filter from Specific Folder
This action filters emails from a folder specified by the user.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Input Folder Name | Enter the folder name. | Text | Optional | Default value: "inbox" |
Input Flag Type of Email you Want to Get | Enter the flag type. | Text | Optional | |
Input Sender Email ID | Enter the email ID of the sender. | Text | Optional | Default value: None |
Input Email Subject | Enter the subject of the email. | Text | Optional | Default value: None |
Input Number of Days Since you Want to Get Emails | Enter the number of days since you want to get emails from current date. | Integer | Optional | Default value: 1 |
Input Number of Days Before you Want to Get Emails | Enter the number of days before you want to get emails from current date. | Integer | Optional | Default value: 1 |
Action: Read Inbox Email with Subject
This action reads inbox emails with the subject provided.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Email Subject | Enter the subject of the email to be searched. | Text | Required |