Gmail

通过受管的 OAuth 认证访问 Gmail API。读取、发送和管理邮件、会话（threads）、标签（labels）及草稿（drafts）。

快速开始

# 列出邮件
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 token。

认证

所有请求均需在 Authorization 请求头中提供 Maton API 密钥：

Authorization: Bearer $MATON_API_KEY

环境变量：请将您的 API 密钥设为 MATON_API_KEY：

export MATON_API_KEY="YOUR_API_KEY"

获取您的 API 密钥

1. 在 maton.ai 登录或注册账户
2. 访问 maton.ai/settings
3. 复制您的 API 密钥

连接管理

在 https://ctrl.maton.ai 管理您的 Google OAuth 连接。

列出连接

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

创建连接

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

获取连接

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

响应示例：

{
  "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 授权流程。

删除连接

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 请求头明确指定要使用的连接：

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 参考

列出邮件

GET /google-mail/gmail/v1/users/me/messages?maxResults=10

带查询过滤器：

GET /google-mail/gmail/v1/users/me/messages?q=is:unread&maxResults=10

获取邮件

GET /google-mail/gmail/v1/users/me/messages/{messageId}

仅返回元数据：

GET /google-mail/gmail/v1/users/me/messages/{messageId}?format=metadata&metadataHeaders=From&metadataHeaders=Subject&metadataHeaders=Date

发送邮件

POST /google-mail/gmail/v1/users/me/messages/send
Content-Type: application/json

{
  "raw": "BASE64_ENCODED_EMAIL"
}

列出标签

GET /google-mail/gmail/v1/users/me/labels

列出会话

GET /google-mail/gmail/v1/users/me/threads?maxResults=10

获取会话

GET /google-mail/gmail/v1/users/me/threads/{threadId}

修改邮件标签

POST /google-mail/gmail/v1/users/me/messages/{messageId}/modify
Content-Type: application/json

{
  "addLabelIds": ["STARRED"],
  "removeLabelIds": ["UNREAD"]
}

将邮件移入回收站

POST /google-mail/gmail/v1/users/me/messages/{messageId}/trash

创建草稿

POST /google-mail/gmail/v1/users/me/drafts
Content-Type: application/json

{
  "message": {
    "raw": "BASE64URL_ENCODED_EMAIL"
  }
}

发送草稿

POST /google-mail/gmail/v1/users/me/drafts/send
Content-Type: application/json

{
  "id": "{draftId}"
}

获取用户资料

GET /google-mail/gmail/v1/users/me/profile

查询操作符

可在 q 参数中使用以下操作符：

• is:unread —— 未读邮件
• is:starred —— 已加星标邮件
• from:email@example.com —— 来自特定发件人
• to:email@example.com —— 发送给特定收件人
• subject:keyword —— 主题包含关键词
• after:2024/01/01 —— 指定日期之后
• before:2024/12/31 —— 指定日期之前
• has:attachment —— 包含附件

代码示例

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

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[]），请务必添加 -g 参数以禁用 glob 解析
• 重要：当将 curl 输出通过管道传递给 jq 或其他命令时，在某些 shell 环境下环境变量（例如 $MATON_API_KEY）可能无法正确展开，导致出现“Invalid API key”错误

错误处理

问题排查：API 密钥相关问题

1. 检查 MATON_API_KEY 环境变量是否已设置：

echo $MATON_API_KEY

2. 通过列出连接验证 API 密钥是否有效：

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 概览
• 列出邮件
• 获取邮件
• 发送邮件
• 列出会话
• 列出标签
• 创建草稿
• Maton 社区
• Maton 支持