article
README
🚀 Gmail MCP 服务器
Gmail MCP 服务器是一个功能强大且灵活的 Gmail 集成服务器,基于 MCP(消息控制协议)框架构建。它提供了与 Gmail API 交互的强大接口,支持邮件的读取、发送和管理,能极大地提升邮件处理效率。
✨ 主要特性
- 🔍 支持从多个 Gmail 账户读取邮件
- 📎 支持发送带有附件的邮件
- 🔎 具备高级搜索选项,可精准搜索邮件
- 💾 支持邮件附件下载功能
- 💬 可管理邮件对话和线程
- 🕒 提供实时邮件监控功能
- 👥 支持多个 Gmail 账户同时使用
📦 安装指南
通过 Smithery 安装
使用 Smithery 可自动安装 Gmail 集成服务器:
npx -y @smithery/cli install @Quantum-369/Gmail-mcp-server --client claude
手动安装
- 克隆仓库:
git clone <your-repository-url>
cd gmail-mcp-server
- 创建并激活虚拟环境:
python -m venv venv
# Windows 系统
venv\Scripts\activate
# Unix/MacOS 系统
source venv/bin/activate
- 安装依赖项:
pip install .
📚 详细文档
运行前的先决条件
运行 Gmail MCP 服务器之前,请确保以下条件已满足:
- Python 3.12 或更高版本
- 启用 Gmail API 的 Google Cloud 项目
- OAuth 2.0 客户端 ID 凭证
- 所需的 Python 包(在 pyproject.toml 中指定)
配置 Google Cloud 项目
- 访问 Google Cloud Console
- 创建新项目或选择现有项目
- 启用项目的 Gmail API
- 创建 OAuth 2.0 凭证:
- 转到 "APIs & Services" > "Credentials"
- 点击 "Create Credentials" > "OAuth client ID"
- 选择 "Desktop app" 作为应用类型
- 下载客户端配置文件
- 将下载的文件重命名为
client_secret.json并放在项目根目录中
配置
- 在
gmail_token_creator.py中设置电子邮件标识符:
email_identifier = 'your.email@gmail.com' # 根据需要修改
- 运行令牌创建工具以验证您的 Gmail 账户:
python gmail_token_creator.py
- 对于每个要集成的 Gmail 账户,重复上述步骤
服务器结构
gmail_server.py:主要 MCP 服务器实现gmail_api.py:Gmail API 交互函数google_apis.py:Google API 认证工具- 支持文件:
read_emails.py:邮件读取功能search_emails.py:邮件搜索功能send_emails.py:邮件发送功能
💻 使用示例
启动服务器
python gmail_server.py
发送邮件
await send_gmail(
email_identifier="your.email@gmail.com",
to="recipient@example.com",
subject="Test Subject",
body="Email body content",
attachment_paths=["path/to/attachment"]
)
搜索邮件
async def process_email(email):
# 处理找到的邮件
pass
await search_emails(
email_identifier="your.email@gmail.com",
query="subject:important",
callback=process_email
)
下载附件
async def download_attachment(attachment):
# 处理下载的附件
pass
await get_attachments(
email_identifier="your.email@gmail.com",
message_id="message-id-12345",
attachments_callback=download_attachment
)
⚠️ 重要提示
- 确保
client_secret.json文件的安全性,避免泄露。 - 使用环境变量存储敏感信息(如电子邮件密码)。
- 定期更新 OAuth 令牌以增强安全性。
📖 其他资源
通过以上步骤,您可以轻松设置并使用 Gmail MCP 服务器来管理您的邮件和附件。
Scan to join WeChat group