airbyte-agent-gmail 0.1.0__tar.gz

airbyte_agent_gmail-0.1.0/.gitignore

@@ -0,0 +1,34 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+dist/
+build/
+.eggs/
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+
+# Virtual environments
+.venv/
+venv/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+
+# OS
+.DS_Store
+Thumbs.db
+
+.env
+configured_connectors.yaml
+
+# Claude Code development symlink
+# Contributors: Create this symlink locally for skill testing
+# mkdir -p .claude/skills && ln -s ../../skills/airbyte-agent-connectors .claude/skills/airbyte-agent-connectors
+.claude/skills/airbyte-agent-connectors

airbyte_agent_gmail-0.1.0/AUTH.md

@@ -0,0 +1,179 @@
+# Gmail authentication
+
+This page documents the authentication and configuration options for the Gmail agent connector.
+
+## Authentication
+
+### Open source execution
+
+In open source mode, you provide API credentials directly to the connector.
+
+#### OAuth
+
+`credentials` fields you need:
+
+
+| Field Name | Type | Required | Description |
+|------------|------|----------|-------------|
+| `access_token` | `str` | No | Your Google OAuth2 Access Token (optional, will be obtained via refresh) |
+| `refresh_token` | `str` | Yes | Your Google OAuth2 Refresh Token |
+| `client_id` | `str` | No | Your Google OAuth2 Client ID |
+| `client_secret` | `str` | No | Your Google OAuth2 Client Secret |
+
+Example request:
+
+```python
+from airbyte_agent_gmail import GmailConnector
+from airbyte_agent_gmail.models import GmailAuthConfig
+
+connector = GmailConnector(
+    auth_config=GmailAuthConfig(
+        access_token="<Your Google OAuth2 Access Token (optional, will be obtained via refresh)>",
+        refresh_token="<Your Google OAuth2 Refresh Token>",
+        client_id="<Your Google OAuth2 Client ID>",
+        client_secret="<Your Google OAuth2 Client Secret>"
+    )
+)
+```
+
+#### Token
+This authentication method isn't available for this connector.
+
+### Hosted execution
+
+In hosted mode, you first create a connector via the Airbyte API (providing your OAuth or Token credentials), then execute operations using either the Python SDK or API. If you need a step-by-step guide, see the [hosted execution tutorial](https://docs.airbyte.com/ai-agents/quickstarts/tutorial-hosted).
+
+#### OAuth
+Create a connector with OAuth credentials.
+
+`credentials` fields you need:
+
+
+| Field Name | Type | Required | Description |
+|------------|------|----------|-------------|
+| `access_token` | `str` | No | Your Google OAuth2 Access Token (optional, will be obtained via refresh) |
+| `refresh_token` | `str` | Yes | Your Google OAuth2 Refresh Token |
+| `client_id` | `str` | No | Your Google OAuth2 Client ID |
+| `client_secret` | `str` | No | Your Google OAuth2 Client Secret |
+
+`replication_config` fields you need:
+
+| Field Name | Type | Required | Description |
+|------------|------|----------|-------------|
+| `include_spam_and_trash` | `bool` | No | Include messages from SPAM and TRASH in the results. Defaults to false. |
+
+Example request:
+
+```bash
+curl -X POST "https://api.airbyte.ai/api/v1/integrations/connectors" \
+  -H "Authorization: Bearer <YOUR_BEARER_TOKEN>" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "external_user_id": "<EXTERNAL_USER_ID>",
+    "connector_type": "Gmail",
+    "name": "My Gmail Connector",
+    "credentials": {
+      "access_token": "<Your Google OAuth2 Access Token (optional, will be obtained via refresh)>",
+      "refresh_token": "<Your Google OAuth2 Refresh Token>",
+      "client_id": "<Your Google OAuth2 Client ID>",
+      "client_secret": "<Your Google OAuth2 Client Secret>"
+    },
+    "replication_config": {
+      "include_spam_and_trash": "<Include messages from SPAM and TRASH in the results. Defaults to false.>"
+    }
+  }'
+```
+
+
+
+#### Bring your own OAuth flow
+To implement your own OAuth flow, use Airbyte's server-side OAuth API endpoints. For a complete guide, see [Implement your own OAuth flow](https://docs.airbyte.com/ai-agents/quickstarts/tutorial-server-side-oauth).
+
+**Step 1: Initiate the OAuth flow**
+
+Request a consent URL for your user.
+
+| Field Name | Type | Required | Description |
+|------------|------|----------|-------------|
+| `external_user_id` | `string` | Yes | Your unique identifier for the end user |
+| `connector_type` | `string` | Yes | The connector type (e.g., "Gmail") |
+| `redirect_url` | `string` | Yes | URL to redirect to after OAuth authorization |
+
+Example request:
+
+```bash
+curl -X POST "https://api.airbyte.ai/api/v1/integrations/connectors/oauth/initiate" \
+  -H "Authorization: Bearer <YOUR_BEARER_TOKEN>" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "external_user_id": "<EXTERNAL_USER_ID>",
+    "connector_type": "Gmail",
+    "redirect_url": "https://yourapp.com/oauth/callback"
+  }'
+```
+
+Redirect your user to the `consent_url` from the response. After they authorize, they'll be redirected back to your app with a `secret_id` query parameter.
+
+**Step 2: Create a connector with the secret ID**
+
+| Field Name | Type | Required | Description |
+|------------|------|----------|-------------|
+| `external_user_id` | `string` | Yes | Your unique identifier for the end user |
+| `connector_type` | `string` | Yes | The connector type (e.g., "Gmail") |
+| `name` | `string` | Yes | A name for this connector instance |
+| `server_side_oauth_secret_id` | `string` | Yes | The secret_id from the OAuth callback |
+| `replication_config.include_spam_and_trash` | `bool` | No | Include messages from SPAM and TRASH in the results. Defaults to false. |
+
+Example request:
+
+```bash
+curl -X POST "https://api.airbyte.ai/api/v1/integrations/connectors" \
+  -H "Authorization: Bearer <YOUR_BEARER_TOKEN>" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "external_user_id": "<EXTERNAL_USER_ID>",
+    "connector_type": "Gmail",
+    "name": "My Gmail Connector",
+    "server_side_oauth_secret_id": "<secret_id_from_callback>",
+    "replication_config": {
+      "include_spam_and_trash": "<Include messages from SPAM and TRASH in the results. Defaults to false.>"
+    }
+  }'
+```
+
+#### Token
+This authentication method isn't available for this connector.
+
+#### Execution
+
+After creating the connector, execute operations using either the Python SDK or API.
+
+**Python SDK**
+
+```python
+from airbyte_agent_gmail import GmailConnector, AirbyteAuthConfig
+
+connector = GmailConnector(
+    auth_config=AirbyteAuthConfig(
+        external_user_id="<your_external_user_id>",
+        airbyte_client_id="<your-client-id>",
+        airbyte_client_secret="<your-client-secret>"
+    )
+)
+
+@agent.tool_plain # assumes you're using Pydantic AI
+@GmailConnector.tool_utils
+async def gmail_execute(entity: str, action: str, params: dict | None = None):
+    return await connector.execute(entity, action, params or {})
+```
+
+**API**
+
+```bash
+curl -X POST 'https://api.airbyte.ai/api/v1/integrations/connectors/<connector_id>/execute' \
+  -H 'Authorization: Bearer <YOUR_BEARER_TOKEN>' \
+  -H 'Content-Type: application/json' \
+  -d '{"entity": "<entity>", "action": "<action>", "params": {}}'
+```
+
+

airbyte_agent_gmail-0.1.0/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Gmail changelog
+
+## [0.1.0] - 2026-02-11
+- Updated connector definition (YAML version 0.1.0)
+- Source commit: 7c00a573
+- SDK version: 0.1.0

airbyte_agent_gmail-0.1.0/PKG-INFO

@@ -0,0 +1,170 @@
+Metadata-Version: 2.4
+Name: airbyte-agent-gmail
+Version: 0.1.0
+Summary: Airbyte Gmail Connector for AI platforms
+Project-URL: Homepage, https://github.com/airbytehq/airbyte-agent-connectors
+Project-URL: Documentation, https://docs.airbyte.com/ai-agents/
+Project-URL: Repository, https://github.com/airbytehq/airbyte-agent-connectors
+Project-URL: Issues, https://github.com/airbytehq/airbyte-agent-connectors/issues
+Author-email: Airbyte <contact@airbyte.io>
+License: Elastic-2.0
+Keywords: agent,ai,airbyte,api,connector,data-integration,gmail,llm,mcp
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: Other/Proprietary License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.13
+Requires-Dist: httpx>=0.24.0
+Requires-Dist: jinja2>=3.0.0
+Requires-Dist: jsonpath-ng>=1.6.1
+Requires-Dist: jsonref>=1.1.0
+Requires-Dist: opentelemetry-api>=1.37.0
+Requires-Dist: opentelemetry-sdk>=1.37.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: segment-analytics-python>=2.2.0
+Description-Content-Type: text/markdown
+
+# Gmail
+
+The Gmail agent connector is a Python package that equips AI agents to interact with Gmail through strongly typed, well-documented tools. It's ready to use directly in your Python app, in an agent framework, or exposed through an MCP.
+
+Gmail is Google's email service that provides email sending, receiving, and organization
+capabilities. This connector provides access to messages, threads, labels, drafts, and
+user profile information. It supports read operations for listing and retrieving email
+data, as well as write operations including sending messages, managing drafts, modifying
+message labels, and creating or updating labels.
+
+
+## Example questions
+
+The Gmail connector is optimized to handle prompts like these.
+
+- List my recent emails
+- Show me unread messages in my inbox
+- Get the details of a specific email
+- List all my Gmail labels
+- Show me details for a specific label
+- List my email drafts
+- Get the content of a specific draft
+- List my email threads
+- Show me the full thread for a conversation
+- Get my Gmail profile information
+- Send an email to someone
+- Create a new email draft
+- Archive a message by removing the INBOX label
+- Mark a message as read
+- Mark a message as unread
+- Move a message to trash
+- Create a new label
+- Update a label name or settings
+- Delete a label
+- Search for messages matching a query
+- Find emails from a specific sender
+- Show me emails with attachments
+
+## Unsupported questions
+
+The Gmail connector isn't currently able to handle prompts like these.
+
+- Attach a file to an email
+- Forward an email to someone
+- Create a filter or rule
+- Manage Gmail settings
+- Access Google Calendar events
+- Manage contacts
+
+## Installation
+
+```bash
+uv pip install airbyte-agent-gmail
+```
+
+## Usage
+
+Connectors can run in open source or hosted mode.
+
+### Open source
+
+In open source mode, you provide API credentials directly to the connector.
+
+```python
+from airbyte_agent_gmail import GmailConnector
+from airbyte_agent_gmail.models import GmailAuthConfig
+
+connector = GmailConnector(
+    auth_config=GmailAuthConfig(
+        access_token="<Your Google OAuth2 Access Token (optional, will be obtained via refresh)>",
+        refresh_token="<Your Google OAuth2 Refresh Token>",
+        client_id="<Your Google OAuth2 Client ID>",
+        client_secret="<Your Google OAuth2 Client Secret>"
+    )
+)
+
+@agent.tool_plain # assumes you're using Pydantic AI
+@GmailConnector.tool_utils
+async def gmail_execute(entity: str, action: str, params: dict | None = None):
+    return await connector.execute(entity, action, params or {})
+```
+
+### Hosted
+
+In hosted mode, API credentials are stored securely in Airbyte Cloud. You provide your Airbyte credentials instead. 
+
+This example assumes you've already authenticated your connector with Airbyte. See [Authentication](AUTH.md) to learn more about authenticating. If you need a step-by-step guide, see the [hosted execution tutorial](https://docs.airbyte.com/ai-agents/quickstarts/tutorial-hosted).
+
+```python
+from airbyte_agent_gmail import GmailConnector, AirbyteAuthConfig
+
+connector = GmailConnector(
+    auth_config=AirbyteAuthConfig(
+        external_user_id="<your_external_user_id>",
+        airbyte_client_id="<your-client-id>",
+        airbyte_client_secret="<your-client-secret>"
+    )
+)
+
+@agent.tool_plain # assumes you're using Pydantic AI
+@GmailConnector.tool_utils
+async def gmail_execute(entity: str, action: str, params: dict | None = None):
+    return await connector.execute(entity, action, params or {})
+```
+
+## Full documentation
+
+### Entities and actions
+
+This connector supports the following entities and actions. For more details, see this connector's [full reference documentation](REFERENCE.md).
+
+| Entity | Actions |
+|--------|---------|
+| Profile | [Get](./REFERENCE.md#profile-get) |
+| Messages | [List](./REFERENCE.md#messages-list), [Get](./REFERENCE.md#messages-get), [Create](./REFERENCE.md#messages-create), [Update](./REFERENCE.md#messages-update) |
+| Labels | [List](./REFERENCE.md#labels-list), [Create](./REFERENCE.md#labels-create), [Get](./REFERENCE.md#labels-get), [Update](./REFERENCE.md#labels-update), [Delete](./REFERENCE.md#labels-delete) |
+| Drafts | [List](./REFERENCE.md#drafts-list), [Create](./REFERENCE.md#drafts-create), [Get](./REFERENCE.md#drafts-get), [Update](./REFERENCE.md#drafts-update), [Delete](./REFERENCE.md#drafts-delete) |
+| Drafts Send | [Create](./REFERENCE.md#drafts-send-create) |
+| Threads | [List](./REFERENCE.md#threads-list), [Get](./REFERENCE.md#threads-get) |
+| Messages Trash | [Create](./REFERENCE.md#messages-trash-create) |
+| Messages Untrash | [Create](./REFERENCE.md#messages-untrash-create) |
+
+
+### Authentication
+
+For all authentication options, see the connector's [authentication documentation](AUTH.md).
+
+### Gmail API docs
+
+See the official [Gmail API reference](https://developers.google.com/gmail/api/reference/rest).
+
+## Version information
+
+- **Package version:** 0.1.0
+- **Connector version:** 0.1.0
+- **Generated with Connector SDK commit SHA:** 7c00a573513c38c66c062e280768f79e987d8253
+- **Changelog:** [View changelog](https://github.com/airbytehq/airbyte-agent-connectors/blob/main/connectors/gmail/CHANGELOG.md)

airbyte_agent_gmail-0.1.0/README.md

@@ -0,0 +1,137 @@
+# Gmail
+
+The Gmail agent connector is a Python package that equips AI agents to interact with Gmail through strongly typed, well-documented tools. It's ready to use directly in your Python app, in an agent framework, or exposed through an MCP.
+
+Gmail is Google's email service that provides email sending, receiving, and organization
+capabilities. This connector provides access to messages, threads, labels, drafts, and
+user profile information. It supports read operations for listing and retrieving email
+data, as well as write operations including sending messages, managing drafts, modifying
+message labels, and creating or updating labels.
+
+
+## Example questions
+
+The Gmail connector is optimized to handle prompts like these.
+
+- List my recent emails
+- Show me unread messages in my inbox
+- Get the details of a specific email
+- List all my Gmail labels
+- Show me details for a specific label
+- List my email drafts
+- Get the content of a specific draft
+- List my email threads
+- Show me the full thread for a conversation
+- Get my Gmail profile information
+- Send an email to someone
+- Create a new email draft
+- Archive a message by removing the INBOX label
+- Mark a message as read
+- Mark a message as unread
+- Move a message to trash
+- Create a new label
+- Update a label name or settings
+- Delete a label
+- Search for messages matching a query
+- Find emails from a specific sender
+- Show me emails with attachments
+
+## Unsupported questions
+
+The Gmail connector isn't currently able to handle prompts like these.
+
+- Attach a file to an email
+- Forward an email to someone
+- Create a filter or rule
+- Manage Gmail settings
+- Access Google Calendar events
+- Manage contacts
+
+## Installation
+
+```bash
+uv pip install airbyte-agent-gmail
+```
+
+## Usage
+
+Connectors can run in open source or hosted mode.
+
+### Open source
+
+In open source mode, you provide API credentials directly to the connector.
+
+```python
+from airbyte_agent_gmail import GmailConnector
+from airbyte_agent_gmail.models import GmailAuthConfig
+
+connector = GmailConnector(
+    auth_config=GmailAuthConfig(
+        access_token="<Your Google OAuth2 Access Token (optional, will be obtained via refresh)>",
+        refresh_token="<Your Google OAuth2 Refresh Token>",
+        client_id="<Your Google OAuth2 Client ID>",
+        client_secret="<Your Google OAuth2 Client Secret>"
+    )
+)
+
+@agent.tool_plain # assumes you're using Pydantic AI
+@GmailConnector.tool_utils
+async def gmail_execute(entity: str, action: str, params: dict | None = None):
+    return await connector.execute(entity, action, params or {})
+```
+
+### Hosted
+
+In hosted mode, API credentials are stored securely in Airbyte Cloud. You provide your Airbyte credentials instead. 
+
+This example assumes you've already authenticated your connector with Airbyte. See [Authentication](AUTH.md) to learn more about authenticating. If you need a step-by-step guide, see the [hosted execution tutorial](https://docs.airbyte.com/ai-agents/quickstarts/tutorial-hosted).
+
+```python
+from airbyte_agent_gmail import GmailConnector, AirbyteAuthConfig
+
+connector = GmailConnector(
+    auth_config=AirbyteAuthConfig(
+        external_user_id="<your_external_user_id>",
+        airbyte_client_id="<your-client-id>",
+        airbyte_client_secret="<your-client-secret>"
+    )
+)
+
+@agent.tool_plain # assumes you're using Pydantic AI
+@GmailConnector.tool_utils
+async def gmail_execute(entity: str, action: str, params: dict | None = None):
+    return await connector.execute(entity, action, params or {})
+```
+
+## Full documentation
+
+### Entities and actions
+
+This connector supports the following entities and actions. For more details, see this connector's [full reference documentation](REFERENCE.md).
+
+| Entity | Actions |
+|--------|---------|
+| Profile | [Get](./REFERENCE.md#profile-get) |
+| Messages | [List](./REFERENCE.md#messages-list), [Get](./REFERENCE.md#messages-get), [Create](./REFERENCE.md#messages-create), [Update](./REFERENCE.md#messages-update) |
+| Labels | [List](./REFERENCE.md#labels-list), [Create](./REFERENCE.md#labels-create), [Get](./REFERENCE.md#labels-get), [Update](./REFERENCE.md#labels-update), [Delete](./REFERENCE.md#labels-delete) |
+| Drafts | [List](./REFERENCE.md#drafts-list), [Create](./REFERENCE.md#drafts-create), [Get](./REFERENCE.md#drafts-get), [Update](./REFERENCE.md#drafts-update), [Delete](./REFERENCE.md#drafts-delete) |
+| Drafts Send | [Create](./REFERENCE.md#drafts-send-create) |
+| Threads | [List](./REFERENCE.md#threads-list), [Get](./REFERENCE.md#threads-get) |
+| Messages Trash | [Create](./REFERENCE.md#messages-trash-create) |
+| Messages Untrash | [Create](./REFERENCE.md#messages-untrash-create) |
+
+
+### Authentication
+
+For all authentication options, see the connector's [authentication documentation](AUTH.md).
+
+### Gmail API docs
+
+See the official [Gmail API reference](https://developers.google.com/gmail/api/reference/rest).
+
+## Version information
+
+- **Package version:** 0.1.0
+- **Connector version:** 0.1.0
+- **Generated with Connector SDK commit SHA:** 7c00a573513c38c66c062e280768f79e987d8253
+- **Changelog:** [View changelog](https://github.com/airbytehq/airbyte-agent-connectors/blob/main/connectors/gmail/CHANGELOG.md)