介绍
# Gmail
使用托管式 OAuth 身份验证访问 Gmail API。读取、发送和管理电子邮件、邮件会话、标签和草稿。
## 快速开始
```bash # List messages python <<'EOF' import urllib.request, os, json req = urllib.request.Request('https://gateway.maton.ai/google-mail/gmail/v1/users/me/messages?maxResults=10') req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}') print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2)) EOF ```
## 基础 URL
``` https://gateway.maton.ai/google-mail/{native-api-path} ```
将 `{native-api-path}` 替换为实际的 Gmail API 端点路径。网关会将请求代理到 `gmail.googleapis.com` 并自动注入您的 OAuth 令牌。
## 身份验证
所有请求都需要在 Authorization 标头中包含 Maton API 密钥：
``` Authorization: Bearer $MATON_API_KEY ```
**环境变量：** 将您的 API 密钥设置为 `MATON_API_KEY`：
```bash export MATON_API_KEY="YOUR_API_KEY" ```
### 获取 API 密钥
1. 在 [maton.ai](https://maton.ai) 登录或创建账户 2. 前往 [maton.ai/settings](https://maton.ai/settings) 3. 复制您的 API 密钥
## 连接管理
在 `https://ctrl.maton.ai` 管理您的 Google OAuth 连接。
### 列出连接
```bash python <<'EOF' import urllib.request, os, json req = urllib.request.Request('https://ctrl.maton.ai/connections?app=google-mail&status=ACTIVE') req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}') print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2)) EOF ```
### 创建连接
```bash python <<'EOF' import urllib.request, os, json data = json.dumps({'app': 'google-mail'}).encode() req = urllib.request.Request('https://ctrl.maton.ai/connections', data=data, method='POST') req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}') req.add_header('Content-Type', 'application/json') print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2)) EOF ```
### 获取连接
```bash python <<'EOF' import urllib.request, os, json req = urllib.request.Request('https://ctrl.maton.ai/connections/{connection_id}') req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}') print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2)) EOF ```
**响应：** ```json { "connection": { "connection_id": "21fd90f9-5935-43cd-b6c8-bde9d915ca80", "status": "ACTIVE", "creation_time": "2025-12-08T07:20:53.488460Z", "last_updated_time": "2026-01-31T20:03:32.593153Z", "url": "https://connect.maton.ai/?session_token=...", "app": "google-mail", "metadata": {} } } ```
在浏览器中打开返回的 `url` 以完成 OAuth 授权。
### 删除连接
```bash python <<'EOF' import urllib.request, os, json req = urllib.request.Request('https://ctrl.maton.ai/connections/{connection_id}', method='DELETE') req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}') print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2)) EOF ```
### 指定连接
如果您有多个 Gmail 连接，请使用 `Maton-Connection` 标头指定要使用的连接：
```bash python <<'EOF' import urllib.request, os, json req = urllib.request.Request('https://gateway.maton.ai/google-mail/gmail/v1/users/me/messages') req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}') req.add_header('Maton-Connection', '21fd90f9-5935-43cd-b6c8-bde9d915ca80') print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2)) EOF ```
如果省略，网关将使用默认（最早）的活跃连接。
## API 参考
### 列出消息
```bash GET /google-mail/gmail/v1/users/me/messages?maxResults=10 ```
使用查询筛选器：
```bash GET /google-mail/gmail/v1/users/me/messages?q=is:unread&maxResults=10 ```
### 获取消息
```bash GET /google-mail/gmail/v1/users/me/messages/{messageId} ```
仅获取元数据：
```bash GET /google-mail/gmail/v1/users/me/messages/{messageId}?format=metadata&metadataHeaders=From&metadataHeaders=Subject&metadataHeaders=Date ```
### 发送消息
```bash POST /google-mail/gmail/v1/users/me/messages/send Content-Type: application/json
{ "raw": "BASE64_ENCODED_EMAIL" } ```
### 列出标签
```bash GET /google-mail/gmail/v1/users/me/labels ```
### 列出会话
```bash GET /google-mail/gmail/v1/users/me/threads?maxResults=10 ```
### 获取会话
```bash GET /google-mail/gmail/v1/users/me/threads/{threadId} ```
### 修改消息标签
```bash POST /google-mail/gmail/v1/users/me/messages/{messageId}/modify Content-Type: application/json
{ "addLabelIds": ["STARRED"], "removeLabelIds": ["UNREAD"] } ```
### 删除消息（移至回收站）
```bash POST /google-mail/gmail/v1/users/me/messages/{messageId}/trash ```
### 创建草稿
```bash POST /google-mail/gmail/v1/users/me/drafts Content-Type: application/json
{ "message": { "raw": "BASE64URL_ENCODED_EMAIL" } } ```
### 发送草稿
```bash POST /google-mail/gmail/v1/users/me/drafts/send Content-Type: application/json
{ "id": "{draftId}" } ```
### 获取个人资料
```bash GET /google-mail/gmail/v1/users/me/profile ```
## 查询运算符
在 `q` 参数中使用： - `is:unread` - 未读消息 - `is:starred` - 带有星标的消息 - `from:[email protected]` - 来自特定发件人 - `to:[email protected]` - 发送给特定收件人 - `subject:keyword` - 主题包含关键词 - `after:2024/01/01` - 指定日期之后 - `before:2024/12/31` - 指定日期之前 - `has:attachment` - 包含附件
## 代码示例
### JavaScript
```javascript const response = await fetch( 'https://gateway.maton.ai/google-mail/gmail/v1/users/me/messages?maxResults=10', { headers: { 'Authorization': `Bearer ${process.env.MATON_API_KEY}` } } ); ```
### Python
```python import os import requests
response = requests.get( 'https://gateway.maton.ai/google-mail/gmail/v1/users/me/messages', headers={'Authorization': f'Bearer {os.environ["MATON_API_KEY"]}'}, params={'maxResults': 10, 'q': 'is:unread'} ) ```
## 注意事项
- 使用 `me` 作为经过身份验证的用户的 userId - 消息正文在 `raw` 字段中采用 base64url 编码 - 常用标签：`INBOX`、`SENT`、`DRAFT`、`STARRED`、`UNREAD`、`TRASH` - 重要：使用 curl 命令时，如果 URL 包含括号（`fields[]`、`sort[]`、`records[]`），请使用 `curl -g` 以禁用 glob 解析 - 重要：当将 curl 输出通过管道传递给 `jq` 或其他命令时，某些 shell 环境中的环境变量（如 `$MATON_API_KEY`）可能无法正确展开。通过管道传输时，您可能会收到“Invalid API key”错误。
## 错误处理
| 状态 | 含义 | |--------|---------| | 400 | 缺少 Gmail 连接 | | 401 | Maton API 密钥无效或缺失 | | 429 | 请求频率受限（每个账户每秒 10 次请求） | | 4xx/5xx | 来自 Gmail API 的透传错误 |
### 故障排除：API 密钥问题
1. 检查 `MATON_API_KEY` 环境变量是否已设置：
```bash echo $MATON_API_KEY ```
2. 通过列出连接来验证 API 密钥是否有效：
```bash python <<'EOF' import urllib.request, os, json req = urllib.request.Request('https://ctrl.maton.ai/connections') req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}') print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2)) EOF ```
### 故障排除：无效的应用名称
1. 确保您的 URL 路径以 `google-mail` 开头。例如：
- 正确：`https://gateway.maton.ai/google-mail/gmail/v1/users/me/messages` - 错误：`https://gateway.maton.ai/gmail/v1/users/me/messages`
## 资源
- [Gmail API 概览](https://developers.google.com/gmail/api/reference/rest) - [列出消息](https://developers.google.com/gmail/api/reference/rest/v1/users.messages/list) - [获取消息](https://developers.google.com/gmail/api/reference/rest/v1/users.messages/get) - [发送消息](https://developers.google.com/gmail/api/reference/rest/v1/users.messages/send) - [列出会话](https://developers.google.com/gmail/api/reference/rest/v1/users.threads/list) - [列出标签](https://developers.google.com/gmail/api/reference/rest/v1/users.labels/list) - [创建草稿](https://developers.google.com/gmail/api/reference/rest/v1/users.drafts/create) - [Maton 社区](https://discord.com/invite/dBfFAcefs2) - [Maton 支持](mailto:[email protected])