Skip to main content

Gmail

Gmail connector for reading, sending, and organizing messages, threads, drafts, labels, and attachments.

What you can ask​

  • Find every email from contacts at our top-10 accounts in the last 7 days that I haven't replied to.
  • Draft a follow-up reply to the latest message from customer@acme.com thanking them for the call.
  • Search for emails containing invoice from this month and forward them to accounting\@.

Set up​

Gmail is ready to enable, and an admin doesn't need to create anything first.

  1. Go to Organization > Connectors and find Gmail.
  2. Click Enable and choose which tools to allow.
  3. Each member connects their own account the first time they use it.

To use one account for the whole organization, turn on Share one connection with everyone. Every member's agents then act as that account, with exactly the access it has.

You can also use your own OAuth application instead of the shared one. Create it in the Gmail developer portal, then enter its details under Use your own OAuth application.

Tools​

Gmail offers 32 tools. Admins choose which ones agents can use. See Tool permission groups.

Read (14)​

View and search information without changing it.

ToolWhat it does
get_attachmentDownload an attachment from a message by attachment ID: raw base64url data, filename, MIME type, and size.
get_draftRetrieve complete details of a specific draft by ID including message content, headers, recipients, and metadata.
get_labelRetrieve detailed information about a specific label by ID including name, type, visibility, message counts, and colors.
get_messageRetrieve complete message details by ID including the raw MIME tree, all headers, base64-encoded body parts, attachments, and labels.
get_message_textRead one email's body as plain text, with From/To/Subject/Date, Message-ID, labels, and an attachment list.
get_profileGet the authenticated mailbox's own address plus its total message and thread counts.
get_threadRetrieve a complete conversation thread by ID including all messages in chronological order.
list_draftsList draft messages, newest first, with pagination.
list_labelsList all labels, both system and custom.
list_messagesSearch or list messages with Gmail query syntax (from:, subject:, is:unread, newer_than:, OR, -negation) and pagination.
list_send_as_addressesList the addresses this mailbox can send mail as, including aliases and delegated addresses.
list_threadsSearch or list conversation threads with Gmail query syntax and pagination.
read_attachment_textRead a message attachment as text; prefer over get_attachment to READ.
validate_credentialValidate Gmail credentials.

Write (5)​

Create or send data.

ToolWhat it does
create_draftCreate a draft with recipients, subject, and body.
create_forward_draftCreate a forward of an email as a draft without sending it.
create_labelCreate a custom label.
forward_messageForward an email to new recipients and send it immediately.
send_messageSend an email.

Delete or overwrite (13)​

Remove or replace existing data.

ToolWhat it does
batch_delete_messagesMove multiple messages to trash in one batch by adding the TRASH label to each.
batch_modify_messagesModify labels on multiple messages in one batch.
delete_draftPermanently delete a draft.
delete_labelPermanently delete a custom label.
delete_messageMove a message to trash by adding the TRASH label.
delete_threadMove every message in a thread to trash by adding the TRASH label.
modify_message_labelsAdd or remove labels from a message.
modify_thread_labelsAdd or remove labels from every message in a thread at once.
send_draftSend an existing draft immediately.
untrash_messageRestore a message from trash by removing the TRASH label.
untrash_threadRestore an entire conversation from trash by removing the TRASH label from its messages.
update_draftEdit an existing draft.
update_labelUpdate an existing label's properties including name, visibility, and colors.
⌘J