Protonmail MCP

🚀 Protonmail MCP 服務器

該MCP服務器由 amotivv 提供，用於與Protonmail服務集成。它專為需要通過Model Context Protocol（MCP）協議連接到外部服務的用戶設計，能幫助用戶輕鬆實現相關功能。

🚀 快速開始

此MCP服務器由 amotivv 提供，可直接與Protonmail服務集成，為需通過MCP協議連接外部服務的用戶帶來便利。

✨ 主要特性

• 直接集成：無需額外配置，即可直接連接到Protonmail服務。
• 安全傳輸：支持通過SSL/TLS加密通信，確保數據傳輸的安全性。
• 多線程支持：服務器能夠處理多個併發請求，提升性能和響應速度。
• 日誌記錄：內置詳細的日誌系統，便於調試和監控服務器狀態。

📦 安裝指南

快速安裝

1. 克隆倉庫：

git clone https://github.com/amotivv/protonmail-mcp.git
cd protonmail-mcp

2. 安裝依賴並構建：

npm install
npm run build

3. 配置環境變量，設置Protonmail API密鑰和端點。
4. 啟動服務器：

npm start

擴展功能

• 自定義日誌：允許用戶根據需求擴展日誌記錄的功能。
• 插件支持：提供靈活的插件系統，便於添加額外功能模塊。

📚 詳細文檔

配置說明

環境變量配置

以下是服務器運行所需的關鍵環境變量：

日誌配置

用戶可以選擇輸出格式和日誌級別，支持以下選項：

• JSON格式：便於機器解析。
• PLAIN文本：適合手動查看。
• SYSLOG格式：兼容系統日誌記錄工具。

使用說明

如何發送郵件

const { ProtonmailService } = require('protonmail-mcp');

async function sendEmail(to, subject, text) {
    const service = new ProtonmailService({
        apiKey: 'your_api_key',
        endpoint: 'api.proton.me'
    });

    await service.send({
        to,
        subject,
        text
    });
}

// 示例調用
sendEmail('user@example.com', '測試郵件', '這是一封測試郵件。')
    .then(() => console.log('郵件發送成功！'))
    .catch(err => console.error('發送失敗:', err));

故障排除

常見問題解答

1. 連接超時：
   • 檢查網絡是否正常。
   • 確保Protonmail API端點可用。
   • 查看服務器日誌獲取更多信息。
2. 認證失敗：
   • 驗證API密鑰的正確性。
   • 確保密鑰未過期或被鎖定。
   • 聯繫Protonmail支持團隊確認密鑰狀態。
3. 郵件發送限制：
   • 檢查速率限制文檔。
   • 分散郵件發送頻率，避免觸發限制。
   • 升級到高級賬戶以提高發送限制。

💻 使用示例

基礎用法

const { ProtonmailService } = require('protonmail-mcp');

async function main() {
    const service = new ProtonmailService({
        apiKey: process.env.PROTONMAIL_API_KEY,
        endpoint: process.env.PROTONMAIL_ENDPOINT
    });

    try {
        await service.sendEmail('to@example.com', '測試主題', '測試內容');
        console.log('郵件發送成功');
    } catch (error) {
        console.error('發送失敗:', error);
    }
}

main();

高級用法

const { ProtonmailService, Logger } = require('protonmail-mcp');

// 自定義日誌記錄器
const logger = new Logger({
    format: 'json',
    level: 'debug'
});

async function processEmails(emails) {
    const service = new ProtonmailService({
        apiKey: process.env.PROTONMAIL_API_KEY,
        endpoint: process.env.PROTONMAIL_ENDPOINT,
        logger
    });

    for (const email of emails) {
        try {
            await service.send(email);
            logger.info(`郵件已發送到 ${email.to}`);
        } catch (error) {
            logger.error(`發送失敗：${email.to}`, error);
        }
    }
}

// 示例調用
processEmails([
    { to: 'user1@example.com', subject: '通知', text: '新的消息提醒' },
    { to: 'user2@example.com', subject: '更新', text: '系統已更新，請檢查。' }
]);

文檔資源

• 官方文檔：詳細說明了API使用方法和最佳實踐。
• 示例代碼倉庫：提供多種應用場景的代碼示例。

貢獻指南

歡迎社區貢獻代碼或提出建議，幫助我們共同完善這個項目。

提交規範

1. 為每個提交創建清晰的問題描述。
2. 確保代碼遵循項目的編碼風格。
3. 提供詳細的變更日誌和測試用例。

📄 許可證

該軟件基於MIT許可證發佈，允許自由使用、修改和分發，但需保留版權聲明。

📞 聯繫方式

如需反饋或技術支持，請訪問我們的 GitHub倉庫 提交問題。