elasticemail-mcp-server

🚀 邮件管理系统

本项目是一个邮件管理系统，可与 Elastic Email API 连接，实现邮件活动管理、联系人管理、模板管理等功能，借助 Copilot 集成还能更高效地使用。

🚀 快速开始

环境要求

• .NET SDK 10 或更高版本。
• 需连接到 Elastic Email API 才能正常工作。
• 为 HTTP 开放端口 5001。

Copilot 集成步骤

1. 使用 VS Code。
2. 打开聊天窗口。
3. 选择“Agent”模式。
4. 使用 settings.json 文件连接到 mcp 服务器（打开包含此文件的文件夹）。
5. 你应该会在“servers”附近看到小控件。
6. 添加一个设置文件作为代理的上下文。
7. 打开“Select tools...”窗口（点击螺丝刀和扳手图标）。
8. 找到 mcp 服务器并确保选择了所有工具。
9. 点击“Start”。

代理的示例配置

"my-server-unique-number": {
    "url": "http://localhost:5001/",
    "headers": {
        "X-Auth-Token": <api_key>
    }
}

✨ 主要特性

本系统提供了丰富的工具，用于管理邮件活动、联系人、模板等，具体如下：

• 健康检查：
  • HealthCheck.IsReady：检查 Elastic Email API 服务器是否可用并响应。
• 活动管理：
  • CampaignManagement.CreateCampaign：在系统中创建活动。
  • CampaignManagement.ListCampaigns：列出现有活动。
  • CampaignManagement.GetCampaign：获取活动详情。
  • CampaignManagement.Pause：停止活动处理。
  • CampaignManagement.UpdateCampaign：更改活动数据（可通过状态编辑重新启动）。
  • CampaignManagement.GetAllCampaignStatistics：获取所有活动的统计数据，如打开邮件的数量。
  • CampaignManagement.GetCampaignStatistics：获取指定活动（按名称）的统计数据，如打开、点击等。
• 分段管理：
  • SegmentsManagement.CreateSegment：创建新的分段。
  • SegmentsManagement.GetSegments：获取现有分段的列表。
  • SegmentsManagement.GetSegment：按名称获取分段。
• 模板管理：
  • TemplateManagement.FetchTemplate：获取模板详情。
  • TemplateManagement.FetchTemplates：获取模板列表，可按类型和可访问性过滤。
• 邮件发送：
  • EmailSending.SendBulkEmails：向多个用户发送邮件（可使用联系人列表），可提供内容或使用模板。
  • EmailSending.SendTransactionalEmail：向联系人发送邮件，可提供模板。
• 联系人管理：
  • ContactsManagement.FetchContacts：获取联系人列表。
  • ContactsManagement.FetchContactHistory：获取联系人历史记录（如果启用）。
  • ContactsManagement.FetchLists：获取所有联系人列表。
  • ContactsManagement.FetchList：获取联系人列表详情。
  • ContactsManagement.FetchListContacts：获取指定列表（按名称）中的联系人。
  • ContactsManagement.AddContactToList：将联系人添加到列表。
  • ContactsManagement.RemoveContactsToList：从指定列表（按名称）中移除联系人。
  • ContactsManagement.CreateList：创建新的联系人列表。
  • ContactsManagement.AddContact：添加新联系人。
  • ContactsManagement.DeleteContacts：删除联系人（提供电子邮件地址）。
  • ContactsManagement.UploadContacts：从文件中上传并添加新联系人。