Google Mail

Overview

Gmail, Google’s email service, offers a comprehensive platform for communication and productivity. With features like advanced search capabilities, powerful filters, and seamless integration with other Google Workspace tools, Gmail is a cornerstone of modern email management.

By integrating Suger with Gmail, users can leverage automation workflows to enhance email productivity. Tasks such as sending emails, applying labels for organization, and managing threads can be automated, improving efficiency and enabling customized email workflows tailored to specific needs.

Org-Level vs User-Level

When to use Org-Level: Use org-level integration when you want all users in your organization to have access to Gmail data through a shared service account. Best for company-wide data access.

When to use User-Level: Use user-level integration when each user needs to connect their personal Google Mail account. Each user authenticates with their own credentials.

Create Integration (Org-Level)

Authenticate by OAuth2.0 (Recommended)

Click the Connect Now button, select OAuth2.0 as the authentication method, and click Create. You will be redirected to the Google OAuth2.0 authentication page.

Click the Allow button to grant Suger permission to access your Gmail account. This authorization enables Suger to send emails on your behalf.

After the authorization is granted, you will be redirected to the Suger console. You can see the integration is connected successfully.
Verify the integration by clicking the Verify button. If the integration is successful, you will see the Verified status.

Authenticate by a Service Account

Create a service account in your target GCP project for Google Mail integration.
Info
- Grant the service account with the IAM role Service Account Token Creator under the GCP project.
Enable the Gmail API in the same Google project.
Create the service account key, and download the associated JSON file. It is required for the following integration.
Enable G-Suite Domain-wide Delegation for the service account.
Info
- In the “OAuth Scopes” field, only select the scope https://www.googleapis.com/auth/gmail.send.
Specify the impersonated email address, select the appropriate scopes configured in the previous step, and store the JSON key file contents within the Suger console integration page.
Info
- Enter the Impersonation Email (an user email from your company) that Suger will impersonate to send emails on behalf of the user. It MUST be user email, instead of group email, since the group email can’t be impersonated.
- Select only the scope https://www.googleapis.com/auth/gmail.send.

Create User Integration

Click Connect Now button in the User Integrations section, you will be redirected to the Google OAuth2.0 authentication page.

Click the Allow button to grant Suger permission to access your Google mail account. This authorization enables Suger to read and send emails on your behalf.

After the authorization is granted, you will be redirected to the Suger console. You can see the integration is connected successfully.
Verify the integration by clicking the Verify button. If the integration is successful, you will see the Verified status.

Suger AI Tools

Suger AI uses a middleware strategy — wrapping the Gmail API directly.

Org-level and user-level: Both integration levels are supported. User-level takes precedence when both are connected.

Profile & Labels

Tool	Description
`googlemail_get_profile`	Get the authenticated user’s Gmail profile
`googlemail_list_labels`	List all Gmail labels (system and user-created)

Messages

Tool	Description
`googlemail_list_messages`	List messages using Gmail search syntax
`googlemail_get_message`	Get a message (headers by default)
`googlemail_get_message_body`	Get a message with fully decoded body (plain text + HTML)
`googlemail_send_mail`	Send an email (plain text, HTML, or threaded reply)
`googlemail_reply_to_message`	Reply to a message, preserving thread
`googlemail_modify_message_labels`	Add or remove labels on a message
`googlemail_batch_modify_messages`	Apply label changes to up to 1,000 messages at once
`googlemail_get_attachment`	Download a message attachment
`googlemail_trash_message`	Move a message to Trash
`googlemail_untrash_message`	Restore a trashed message

Threads

Tool	Description
`googlemail_list_threads`	List conversation threads
`googlemail_get_thread`	Get all messages in a thread
`googlemail_modify_thread_labels`	Add or remove labels on an entire thread
`googlemail_trash_thread`	Trash an entire thread
`googlemail_untrash_thread`	Restore a trashed thread

Drafts

Tool	Description
`googlemail_list_drafts`	List drafts
`googlemail_create_draft`	Save an email as a draft
`googlemail_get_draft`	Get a draft
`googlemail_update_draft`	Replace a draft’s content
`googlemail_send_draft`	Send a previously saved draft
`googlemail_delete_draft`	Permanently delete a draft

Edit Integration

Editing is not supported for security reasons. To change configuration, delete the integration and create a new one.

Delete Integration

The Google Mail integration can be deleted like all other integrations. Once the deletion is triggered, all integration info including the service account with the key will be deleted immediately & permanently from Suger. No time window or methods to recover.