邮件处理服务器

一个基于模型上下文协议(MCP)的服务器,使AI助手能够检查电子邮件、处理消息并通过交互学习用户偏好。

  • by non-dirty
  • Python
  • 本地部署
  • 58 星标
  • 更新于
在 GitHub 查看 non-dirty/imap-mcp

使用说明

IMAP MCP服务器

一种模型上下文协议(MCP)服务器,使AI助手能够检查电子邮件、处理消息,并通过交互学习用户偏好。

概述

此项目实现了一个与IMAP电子邮件服务器接口的MCP服务器,以提供以下功能:

  • 电子邮件浏览和搜索
  • 电子邮件组织(移动、标记、标记)
  • 电子邮件撰写和回复
  • 交互式电子邮件处理和学习用户偏好
  • 自动电子邮件摘要和分类
  • 支持多个IMAP提供商

IMAP MCP服务器旨在与Claude或任何其他兼容MCP的助手配合使用,使其能够作为智能电子邮件助手,随着时间的推移学习您的偏好。

特性

  • 电子邮件身份验证:使用各种身份验证方法安全访问IMAP服务器
  • 电子邮件浏览:列出具有筛选选项的文件夹和邮件
  • 邮件内容:读取邮件内容,包括文本、HTML和附件
  • 电子邮件操作:移动、删除、标记为已读/未读、标记消息
  • 电子邮件撰写:以适当的格式起草并保存对邮件的回复
    • 支持纯文本和HTML回复
    • 使用CC支持回复所有功能
    • 使用“回复”和“参考”标题正确穿线
    • 将草稿保存到适当的文件夹
  • 搜索:跨文件夹的基本搜索功能
  • 交互模式:处理电子邮件和学习偏好的结构化模式(计划中)
  • 学习层:记录和分析用户决策,以预测未来的行动(计划)

当前项目结构

该项目目前组织如下:

.
├── examples/              # Example configurations
│   └── config.yaml.example
├── imap_mcp/              # Source code
│   ├── __init__.py
│   ├── config.py          # Configuration handling
│   ├── imap_client.py     # IMAP client implementation
│   ├── models.py          # Data models
│   ├── resources.py       # MCP resources implementation
│   ├── server.py          # Main server implementation
│   └── tools.py           # MCP tools implementation
├── tests/                 # Test suite
│   ├── __init__.py
│   └── test_models.py
├── INSTALLATION.md        # Detailed installation guide
├── pyproject.toml         # Project configuration
└── README.md              # This file

入门指南

先决条件

  • Python 3.8或更高版本
  • 支持IMAP的电子邮件帐户(建议使用Gmail)
  • 紫外线 用于包管理和运行Python脚本

安装

  1. 如果您还没有安装uv:

    curl -LsSf https://astral.sh/uv/install.sh | sh
    
  2. 克隆并安装软件包:

    git clone https://github.com/non-dirty/imap-mcp.git
    cd imap-mcp
    uv venv
    source .venv/bin/activate  # On Windows: .venv\Scripts\activate
    uv pip install -e ".[dev]"
    

Gmail配置

  1. 创建配置文件:

    cp config.sample.yaml config.yaml
    
  2. 设置Gmail OAuth2凭据:

    • 首选 谷歌云控制台
    • 创建新项目或选择现有项目
    • 启用Gmail API
    • 创建OAuth2凭据(桌面应用程序类型)
    • 下载客户端配置
  3. 更新 config.yaml 使用您的Gmail设置:

    imap:
      host: imap.gmail.com
      port: 993
      username: your-email@gmail.com
      use_ssl: true
      oauth2:
        client_id: YOUR_CLIENT_ID
        client_secret: YOUR_CLIENT_SECRET
        refresh_token: YOUR_REFRESH_TOKEN
    

用法

正在检查电子邮件

要在收件箱中列出电子邮件,请执行以下操作:

uv run list_inbox.py --config config.yaml --folder INBOX --limit 10

可用选项:

  • --folder:指定要检查的文件夹(默认值:收件箱)
  • --limit:要显示的最大电子邮件数(默认值:10)
  • --verbose:启用详细的日志输出

启动MCP服务器

要启动IMAP MCP服务器,请执行以下操作:

uv run imap_mcp.server --config config.yaml

对于带调试的开发模式:

uv run imap_mcp.server --dev

管理OAuth2令牌

要刷新您的OAuth2令牌:

uv run imap_mcp.auth_setup refresh-token --config config.yaml

要生成新的OAuth2令牌,请执行以下操作:

uv run imap_mcp.auth_setup generate-token --config config.yaml

发展

设置开发环境

# Set up virtual environment
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install development dependencies
pip install -e ".[dev]"

运行测试

pytest

安全考虑

此MCP服务器需要访问您的电子邮件帐户,其中包含敏感的个人信息。请注意以下安全注意事项:

  • 使用环境变量或安全凭据存储安全地存储电子邮件凭据
  • 考虑使用特定于应用程序的密码,而不是您的主帐户密码
  • 将文件夹访问权限限制在用例所需的范围内
  • 查看电子邮件提供商设置中授予服务器的权限

项目路线图

  • [x] 项目初始化和存储库设置
  • [x] 基本IMAP集成
  • [x] 电子邮件资源实施
  • [x] 电子邮件工具实施
  • [x] 电子邮件回复和草稿功能
  • []用户偏好学习实现
  • []高级搜索功能
  • []多账户支持
  • []与主要电子邮件提供商集成

贡献

欢迎投稿!请看 贡献.md 作为指导方针。

许可证

此项目根据MIT许可证获得许可-请参阅 许可证 文件以获取详细信息。

致谢