Gmail

🚀 Gmail MCP 使用說明

這是一個實現了模型上下文協議（MCP）的 npm 包，用於與 Gmail API 進行交互。它提供了標準化接口，便於管理、發送和檢索電子郵件。

🚀 快速開始

初始化配置文件

根據操作系統不同，將配置文件置於相應的目錄中：

• Mac/Linux：~/.config/gmail-mcp/config.json
• Windows：%APPDATA%/gmail-mcp/config.json

示例內容如下：

{
  "clientId": "your_client_id",
  "clientSecret": "your_client_secret",
  "refreshToken": "your_refresh_token"
}

初始化 Gmail 客戶端

在代碼中初始化客戶端時，需要指定配置文件的路徑和默認的收件箱：

import { GmailClient } from '@shinzolabs/gmail-mcp';

// 初始化 Gmail 客戶端，默認使用 development 環境模式
const gmail = new GmailClient({
  configFile: process.env.NODE_ENV === 'development' ? '~/.config/gmail-mcp/config.json' : undefined,
  defaultInbox: 'INBOX'
});

// 連接 Gmail 服務
await gmail.connect();

✨ 主要特性

該 npm 包實現了模型上下文協議（MCP），與 Gmail API 交互，提供標準化接口，方便進行電子郵件的管理、發送和檢索操作。

📦 安裝指南

使用 npm 或 yarn 進行安裝：

npm install @shinzolabs/gmail-mcp
# 或者
yarn add @shinzolabs/gmail-mcp

📚 詳細文檔

支持的 API 端點

用戶管理

• get_profile：獲取當前用戶的 Gmail 資料信息
• stop_mail_watch：停止接收郵件推送通知
• watch_mailbox：開啟郵件箱變動的推送通知功能

消息管理

操作消息

• list_messages：列出符合條件的消息
• get_message：獲取指定消息的具體內容
• get_attachment：下載特定消息中的附件
• modify_message：修改消息標籤信息
• send_message：向指定收件人發送電子郵件
• delete_message：永久刪除一條消息
• trash_message：將消息移至廢紙簍
• untrash_message：從廢紙簍中移除消息
• batch_modify_messages：批量修改多條消息的標籤
• batch_delete_messages：批量刪除多條消息

標籤管理

• list_labels：列出所有現有標籤
• get_label：獲取特定標籤的詳細信息
• create_label：創建新的標籤
• update_label：更新標籤配置信息
• patch_label：部分更新標籤信息（僅修改指定字段）
• delete_label：刪除一個標籤

線程管理

• list_threads：列出所有郵件線程
• get_thread：獲取特定線程的詳細內容
• modify_thread：修改線程的相關屬性
• trash_thread：將整個線程移至廢紙簍
• untrash_thread：從廢紙簍中恢復整個線程

收件箱管理

• list_inboxes：獲取所有可用收件箱的列表
• get_inbox：獲取指定收件箱的詳細信息
• select_inbox：切換到指定的收件箱進行操作
• create_inbox：創建新的收件箱（僅管理員可用）
• delete_inbox：刪除指定收件箱（僅管理員可用）

⚠️ 注意事項

⚠️ 重要提示

1. 請確保在運行時通過環境變量提供 Gmail 的授權憑據。具體來說，需要設置以下變量：
   • GMAIL_CLIENT_ID：客戶端 ID
   • GMAIL_CLIENT_SECRET：客戶端密鑰
   • GMAIL_REFRESH_TOKEN：刷新令牌
2. 在開發和測試環境中，請避免使用實際的生產賬戶。建議創建一個專門用於測試的 Gmail 賬戶。

📫 問題反饋

如遇任何問題或需要進一步的支持，請聯繫我們的團隊：

• 郵箱：support@shinzolabs.com
• GitHub 倉庫：前往項目倉庫

感謝您使用 Gmail MCP！