使用Volo.Abp.MailKit傳送郵件

zero@發表於2020-06-10
AI

Volo.Abp.MailKit封裝繼承MailKit庫，為Abp郵件傳送提供了快捷實現。

郵箱配置

qq郵箱支援smtp功能，需要去申請開通。參考qq郵箱設定，最重要的是smtp傳送郵件，qq郵箱對應的密碼不是使用者的qq郵箱密碼，而是需要申請生成的授權碼。

郵箱配置

在專案的appsettings.json配置檔案裡，新增如下配置專案。

"Settings": {
    "Abp.Mailing.DefaultFromAddress": "xx@qq.com",
    "Abp.Mailing.DefaultFromDisplayName": "xx",
    "Abp.Mailing.Smtp.Host": "smtp.qq.com",
    "Abp.Mailing.Smtp.Port": "587",
    "Abp.Mailing.Smtp.Domain": "smtp.qq.com",
    "Abp.Mailing.Smtp.UserName": "xx@qq.com",
    "Abp.Mailing.Smtp.Password": "xxx",
    "Abp.Mailing.Smtp.EnableSsl": "false",
    "Abp.Mailing.Smtp.UseDefaultCredentials": "false"
  }

注意

  1. Abp.Mailing.Smtp.EnableSsl專案應設定為false。

  2. Abp.Mailing.Smtp.UseDefaultCredentials專案應設定為false。

  3. Abp.Mailing.Smtp.Password應設定為qq郵箱對應的授權碼密文。

密文可呼叫IStringEncryptionService.Encrypt(授權碼)獲取

傳送郵件

在一個後臺作業裡傳送郵件，完整程式碼如下。

 public class EmailSendingJob : BackgroundJob<EmailSendingArgs>, ITransientDependency
    {
        private readonly IMailKitSmtpEmailSender _emailSender;
        public EmailSendingJob(IMailKitSmtpEmailSender emailSender)
        {
            _emailSender = emailSender;
        }

        public override void Execute(EmailSendingArgs args)
        {
            Action action = async () =>
            {
                await _emailSender.SendAsync(
                    args.EmailAddress,
                    args.Subject,
                    args.Body,
                    false
                );
            };
            action?.Invoke();
        }
    }

看看測試效果，郵件正確的傳送接收了。

測試效果

配置郵箱密碼使用明文

框架預設EmailSettingProvider設定EmailSettingNames.Smtp.Password的isEncrypted屬性預設為true，所以在上面的appsettings.json中需要設定為授權碼的密文。

根據官方的文件，我們可以修改EmailSettingNames.Smtp.Password的isEncrypted屬性預設為false，這樣就可以直接使用授權碼明文。

在專案中新建一個MySettingDefinitionProvider檔案，並繼承自SettingDefinitionProvider類。

 public class MySettingDefinitionProvider : SettingDefinitionProvider
    {
        public override void Define(ISettingDefinitionContext context)
        {
            var smtpPassword = context.GetOrNull("Abp.Mailing.Smtp.Password");
            if (smtpPassword != null)
            {
                smtpPassword.IsEncrypted = false;
            }
        }
    }

官方參考文件

相關文章