NETCore.MailKit 项目教程

2024-09-28 11:31:28作者：谭伦延

1. 项目的目录结构及介绍

NETCore.MailKit/
├── example/
│   └── NETCore.MailKit.Web/
├── src/
│   └── NETCore.MailKit/
├── test/
│   └── NETCore.MailKit.Tests/
├── .gitattributes
├── .gitignore
├── NETCore.MailKit.sln
├── README.md
└── LICENSE

目录结构说明

example/: 包含项目的示例代码，展示了如何在 ASP.NET Core 项目中使用 NETCore.MailKit 发送邮件。
src/: 包含 NETCore.MailKit 的核心代码，提供了邮件发送的功能扩展。
test/: 包含项目的单元测试代码，用于测试 NETCore.MailKit 的功能。
.gitattributes: Git 属性文件，用于指定文件的 Git 行为。
.gitignore: Git 忽略文件，指定哪些文件或目录不需要被 Git 管理。
NETCore.MailKit.sln: 项目的解决方案文件，用于在 Visual Studio 或其他 IDE 中打开项目。
README.md: 项目的说明文件，包含项目的简介、安装和使用说明。
LICENSE: 项目的许可证文件，指定了项目的开源许可证类型。

2. 项目的启动文件介绍

在 src/NETCore.MailKit/ 目录下，主要的启动文件是 Startup.cs，它负责配置 ASP.NET Core 应用程序的服务和中间件。

Startup.cs 文件内容

public void ConfigureServices(IServiceCollection services)
{
    // 添加框架服务
    services.AddMvc();

    // 添加 MailKit 服务
    services.AddMailKit(optionBuilder =>
    {
        optionBuilder.UseMailKit(new MailKitOptions()
        {
            // 从配置文件中获取选项
            Server = Configuration["Server"],
            Port = Convert.ToInt32(Configuration["Port"]),
            SenderName = Configuration["SenderName"],
            SenderEmail = Configuration["SenderEmail"],
            // 可选，无认证时可省略
            Account = Configuration["Account"],
            Password = Configuration["Password"],
            // 启用 SSL 或 TLS
            Security = true
        });
    });
}

启动文件说明

ConfigureServices 方法: 用于配置应用程序的服务，包括 MVC 服务和 MailKit 服务。
AddMailKit 方法: 用于注册 MailKit 服务，并从配置文件中读取邮件服务器的相关配置。

3. 项目的配置文件介绍

在 src/NETCore.MailKit/ 目录下，主要的配置文件是 appsettings.json，它包含了应用程序的配置信息，特别是与邮件发送相关的配置。

appsettings.json 文件内容

{
  "Server": "smtp.example.com",
  "Port": "587",
  "SenderName": "Example Sender",
  "SenderEmail": "sender@example.com",
  "Account": "your-account",
  "Password": "your-password"
}