Sim

Gmail

Send, read, search, and move Gmail messages or trigger workflows from Gmail events

Gmail is Google's popular email service that provides a robust platform for sending, receiving, and managing email communications. With over 1.8 billion active users worldwide, Gmail offers a feature-rich experience with powerful search capabilities, organizational tools, and integration options.

With Gmail, you can:

  • Send and receive emails: Communicate with contacts through a clean, intuitive interface
  • Organize messages: Use labels, folders, and filters to keep your inbox organized
  • Search efficiently: Find specific messages quickly with Google's powerful search technology
  • Automate workflows: Create filters and rules to automatically process incoming emails
  • Access from anywhere: Use Gmail across devices with synchronized content and settings
  • Integrate with other services: Connect with Google Calendar, Drive, and other productivity tools

In Sim, the Gmail integration enables your agents to fully manage emails programmatically with comprehensive automation capabilities. This allows for powerful automation scenarios such as sending notifications, processing incoming messages, extracting information from emails, and managing communication workflows at scale. Your agents can:

  • Compose and send: Create personalized emails with attachments and send to recipients
  • Read and search: Find specific messages using Gmail's query syntax and extract content
  • Organize intelligently: Mark messages as read/unread, archive or unarchive emails, and manage labels
  • Clean up inbox: Delete messages, move emails between labels, and maintain inbox zero
  • Trigger workflows: Listen for new emails in real-time, enabling responsive workflows that react to incoming messages

This integration bridges the gap between your AI workflows and email communications, enabling seamless interaction with one of the world's most widely used communication platforms. Whether you're automating customer support responses, processing receipts, managing subscriptions, or coordinating team communications, the Gmail integration provides all the tools you need for comprehensive email automation.

Usage Instructions

Integrate Gmail into the workflow. Can send, read, search, and move emails. Can be used in trigger mode to trigger a workflow when a new email is received.

Tools

gmail_send

Send emails using Gmail

Input

ParameterTypeRequiredDescription
tostringYesRecipient email address
subjectstringNoEmail subject
bodystringYesEmail body content
contentTypestringNoContent type for the email body (text or html)
threadIdstringNoThread ID to reply to (for threading)
replyToMessageIdstringNoGmail message ID to reply to - use the "id" field from Gmail Read results (not the RFC "messageId")
ccstringNoCC recipients (comma-separated)
bccstringNoBCC recipients (comma-separated)
attachmentsfile[]NoFiles to attach to the email

Output

ParameterTypeDescription
contentstringSuccess message
metadataobjectEmail metadata

gmail_draft

Draft emails using Gmail

Input

ParameterTypeRequiredDescription
tostringYesRecipient email address
subjectstringNoEmail subject
bodystringYesEmail body content
contentTypestringNoContent type for the email body (text or html)
threadIdstringNoThread ID to reply to (for threading)
replyToMessageIdstringNoGmail message ID to reply to - use the "id" field from Gmail Read results (not the RFC "messageId")
ccstringNoCC recipients (comma-separated)
bccstringNoBCC recipients (comma-separated)
attachmentsfile[]NoFiles to attach to the email draft

Output

ParameterTypeDescription
contentstringSuccess message
metadataobjectDraft metadata

gmail_read

Read emails from Gmail

Input

ParameterTypeRequiredDescription
messageIdstringNoID of the message to read
folderstringNoFolder/label to read emails from
unreadOnlybooleanNoOnly retrieve unread messages
maxResultsnumberNoMaximum number of messages to retrieve (default: 1, max: 10)
includeAttachmentsbooleanNoDownload and include email attachments

Output

ParameterTypeDescription
contentstringText content of the email
metadatajsonMetadata of the email
attachmentsfile[]Attachments of the email

Search emails in Gmail

Input

ParameterTypeRequiredDescription
querystringYesSearch query for emails
maxResultsnumberNoMaximum number of results to return

Output

ParameterTypeDescription
contentstringSearch results summary
metadataobjectSearch metadata

gmail_move

Move emails between Gmail labels/folders

Input

ParameterTypeRequiredDescription
messageIdstringYesID of the message to move
addLabelIdsstringYesComma-separated label IDs to add (e.g., INBOX, Label_123)
removeLabelIdsstringNoComma-separated label IDs to remove (e.g., INBOX, SPAM)

Output

ParameterTypeDescription
contentstringSuccess message
metadataobjectEmail metadata

gmail_mark_read

Mark a Gmail message as read

Input

ParameterTypeRequiredDescription
messageIdstringYesID of the message to mark as read

Output

ParameterTypeDescription
contentstringSuccess message
metadataobjectEmail metadata

gmail_mark_unread

Mark a Gmail message as unread

Input

ParameterTypeRequiredDescription
messageIdstringYesID of the message to mark as unread

Output

ParameterTypeDescription
contentstringSuccess message
metadataobjectEmail metadata

gmail_archive

Archive a Gmail message (remove from inbox)

Input

ParameterTypeRequiredDescription
messageIdstringYesID of the message to archive

Output

ParameterTypeDescription
contentstringSuccess message
metadataobjectEmail metadata

gmail_unarchive

Unarchive a Gmail message (move back to inbox)

Input

ParameterTypeRequiredDescription
messageIdstringYesID of the message to unarchive

Output

ParameterTypeDescription
contentstringSuccess message
metadataobjectEmail metadata

gmail_delete

Delete a Gmail message (move to trash)

Input

ParameterTypeRequiredDescription
messageIdstringYesID of the message to delete

Output

ParameterTypeDescription
contentstringSuccess message
metadataobjectEmail metadata

gmail_add_label

Add label(s) to a Gmail message

Input

ParameterTypeRequiredDescription
messageIdstringYesID of the message to add labels to
labelIdsstringYesComma-separated label IDs to add (e.g., INBOX, Label_123)

Output

ParameterTypeDescription
contentstringSuccess message
metadataobjectEmail metadata

gmail_remove_label

Remove label(s) from a Gmail message

Input

ParameterTypeRequiredDescription
messageIdstringYesID of the message to remove labels from
labelIdsstringYesComma-separated label IDs to remove (e.g., INBOX, Label_123)

Output

ParameterTypeDescription
contentstringSuccess message
metadataobjectEmail metadata

Notes

  • Category: tools
  • Type: gmail
On this page

On this page

Start building today
Trusted by over 60,000 builders.
Build Agentic workflows visually on a drag-and-drop canvas or with natural language.
Get started