feat: update to latest Azure Email Client

Credit: @TheObliterator https://github.com/TheObliterator/FluentEmail/tree/add-azure-email-sender

Author: JohnCampionJr

src/Senders/FluentEmail.Azure.Email/AzureEmailSender.cs

@@ -1,12 +1,10 @@
 using System;
 using System.Collections.Generic;
-using System.IO;
 using System.Linq;
 using System.Threading;
 using System.Threading.Tasks;
 using Azure;
 using Azure.Communication.Email;
-using Azure.Communication.Email.Models;
 using Azure.Core;
 using FluentEmail.Core;
 using FluentEmail.Core.Interfaces;
@@ -20,6 +18,13 @@ public class AzureEmailSender : ISender
 {
     private EmailClient _emailClient;
 
+    /// <summary>
+    /// The priority header to use when specifying the importance of an email.
+    /// Values: 1-High, 3-Normal (default), 5-Low
+    /// https://sendgrid.com/blog/magic-email-headers/
+    /// </summary>
+    const string PriorityHeader = "X-Priority";
+
     /// <summary>
     /// Initializes a new instance of <see cref="AzureEmailSender"/>
     /// </summary>
@@ -96,8 +101,10 @@ public async Task<SendResponse> SendAsync(IFluentEmail email, CancellationToken?
 
         var emailRecipients = new EmailRecipients(toRecipients, ccRecipients, bccRecipients);
 
-        var sender = $"{email.Data.FromAddress.Name} <{email.Data.FromAddress.EmailAddress}>";
-        var emailMessage = new EmailMessage(sender, emailContent, emailRecipients);
+        // Azure Email Sender doesn't allow us to specify the 'from' display name (instead the sender name is defined in the blade configuration)
+        // var sender = $"{email.Data.FromAddress.Name} <{email.Data.FromAddress.EmailAddress}>";
+        var sender = email.Data.FromAddress.EmailAddress;
+        var emailMessage = new EmailMessage(sender, emailRecipients, emailContent);
 
         if (email.Data.ReplyToAddresses.Any(a => !string.IsNullOrWhiteSpace(a.EmailAddress)))
         {
@@ -111,7 +118,7 @@ public async Task<SendResponse> SendAsync(IFluentEmail email, CancellationToken?
         {
             foreach (var header in email.Data.Headers)
             {
-                emailMessage.CustomHeaders.Add(new EmailCustomHeader(header.Key, header.Value));
+                emailMessage.Headers.Add(header.Key, header.Value);
             }
         }
 
@@ -123,19 +130,19 @@ public async Task<SendResponse> SendAsync(IFluentEmail email, CancellationToken?
             }
         }
 
-        emailMessage.Importance = email.Data.Priority switch
+        emailMessage.Headers.Add(PriorityHeader, (email.Data.Priority switch
         {
-            Priority.High => EmailImportance.High,
-            Priority.Normal => EmailImportance.Normal,
-            Priority.Low => EmailImportance.Low,
-            _ => EmailImportance.Normal
-        };
+            Priority.High => 1,
+            Priority.Normal => 3,
+            Priority.Low => 5,
+            _ => 3
+        }).ToString());
+
 
         try
         {
-            var sendEmailResult = (await _emailClient.SendAsync(emailMessage, token ?? CancellationToken.None)).Value;
-            
-            var messageId = sendEmailResult.MessageId;
+            EmailSendOperation sendOperation = await _emailClient.SendAsync(WaitUntil.Started, emailMessage, token ?? CancellationToken.None);
+            var messageId = sendOperation.Id;
             if (string.IsNullOrWhiteSpace(messageId))
             {
                 return new SendResponse
@@ -147,32 +154,21 @@ public async Task<SendResponse> SendAsync(IFluentEmail email, CancellationToken?
             // We want to verify that the email was sent.
             // The maximum time we will wait for the message status to be sent/delivered is 2 minutes.
             var cancellationToken = new CancellationTokenSource(TimeSpan.FromMinutes(2));
-            SendStatusResult sendStatusResult;
-            do
-            {
-                sendStatusResult = await _emailClient.GetSendStatusAsync(messageId, cancellationToken.Token);
-                
-                if (sendStatusResult.Status != SendStatus.Queued)
-                {
-                    break;
-                }
-
-                await Task.Delay(TimeSpan.FromSeconds(10), cancellationToken.Token);
-            } while (!cancellationToken.IsCancellationRequested);
+            var sendStatusResult = sendOperation.WaitForCompletion(cancellationToken.Token).Value;
 
-            if (cancellationToken.IsCancellationRequested)
+            if (sendStatusResult.Status == EmailSendStatus.Succeeded)
             {
                 return new SendResponse
                 {
-                    ErrorMessages = new List<string> { "Failed to send email, timed out while getting status." }
+                    MessageId = messageId
                 };
             }
 
-            if (sendStatusResult.Status == SendStatus.OutForDelivery)
+            if (cancellationToken.IsCancellationRequested)
             {
                 return new SendResponse
                 {
-                    MessageId = messageId
+                    ErrorMessages = new List<string> { "Failed to send email, timed out while getting status." }
                 };
             }
 
@@ -189,17 +185,7 @@ public async Task<SendResponse> SendAsync(IFluentEmail email, CancellationToken?
             };
         }
     }
-    
-    private async Task<EmailAttachment> ConvertAttachment(Attachment attachment) =>
-        new(attachment.Filename, attachment.ContentType,
-            await GetAttachmentAsBase64String(attachment.Data));
 
-    private async Task<string> GetAttachmentAsBase64String(Stream stream)
-    {
-        using var ms = new MemoryStream();
-        
-        await stream.CopyToAsync(ms);
-        
-        return Convert.ToBase64String(ms.ToArray());
-    }
-}
+    private async Task<EmailAttachment> ConvertAttachment(Attachment attachment) =>
+        new(attachment.Filename, attachment.ContentType, await BinaryData.FromStreamAsync(attachment.Data));
+}

src/Senders/FluentEmail.Azure.Email/FluentEmail.Azure.Email.csproj

@@ -15,7 +15,7 @@
     </ItemGroup>
 
     <ItemGroup>
-      <PackageReference Include="Azure.Communication.Email" Version="1.0.0-beta.1" />
+      <PackageReference Include="Azure.Communication.Email" Version="1.0.1" />
     </ItemGroup>
 
 </Project>

src/Senders/FluentEmail.Azure.Email/FluentEmailAzureEmailBuilderExtensions.cs

@@ -14,7 +14,7 @@ public static FluentEmailServicesBuilder AddAzureEmailSender(
             this FluentEmailServicesBuilder builder,
             string connectionString)
         {
-            builder.Services.TryAdd(ServiceDescriptor.Scoped<ISender>(_ => new AzureEmailSender(connectionString)));
+            builder.Services.TryAdd(ServiceDescriptor.Singleton((IServiceProvider x) => (ISender)(object)new AzureEmailSender(connectionString)));
             return builder;
         }
 
@@ -23,7 +23,7 @@ public static FluentEmailServicesBuilder AddAzureEmailSender(
             string connectionString,
             EmailClientOptions options)
         {
-            builder.Services.TryAdd(ServiceDescriptor.Scoped<ISender>(_ => new AzureEmailSender(connectionString, options)));
+            builder.Services.TryAdd(ServiceDescriptor.Singleton((IServiceProvider x) => (ISender)(object)new AzureEmailSender(connectionString, options)));
             return builder;
         }
 
@@ -33,7 +33,7 @@ public static FluentEmailServicesBuilder AddAzureEmailSender(
             AzureKeyCredential keyCredential,
             EmailClientOptions options = default)
         {
-            builder.Services.TryAdd(ServiceDescriptor.Scoped<ISender>(_ => new AzureEmailSender(endpoint, keyCredential, options)));
+            builder.Services.TryAdd(ServiceDescriptor.Singleton((IServiceProvider x) => (ISender)(object)new AzureEmailSender(endpoint, keyCredential, options)));
             return builder;
         }
 
@@ -43,7 +43,7 @@ public static FluentEmailServicesBuilder AddAzureEmailSender(
             TokenCredential tokenCredential,
             EmailClientOptions options = default)
         {
-            builder.Services.TryAdd(ServiceDescriptor.Scoped<ISender>(_ => new AzureEmailSender(endpoint, tokenCredential, options)));
+            builder.Services.TryAdd(ServiceDescriptor.Singleton((IServiceProvider x) => (ISender)(object)new AzureEmailSender(endpoint, tokenCredential, options)));
             return builder;
         }
     }

test/FluentEmail.Core.Tests/AzureEmailSenderTests.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.IO;
 using System.Threading.Tasks;
 using NUnit.Framework;