Introduction

Email sending is a pretty common task for almost every application. ASP.NET Boilerplate provides a basic infrastructure to simply send emails and seperate email server configuration from sending emails.

IEmailSender

IEmailSender is a service to simply send emails without knowing details. Example usage:

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
);
}
}

We simply injected IEmailSender and used Send method. Send method has a few more overloads. It can also get a MailMessage object (not available for .net core since .net core does not include SmtpClient and MailMessage).

我们简单用注射IEmailSender和发送方法。发送方法有更多重载。它也可以让一个MailMessage对象(不可用。NET的核心从.NET核心不包括SmtpClient和邮件)。

ISmtpEmailSender

There is also ISmtpEmailSender which extends IEmailSender and adds BuildClient method to create an SmtpClient to directly use it (not available for .net core since .net core does not include SmtpClient and MailMessage). Using IEmailSender will be enough for most cases.

也有ismtpemailsender继承 iemailsender和添加方法用于创建在一buildclient SmtpClient直接使用它(不可用,因为.NET .NET核心的核心不包含MailMessage和SmtpClient)。使用iemailsender要足够的大多数例子。

NullEmailSender

There is also a null object pattern implementation of IEmailSender as NullEmailSender. You can use it in unit tests or injecting IEmalSender with property injection pattern.

Configuration

Email Sender uses setting management system to read emal sending configuration. All setting names are defined in Abp.Net.Mail.EmailSettingNames class as constant strings. Their values and descriptions:

电子邮件发件人使用设置管理系统读取邮件发送配置。所有设定的名字是在类的定义abp.net.mail.emailsettingnames常量字符串。他们的值和描述:

  • Abp.Net.Mail.DefaultFromAddress: Used as sender email address when you don't specify a sender while sending emails (as like in the sample above).
  • Abp.Net.Mail.DefaultFromDisplayName: Used as sender display name when you don't specify a sender while sending emails (as like in the sample above).
  • Abp.Net.Mail.Smtp.Host: IP/Domain of the SMTP server (default: 127.0.0.1).
  • Abp.Net.Mail.Smtp.Port: Port of the SMTP server (default: 25).
  • Abp.Net.Mail.Smtp.UserName: Username, if SMTP server requires authentication.
  • Abp.Net.Mail.Smtp.Password: Password, if SMTP server requires authentication.
  • Abp.Net.Mail.Smtp.Domain: Domain for the username, if SMTP server requires authentication.
  • Abp.Net.Mail.Smtp.EnableSsl: A value indicates that SMTP server uses SSL or not ("true" or "false". Default: "false").
  • Abp.Net.Mail.Smtp.UseDefaultCredentials: True, to use default credentials instead of provided username and password ("true" or "false". Default: "true").

MailKit Integration

Since .net core does not support standard System.Net.Mail.SmtpClient, so we need a 3rd-party vendor to send emails. Fortunately, MailKit provides a good replacement for default SmtpClient. It's also suggested by Microsoft.

Abp.MailKit package gracefully integrates to ABP's email sending system. So, you can still use IEmailSender as described above to send emails via MailKit.

Installation

First, install Abp.MailKit nuget package to your project:

Install-Package Abp.MailKit

Integration

Add AbpMailKitModule to dependencies of your module:

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

Usage

You can use IEmailSender as described before since Abp.MailKit package registers MailKit implementation for it. It also uses the same configuration defined above.

Customization

You may need to make additional configuration or customization while creating MailKit's SmtpClient. In that case, you can replace IMailKitSmtpBuilder interface with your own implementation. You can derive from DefaultMailKitSmtpBuilder to make it easier. For instance, you may want to accept all SSL certificates. In that case, you can override ConfigureClient method as shown below:

你可能需要进行额外的配置或定制的同时创造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);
}
}

Then you can replace IMailKitSmtpBuilder interface with your implementation in PreInitialize method of your module:

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

(remember to add "using Abp.Configuration.Startup;" statement since ReplaceService extension method is defined in that namespace)

(记得添加“使用ABP。配置。启动;”声明后,replaceservice扩展方法是定义在命名空间)

ABP框架系列之二十四:(Email-Sending-EF-电子邮件发送)的更多相关文章

  1. ABP框架系列之二十:(Dependency-Injection-依赖注入)

    What is Dependency Injection If you already know Dependency Injection concept, Constructor and Prope ...

  2. ABP框架系列之二十六:(EventBus-Domain-Events-领域事件)

    In C#, a class can define own events and other classes can register it to be notified when something ...

  3. ABP框架系列之二十二:(Dynamic-Web-API-动态WebApi)

    Building Dynamic Web API Controllers This document is for ASP.NET Web API. If you're interested in A ...

  4. ABP框架系列之二十八:(Handling-Exceptions-异常处理)

    Introduction This document is for ASP.NET MVC and Web API. If you're interested in ASP.NET Core, see ...

  5. ABP框架系列之二十五:(Embedded-Resource-Files-嵌入式资源文件)

    Introduction ASP.NET Boilerplate provides an easy way of using embedded Razor views (.cshtml files) ...

  6. ABP框架系列之二十九:(Hangfire-Integration-延迟集成)

    Introduction Hangfire is a compherensive background job manager. You can integrate ASP.NET Boilerpla ...

  7. 《sed的流艺术之四》-linux命令五分钟系列之二十四

    本原创文章属于<Linux大棚>博客,博客地址为http://roclinux.cn.文章作者为rocrocket. 为了防止某些网站的恶性转载,特在每篇文章前加入此信息,还望读者体谅. ...

  8. ABP源码分析二十四:Notification

    NotificationDefinition: 用于封装Notification Definnition 的信息.注意和Notification 的区别,如果把Notification看成是具体的消息 ...

  9. ABP框架系列之二:(Entity Framework Core-实体核心框架)

    Introduction(介绍) Abp.EntityFrameworkCore nuget package is used to integrate to Entity Framework (EF) ...

随机推荐

  1. ado.net调用带参数的存储过程

  2. k8s学习笔记之五:Pod资源清单spec字段常用字段及含义

    第一章.前言 在上一篇博客中,我们大致简述了一般情况下资源清单的格式,以及如何获得清单配置的命令帮助,下面我们再讲解下清单中spec字段中比较常见的字段及其含义 第二章.常用字段讲解 spec.con ...

  3. 完整安装always on 集群

    1.  四台已安装windows server 2008 r2 系统的虚拟机,配置如下: CPU : 1核 MEMORY : 2GB DISK : 40GB(未分区) NetAdapter : 2块 ...

  4. spring 之 property-placeholder 分析2

    其实我们可以完全不使用  context:property-placeholder  ,而是使用 PropertySourcesPlaceholderConfigurer : <bean cla ...

  5. ES6语法的数组查询

    setProductId(param){ console.log(param); let prod = this.products.find(item =>{ return item.prodC ...

  6. xml实现登录表单验证

    定义: XML(eXtended Markup Language,可扩展标记语言)提供了一套跨平台.跨网络.跨程序的语言的数据描述方式,使用XML可以方便地实现数据交换.系统配置.内容管理等常见功能. ...

  7. openvas安装和基本使用

    OpenVAS是开放式漏洞评估系统,也可以说它是一个包含着相关工具的网络扫描器. OpenVAS是开放式漏洞评估系统,也可以说它是一个包含着相关工具的网络扫描器.其核心部件是一个服务器,包括一套网络漏 ...

  8. faster rcnn源码阅读笔记3

  9. H5相关网址

    html5中国 http://www.html5cn.org/   HTML 5 教程 http://www.w3school.com.cn/html5/index.asp   http://www. ...

  10. Tomcat常用设置及安全管理规范

    前言 随着公司内部使用Tomcat作为web应用服务器的规模越来越大,为保证Tomcat的配置安全,防止信息泄露,恶性攻击以及配置的安全规范,特制定此Tomcat安全配置规范.注意:  本文章从htt ...