發送郵件

文檔目錄

 

• 簡介
• IEmailSender
  • ISmtpEmailSender
  • NullEmailSender
• 配置
• 集成 MailKit
  • 安裝
  • 集成
  • 用法
  • 定製

 

簡介

發送郵件是一個很經常使用的任務，幾乎每一個應用都須要。Abp提供了一個基本的框架，用於簡單地發送郵件併爲它分離出了郵件服務的配置。

 

IEmailSender

它是一個你無需瞭解它的細節就能簡單地用來發送郵件的服務，用法以下所示：

public class TaskManager : IDomainService
{
    private readonly IEmailSender _emailSender;     public TaskManager(IEmailSender emailSender)
    {
        _emailSender = emailSender;
    }

    public void Assign(Task task, Person person)
    {
        //Assign task to the person
        task.AssignedTo = person;

        //Send a notification email
 _emailSender.Send( to: person.EmailAddress, subject: "You have a new task!", body: $"A new task is assigned for you: <b>{task.Title}</b>", isBodyHtml: true );
    }
}

咱們簡單地注入IEmailSender，並使用Send方法，該方法有幾個重載版本，其中也有能接受MailMessage對象的重載（.net core裏不能用，由於.net core不包含SmtpClient和MailMessage）。

 

ISmtpEmailSender

一樣也有一個ISmtpEmailSender，它擴展了IEmailSender，添加了BuildClient方法，用來建立一個SmtpClient，而後能夠直接使用SmtpClient（.net core裏不能用，由於.net core不包含SmtpClient和MailMessage）。大部分狀況下使用ISmtpEmailSender就已足夠。

 

NullEmailSender

NullEmailSender是IEmailSender 的Null對象設計模式的實現，可用在單元測試和屬性依賴注入中。

 

配置

郵件發送使用了設置管理系統來讀取郵件發送的配置，全部設置的名稱都以常量的形式定義在Abp.Net.Mail.EmailSettingNames類裏。下列是它的值和描述：

• Abp.Net.Mail.DefaultFromAddress：默認的郵件發送者的地址（如上面的示例）。
• Abp.Net.Mail.DefaultFromDisplayName：默認的郵件發送者顯示的名稱（如上面的示例）。
• Abp.Net.Mail.Smtp.Host: SMTP服務器的IP或域名（默認爲127.0.0.1）。
• Abp.Net.Mail.Smtp.Port: SMTP服務器的端口（默認爲25）。
• Abp.Net.Mail.Smtp.UserName: 當SMTP服務器要求認證時，須要提供的用戶名。
• Abp.Net.Mail.Smtp.Password: 當SMTP服務器要求認證時，須要提供的密碼。
• Abp.Net.Mail.Smtp.Domain: 當SMTP服務器要求認證時，須要提供的域名。
• Abp.Net.Mail.Smtp.EnableSsl: 代表一個SMTP服務器是（true）否（false）須要使用SSL鏈接（默認爲false）。
• Abp.Net.Mail.Smtp.UseDefaultCredentials: 爲True時使用默認的憑證代替提供的用戶和密碼（默認爲true）。

 

集成 MailKit

因爲.net core不支持標準的System.Net.Mail.SmtpClient，因此咱們須要第三方供應商來發送郵件，幸運地是，MailKit 是默認的Smtpclient的一個很好的代替，並且微軟也建議使用它。

Abp.MailKit 包優雅地集成到了Abp的郵件發送系統裏，因此，你仍可像前面的方式經過MailKit使用IEmailSender。

 

安裝

首先，安裝Abp.MailKit 包到你的項目：

Install-Package Abp.MailKit

 

集成

添加AbpMailKitModule 依賴到你的模塊：

[DependsOn(typeof(AbpMailKitModule))] public class MyProjectModule : AbpModule
{
    //...
}

 

用法

你能夠像前面描述的那樣使用IEmailSender，由於Abp.MailKit包爲它註冊了MailKit的實現。也使用上面定義的配置。

 

定製

在建立MailKit的SmtpClient時，你可能會有額外的配置或本身的定製，此時，你能夠用你本身的實現替換IMailKitSmtpBuilder 接口的註冊，不過能夠經過繼承DefaultMailKitSmtpBuilder 更簡單。好比，你想爲全部的SSL鏈接提供一個憑證，這種狀況下，你能夠重寫ConfigureClient方法，以下所示：

public class MyMailKitSmtpBuilder : DefaultMailKitSmtpBuilder
{
    public MyMailKitSmtpBuilder(ISmtpEmailSenderConfiguration smtpEmailSenderConfiguration) 
        : base(smtpEmailSenderConfiguration)
    {
    }

    protected override void ConfigureClient(SmtpClient client)
    {
        client.ServerCertificateValidationCallback = (sender, certificate, chain, errors) => true;         base.ConfigureClient(client);
    }
}

而後在你的模塊的PreInitialize方法中用你上面的實現替換IMailKitStmpBuilder接口的實現：

[DependsOn(typeof(AbpMailKitModule))]
public class MyProjectModule : AbpModule
{
    public override void PreInitialize()
    {
        Configuration.ReplaceService<IMailKitSmtpBuilder, MyMailKitSmtpBuilder>();
    }

    //...
}

（記得添加"using Abp.Configuration.Startup;"聲明，由於ReplaceService 的擴展方法定義在這個命名空間裏）。