AI导哈

电子邮件管理服务器

一个基于cPanel UAPI的MCP服务器，提供电子邮件账户的自动化创建、删除、配置和转发管理功能。

  • by ashrobertsdragon
  • Python
  • 本地部署
  • 3 星标
  • 更新于
在 GitHub 查看 ashrobertsdragon/cpanel-mcp

使用说明

cPanel MCP服务器

MCP（模型上下文协议）服务器，为AI助手提供通过cPanel的UAPI管理电子邮件帐户的能力。此服务器支持自动创建、删除、配置和转发电子邮件帐户。

特性

  • 电子邮件帐户管理：创建、删除和列出电子邮件帐户
  • 密码管理：更改现有电子邮件帐户的密码
  • 配额管理：设置和更新邮箱存储限制
  • 邮件转发：创建、删除和列出电子邮件转发器
  • 客户端设置：检索电子邮件客户端配置设置
  • 安全认证：使用cPanel API令牌进行安全访问

可用工具

电子邮件帐户操作

  • add_email_account(email, password, quota=0) -创建新的电子邮件帐户
  • delete_email_account(email) -删除现有电子邮件帐户
  • list_email_accounts(domain) -列出域的所有电子邮件帐户
  • change_password(email, new_password) -更改电子邮件帐户密码
  • update_quota(email, quota) -更新邮箱大小限制
  • get_email_settings(email) -获取电子邮件客户端配置设置

电子邮件转发操作

  • create_email_forwarder(email, destination) -创建电子邮件转发器
  • delete_email_forwarder(email, destination) -删除电子邮件转发器
  • list_email_forwarders(domain) -列出域的所有转发器

需求

  • Python 3.10或更高版本
  • 具有API访问权限的cPanel托管帐户
  • 有效的cPanel API令牌

安装

使用紫外线（推荐）

使用紫外线时，不需要安装。相反，您可以直接从Github调用服务器，使用 uvx 命令

配置

服务器需要以下环境变量：

必需变量

  • USERNAME -您的cPanel用户名
  • HOSTNAME -您的cPanel主机名（例如。， example.com 或 server.example.com)
  • CPANEL_API_TOKEN -您的cPanel API令牌

可选变量

  • PORT -cPanel端口（默认值：2083）
  • SSL -启用SSL连接（默认值：true）

获取cPanel API令牌

  1. 登录您的cPanel帐户
  2. 引导到 安全 → 管理API令牌
  3. 点击 创建令牌
  4. 给它一个描述性的名称（例如“MCP服务器”）
  5. 必要时设置适当的限制
  6. 复制生成的令牌

用法

MCP客户端配置

将服务器添加到MCP客户端配置中（例如，Claude Desktop）：

{
  "mcpServers": {
    "cpanel-mcp": {
      "command": "uvx",
      "args": ["cpanel-mcp", "--repository", "https://github.com/ashrobertsdragon/cpanel-mcp"],
      "env": {
        "USERNAME": "your_cpanel_username",
        "HOSTNAME": "your.cpanel.hostname.com",
        "CPANEL_API_TOKEN": "your_api_token_here"
      }
    }
  }
}

示例用法

连接到MCP客户端后，您可以使用自然语言命令：

  • “创建新电子邮件帐户support@example.com使用密码SecurePass123“
  • “列出所有电子邮件帐户，例如.com”
  • “设置来自的电子邮件转发info@example.com向admin@example.com"
  • “更改密码user@example.com到新密码456“
  • “删除电子邮件帐户temp@example.com"
  • “更新配额sales@example.com至1000 MB”

安全考虑

  • API代币安全：永远不要将API令牌提交到版本控制
  • 环境变量：使用环境变量或安全密钥管理
  • 网络安全：确保您的cPanel服务器支持HTTPS（SSL）
  • 密码策略：对电子邮件帐户使用强密码

故障排除

常见问题

  1. 身份验证错误

    • 验证您的API令牌是否正确且处于活动状态
    • 检查您的用户名是否与cPanel帐户匹配
    • 确保主机名包含正确的域/子域

  2. 连接问题

    • 验证主机名和端口是否正确
    • 检查SSL是否配置正确
    • 确保您的服务器允许API连接

  3. 权限错误

    • 验证您的cPanel帐户是否具有电子邮件管理权限
    • 检查API令牌是否具有必要的权限

api参考

服务器将cPanel的UAPI（统一API）与以下模块一起使用：

  • 电子邮件模块：核心电子邮件帐户管理
  • 使用的功能:
    • add_pop -创建电子邮件帐户
    • del_pop -删除电子邮件帐户
    • list_pops -列出电子邮件帐户
    • passwd_pop -更改密码
    • edit_pop_quota -更新配额
    • get_client_settings -获取电子邮件设置
    • add_forwarder -创建转发器
    • delete_forwarder -删除转发器
    • list_forwarders -列出货运代理

贡献

  1. 分叉存储库
  2. 创建要素分支
  3. 进行更改
  4. 如果适用，添加测试
  5. 提交拉取请求

许可证

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

支持

对于问题和疑问：

  • 检查上面的故障排除部分
  • 查看cPanel的UAPI文档
  • 在项目存储库中打开问题

更新日志

v0.1.0

  • 初始版本
  • 基本电子邮件帐户管理
  • 电子邮件转发支持
  • 配额和密码管理
  • MCP集成

相关 MCP