邮件发送

1、找回密码/发送激活码 分析

使用包<PackageReference Include="NETCore.MailKit" Version="2.1.0" />进行邮件的发送

2、定义邮件内容

这里我们通过发送邮件的方式，找回密码。

在Cms.Entity项目中，创建Email文件夹，该文件中创建MailBox.cs,表示邮件内容

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
namespace Cms.Entity.Email
{
    public class MailBox
    {
        /// <summary>
        /// 邮件正文
        /// </summary>
        public string? Body { get; set; }
        /// <summary>
        /// 邮件抄送给谁
        /// </summary>
        //public IEnumerable<string> Cc { get; set; }

        // 如果为true,表示有html内容
        public bool IsHtml { get; set; }
        /// <summary>
        /// 邮件标题
        /// </summary>
        public string? Subject { get; set; }
        /// <summary>
        /// 发送给谁
        /// </summary>
        public IEnumerable<string>? To { get; set; }
    }
}

3、实现邮件队列

在Cms.Common项目中创建MailQueueProvider.cs类，代码如下所示：

1
2
3
4
5
6
7
8
9
10
11
12
13
public static class MailQueueProvider
   {
       public static readonly ConcurrentQueue<MailBox> _mailQueue = new ConcurrentQueue<MailBox>();

       public static void Enqueue(MailBox mailBox)
       {
           _mailQueue.Enqueue(mailBox);
       }
       public static bool TryDequeue(out MailBox mailBox)
       {
           return _mailQueue.TryDequeue(out mailBox!);
       }
   }

4、实现邮件服务

然后在Cms.Web项目中安装发送邮件的包:NETCore.MailKit

在登录页面中添加一个找回密码的链接。

1
2
3
4
5
6
7
<form>
     用户名：<input type="text" name="userName" /><br/>
     密码：<input type="password" name="userPwd" /><br/>
     免登录:<input type="checkbox" name="checkMe" value="1"/><br/>
     <button type="submit"  id="btnLogin">登录</button><br/>
     <a href="/login/findPwd">找回密码</a>
</form>

在Login控制器中，创建FindPwd方法，如下：

1
2
3
4
5
6
7
8
9
10
11
/// <summary>
      /// 呈现找回密码的页面
      /// </summary>
      /// <returns></returns>

      [NoCheck]
      [HttpGet]
      public IActionResult FindPwd()
      {
          return View();
      }

FindPwd方法对应的视图

1
2
3
4
<form method="post" action="/login/findPwd">
 邮箱：<input type="text" name="email"/>
 <input type="submit" value="找回密码"/>
</form>

继续在Login控制器中创建一个重载的方法FindPwd

1
2
3
4
5
6
7
8
[NoCheck]
        [HttpPost]
        public async Task<IActionResult> FindPwd([FromForm] string email)
        {
            var result = await userInfoService.FindPassword(email);

            return result ? Ok() : Content("错误");
        }

这里调用了服务层中的FindPassword方法。

先在IUserInfoService接口中声明FindPassword方法。

1
2
3
4
5
6
/// <summary>
     /// 根据邮箱找回密码
     /// </summary>
     /// <param name="email"></param>
     /// <returns></returns>
     Task<bool> FindPassword(string email);

下面是关于FindPassword方法的具体实现：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
/// <summary>
      /// 根据邮箱找回密码
      /// </summary>
      /// <param name="email"></param>
      /// <returns></returns>
      /// <exception cref="NotImplementedException"></exception>
      public async Task<bool> FindPassword(string email)
      {
          var user = await _userInfoRepository.LoadEntities(u => u.UserEmail == email).FirstOrDefaultAsync();
          if (user == null)
          {
              return false;
          }
          // 构建邮件内容
          MailBox mailBox = new MailBox()
          {
              Body = "你的密码是:" + user.UserPassword,
              IsHtml = true,
              Subject = "找回密码",
              To = new List<string>() { email }
          };
          // 将邮件的内容入队
          Common.MailQueueProvider.Enqueue(mailBox);
          return true;
      }

这里，首先根据用户输入的邮箱，查询对应的信息，然后构建邮箱的内容，最后将邮件的内容插入到了队列中。

注意：这里我们是将用户的密码从数据库中查询出来以后直接作为了邮件内容发送到用户的邮箱中。

但是，这里有一个问题：数据库中存储的用户密码都是加密的，所以直接进行以上操作是有问题的。应该是生成一个默认的密码，然后发送到用户邮箱中，并且提示，尽快修改自己需要的密码

5、邮件发送

在Cms.Web项目创建文件夹Email,在该文件夹中创建类MailQueueManager .cs,该类中的代码如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
using Cms.Common;
using Cms.Entity.Email;
using MailKit.Net.Smtp;
using MimeKit;
using System.Diagnostics;
namespace Cms.Web.Email
{
    public class MailQueueManager
    {
        // 发送邮件客户端
        private readonly SmtpClient _client;
        private Thread? _thread = null;

        public MailQueueManager()
        {
            _client = new SmtpClient();
        }

        /// <summary>
        /// 启动队列
        /// </summary>
        public void Run()
        {

            _thread = new Thread(StartSendMail)
            {
                Name = "PmpEmailQueue",
                IsBackground = true,
            };
            Console.WriteLine("线程即将启动");
            _thread.Start();
            Console.WriteLine("线程已经启动，线程Id是：{0}", _thread.ManagedThreadId);
        }

        /// <summary>
        /// 开始发送邮件
        /// </summary>
        private void StartSendMail()
        {
            var sw = new Stopwatch();
            try
            {
                while (true)
                {
                    if (MailQueueProvider._mailQueue.Count <= 0)
                    {
                        Console.WriteLine("队列是空，开始睡眠");
                        Thread.Sleep(5000);
                        continue;
                    }
                    if (MailQueueProvider.TryDequeue(out MailBox box))
                    {
                        Console.WriteLine("开始发送邮件 标题：{0},收件人 {1}", box.Subject, box.To!.First());
                        sw.Restart();
                        SendMail(box);
                        sw.Stop();
                        Console.WriteLine("发送邮件结束标题：{0},收件人 {1},耗时{2}", box.Subject, box.To!.First(), sw.Elapsed.TotalSeconds);
                    }
                }
            }
            catch (Exception ex)
            {
                Console.WriteLine(ex.ToString(), "循环中出错,线程即将结束");

            }
        }

        /// <summary>
        /// 开始构建具体的邮件内容
        /// </summary>
        /// <param name="box"></param>
        /// <exception cref="ArgumentNullException"></exception>
        private void SendMail(MailBox box)
        {
            if (box == null)
            {
                throw new ArgumentNullException(nameof(box));
            }

            try
            {
                MimeMessage message = ConvertToMimeMessage(box);
                SendMail(message);
            }
            catch (Exception exception)
            {
                Console.WriteLine(exception.ToString(), "发送邮件发生异常主题：{0},收件人：{1}", box.Subject, box.To!.First());
            }

        }

        /// <summary>
        /// 邮件具体的内容转换成MimeMessage
        /// </summary>
        /// <param name="box"></param>
        /// <returns></returns>
        /// <exception cref="ArgumentNullException"></exception>
        private MimeMessage ConvertToMimeMessage(MailBox box)
        {
            var message = new MimeMessage();
            //MailboxAddress(发送者名称，发送者账号)
            message.From.Add(new MailboxAddress("cms系统", "wangchengwei324@126.com"));

            //下面构建的是接收者账号
            var mailboxAddressList = new List<MailboxAddress>();
            box.To!.ToList().ForEach(f =>
            {

                mailboxAddressList.Add(new MailboxAddress(box.Subject, f));
            });
            message.To.AddRange(mailboxAddressList);

            message.Subject = box.Subject;// 邮件主题

            // 下面构建邮件内容
            var builder = new BodyBuilder();
            if (box.IsHtml)
            {
                builder.HtmlBody = box.Body;
            }
            else
            {
                builder.TextBody = box.Body;
            }
            message.Body = builder.ToMessageBody();
            return message;
        }

        /// <summary>
        /// 邮件的具体发送
        /// </summary>
        /// <param name="message"></param>
        /// <exception cref="ArgumentNullException"></exception>
        private void SendMail(MimeMessage message)
        {
            if (message == null)
            {
                throw new ArgumentNullException(nameof(message));
            }

            try
            {
                // 指定smtp服务器地址，以及端口号
                _client.Connect("smtp.126.com", 25, false);
                // Note: only needed if the SMTP server requires authentication
                if (!_client.IsAuthenticated)
                {
				// 指定发送者邮箱的地址以及授权码
                    _client.Authenticate(System.Text.Encoding.UTF8, "wangchengwei324@126.com", "OABKWRZWCCHUIU");
                }
                _client.Send(message);
            }
            catch (Exception ex)
            {

                Console.WriteLine(ex.ToString());
            }

            finally
            {
                _client.Disconnect(false);
            }
        }

    }



}

注意：在指定发送者邮箱的时候，一定要指定授权码

授权码可以在发送者邮箱中，通过设置进行获取。（网易126邮箱，授权码有效期为180天）

同时：在发送者（发件人）的邮箱里还需要开启smtp服务与pop3服务。

还需要注意的一个问题：以上关于邮箱的内容最好写到配置文件中，大家自己完成。

6、开启服务

修改Program.cs文件中的代码：

1
2
3
builder.Services.AddSession();
builder.Services.AddHttpClient();
builder.Services.AddSingleton<MailQueueManager>(); //---------------

这里将MailQueueManager.cs类以单例的方式添加到容器中。

1
2
3
4
5
6
7
8
9
10
11
// 处理文章点赞操作
StartProcessingQueue();
//----------------------------- 处理邮件操作
app.Services.GetService<MailQueueManager>()!.Run();

// Configure the HTTP request pipeline.
if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Home/Error");
}
app.UseStaticFiles();

从容器中获取MailQueueManager类的实例，并且调用其内部的Run方法，开启线程，对队列进行扫描，来发送邮件。

注意：实际应用中都是购买相应的邮件服务器。

同时，在测试的时候，可以将数据库中，某个用户的邮箱修改成wang_itcast@126.com,然后，启动网易邮箱大师软件，查看wang_itcast@126.com中的邮件。