Gmail Integration ↗

Parameters:

• userId (string, required): The user’s email address or ‘me’ for the authenticated user. (default: “me”)

• q (string, optional): Search query to filter messages (e.g., ‘from:someone@example.com is:unread’).

• maxResults (integer, optional): Maximum number of messages to return (1-500). (default: 100)

• pageToken (string, optional): Page token to retrieve a specific page of results.

• labelIds (array, optional): Only return messages with labels that match all of the specified label IDs.

• includeSpamTrash (boolean, optional): Include messages from SPAM and TRASH in the results. (default: false)

Description: Send an email.

Parameters:

• to (string, required): Recipient email address.

• subject (string, required): Email subject line.

• body (string, required): Email message content.

• userId (string, optional): The user’s email address or ‘me’ for the authenticated user. (default: “me”)

• cc (string, optional): CC email addresses (comma-separated).

• bcc (string, optional): BCC email addresses (comma-separated).

• from (string, optional): Sender email address (if different from authenticated user).

• replyTo (string, optional): Reply-to email address.

• threadId (string, optional): Thread ID if replying to an existing conversation.

Description: Delete an email by ID.

Parameters:

• userId (string, required): The user’s email address or ‘me’ for the authenticated user.

• id (string, required): The ID of the message to delete.

Description: Create a new draft email.

Parameters:

• userId (string, required): The user’s email address or ‘me’ for the authenticated user.

• message (object, required): Message object containing the draft content.

  • raw (string, required): Base64url encoded email message.

Description: Retrieve a specific message by ID.

Parameters:

• userId (string, required): The user’s email address or ‘me’ for the authenticated user. (default: “me”)

• id (string, required): The ID of the message to retrieve.

• format (string, optional): The format to return the message in. Options: “full”, “metadata”, “minimal”, “raw”. (default: “full”)

• metadataHeaders (array, optional): When given and format is METADATA, only include headers specified.

Description: Retrieve a message attachment.

Parameters:

• userId (string, required): The user’s email address or ‘me’ for the authenticated user. (default: “me”)

• messageId (string, required): The ID of the message containing the attachment.

• id (string, required): The ID of the attachment to retrieve.

Description: Retrieve a specific email thread by ID.

Parameters:

• userId (string, required): The user’s email address or ‘me’ for the authenticated user. (default: “me”)

• id (string, required): The ID of the thread to retrieve.

• format (string, optional): The format to return the messages in. Options: “full”, “metadata”, “minimal”. (default: “full”)

• metadataHeaders (array, optional): When given and format is METADATA, only include headers specified.

Description: Modify the labels applied to a thread.

Parameters:

• userId (string, required): The user’s email address or ‘me’ for the authenticated user. (default: “me”)

• id (string, required): The ID of the thread to modify.

• addLabelIds (array, optional): A list of IDs of labels to add to this thread.

• removeLabelIds (array, optional): A list of IDs of labels to remove from this thread.

Description: Move a thread to the trash.

Parameters:

• userId (string, required): The user’s email address or ‘me’ for the authenticated user. (default: “me”)

• id (string, required): The ID of the thread to trash.

Description: Remove a thread from the trash.

Parameters:

• userId (string, required): The user’s email address or ‘me’ for the authenticated user. (default: “me”)
• id (string, required): The ID of the thread to untrash.

Usage Examples#

Basic Gmail Agent Setup#

from crewai import Agent, Task, Crew

# Create an agent with Gmail capabilities
gmail_agent = Agent(
    role="Email Manager",
    goal="Manage email communications and messages efficiently",
    backstory="An AI assistant specialized in email management and communication.",
    apps=['gmail']  # All Gmail actions will be available
)

# Task to send a follow-up email
send_email_task = Task(
    description="Send a follow-up email to john@example.com about the project update meeting",
    agent=gmail_agent,
    expected_output="Email sent successfully with confirmation"
)

# Run the task
crew = Crew(
    agents=[gmail_agent],
    tasks=[send_email_task]
)

crew.kickoff()

Filtering Specific Gmail Tools#

from crewai import Agent, Task, Crew

# Create agent with specific Gmail actions only
email_coordinator = Agent(
    role="Email Coordinator",
    goal="Coordinate email communications and manage drafts",
    backstory="An AI assistant that focuses on email coordination and draft management.",
    apps=[
        'gmail/send_email',
        'gmail/fetch_emails',
        'gmail/create_draft'
    ]
)

# Task to prepare and send emails
email_coordination = Task(
    description="Search for emails from the marketing team, create a summary draft, and send it to stakeholders",
    agent=email_coordinator,
    expected_output="Summary email sent to stakeholders"
)

crew = Crew(
    agents=[email_coordinator],
    tasks=[email_coordination]
)

crew.kickoff()

Email Search and Analysis#

from crewai import Agent, Task, Crew

# Create agent with Gmail search and analysis capabilities
email_analyst = Agent(
    role="Email Analyst",
    goal="Analyze email patterns and provide insights",
    backstory="An AI assistant that analyzes email data to provide actionable insights.",
    apps=['gmail/fetch_emails', 'gmail/get_message']  # Specific actions for email analysis
)

# Task to analyze email patterns
analysis_task = Task(
    description="""
    Search for all unread emails from the last 7 days,
    categorize them by sender domain,
    and create a summary report of communication patterns
    """,
    agent=email_analyst,
    expected_output="Email analysis report with communication patterns and recommendations"
)

crew = Crew(
    agents=[email_analyst],
    tasks=[analysis_task]
)

crew.kickoff()

Thread Management#

from crewai import Agent, Task, Crew

# Create agent with Gmail thread management capabilities
thread_manager = Agent(
    role="Thread Manager",
    goal="Organize and manage email threads efficiently",
    backstory="An AI assistant that specializes in email thread organization and management.",
    apps=[
        'gmail/fetch_thread',
        'gmail/modify_thread',
        'gmail/trash_thread'
    ]
)

# Task to organize email threads
thread_task = Task(
    description="""
    1. Fetch all threads from the last month
    2. Apply appropriate labels to organize threads by project
    3. Archive or trash threads that are no longer relevant
    """,
    agent=thread_manager,
    expected_output="Email threads organized with appropriate labels and cleanup completed"
)

crew = Crew(
    agents=[thread_manager],
    tasks=[thread_task]
)

crew.kickoff()

Getting Help#

Contact our support team for assistance with Gmail integration setup or troubleshooting.