loopingz/aws-smtp-relay

aws-smtp-relay镜像说明

镜像概述

该镜像提供本地SMTP服务器，可将SMTP消息转换为AWS SES API调用，支持使用AWS角色实例（AWS Role Instance），避免手动创建和轮换SMTP凭证，符合AWS安全最佳实践，简化邮件中继流程。

核心功能

1. 将SMTP消息转换为AWS SES的SendRawEmail API请求
2. 支持AWS IAM角色认证，无需管理SMTP凭证
3. 可通过SSM参数存储管理配置，支持动态刷新
4. 允许覆盖SMTP配置，指向MailHog等测试工具（禁用实际 outbound 邮件）

使用场景

• 云环境中需要通过AWS SES发送邮件的应用服务
• 希望遵循AWS最佳实践，避免手动维护SMTP凭证的场景
• 需要测试邮件发送流程（通过MailHog等工具）的开发环境

配置说明

运行参数

支持以下关键命令行参数：

• -r,--region <arg>: 指定AWS区域（如ap-southeast-2）
• -p,--port <arg>: SMTP监听端口（默认***）
• -ssm,--ssmEnable: 启用SSM参数存储获取配置
• -smtpOverride <arg>: 是否覆盖SMTP配置（true/false，用于指向测试工具）
• -smtpHost <arg>: 覆盖后的SMTP主机地址（如MailHog地址）

IAM策略配置

发送邮件权限策略

需为角色或用户附加以下IAM策略以允许SES发送邮件：

json
{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": "ses:SendRawEmail",
      "Resource": "*"
    }
  ]
}

SSM参数存储访问策略

若启用SSM配置，需附加以下策略（替换$SSMKEY为实际KMS密钥ARN）：

json
{
  "Statement": [
    {
      "Effect": "Allow",
      "Action": ["ssm:DescribeParameters"],
      "Resource": "*"
    },
    {
      "Effect": "Allow",
      "Action": ["ssm:GetParameters", "ssm:GetParameter", "ssm:GetParametersByPath"],
      "Resource": ["arn:aws:ssm:*:*:parameter/smtpRelay", "arn:aws:ssm:*:*:parameter/smtpRelay/*"]
    },
    {
      "Effect": "Allow",
      "Action": ["kms:Decrypt"],
      "Resource": ["$SSMKEY"]
    }
  ]
}

Docker部署示例

基础运行

bash
docker run -p 10025:10025 docker.xuanyuan.run/loopingz/aws-smtp-relay

指定区域运行

bash
docker run -p 10025:10025 docker.xuanyuan.run/loopingz/aws-smtp-relay -r ap-southeast-2

启用SSM配置运行

bash
docker run -p ***:*** docker.xuanyuan.run/loopingz/aws-smtp-relay -ssm -ssmP /custom/smtpRelay