How does .net send emails?

Document Directory

• Introduction

• IEmailSender

• ISmtpEmailSender

• NullEmailSender

• Configuration

• Integrated MailKit

• Installation

• Integration

• Usage

• ## Customization

##Introduction

Sending emails is a very common task that is required by almost every application. Abp provides a basic framework for simply sending emails and separates out the configuration of the email service for it.

IEmailSender

It is a service that you can simply use to send emails without knowing its details. The usage is as follows:

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 persontask.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 inject IEmailSender and use the Send method. This method has several overloaded versions, including one that can accept MailMessage objects (it cannot be used in .net core because .net core does not include SmtpClient and MailMessage).

ISmtpEmailSender

There is also an ISmtpEmailSender, which extends IEmailSender and adds the BuildClient method to create a SmtpClient, and then you can use SmtpClient directly (in .net core It cannot be used because .net core does not contain SmtpClient and MailMessage). In most cases it is sufficient to use ISmtpEmailSender.

NullEmailSender

NullEmailSender is the implementation of the Null object design pattern of IEmailSender and can be used in unit testing and property dependency injection.

Configuration

Email sending uses the settings management system to read the configuration of email sending. The names of all settings are defined in Abp.Net.Mail in the form of constants. In the .EmailSettingNames class. The following are its values ​​and descriptions:

Abp.Net.Mail.
• DefaultFromAddress

  : The default email sender's address (as in the example above).

Abp.Net.Mail.
• DefaultFromDisplayName

  : The default email sender display name (as in the example above).

Abp.Net.Mail.
• Smtp.Host

  : IP or domain name of the SMTP server (default is 127.0.0.1).

Abp.Net.Mail.
• Smtp.Port

  : The port of the SMTP server (default is 25).

Abp.Net.Mail.
• Smtp.UserName

  : The user name that needs to be provided when the SMTP server requires authentication.

Abp.Net.Mail.
• Smtp.Password

  : The password that needs to be provided when the SMTP server requires authentication.

Abp.Net.Mail.
• Smtp.Domain

  : The domain name that needs to be provided when the SMTP server requires authentication.

Abp.Net.Mail.
• Smtp.EnableSsl

  : Indicates whether (true) or not (false) an SMTP server requires the use of SSL connections (default is false).

Abp.Net.Mail.
• Smtp.UseDefaultCredentials

  : When True, use the default credentials instead of the provided user and password (default is true).

Integrated MailKit

Since .net core does not support the standard System.Net.Mail.SmtpClient, we need a third-party supplier to To send emails, fortunately, MailKit is a good alternative to the default Smtpclient, and Microsoft recommends using it.

Abp.MailKit package is elegantly integrated into Abp's mail sending system, so you can still use IEmailSender through MailKit as before.

Installation

First, install the Abp.MailKit package into your project:

Install-Package Abp.MailKit

Integration

Add AbpMailKitModule dependency to your module:

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

Usage

You can use IEmailSender as described previously , because the Abp.MailKit package registers the MailKit implementation for it. Also uses the configuration defined above.

Customization

When creating MailKit's SmtpClient, you may have additional configuration or your own customization. At this time, you can replace IMailKitSmtpBuilder with your own implementation The registration of the interface can be made simpler by inheriting DefaultMailKitSmtpBuilder. For example, you want to provide a credential for all SSL connections. In this case, you can override the ConfigureClient method as follows:

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 in the PreInitialize method of your module Replace the implementation of the IMailKitStmpBuilder interface with your implementation above:

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

(Remember to add the "using Abp.Configuration.Startup;" statement, because the extension method of ReplaceService is defined in this namespace ).

The above is the detailed content of How does .net send emails?. For more information, please follow other related articles on the PHP Chinese website!