Email.Azure: Deconstructing email addresses that include a display name (Lombiq Technologies: OCORE-204)

src/OrchardCore.Modules/OrchardCore.Email.Azure/Services/AzureEmailProviderBase.cs

@@ -1,3 +1,4 @@
+using System.Net.Mail;
 using Azure;
 using Azure.Communication.Email;
 using Microsoft.Extensions.Localization;
@@ -161,19 +162,19 @@ private EmailMessage FromMailMessage(MailMessage message, Dictionary<string, ILi
         List<EmailAddress> toRecipients = null;
         if (recipients.To.Count > 0)
         {
-            toRecipients = [.. recipients.To.Select(r => new EmailAddress(r))];
+            toRecipients = [.. recipients.To.Select(ConvertEmailAddressToAzureEmailAddress)];
         }
 
         List<EmailAddress> ccRecipients = null;
         if (recipients.Cc.Count > 0)
         {
-            ccRecipients = [.. recipients.Cc.Select(r => new EmailAddress(r))];
+            ccRecipients = [.. recipients.Cc.Select(ConvertEmailAddressToAzureEmailAddress)];
         }
 
         List<EmailAddress> bccRecipients = null;
         if (recipients.Bcc.Count > 0)
         {
-            bccRecipients = [.. recipients.Bcc.Select(r => new EmailAddress(r))];
+            bccRecipients = [.. recipients.Bcc.Select(ConvertEmailAddressToAzureEmailAddress)];
         }
 
         var content = new EmailContent(message.Subject);
@@ -187,13 +188,14 @@ private EmailMessage FromMailMessage(MailMessage message, Dictionary<string, ILi
         }
 
         var emailMessage = new EmailMessage(
-            message.From,
+            // For compatibility with configuration for other providers that allow a sender with display name.
+            TryCreateMailAddressOrFail(message.From).EmailAddress,
             new EmailRecipients(toRecipients, ccRecipients, bccRecipients),
             content);
 
         foreach (var address in message.GetReplyTo())
         {
-            emailMessage.ReplyTo.Add(new EmailAddress(address));
+            emailMessage.ReplyTo.Add(ConvertEmailAddressToAzureEmailAddress(address));
         }
 
         foreach (var attachment in message.Attachments)
@@ -224,4 +226,21 @@ private EmailMessage FromMailMessage(MailMessage message, Dictionary<string, ILi
 
         return emailMessage;
     }
+
+    private static EmailAddress ConvertEmailAddressToAzureEmailAddress(string emailWithDisplayName)
+    {
+        var (displayName, emailAddress) = TryCreateMailAddressOrFail(emailWithDisplayName);
+
+        return new EmailAddress(emailAddress, displayName);
+    }
+
+    private static (string DisplayName, string EmailAddress) TryCreateMailAddressOrFail(string email)
+    {
+        if (MailAddress.TryCreate(email, out var mailAddress))
+        {
+            return (mailAddress.DisplayName, mailAddress.Address);
+        }
+
+        throw new ArgumentException($"The email address '{email}' is invalid.");
+    }
 }