当前位置：首页 > news >正文

使用MailKit在.NET Core中收发邮件的完整示例

news 来源：原创 2024/9/20 19:23:19

在.NET Core中处理邮件收发操作时，MailKit是一个非常强大的库。它支持SMTP、POP3、IMAP等多种协议，可以轻松实现发送、接收、以及管理邮件的功能。下面我们将通过一个详细的示例，展示如何在.NET Core项目中使用MailKit来收发邮件，并对关键代码进行解释。

一、安装MailKit

首先，你需要在项目中安装MailKit库。你可以通过NuGet包管理器安装它，或者使用以下命令：

dotnet add package MailKit

二、发送邮件的示例

发送邮件是MailKit最常见的功能之一。以下是一个完整的发送邮件示例代码：

using System;
using System.Threading.Tasks;
using MimeKit;
using MailKit.Net.Smtp;
using MailKit.Security;namespace EmailExample
{class Program{static async Task Main(string[] args){// 创建邮件消息对象var message = new MimeMessage();// 设置发件人message.From.Add(new MailboxAddress("发件人名字", "your-email@example.com"));// 设置收件人message.To.Add(new MailboxAddress("收件人名字", "recipient-email@example.com"));// 设置邮件主题message.Subject = "来自 .NET Core 的测试邮件";// 创建邮件内容var bodyBuilder = new BodyBuilder{TextBody = "这是纯文本消息内容。",HtmlBody = "<h1>这是HTML消息</h1><p>这封邮件是通过MailKit从 .NET Core 发送的。</p>"};// 将邮件内容添加到消息对象中message.Body = bodyBuilder.ToMessageBody();// 创建并配置SMTP客户端using var client = new SmtpClient();try{// 连接到SMTP服务器，使用STARTTLS进行加密await client.ConnectAsync("smtp.example.com", 587, SecureSocketOptions.StartTls);// 使用邮箱账号和密码进行身份验证await client.AuthenticateAsync("your-email@example.com", "your-email-password");// 发送邮件await client.SendAsync(message);// 输出发送成功的提示信息Console.WriteLine("邮件发送成功！");}catch (Exception ex){// 如果发生异常，输出错误信息Console.WriteLine($"发送邮件时发生错误：{ex.Message}");}finally{// 断开与SMTP服务器的连接await client.DisconnectAsync(true);}}}
}

代码解释：

安装依赖：
首先，确保在项目中安装了MailKit库。
创建邮件信息（MimeMessage）：
- MimeMessage 是MailKit中用于构建电子邮件的类。
- message.From.Add(new MailboxAddress("发件人名字", "your-email@example.com")); 设置发件人信息。
- message.To.Add(new MailboxAddress("收件人名字", "recipient-email@example.com")); 设置收件人信息。
- message.Subject = "来自 .NET Core 的测试邮件"; 设置邮件主题。
构建邮件内容（BodyBuilder）：
- BodyBuilder 用于构建邮件的正文，可以包含纯文本和HTML内容。
- message.Body = bodyBuilder.ToMessageBody(); 将邮件正文附加到邮件信息中。
配置并连接SMTP客户端：
- 使用 SmtpClient 类连接到SMTP服务器。
- await client.ConnectAsync("smtp.example.com", 587, SecureSocketOptions.StartTls); 连接到SMTP服务器，使用STARTTLS进行加密。
- await client.AuthenticateAsync("your-email@example.com", "your-email-password"); 进行身份验证。
发送邮件并处理异常：
- 使用 client.SendAsync(message); 发送邮件。
- 如果发生异常，将捕获并输出错误信息。
断开与SMTP服务器的连接：
- await client.DisconnectAsync(true); 断开连接，并确保所有未发送的邮件被发送。

三、接收邮件的示例

除了发送邮件，MailKit还支持通过IMAP或POP3协议接收邮件。下面是一个简单的IMAP接收邮件的示例：

using System;
using System.Threading.Tasks;
using MailKit.Net.Imap;
using MailKit.Search;
using MailKit;
using MimeKit;namespace EmailExample
{class Program{static async Task Main(string[] args){// 创建并配置IMAP客户端using var client = new ImapClient();try{// 连接到IMAP服务器，通常使用SSL（端口993）await client.ConnectAsync("imap.example.com", 993, true);// 使用邮箱账号和密码进行身份验证await client.AuthenticateAsync("your-email@example.com", "your-email-password");// 打开收件箱文件夹var inbox = client.Inbox;await inbox.OpenAsync(FolderAccess.ReadOnly);// 搜索所有未读邮件var results = await inbox.SearchAsync(SearchQuery.NotSeen);// 遍历搜索结果，获取邮件信息foreach (var uniqueId in results){var message = await inbox.GetMessageAsync(uniqueId);// 输出邮件的关键信息Console.WriteLine($"邮件主题: {message.Subject}");Console.WriteLine($"发件人: {message.From}");Console.WriteLine($"接收日期: {message.Date}");Console.WriteLine($"邮件内容: {message.TextBody}");}}catch (Exception ex){// 如果发生异常，输出错误信息Console.WriteLine($"接收邮件时发生错误：{ex.Message}");}finally{// 断开与IMAP服务器的连接await client.DisconnectAsync(true);}}}
}

代码解释：

连接到IMAP服务器：
- ImapClient 类用于连接到IMAP服务器。
- await client.ConnectAsync("imap.example.com", 993, true); 连接到IMAP服务器，通常使用SSL（端口993）。
身份验证：
- 使用 await client.AuthenticateAsync("your-email@example.com", "your-email-password"); 进行邮箱账号的身份验证。
打开收件箱：
- var inbox = client.Inbox; 获取收件箱文件夹。
- await inbox.OpenAsync(FolderAccess.ReadOnly); 以只读模式打开收件箱。
搜索并获取未读邮件：
- var results = await inbox.SearchAsync(SearchQuery.NotSeen); 搜索所有未读邮件。
- 遍历搜索结果，并通过 inbox.GetMessageAsync(uniqueId) 获取具体邮件内容。
输出邮件信息：
- 输出邮件主题、发件人、日期以及正文内容。
断开与IMAP服务器的连接：
- await client.DisconnectAsync(true); 断开连接。