Gmail

Configuration

Gmail source connector integrates with the Gmail API to extract and synchronize email data.

Connects to your Gmail account.

It supports syncing email threads, individual messages, and file attachments.

Explore the Gmail connector implementation

Authentication

This connector uses OAuth 2.0 with custom credentials. You need to provide your OAuth application’s Client ID and Client Secret in the Airweave UI, then go through the OAuth consent screen.

OAuth Setup Required

Create an OAuth application in your provider’s developer console
Enter your Client ID and Client Secret in the Airweave UI
Complete the OAuth consent flow when connecting the source

Configuration Options

This connector does not have any additional configuration options.

Data Models

The following data models are available for this connector:

GmailThreadEntity

Schema for Gmail thread entities.

Reference: https://developers.google.com/gmail/api/reference/rest/v1/users.threads

Field	Type	Description
snippet	Optional[str]	A short snippet from the thread
history_id	Optional[str]	The thread’s history ID
message_count	Optional[int]	Number of messages in the thread
label_ids	List[str]	Labels applied to this thread
last_message_date	Optional[datetime]	Date of the last message

GmailMessageEntity

Schema for Gmail message entities.

Reference: https://developers.google.com/gmail/api/reference/rest/v1/users.messages

Field	Type	Description
thread_id	str	ID of the thread this message belongs to
subject	Optional[str]	Subject line of the message
sender	Optional[str]	Email address of the sender
to	List[str]	Recipients of the message
cc	List[str]	CC recipients
bcc	List[str]	BCC recipients
date	Optional[datetime]	Date the message was sent
snippet	Optional[str]	Brief snippet of the message content
body_plain	Optional[str]	Plain text message body
body_html	Optional[str]	HTML message body
label_ids	List[str]	Labels applied to this message
internal_date	Optional[datetime]	Internal Gmail timestamp
size_estimate	Optional[int]	Estimated size in bytes

GmailAttachmentEntity

Schema for Gmail attachment entities.

Reference: https://developers.google.com/gmail/api/reference/rest/v1/users.messages.attachments

Field	Type	Description
message_id	str	ID of the message this attachment belongs to
attachment_id	str	Gmail’s attachment ID
thread_id	str	ID of the thread containing the message
metadata	Optional[Dict[str, Any]]	Additional metadata about the attachment

Integrate Airweave with Google APIs on localhost

This guide will walk you through connecting Google Workspace APIs to Airweave when running locally. Google provides extensive documentation on setting up your workspace. Below is a streamlined process for connecting Google APIs to Airweave.

Create a Google Cloud project for your Google Workspace (if you don’t already have one)
Enable the Google Workspace APIs for Gmail, Google Calendar, and Google Drive
Configure Google OAuth 2.0 consent screen
Under Audience, select Make external and add test users
Under Data Access, add the following scopes:

https://www.googleapis.com/auth/docs
https://www.googleapis.com/auth/drive.photos.readonly
https://www.googleapis.com/auth/drive
https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive.metadata
https://www.googleapis.com/auth/drive.metadata.readonly
https://www.googleapis.com/auth/gmail.readonly
https://www.googleapis.com/auth/calendar.events.public.readonly
https://www.googleapis.com/auth/calendar.freebusy
https://www.googleapis.com/auth/calendar.readonly
https://www.googleapis.com/auth/calendar.calendars.readonly
https://www.googleapis.com/auth/calendar.events.owned.readonly
https://www.googleapis.com/auth/calendar.events.readonly

Create OAuth client ID credentials

Under “Authorized redirect URIs,” click ”+ Add URI” and add the following URIs:

http://localhost:8080/auth/callback/gmail

http://localhost:8080/auth/callback/google_calendar

http://localhost:8080/auth/callback/google_drive

Locate the client ID and client secret from your newly created OAuth client. Add these credentials to the dev.integrations.yml file to enable Google API integration.