yv01p/Umbraco-CMS
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #10998 from umbraco/v9/bugfix/email-sending-metadata

Browse Source 
Updates email sender to have some metadata
This commit is contained in:
Warren Buckley
2021-09-01 10:27:29 +01:00
committed by GitHub
parent e727f0f1be 8888c55d2e
commit 74b1c8384a
9 changed files with 35 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
src/Umbraco.Core/Constants-Web.cs
View File

@@ -59,6 +59,15 @@ namespace Umbraco.Cms.Core
public const string ActionToken = "action";
public const string AreaToken = "area";
}
public static class EmailTypes
{
public const string HealthCheck = "HealthCheck";
public const string Notification = "Notification";
public const string PasswordReset = "PasswordReset";
public const string TwoFactorAuth = "2FA";
public const string UserInvite = "UserInvite";
}
}
}
}

4
src/Umbraco.Core/HealthChecks/NotificationMethods/EmailNotificationMethod.cs
View File

@@ -1,4 +1,4 @@
using System;
using System;
using System.Threading.Tasks;
using Microsoft.Extensions.Options;
using Umbraco.Cms.Core.Configuration.Models;
@@ -74,7 +74,7 @@ namespace Umbraco.Cms.Core.HealthChecks.NotificationMethods
var mailMessage = CreateMailMessage(subject, message);
await _emailSender.SendAsync(mailMessage);
await _emailSender.SendAsync(mailMessage, Constants.Web.EmailTypes.HealthCheck);
}
private EmailMessage CreateMailMessage(string subject, string message)

4
src/Umbraco.Core/Mail/IEmailSender.cs
View File

@@ -8,9 +8,9 @@ namespace Umbraco.Cms.Core.Mail
/// </summary>
public interface IEmailSender
{
Task SendAsync(EmailMessage message);
Task SendAsync(EmailMessage message, string emailType);
Task SendAsync(EmailMessage message, bool enableNotification);
Task SendAsync(EmailMessage message, string emailType, bool enableNotification);
bool CanSendRequiredEmail();
}

4
src/Umbraco.Core/Mail/NotImplementedEmailSender.cs
View File

@@ -6,10 +6,10 @@ namespace Umbraco.Cms.Core.Mail
{
internal class NotImplementedEmailSender : IEmailSender
{
public Task SendAsync(EmailMessage message)
public Task SendAsync(EmailMessage message, string emailType)
=> throw new NotImplementedException("To send an Email ensure IEmailSender is implemented with a custom implementation");
public Task SendAsync(EmailMessage message, bool enableNotification) =>
public Task SendAsync(EmailMessage message, string emailType, bool enableNotification) =>
throw new NotImplementedException(
"To send an Email ensure IEmailSender is implemented with a custom implementation");

11
src/Umbraco.Core/Notifications/SendEmailNotification.cs
View File

@@ -4,10 +4,19 @@ namespace Umbraco.Cms.Core.Notifications
{
public class SendEmailNotification : INotification
{
public SendEmailNotification(NotificationEmailModel message) => Message = message;
public SendEmailNotification(NotificationEmailModel message, string emailType)
{
Message = message;
EmailType = emailType;
}
public NotificationEmailModel Message { get; }
/// <summary>
/// Some metadata about the email which can be used by handlers to determine if they should handle the email or not
/// </summary>
public string EmailType { get; }
/// <summary>
/// Call to tell Umbraco that the email sending is handled.
/// </summary>

10
src/Umbraco.Infrastructure/Mail/EmailSender.cs
View File

@@ -49,16 +49,16 @@ namespace Umbraco.Cms.Infrastructure.Mail
/// </summary>
/// <param name="message"></param>
/// <returns></returns>
public async Task SendAsync(EmailMessage message) => await SendAsyncInternal(message, false);
public async Task SendAsync(EmailMessage message, string emailType) => await SendAsyncInternal(message, emailType, false);
public async Task SendAsync(EmailMessage message, bool enableNotification) =>
await SendAsyncInternal(message, enableNotification);
public async Task SendAsync(EmailMessage message, string emailType, bool enableNotification) =>
await SendAsyncInternal(message, emailType, enableNotification);
private async Task SendAsyncInternal(EmailMessage message, bool enableNotification)
private async Task SendAsyncInternal(EmailMessage message, string emailType, bool enableNotification)
{
if (enableNotification)
{
var notification = new SendEmailNotification(message.ToNotificationEmail(_globalSettings.Smtp?.From));
var notification = new SendEmailNotification(message.ToNotificationEmail(_globalSettings.Smtp?.From), emailType);
await _eventAggregator.PublishAsync(notification);
// if a handler handled sending the email then don't continue.

4
src/Umbraco.Infrastructure/Services/Implement/NotificationService.cs
View File

@@ -1,4 +1,4 @@
using System;
using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Globalization;
@@ -519,7 +519,7 @@ namespace Umbraco.Cms.Core.Services.Implement
{
try
{
_emailSender.SendAsync(request.Mail).GetAwaiter().GetResult();
_emailSender.SendAsync(request.Mail, Constants.Web.EmailTypes.Notification).GetAwaiter().GetResult();
_logger.LogDebug("Notification '{Action}' sent to {Username} ({Email})", request.Action, request.UserName, request.Email);
}
catch (Exception ex)

4
src/Umbraco.Web.BackOffice/Controllers/AuthenticationController.cs
View File

@@ -394,7 +394,7 @@ namespace Umbraco.Cms.Web.BackOffice.Controllers
var mailMessage = new EmailMessage(from, user.Email, subject, message, true);
await _emailSender.SendAsync(mailMessage);
await _emailSender.SendAsync(mailMessage, Constants.Web.EmailTypes.PasswordReset);
_userManager.NotifyForgotPasswordRequested(User, user.Id.ToString());
}
@@ -458,7 +458,7 @@ namespace Umbraco.Cms.Web.BackOffice.Controllers
{
var mailMessage = new EmailMessage(from, user.Email, subject, message, true);
await _emailSender.SendAsync(mailMessage);
await _emailSender.SendAsync(mailMessage, Constants.Web.EmailTypes.TwoFactorAuth);
}
else if (provider == "Phone")
{

2
src/Umbraco.Web.BackOffice/Controllers/UsersController.cs
View File

@@ -559,7 +559,7 @@ namespace Umbraco.Cms.Web.BackOffice.Controllers
var mailMessage = new EmailMessage(fromEmail, toMailBoxAddress.ToString(), emailSubject, emailBody, true);
await _emailSender.SendAsync(mailMessage, true);
await _emailSender.SendAsync(mailMessage, Constants.Web.EmailTypes.UserInvite, true);
}
/// <summary>