深入解析Coravel项目中的邮件发送功能-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00001/article/details/148548997

深入解析Coravel项目中的邮件发送功能

coravel Near-zero config .NET library that makes advanced application features like Task Scheduling, Caching, Queuing, Event Broadcasting, and more a breeze! 项目地址: https://gitcode.com/gh_mirrors/co/coravel

Coravel是一个功能强大的.NET Core库，它简化了任务调度、缓存、队列、邮件发送等常见开发任务。本文将重点介绍Coravel中的邮件发送功能，帮助开发者快速掌握这一实用工具。

邮件发送功能概述

Coravel的邮件发送功能设计理念是"简单至上"，它提供了以下核心特性：

内置支持Razor模板的邮件系统
灵活易用的邮件API
支持通过ASP控制器渲染邮件进行可视化测试
多种邮件驱动支持（SMTP、本地日志文件、自定义驱动）
通过appsettings.json快速配置
丰富的邮件模板组件

安装与配置

安装步骤

首先安装Coravel CLI工具：

dotnet tool install --global coravel-cli

使用CLI安装邮件功能：
```
coravel mail install
```

安装过程会自动创建以下文件和目录结构：

~/Views/Mail/ - 邮件视图目录
~/Mailables/ - Mailable类目录
基础配置文件和示例文件

基本配置

在.NET 6+的最小化配置中，通过Program.cs进行配置：

var builder = WebApplication.CreateBuilder(args);
builder.AddMailer();

对于非Web项目，在Startup.ConfigureServices()中配置：

services.AddMailer(this.Configuration);

邮件驱动详解

Coravel支持多种邮件驱动方式，满足不同场景需求。

文件日志驱动

开发测试阶段最实用的驱动方式，将邮件内容输出到项目根目录的mail.log文件中。

配置示例：

"Coravel": {
  "Mail": {
    "Driver": "FileLog"
  }
}

SMTP驱动

生产环境常用的SMTP驱动配置：

"Coravel": {
  "Mail": {
    "Driver": "SMTP",
    "Host": "smtp.mailtrap.io",
    "Port": 2525,
    "Username": "your_username",
    "Password": "your_password"
  }
}

自定义驱动

通过实现ICanSendMail接口创建自定义邮件驱动：

public class MyHttpApiCustomMailer : ICanSendMail
{
    private readonly IHttpClient _httpClient;

    public MyHttpApiCustomMailer(IHttpClientFactory httpFactory)
    {
        this._httpClient = httpFactory.CreateHttpClient("MailApi");
    }

    public async Task SendAsync(MessageBody message, string subject, IEnumerable<MailRecipient> to, MailRecipient from, MailRecipient replyTo, IEnumerable<MailRecipient> cc, IEnumerable<MailRecipient> bcc, IEnumerable<Attachment> attachments = null, MailRecipient sender = null)
    {
        // 自定义HTTP API发送逻辑
    }
}

注册自定义驱动：

builder.Services.AddScoped<MyHttpApiCustomMailer>();
builder.AddCustomMailer<MyHttpApiCustomMailer>();

Mailable邮件模型

Mailable是Coravel邮件系统的核心概念，它封装了特定类型邮件的所有配置和内容。

创建Mailable

典型的Mailable类结构：

public class NewUserViewMailable : Mailable<UserModel>
{
    private UserModel _user;

    public NewUserViewMailable(UserModel user) => this._user = user;

    public override void Build()
    {
        this.To(this._user)
            .From("from@test.com")
            .View("~/Views/Mail/NewUser.cshtml", this._user);
    }
}

邮件内容定义方式

使用Razor视图：

.View("~/Views/Mail/NewUser.cshtml", this._user)

直接使用HTML：

.Html("<html><body><h1>Hello</h1></body></html>")

纯文本内容：
```
.Text("Hello World")
```

收件人配置

支持多种收件人配置方式：

To("test@test.com")  // 简单字符串
To(new MailRecipient(email, name))  // 带名称的收件人
To(userModel)  // 自动检测Email和Name属性

附件处理

添加附件示例：

.Attach(new Attachment
{
    Name = "MyImage.png",
    Bytes = imageBytes,
    ContentId = "unique-id"  // 用于邮件内嵌图片
})

在HTML中引用内嵌图片：

<img src="cid:unique-id" />

邮件模板系统

Coravel提供了强大的邮件模板系统，支持全局配置和组件化设计。

全局模板配置

在appsettings.json中配置全局模板参数：

"Coravel": {
    "Mail": {
        "LogoSrc": "https://example.com/logo.png",
        "CompanyAddress": "123 Main St",
        "CompanyName": "My Company",
        "PrimaryColor": "#539be2"
    }
}

模板组件

邮件视图支持以下特殊组件：

标题和预览文本：

ViewBag.Heading = "欢迎新用户";
ViewBag.Preview = "邮件预览文本";

链接区域：

@section links
{
    <a href="https://example.com">首页</a>
}

页脚区域：

@section footer
{
    <p>自定义页脚内容</p>
}

按钮组件

邮件中常用的按钮组件：

@await Component.InvokeAsync("EmailLinkButton", new { 
    text = "点击按钮", 
    url = "https://example.com",
    backgroundColor = "#333",
    textColor = "#fff"
})

邮件发送与测试

发送邮件

通过注入IMailer服务发送邮件：

private readonly IMailer _mailer;

public MyController(IMailer mailer) => this._mailer = mailer;

public async Task<IActionResult> SendEmail()
{
    await this._mailer.SendAsync(new NewUserViewMailable(user));
    return Ok();
}

队列发送

结合Coravel的队列功能实现异步发送：

this._queue.QueueAsyncTask(async () =>
    await this._mailer.SendAsync(new MyMailable())
);

可视化测试

直接在浏览器中渲染邮件内容进行测试：

public async Task<IActionResult> RenderView()
{
    string message = await this._mailer.RenderAsync(new PendingOrderMailable());
    return Content(message, "text/html");
}