Gmail Sender MCP

🚀 Gmail 發件人 MCP 服務器

這是一個模型上下文協議（MCP）服務器，允許Claude和其他人工智能助手通過Gmail API發送電子郵件。此版本專注於僅提供電子郵件發送功能，為AI助手提供了便捷的郵件交互途徑。

🚀 快速開始

該項目創建的MCP服務器，能讓AI助手實現發送新郵件以及回覆現有郵件的功能。它設計輕量級且易於設置，藉助Gmail API進行郵件操作。

✨ 主要特性

• 功能明確：僅專注於電子郵件發送功能，包括髮送新郵件和回覆現有郵件。
• 輕量易設：設計輕量級，且設置過程簡單。
• API支持：使用Gmail API進行電子郵件操作。

📦 安裝指南

先決條件

• Python 3.8或更高版本
• 具有Gmail API啟用的Google Cloud賬戶
• Docker（可選，用於容器化部署）

設置步驟

1. 創建Google Cloud項目並啟用Gmail API

1. 轉到Google Cloud控制檯
2. 創建新項目或選擇現有項目
3. 在側邊欄中導航到“API和服務”>“庫”
4. 搜索“Gmail API”並啟用它
5. 轉到“API和服務”>“憑證”
6. 點擊“創建憑據”，然後選擇“OAuth客戶端ID”
7. 對於應用程序類型，選擇“桌面應用”
8. 為您的OAuth客戶端命名
9. 點擊“創建”
10. 下載生成的憑據JSON文件

2. 準備您的環境

克隆此倉庫：

git clone https://github.com/abhishekloiwal/gmail-sender-mcp.git
cd gmail-sender-mcp

安裝依賴項：

pip install -r requirements.txt

3. 設置您的憑證

1. 將下載的憑據文件重命名為credentials.json並放在項目根目錄中
2. 運行輔助腳本來獲取刷新令牌：

python get_refresh_token.py

3. 在瀏覽器中完成身份驗證流程
4. 複製終端中顯示的刷新令牌
5. 基於示例創建.env文件：

cp .env.example .env

6. 編輯.env文件並填寫您的憑證：

GMAIL_CLIENT_ID=your-client-id.apps.googleusercontent.com
GMAIL_CLIENT_SECRET=your-client-secret
GMAIL_REFRESH_TOKEN=your-refresh-token
GMAIL_USER_EMAIL=your-email@gmail.com

4. 運行MCP服務器

python gmail_sender.py

服務器將啟動並監聽連接。

Docker 部署

您也可以在Docker容器中運行服務器：

使用Docker構建和運行

docker build -t gmail-sender-mcp .
docker run -d --name gmail-sender-mcp --env-file .env gmail-sender-mcp

或使用Docker Compose

docker-compose up -d

💻 使用示例

基礎用法

要將此MCP服務器與AI助手一起使用，請執行以下操作：

1. 運行MCP服務器
2. 將您的AI助手連接到MCP服務器（具體步驟取決於您的AI平臺）

工具使用

send_email 工具

發送新的電子郵件。 參數：

• to: 收件人電子郵件地址
• subject: 電子郵件主題行
• body: 電子郵件正文內容（支持HTML格式）

reply_to_email 工具

回覆現有的電子郵件。 參數：

• email_id: 要回復的電子郵件ID
• body: 回覆內容（支持HTML格式）

示例代碼

以下是一個使用send_email工具的示例：

from gmail_sender import GmailSender

# 初始化Gmail發送器
gmail = GmailSender(
    client_id='your-client-id.apps.googleusercontent.com',
    client_secret='your-client-secret',
    refresh_token='your-refresh-token',
    user_email='your-email@gmail.com'
)

# 發送電子郵件
gmail.send_email(
    to='recipient@example.com',
    subject='測試郵件',
    body='這是一封測試郵件。'
)

📚 詳細文檔

環境變量說明

以下是.env文件中可能用到的環境變量及其含義：

GMAIL_CLIENT_ID: Gmail OAuth客戶端ID
GMAIL_CLIENT_SECRET: Gmail OAuth客戶端密鑰
GMAIL_REFRESH_TOKEN: Gmail刷新令牌
GMAIL_USER_EMAIL: 要發送電子郵件的Google賬戶電子郵件地址
SMTP_SERVER: SMTP服務器地址（默認為smtp.gmail.com）
SMTP_PORT: SMTP端口（默認為587）

錯誤處理

在使用Gmail API時，可能會遇到以下錯誤：

1. InvalidGrantError: 刷新令牌無效或已過期
2. RateLimitExceeded: 超出API配額限制
3. PermissionDenied: 缺乏必要的權限

確保您的憑據有效，並且您的Google Cloud項目啟用了正確的API。

🔧 技術細節

該項目使用Python編寫，藉助Gmail API實現郵件發送和回覆功能。通過OAuth 2.0進行身份驗證，使用刷新令牌來維持長期的API訪問權限。同時，支持Docker容器化部署，方便在不同環境中使用。

📄 許可證

文檔未提及許可證相關信息。

⚠️ 重要提示

• 保持.env文件安全，且永遠不會將其提交到版本控制中。
• 刷新令牌授予發送郵件的權限，因此請像處理密碼一樣處理它。
• 如果您擔心安全問題，請考慮使用專用的Google賬戶進行此集成。

💡 使用建議

• 若遇到身份驗證錯誤，確保.env文件中的憑證正確無誤。
• 若出現找不到模塊錯誤，檢查Python環境是否已正確安裝所有依賴項。
• 若遇到Gmail API配額限制，請聯繫Google Cloud支持增加配額。