GMAIL Integration Documentation

What the integration does

The GMAIL integration connects the Fluo platform to Gmail, allowing agents to manage and send emails within Gmail. This integration is perfect for automating email communication in workflows, sending notifications, and managing email interactions from a unified platform.

Short Description

  • Purpose: Automate email sending and management through Gmail.
  • Typical Use Cases: Sending automated email responses, managing incoming emails, integrating Gmail functionalities into workflows.

Example Scenarios

  • Sending notification emails to users from a workflow.
  • Automatically replying to customer service emails with predefined replies.

Capabilities

  • Send Email: Enables the agent to send emails through Gmail.
    • Input Schema:
      { "to": "string", "subject": "string", "body": "string", "attachments": ["file"] }
      
    • Output Schema:
      { "messageId": "string", "status": "string" }
      
  • Receive Email: Retrieve emails that match a certain criteria.
    • Input Schema:
      { "query": "string", "label": "string" }
      
    • Output Schema:
      { "emails": [ { "from": "string", "subject": "string", "body": "string" } ] }
      

Limitations

  • Rate limits are in place for email sending to prevent spam.
  • There is partial API coverage concerning email management functions.

Setup & Configuration

  • Prerequisites: Google account with Gmail enabled.
  • Permissions Needed: Access to Gmail with permission to send and receive emails.
  • Authentication: Utilizes OAuth 2.0. Users will need to authorize the Fluo Platform to access Gmail on their behalf.
  • Step-by-step guide:
    1. Navigate to integrations on the Fluo Platform.
    2. Select the Gmail integration and click "Connect".
    3. Follow the OAuth 2.0 authentication process to grant permissions.
  • Testing connection: Send a test email to verify connection.

How to Use in Agents

  • Configure your agent with Gmail capability to automate sending of notifications.
  • Example Prompt: "When a new task is assigned, send an email notification to the user using the Gmail integration."

Code Snippet Example

To enable Gmail in an agent definition:

{
  "integrations": {
    "gmail": {
      "enabled": true
    }
  }
}```
#### Best Practices
- Use Gmail integration for tasks requiring reliable email communication.
- Be mindful of rate limits to avoid disruptions.
#### Reference Section
- **API Endpoints**: Not directly exposed.
- **Schema Definitions**: Provided above in capabilities.
- **Further Reading**: Refer to the official [Gmail API Documentation](https://developers.google.com/gmail/api) for more detailed information.