Improve DX regarding service collection extension methods

CHANGELOG.md

@@ -1,6 +1,11 @@
 # Unreleased
 
 - Added some badges to the README
+- Marked `AddRazorEmailRenderer` obsolete, use `AddRazorMailRenderer` instead
+- Marked `AddMailKitRazorMailClient` obsolete, use `AddMailKitMailClient` instead
+- Marked `AddSystemNetRazorMailClient` obsolete, use `AddSystemNetMailClient` instead
+- Added `configureClient` parameter to `AddMailKitMailClient` and `AddSystemNetMailClient` so you can configure the
+  client instance (e.g. default headers)
 
 # 2.1.1
 

TRENZ.Lib.RazorMail.Core/Extensions/RazorMailServiceCollectionExtensions.cs

@@ -1,3 +1,5 @@
+using System;
+
 using Microsoft.Extensions.DependencyInjection;
 
 using TRENZ.Lib.RazorMail.Interfaces;
@@ -7,13 +9,17 @@ namespace TRENZ.Lib.RazorMail.Extensions;
 
 public static class RazorMailServiceCollectionExtensions
 {
-    public static IServiceCollection AddRazorEmailRenderer(this IServiceCollection services)
+    [Obsolete("Use AddRazorMailRenderer instead.")]
+    public static IServiceCollection AddRazorEmailRenderer(this IServiceCollection services) =>
+        services.AddRazorMailRenderer();
+
+    public static IServiceCollection AddRazorMailRenderer(this IServiceCollection services)
     {
         services.AddMvcCore()
-                .AddRazorViewEngine();
+            .AddRazorViewEngine();
 
-        services.AddTransient<IMailRenderer, MailRenderer>();
+        services.AddTransient<IMailRenderer, RazorMailRenderer>();
 
         return services;
     }
-}
+}

TRENZ.Lib.RazorMail.Core/Services/BaseSmtpMailClient.cs

@@ -23,7 +23,7 @@ public abstract class BaseSmtpMailClient(IOptions<SmtpAccount> accountOptions) :
     protected SmtpAccount Account => accountOptions.Value;
 
     /// <inheritdoc />
-    public MailHeaderCollection DefaultHeaders { get; } = new();
+    public MailHeaderCollection DefaultHeaders { get; set; } = new();
 
     /// <inheritdoc />
     public Task SendAsync(MailMessage message, CancellationToken cancellationToken = default)

TRENZ.Lib.RazorMail.Core/Services/MailRenderer.cs → TRENZ.Lib.RazorMail.Core/Services/RazorMailRenderer.cs

@@ -26,7 +26,7 @@ namespace TRENZ.Lib.RazorMail.Services;
 /// <summary>
 /// via https://scottsauber.com/2018/07/07/walkthrough-creating-an-html-email-template-with-razor-and-razor-class-libraries-and-rendering-it-from-a-net-standard-class-library/
 /// </summary>
-public class MailRenderer(
+public class RazorMailRenderer(
     [SuppressMessage("ReSharper", "SuggestBaseTypeForParameterInConstructor",
         Justification = "Only IRazorViewEngine is registered in the DI container.")]
     IRazorViewEngine viewEngine,
@@ -103,4 +103,4 @@ private ActionContext GetActionContext()
 
         return new ActionContext(httpContext, new RouteData(), new ActionDescriptor());
     }
-}
+}

TRENZ.Lib.RazorMail.MailKit/Extensions/ServiceCollectionExtensions.cs

@@ -1,4 +1,8 @@
+using System;
+
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Options;
 
 using TRENZ.Lib.RazorMail.Interfaces;
 using TRENZ.Lib.RazorMail.Models;
@@ -7,19 +11,55 @@ namespace TRENZ.Lib.RazorMail.MailKit.Extensions;
 
 public static class ServiceCollectionExtensions
 {
-    public static IServiceCollection AddMailKitRazorMailClient(this IServiceCollection services)
+    [Obsolete("Use AddMailKitMailClient instead.")]
+    public static IServiceCollection AddMailKitRazorMailClient(this IServiceCollection services) =>
+        services.AddMailKitMailClient();
+
+    public static IServiceCollection AddMailKitMailClient(
+        this IServiceCollection services,
+        Action<IServiceProvider, MailKitMailClient>? configureClient = null
+    ) => services.InternalAddMailKitMailClient(configureClient);
+
+    [Obsolete("Use AddMailKitMailClient instead.")]
+    public static IServiceCollection AddMailKitRazorMailClient(
+        this IServiceCollection services,
+        object serviceKey
+    ) => services.InternalAddMailKitMailClient(null, serviceKey);
+
+    public static IServiceCollection AddMailKitMailClient(
+        this IServiceCollection services,
+        object serviceKey,
+        Action<IServiceProvider, MailKitMailClient>? configureClient = null
+    ) => services.InternalAddMailKitMailClient(configureClient, serviceKey);
+
+    private static IServiceCollection InternalAddMailKitMailClient(
+        this IServiceCollection services,
+        Action<IServiceProvider, MailKitMailClient>? configureClient = null,
+        object? serviceKey = null
+    )
     {
         services.AddOptions<SmtpAccount>().BindConfiguration(SmtpAccount.SectionName);
-        services.AddSingleton<IMailClient, MailKitMailClient>();
+
+        if (serviceKey is null)
+            services.AddSingleton<IMailClient, MailKitMailClient>(sp =>
+                CreateMailKitMailClient(sp, configureClient));
+        else
+            services.AddKeyedSingleton<IMailClient, MailKitMailClient>(serviceKey,
+                (sp, _) => CreateMailKitMailClient(sp, configureClient));
 
         return services;
     }
 
-    public static IServiceCollection AddMailKitRazorMailClient(this IServiceCollection services, object? key)
+    private static MailKitMailClient CreateMailKitMailClient(IServiceProvider sp,
+        Action<IServiceProvider, MailKitMailClient>? configureClient)
     {
-        services.AddOptions<SmtpAccount>().BindConfiguration(SmtpAccount.SectionName);
-        services.AddKeyedSingleton<IMailClient, MailKitMailClient>(key);
+        var accountOptions = sp.GetRequiredService<IOptions<SmtpAccount>>();
+        var logger = sp.GetRequiredService<ILogger<MailKitMailClient>>();
 
-        return services;
+        var client = new MailKitMailClient(accountOptions, logger);
+
+        configureClient?.Invoke(sp, client);
+
+        return client;
     }
 }

TRENZ.Lib.RazorMail.SampleWebApi/Program.cs

@@ -1,17 +1,26 @@
 using TRENZ.Lib.RazorMail.Extensions;
+using TRENZ.Lib.RazorMail.Interfaces;
 using TRENZ.Lib.RazorMail.MailKit.Extensions;
+using TRENZ.Lib.RazorMail.Models;
 using TRENZ.Lib.RazorMail.SystemNet.Extensions;
 
 var builder = WebApplication.CreateBuilder(args);
 
 builder.Configuration.AddJsonFile("appsettings.local.json", optional: true);
 
-builder.Services.AddRazorEmailRenderer();
-builder.Services.AddMailKitRazorMailClient("MailKit");
-builder.Services.AddSystemNetRazorMailClient("System.Net.Mail");
+builder.Services.AddRazorMailRenderer();
+builder.Services.AddMailKitMailClient("MailKit", ConfigureClient);
+builder.Services.AddSystemNetMailClient("System.Net.Mail", ConfigureClient);
 
 var app = builder.Build();
 
 app.MapControllers();
 
 app.Run();
+
+return;
+
+static void ConfigureClient(IServiceProvider sp, IMailClient client)
+{
+    client.DefaultHeaders.ReplyTo = [new MailAddress("[email protected]")];
+}

TRENZ.Lib.RazorMail.SampleWebApi/sendsamplemail.http

@@ -1,5 +1,5 @@
 # Via HTTPS and System.Net.Mail
-POST https://localhost:7141/mail/SendWithSystemNet
+POST http://localhost:5102/mail/SendWithSystemNet
 Content-Type: application/json
 
 {

TRENZ.Lib.RazorMail.SystemNet/Extensions/ServiceCollectionExtensions.cs

@@ -1,4 +1,8 @@
+using System;
+
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Options;
 
 using TRENZ.Lib.RazorMail.Interfaces;
 using TRENZ.Lib.RazorMail.Models;
@@ -7,19 +11,56 @@ namespace TRENZ.Lib.RazorMail.SystemNet.Extensions;
 
 public static class ServiceCollectionExtensions
 {
+    [Obsolete("Use AddSystemNetMailClient instead.")]
     public static IServiceCollection AddSystemNetRazorMailClient(this IServiceCollection services)
+        => services.AddSystemNetMailClient();
+
+    public static IServiceCollection AddSystemNetMailClient(
+        this IServiceCollection services,
+        Action<IServiceProvider, SystemNetMailClient>? configureClient = null
+    ) => services.InternalAddSystemNetMailClient(configureClient);
+
+
+    [Obsolete("Use AddSystemNetMailClient instead.")]
+    public static IServiceCollection AddSystemNetRazorMailClient(
+        this IServiceCollection services,
+        object serviceKey
+    ) => services.InternalAddSystemNetMailClient(null, serviceKey);
+
+    public static IServiceCollection AddSystemNetMailClient(
+        this IServiceCollection services,
+        object serviceKey,
+        Action<IServiceProvider, SystemNetMailClient>? configureClient = null
+    ) => services.InternalAddSystemNetMailClient(configureClient, serviceKey);
+
+    private static IServiceCollection InternalAddSystemNetMailClient(
+        this IServiceCollection services,
+        Action<IServiceProvider, SystemNetMailClient>? configureClient = null,
+        object? serviceKey = null
+    )
     {
         services.AddOptions<SmtpAccount>().BindConfiguration(SmtpAccount.SectionName);
-        services.AddSingleton<IMailClient, SystemNetMailClient>();
+
+        if (serviceKey is null)
+            services.AddSingleton<IMailClient, SystemNetMailClient>(sp =>
+                CreateSystemNetMailClient(sp, configureClient));
+        else
+            services.AddKeyedSingleton<IMailClient, SystemNetMailClient>(serviceKey,
+                (sp, _) => CreateSystemNetMailClient(sp, configureClient));
 
         return services;
     }
 
-    public static IServiceCollection AddSystemNetRazorMailClient(this IServiceCollection services, object? key)
+    private static SystemNetMailClient CreateSystemNetMailClient(IServiceProvider sp,
+        Action<IServiceProvider, SystemNetMailClient>? configureClient)
     {
-        services.AddOptions<SmtpAccount>().BindConfiguration(SmtpAccount.SectionName);
-        services.AddKeyedSingleton<IMailClient, SystemNetMailClient>(key);
+        var accountOptions = sp.GetRequiredService<IOptions<SmtpAccount>>();
+        var logger = sp.GetRequiredService<ILogger<SystemNetMailClient>>();
 
-        return services;
+        var client = new SystemNetMailClient(accountOptions, logger);
+
+        configureClient?.Invoke(sp, client);
+
+        return client;
     }
 }