ykanazawa/sendgrid-maildev

概述

SendGrid MailDev是https://github.com/yKanazawa/sendgrid-dev%E4%B8%8Ehttps://maildev.github.io/maildev/%E7%9A%84%E7%BB%84%E5%90%88%EF%BC%8C%E7%94%A8%E4%BA%8E%E5%9C%A8%E5%BC%80%E5%8F%91%E8%BF%87%E7%A8%8B%E4%B8%AD%E6%B5%8B%E8%AF%95SendGrid%E9%82%AE%E4%BB%B6%E5%8A%9F%E8%83%BD%E3%80%82

核心功能与特性

• 集成SendGrid模拟API，可模拟SendGrid邮件发送接口
• 包含MailDev组件，提供Web界面查看接收到的测试邮件
• 支持通过API和SMTP两种方式测试邮件发送
• 无需依赖真实SendGrid账户即可完成本地开发测试

使用场景与适用范围

适用于开发和测试阶段，需要验证SendGrid邮件发送逻辑的场景。可避免向真实***发送测试邮件，确保开发环境中邮件功能的正确性和稳定性。

使用方法与配置说明

开发示例

docker-compose.yml示例

以下配置中的环境变量为默认值：

yaml
version: '2'

services:
  sendgrid-maildev:
    image: ykanazawa/sendgrid-maildev
    hostname: sendgrid-maildev
    environment:
      - SENDGRID_DEV_API_SERVER=:3030  # SendGrid模拟API服务地址和端口
      - SENDGRID_DEV_API_KEY=SG.xxxxx  # 访问模拟API的密钥
      - SENDGRID_DEV_SMTP_SERVER=127.0.0.1:1025  # SMTP服务器地址和端口
    container_name: sendgrid-maildev
    ports:
      - 1025:1025  # MailDev SMTP端口
      - 1080:1080  # MailDev Web界面端口
      - 3030:3030  # SendGrid模拟API端口

curl使用示例

通过curl命令测试模拟API接口：

bash
# 进入容器
docker exec -it sendgrid-maildev bash

# 发送测试邮件请求
curl --request POST \
  --url http://127.0.0.1:3030/v3/mail/send \
  --header 'Authorization: Bearer SG.xxxxx' \
  --header 'Content-Type: application/json' \
  --data '{"personalizations": [{ 
    "to": [{"email": "to@example.com"}]}], 
    "from": {"email": "from@example.com"}, 
    "subject": "Test Subject", 
    "content": [{"type": "text/plain", "value": "Test Content"}] 
  }'

AWS示例

!https://raw.githubusercontent.com/yKanazawa/sendgrid-maildev/master/img/example_of_aws.png