yudppp/simple-sendgrid-mock-server

simple-sendgrid-mock-server

https://hub.docker.com/r/yudppp/simple-sendgrid-mock-server

镜像概述

simple-sendgrid-mock-server 是一个轻量级的 Sendgrid v3 API 模拟服务器，内置 GUI ***界面。它旨在为开发和测试环境提供安全、便捷的邮件发送模拟功能，避免向真实 Sendgrid 服务发送测试邮件，同时允许开发者直观地查看和验证邮件内容。

核心功能与特性

• Sendgrid v3 API 兼容：模拟 Sendgrid v3 邮件发送接口，支持标准邮件发送请求格式
• **GUI *界面：提供可视化界面查看所有模拟接收的邮件，便于内容验证
• 无需真实账户：无需配置真实 Sendgrid API 密钥和账户，降低测试环境依赖
• 轻量级部署：基于 Docker 容器化部署，启动快速，资源占用低

使用场景

• 开发环境测试：在应用开发阶段，模拟邮件发送功能，验证业务逻辑
• 集成测试：自动化测试中模拟邮件发送，验证邮件内容、格式和接收情况
• 前端开发：供前端开发人员预览邮件模板展示效果，无需后端完整服务支持

使用方法

应用配置

将应用程序中的 Sendgrid API 请求目标地址指向模拟服务器。

Go 示例

go
import "github.com/sendgrid/sendgrid-go"

func SendMail() error {
    // 将 mockedHost 设置为 simple-sendgrid-mock-server 容器的访问地址
    mockedHost := "http://your-mock-server-ip:port"
    mockAPIKey := "any-string (模拟服务器不验证API密钥)"
    
    request := sendgrid.GetRequest(mockAPIKey, "/v3/mail/send", mockedHost)
    // ... 构建邮件内容并发送请求
}

Docker 部署

基本运行命令

bash
docker run -d -p 8080:8080 --name sendgrid-mock yudppp/simple-sendgrid-mock-server

访问 GUI ***界面

启动容器后，通过浏览器访问 http://localhost:8080 即可打开 GUI ***界面，查看所有模拟接收的邮件。

自定义端口

如需使用非默认端口（默认 8080），可通过端口映射调整：

bash
docker run -d -p 3000:8080 --name sendgrid-mock yudppp/simple-sendgrid-mock-server

此时应用程序应将请求指向 http://localhost:3000。

注意事项

• 模拟服务器不实际发送邮件，所有邮件仅存储在容器内存中，容器重启后数据将丢失
• API 密钥验证被禁用，可使用任意字符串作为 API 密钥
• 支持标准 Sendgrid v3 邮件发送接口，复杂功能（如模板、动态内容）可能存在部分限制