SuperAPI AI 工具集

email-service-aws-ses

通用与其它

查看项目

更新于 10-16 10:52

技能介绍

该技能用于在 .NET API 项目中实现基于 AWS SES 的邮件发送能力,整体遵循接口与实现分离的结构。

用途 面向需要发送事务性邮件的 API 应用,例如预约提醒、检验结果可查看通知、欢迎邮件、密码重置等场景(模板示例中包含这些类型)。

主要能力

  1. AWS SES 集成:使用 Amazon.SimpleEmailV2 客户端进行生产级别的邮件投递。
  2. HTML 模板:基于文件存放的 HTML 模板,支持 {{key}} 语法占位符替换。
  3. Result 模式:方法返回 Result<T>,不抛出异常,通过 EmailErrors 定义错误(如 SendFailed、TemplateNotFound、InvalidRecipient、EmailDisabled)。
  4. 启用/禁用开关:EmailOptions.Enabled 为 false 时仅记录日志、不实际发送,用于开发模式。

使用方式 接口 IEmailService 定义了两个方法:SendTemplatedEmailAsync(按模板名加载模板文件并替换占位符后发送)和 SendHtmlEmailAsync(发送原始 HTML 内容)。实现类 AwsSesEmailService 位于 Infrastructure/Email,通过构造函数接收 IOptions<EmailOptions>,根据配置决定使用显式凭据还是 IAM 角色/环境凭据初始化 SES v2 客户端,并将模板路径定位到应用基础目录下的 TemplatesPath。配置通过 appsettings.json 的 Email 节提供,包括 AwsRegion、AwsAccessKeyId、AwsSecretAccessKey、FromAddress、FromName、Enabled、TemplatesPath。依赖注入通过 services.Configure<EmailOptions>(configuration.GetSection(EmailOptions.SectionName)) 和 services.AddScoped<IEmailService, AwsSesEmailService>() 注册。

项目结构 Application/Abstractions/Email 下放置 IEmailService.cs 与 EmailErrors.cs;Infrastructure/Email 下放置 EmailOptions.cs 与 AwsSesEmailService.cs;Api/EmailTemplates 下放置 HTML 模板文件(如 appointment-reminder.html、test-results-ready.html、welcome.html、password-reset.html 等)。

适用场景 需要以模板化方式发送 HTML 邮件的 .NET API 服务,尤其是希望避免异常、以结果对象统一处理发送失败的场景,以及需要区分开发与生产发送行为的场景。

限制与暂未提供 资料未说明具体的部署要求、SES 配额、价格、发送速率限制、模板语法完整规范、失败重试策略、附件支持、多收件人批量发送等细节;AWS 凭据与 SES 域名验证等前置条件需由使用者按 AWS 自身要求处理,资料中未展开说明。