- Get started
- Build
- HTTP Request
- How connector nodes work
- Create a connection
- Sales and customer relationships
- Customer support and help desk
- Messaging and meetings
- Email
- Marketing
- Social media
- Files, documents, and e-signature
- Projects, collaboration, and code
- People and recruiting
- Finance and commerce
- AI models and agents
- Speech, vision, and language
- Data and location
- Cloud, identity, and security
- Deploy and run
- Examples
- Reference
Gmail
Look up the Gmail connector: its actions and events in alphabetical order, and the sign-in methods of a Gmail connection.
The Gmail connector lets a workflow read, send, label, and organize email, and manage calendar events. In the Add node panel, it's in the Connector category, under Gmail. How connector nodes work describes how a connector node is set up.
This page lists what the connector can do in Maestro Automate. Select an event to see its details in the Integration Service guide.
Actions
Each action is a node that does one thing in Gmail.
| Action | What it does |
|---|---|
| Apply Gmail Labels | Apply labels to a mail in Gmail. |
| Archive Email | Archive an email in Gmail. |
| Create Event (Calendar Event) | Create an event in calendar and send invites to attendees. |
| Delete Email | Delete an email permanently or move it to trash in Gmail. |
| Delete Event (Calendar Event) | Delete or cancel a calendar event. |
| Download Email | Download an email with its content. |
| Download Email Attachment by Attachment ID | Download an attachment from email by attachment ID. |
| Download Email Attachment by File Name | Download an attachment from email by file name. |
| Forward Email | Forward an email in Gmail to another recipient. |
| Forward Event | Forward calendar event or calendar event series based on calendar event ID. |
| Get Calendars | Get list of calendars accessible to user. |
| Get Email by ID | Fetch an email based on ID. |
| Get Email List | List emails according to filter criteria. |
| Get Event by ID (Calendar Event) | Get a calendar event details based on calendar event ID. |
| Get Event List | List events according to filter criteria. |
| Get Gmail Labels | Fetch list of labels/folders user has access to. |
| Get Newest Email | Fetch newest email from the list of emails in specified folder. |
| Get Single Gmail Label | Fetch single label information based on ID. |
| List Email Attachments | Get list of all attachments present in an email. |
| Mark Email As Read or Unread | Mark Email as Read or Unread. |
| Move Email | Move an email in Gmail to a folder or label. |
| Remove Gmail Labels | Remove a label from a mail in Gmail. |
| Reply to Email | Send a reply to an email based on email ID. |
| Respond to Event Invitation (Calendar Event) | Response to an calendar event invitation. |
| Send Email | Send an email message. |
| Turn off Automatic Replies | Turn off automatic replies for mail received. |
| Turn on Automatic Replies | Turn on automatic replies to email messages. |
| Update Event (Calendar Event) | Update an event in calendar. |
The panel also lists 6 actions marked (deprecated), which aren't listed here. Use the actions above instead.
Events
Each event can start a workflow, as a Connector trigger, or pause a run until it happens, as a Connector event. In the connector's list, events have the WAIT tag.
| Event | What it does |
|---|---|
| Calendar Event Created | Triggers when a calendar event is created. |
| Calendar Event Received | Triggers when a calendar event invitation is received. |
| Calendar Event Replied | Triggers when a calendar event invitation replied. |
| Calendar Event Updated | Triggers when a calendar event is changed. |
| Email Moved to Trash | Triggers when an email is moved to trash. |
| Email Received | Triggers when an email is received in your inbox. |
| Email Sent | Triggers when an email is sent. |
| Existing Record Deleted | Triggers when an existing record is deleted. |
| Existing Record Updated | Triggers when an existing record is updated. |
| New Record Created | Triggers when you add a new record. |
Connection
A Gmail node signs in through a connection. Create a connection describes how to create one from the node. On the Connect to page, choose one of these sign-in methods:
| Sign-in method | What you need |
|---|---|
| OAuth 2.0 Authorization code | The email address and password of your Google account. |
| Bring your own OAuth 2.0 app | The client ID, client secret, and scopes of an app that you create in Google Cloud. |
| Service account | The key and email address of a Google service account. |
Gmail authentication in the Integration Service guide describes the full connection setup, including prerequisites and advanced settings.
Next steps
- Connector: every connector, grouped by area.
- Create a connection: sign a workflow in to an app.
- Community: ask questions and share workflows with other builders on the UiPath Forum.