tweak email template service

Author: pwelter34

samples/EntityFramework/src/Tracker.Shared/Extensions/StringExtensions.cs

@@ -39,7 +39,7 @@ public static partial class StringExtensions
     /// </summary>
     /// <param name="item">A String reference</param>
     /// <returns>
-    ///     <c>true</c> if is null or empty; otherwise, <c>false</c>.
+    ///     <see langword="true"/> if is null or empty; otherwise, <see langword="false"/>.
     /// </returns>
     public static bool IsNullOrEmpty([NotNullWhen(false)] this string? item)
     {
@@ -51,7 +51,7 @@ public static bool IsNullOrEmpty([NotNullWhen(false)] this string? item)
     /// </summary>
     /// <param name="item">A String reference</param>
     /// <returns>
-    ///      <c>true</c> if is null or empty; otherwise, <c>false</c>.
+    ///      <see langword="true"/> if is null or empty; otherwise, <see langword="false"/>.
     /// </returns>
     public static bool IsNullOrWhiteSpace([NotNullWhen(false)] this string? item)
     {
@@ -70,7 +70,7 @@ public static bool IsNullOrWhiteSpace([NotNullWhen(false)] this string? item)
     /// </summary>
     /// <param name="value">The value to check.</param>
     /// <returns>
-    ///   <c>true</c> if the specified <paramref name="value"/> is not <see cref="IsNullOrWhiteSpace"/>; otherwise, <c>false</c>.
+    ///   <see langword="true"/> if the specified <paramref name="value"/> is not <see cref="IsNullOrWhiteSpace"/>; otherwise, <see langword="false"/>.
     /// </returns>
     public static bool HasValue([NotNullWhen(true)] this string? value)
     {

src/Arbiter.Communication/Email/EmailBuilder.cs

@@ -27,10 +27,17 @@ public class EmailBuilder
     /// </summary>
     /// <param name="address">The sender's email address.</param>
     /// <param name="displayName">The optional display name for the sender.</param>
+    /// <param name="condition">An optional predicate to determine if the sender should be set.</param>
     /// <returns>The current <see cref="EmailBuilder"/> instance.</returns>
     /// <exception cref="ArgumentException">Thrown if <paramref name="address"/> is null or empty.</exception>
-    public EmailBuilder From(string address, string? displayName = null)
+    public EmailBuilder From(
+        string? address,
+        string? displayName = null,
+        Func<string?, string?, bool>? condition = null)
     {
+        if (condition is not null && !condition(address, displayName))
+            return this;
+
         ArgumentException.ThrowIfNullOrEmpty(address);
 
         _from = new EmailAddress(address, displayName);
@@ -42,10 +49,17 @@ public EmailBuilder From(string address, string? displayName = null)
     /// </summary>
     /// <param name="address">The reply-to email address.</param>
     /// <param name="displayName">The optional display name for the reply-to address.</param>
+    /// <param name="condition">An optional predicate to determine if the reply-to should be added.</param>
     /// <returns>The current <see cref="EmailBuilder"/> instance.</returns>
     /// <exception cref="ArgumentException">Thrown if <paramref name="address"/> is null or empty.</exception>
-    public EmailBuilder ReplyTo(string address, string? displayName = null)
+    public EmailBuilder ReplyTo(
+        string? address,
+        string? displayName = null,
+        Func<string?, string?, bool>? condition = null)
     {
+        if (condition is not null && !condition(address, displayName))
+            return this;
+
         ArgumentException.ThrowIfNullOrEmpty(address);
 
         _replyTo.Add(new EmailAddress(address, displayName));
@@ -57,10 +71,17 @@ public EmailBuilder ReplyTo(string address, string? displayName = null)
     /// </summary>
     /// <param name="address">The recipient's email address.</param>
     /// <param name="displayName">The optional display name for the recipient.</param>
+    /// <param name="condition">An optional predicate to determine if the recipient should be added.</param>
     /// <returns>The current <see cref="EmailBuilder"/> instance.</returns>
     /// <exception cref="ArgumentException">Thrown if <paramref name="address"/> is null or empty.</exception>
-    public EmailBuilder To(string address, string? displayName = null)
+    public EmailBuilder To(
+        string address,
+        string? displayName = null,
+        Func<string?, string?, bool>? condition = null)
     {
+        if (condition is not null && !condition(address, displayName))
+            return this;
+
         ArgumentException.ThrowIfNullOrEmpty(address);
 
         _to.Add(new EmailAddress(address, displayName));
@@ -72,10 +93,17 @@ public EmailBuilder To(string address, string? displayName = null)
     /// </summary>
     /// <param name="address">The Cc recipient's email address.</param>
     /// <param name="displayName">The optional display name for the Cc recipient.</param>
+    /// <param name="condition">An optional predicate to determine if the Cc recipient should be added.</param>
     /// <returns>The current <see cref="EmailBuilder"/> instance.</returns>
     /// <exception cref="ArgumentException">Thrown if <paramref name="address"/> is null or empty.</exception>
-    public EmailBuilder Cc(string address, string? displayName = null)
+    public EmailBuilder Cc(
+        string address,
+        string? displayName = null,
+        Func<string?, string?, bool>? condition = null)
     {
+        if (condition is not null && !condition(address, displayName))
+            return this;
+
         ArgumentException.ThrowIfNullOrEmpty(address);
 
         _cc.Add(new EmailAddress(address, displayName));
@@ -87,10 +115,17 @@ public EmailBuilder Cc(string address, string? displayName = null)
     /// </summary>
     /// <param name="address">The Bcc recipient's email address.</param>
     /// <param name="displayName">The optional display name for the Bcc recipient.</param>
+    /// <param name="condition">An optional predicate to determine if the Bcc recipient should be added.</param>
     /// <returns>The current <see cref="EmailBuilder"/> instance.</returns>
     /// <exception cref="ArgumentException">Thrown if <paramref name="address"/> is null or empty.</exception>
-    public EmailBuilder Bcc(string address, string? displayName = null)
+    public EmailBuilder Bcc(
+        string address,
+        string? displayName = null,
+        Func<string?, string?, bool>? condition = null)
     {
+        if (condition is not null && !condition(address, displayName))
+            return this;
+
         ArgumentException.ThrowIfNullOrEmpty(address);
 
         _bcc.Add(new EmailAddress(address, displayName));
@@ -177,28 +212,30 @@ public EmailBuilder AddAttachment(
         return this;
     }
 
-
     /// <summary>
-    /// Builds and returns an instance of <see cref="EmailSenders"/> containing the configured sender and reply-to email
-    /// addresses.
+    /// Builds and returns an instance of <see cref="EmailSenders"/> containing the configured sender and reply-to email addresses.
     /// </summary>
-    /// <remarks>Use this method to create an <see cref="EmailSenders"/> instance with the current
-    /// configuration. Ensure that the sender and reply-to addresses have been properly set before calling this
-    /// method.</remarks>
+    /// <remarks>
+    /// Use this method to create an <see cref="EmailSenders"/> instance with the current configuration.
+    /// Ensure that the sender and reply-to addresses have been properly set before calling this method.
+    /// </remarks>
     /// <returns>An <see cref="EmailSenders"/> object initialized with the sender and reply-to email addresses.</returns>
     public EmailSenders BuildSenders() => new(_from, _replyTo);
 
     /// <summary>
     /// Constructs an <see cref="EmailRecipients"/> object using the current recipient lists.
     /// </summary>
-    /// <returns>An <see cref="EmailRecipients"/> instance containing the current "To", "CC", and "BCC" recipient lists.</returns>
+    /// <returns>
+    /// An <see cref="EmailRecipients"/> instance containing the current "To", "Cc", and "Bcc" recipient lists.
+    /// </returns>
     public EmailRecipients BuildRecipients() => new(_to, _cc, _bcc);
 
     /// <summary>
-    /// Builds and returns an <see cref="EmailContent"/> object containing the email's subject, HTML body, and text
-    /// body.
+    /// Builds and returns an <see cref="EmailContent"/> object containing the email's subject, HTML body, and text body.
     /// </summary>
-    /// <returns>An <see cref="EmailContent"/> instance initialized with the current subject, HTML body, and text body values.</returns>
+    /// <returns>
+    /// An <see cref="EmailContent"/> instance initialized with the current subject, HTML body, and text body values.
+    /// </returns>
     public EmailContent BuildContent() => new(_subject, _htmlBody, _textBody);
 
     /// <summary>
@@ -226,7 +263,6 @@ public EmailMessage BuildMessage()
         return new EmailMessage(senders, recipients, content, _headers, _attachments);
     }
 
-
     /// <summary>
     /// Creates a new <see cref="EmailBuilder"/> instance, optionally setting the sender address and display name.
     /// </summary>

src/Arbiter.Communication/Email/EmailConfiguration.cs

@@ -44,7 +44,7 @@ public class EmailConfiguration
     /// Gets or sets a value indicating whether to use SSL when connecting to the SMTP server.
     /// </summary>
     /// <remarks>
-    /// The default value is <c>true</c>.
+    /// The default value is <see langword="true"/>.
     /// </remarks>
     public bool UseSSL { get; set; } = true;
 

src/Arbiter.Communication/Email/EmailTemplateService.cs

@@ -16,45 +16,64 @@ namespace Arbiter.Communication.Email;
 /// </remarks>
 public class EmailTemplateService : IEmailTemplateService
 {
-    private readonly ILogger<EmailTemplateService> _logger;
-    private readonly IOptions<EmailConfiguration> _options;
-    private readonly ITemplateService _templateService;
-    private readonly IEmailDeliveryService _deliveryService;
-
     /// <summary>
     /// Initializes a new instance of the <see cref="EmailTemplateService"/> class.
     /// </summary>
     /// <param name="logger">The logger for diagnostic and error messages.</param>
     /// <param name="options">The email options containing sender and template configuration.</param>
     /// <param name="templateService">The template service for applying models to templates.</param>
     /// <param name="deliveryService">The service responsible for delivering emails.</param>
+    /// <exception cref="ArgumentNullException">
+    /// Thrown if <paramref name="logger"/>, <paramref name="options"/>, <paramref name="templateService"/>, or <paramref name="deliveryService"/> is <see langword="null"/>.
+    /// </exception>
     public EmailTemplateService(
         ILogger<EmailTemplateService> logger,
         IOptions<EmailConfiguration> options,
         ITemplateService templateService,
         IEmailDeliveryService deliveryService)
     {
-        _logger = logger;
-        _options = options;
-        _templateService = templateService;
-        _deliveryService = deliveryService;
+        Logger = logger ?? throw new ArgumentNullException(nameof(logger));
+        Options = options ?? throw new ArgumentNullException(nameof(options));
+        TemplateService = templateService ?? throw new ArgumentNullException(nameof(templateService));
+        DeliveryService = deliveryService ?? throw new ArgumentNullException(nameof(deliveryService));
     }
 
+    /// <summary>
+    /// Gets the logger used for diagnostic and error messages.
+    /// </summary>
+    protected ILogger Logger { get; }
+
+    /// <summary>
+    /// Gets the email configuration options.
+    /// </summary>
+    protected IOptions<EmailConfiguration> Options { get; }
+
+    /// <summary>
+    /// Gets the template service for applying models to templates.
+    /// </summary>
+    protected ITemplateService TemplateService { get; }
+
+    /// <summary>
+    /// Gets the service responsible for delivering emails.
+    /// </summary>
+    protected IEmailDeliveryService DeliveryService { get; }
+
     /// <summary>
     /// Sends an email using a named template, binding the specified model to the template and delivering it to the given recipients.
     /// </summary>
     /// <typeparam name="TModel">The type of the model used for template binding.</typeparam>
     /// <param name="templateName">The name of the template to use for the email.</param>
     /// <param name="emailModel">The model containing data to bind to the template.</param>
     /// <param name="recipients">The recipients of the email, including To, Cc, and Bcc addresses.</param>
-    /// <param name="senders">The sender and optional reply-to addresses for the email. If null, default senders from configuration are used.</param>
+    /// <param name="senders">The sender and optional reply-to addresses for the email. If <see langword="null"/>, default senders from configuration are used.</param>
     /// <param name="cancellationToken">A token to monitor for cancellation requests.</param>
     /// <returns>
     /// A <see cref="Task{TResult}"/> that resolves to an <see cref="EmailResult"/> indicating the outcome of the send operation,
     /// including success status, message, and any exception details.
     /// </returns>
-    /// <exception cref="ArgumentException">Thrown if <paramref name="templateName"/> is null or empty.</exception>
-    /// <exception cref="ArgumentNullException">Thrown if <paramref name="emailModel"/> is null.</exception>
+    /// <exception cref="ArgumentException">Thrown if <paramref name="templateName"/> is <see langword="null"/> or empty.</exception>
+    /// <exception cref="ArgumentNullException">Thrown if <paramref name="emailModel"/> is <see langword="null"/>.</exception>
+    /// <exception cref="Exception">Thrown if an error occurs during template loading or email sending.</exception>
     public async Task<EmailResult> Send<TModel>(
         string templateName,
         TModel emailModel,
@@ -65,7 +84,7 @@ public async Task<EmailResult> Send<TModel>(
         ArgumentException.ThrowIfNullOrEmpty(templateName);
         ArgumentNullException.ThrowIfNull(emailModel);
 
-        var options = _options.Value;
+        var options = Options.Value;
 
         try
         {
@@ -74,18 +93,17 @@ public async Task<EmailResult> Send<TModel>(
                 ? string.Format(options.TemplateResourceFormat, templateName)
                 : templateName;
 
-            var emailTemplate = _templateService.GetResourceTemplate<EmailTemplate?>(templateAssembly, resourceName);
-            if (emailTemplate == null)
+            if (!TemplateService.TryGetResourceTemplate<EmailTemplate>(templateAssembly, resourceName, out var emailTemplate))
             {
-                _logger.LogError("Could not find email template: {TemplateName}", templateName);
+                Logger.LogError("Could not find email template: {TemplateName}", templateName);
                 return EmailResult.Fail($"Could not find template '{templateName}'");
             }
 
-            return await Send(emailTemplate.Value, emailModel, recipients, senders, cancellationToken).ConfigureAwait(false);
+            return await Send(emailTemplate, emailModel, recipients, senders, cancellationToken).ConfigureAwait(false);
         }
         catch (Exception ex)
         {
-            _logger.LogError(ex, "Error sending email: {ErrorMessage}", ex.Message);
+            Logger.LogError(ex, "Error sending email: {ErrorMessage}", ex.Message);
             throw;
         }
     }
@@ -97,13 +115,14 @@ public async Task<EmailResult> Send<TModel>(
     /// <param name="emailTemplate">The email template to use for the message.</param>
     /// <param name="emailModel">The model containing data to bind to the template.</param>
     /// <param name="recipients">The recipients of the email, including To, Cc, and Bcc addresses.</param>
-    /// <param name="senders">The sender and optional reply-to addresses for the email. If null, default senders from configuration are used.</param>
+    /// <param name="senders">The sender and optional reply-to addresses for the email. If <see langword="null"/>, default senders from configuration are used.</param>
     /// <param name="cancellationToken">A token to monitor for cancellation requests.</param>
     /// <returns>
     /// A <see cref="Task{TResult}"/> that resolves to an <see cref="EmailResult"/> indicating the outcome of the send operation,
     /// including success status, message, and any exception details.
     /// </returns>
-    /// <exception cref="ArgumentNullException">Thrown if <paramref name="emailModel"/> is null.</exception>
+    /// <exception cref="ArgumentNullException">Thrown if <paramref name="emailModel"/> is <see langword="null"/>.</exception>
+    /// <exception cref="Exception">Thrown if an error occurs during template application or email sending.</exception>
     public async Task<EmailResult> Send<TModel>(
         EmailTemplate emailTemplate,
         TModel emailModel,
@@ -113,13 +132,13 @@ public async Task<EmailResult> Send<TModel>(
     {
         ArgumentNullException.ThrowIfNull(emailModel);
 
-        var options = _options.Value;
+        var options = Options.Value;
 
         try
         {
-            var subject = _templateService.ApplyTemplate(emailTemplate.Subject, emailModel);
-            var htmlBody = _templateService.ApplyTemplate(emailTemplate.HtmlBody, emailModel);
-            var textBody = _templateService.ApplyTemplate(emailTemplate.TextBody, emailModel);
+            var subject = TemplateService.ApplyTemplate(emailTemplate.Subject, emailModel);
+            var htmlBody = TemplateService.ApplyTemplate(emailTemplate.HtmlBody, emailModel);
+            var textBody = TemplateService.ApplyTemplate(emailTemplate.TextBody, emailModel);
 
             var fromName = options.FromName;
             var fromEmail = options.FromAddress;
@@ -128,18 +147,18 @@ public async Task<EmailResult> Send<TModel>(
 
             if (localSenders.From.Address.IsNullOrWhiteSpace())
             {
-                _logger.LogError("From address is not configured in EmailOptions.");
+                Logger.LogError("From address is not configured in EmailOptions.");
                 return EmailResult.Fail("From address is not configured.");
             }
 
             var content = new EmailContent(subject, htmlBody, textBody);
             var message = new EmailMessage(localSenders, recipients, content);
 
-            return await _deliveryService.Send(message, cancellationToken).ConfigureAwait(false);
+            return await DeliveryService.Send(message, cancellationToken).ConfigureAwait(false);
         }
         catch (Exception ex)
         {
-            _logger.LogError(ex, "Error Sending Email: {ErrorMessage}", ex.Message);
+            Logger.LogError(ex, "Error Sending Email: {ErrorMessage}", ex.Message);
             throw;
         }
     }

src/Arbiter.Communication/Sms/SmsTemplateService.cs

@@ -73,14 +73,13 @@ public async Task<SmsResult> Send<TModel>(
                 ? string.Format(options.TemplateResourceFormat, templateName)
                 : templateName;
 
-            var template = _templateService.GetResourceTemplate<SmsTemplate?>(templateAssembly, resourceName);
-            if (template == null)
+            if (!_templateService.TryGetResourceTemplate<SmsTemplate>(templateAssembly, resourceName, out var template))
             {
                 _logger.LogError("Could not find template: {TemplateName}", templateName);
                 return SmsResult.Fail($"Could not find template '{templateName}'");
             }
 
-            return await Send(template.Value, model, recipient, sender, cancellationToken)
+            return await Send(template, model, recipient, sender, cancellationToken)
                 .ConfigureAwait(false);
         }
         catch (Exception ex)