Resolves #2 adding new support for optional configuration of Admin Name property.

Author: mitchelsellers

README.md

@@ -48,6 +48,7 @@ Additionally you must specify the needed configuration elements within your AppS
 ```
   "SendGridServiceOptions": {
     "AdminEmail": "[email protected]",
+    "AdminName": "John Smith",
     "SendGridApiKey": "YourKey",
     "AdditionalApiKeys": { "SpecialSender": "SpecialKey" }
     "AlwaysTemplateEmails": true,
@@ -63,6 +64,7 @@ Additionally you must specify the needed configuration elements within your AppS
 | Setting | Description |
 | --- | --- |
 | AdminEmail | This is the email address used as the "from" address and also for any usage of the "SendToAdministrator" option |
+| AdminName | If specified this is the name that will be used for the "From" address on all outbound emails |
 | SendGridApiKey | The API Key to use for default sending of email addresses |
 | AdditionalApiKeys | These are name/value pairs of additional API keys that could be used for sending emails.  Totally optional |
 | AlwaysTemplateEmails | If selected ALL emails sent will be templated, by default using the "DefaultTemplate" as configured |

src/NetCore.Utilities.Email.SendGrid.Tests/NetCore.Utilities.Email..SendGrid.Tests.csproj

@@ -10,8 +10,8 @@
     <PackageReference Include="Microsoft.AspNetCore.Hosting.Abstractions" Version="2.2.0" />
     <PackageReference Include="Microsoft.Extensions.Configuration" Version="5.0.0" />
     <PackageReference Include="Microsoft.Extensions.Configuration.Json" Version="5.0.0" />
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.8.3" />
-    <PackageReference Include="Moq" Version="4.16.0" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.11.0" />
+    <PackageReference Include="Moq" Version="4.16.1" />
     <PackageReference Include="xunit" Version="2.4.1" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.4.3">
       <PrivateAssets>all</PrivateAssets>

src/NetCore.Utilities.Email.SendGrid.Tests/SmtpServiceTests.cs

@@ -11,6 +11,7 @@ public class SendGridServiceTests
         private readonly SendGridServiceOptions _options = new SendGridServiceOptions()
         {
             AdminEmail = "[email protected]",
+            AdminName = "John Smith",
             SendGridApiKey = "APIKEY",
             AddEnvironmentSuffix = false,
             AlwaysTemplateEmails = false
@@ -54,6 +55,32 @@ public void AdminEmail_ShouldReturnNullWhenNoConfiguration()
             Assert.Null(result);
         }
 
+        [Fact]
+        public void AdminName_ShouldReturnConfigurationName()
+        {
+            //Arrange
+            var expectedName = "John Smith";
+
+            //Act
+            var result = _service.AdminName;
+
+            //Assert
+            Assert.Equal(expectedName, result);
+        }
+
+        [Fact]
+        public void AdminName_ShouldReturnNullWhenNoConfiguration()
+        {
+            //Arrange
+            var testService = new SendGridService(new OptionsWrapper<SendGridServiceOptions>(null), _sendGridMessageBuilderMock.Object, _sendGridSenderMock.Object);
+
+            //Act
+            var result = testService.AdminName;
+
+            //Assert
+            Assert.Null(result);
+        }
+
         [Fact]
         public void SendToAdministrator_ShouldSend_DefaultingFromAndToAddress()
         {

src/NetCore.Utilities.Email.SendGrid.Tests/appsettings.json

@@ -1,6 +1,7 @@
 {
   "SendGridServiceOptions": {
     "AdminEmail": "[email protected]",
+    "AdminName": "John Smith", 
     "SendGridApiKey": "TestKey",
     "AdditionalApiKeys": { "SpecialSender": "SpecialKey" },
     "AlwaysTemplateEmails": true,

src/NetCore.Utilities.Email.SendGrid/NetCore.Utilities.Email.SendGrid.csproj

@@ -33,17 +33,17 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="icg.netcore.utilities.email" Version="3.0.4" />
+    <PackageReference Include="icg.netcore.utilities.email" Version="4.0.4" />
     <PackageReference Include="Microsoft.AspNetCore.Hosting.Abstractions" Version="2.2.0" />
-    <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="5.0.1" />
+    <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="5.0.2" />
     <PackageReference Include="Microsoft.Extensions.Logging" Version="5.0.0" />
     <PackageReference Include="Microsoft.Extensions.Options" Version="5.0.0" />
     <PackageReference Include="Microsoft.Extensions.Options.ConfigurationExtensions" Version="5.0.0" />
     <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.0.0">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
-    <PackageReference Include="SendGrid" Version="9.24.0" />
+    <PackageReference Include="SendGrid" Version="9.24.3" />
   </ItemGroup>
 
 </Project>

src/NetCore.Utilities.Email.SendGrid/SendGridMessageBuilder.cs

@@ -13,41 +13,33 @@ namespace ICG.NetCore.Utilities.Email.SendGrid
     /// </summary>
     public interface ISendGridMessageBuilder
     {
-        /// <summary>
-        /// Creates a simple message for sending
-        /// </summary>
-        /// <param name="from">Who the message is from</param>
-        /// <param name="to">Who the message is to</param>
-        /// <param name="subject">The subject of the message</param>
-        /// <param name="bodyHtml">The Email's HTML content</param>
-        /// <returns></returns>
-        SendGridMessage CreateMessage(string from, string to, string subject, string bodyHtml);
-
         /// <summary>
         /// Creates a simple message for sending with a custom template
         /// </summary>
         /// <param name="from">Who the message is from</param>
+        /// <param name="fromName">The name of the sender</param>
         /// <param name="to">Who the message is to</param>
         /// <param name="cc">An optional listing of CC addresses</param>
         /// <param name="subject">The subject of the message</param>
         /// <param name="bodyHtml">The Email's HTML content</param>
         /// <param name="templateName">The name of the template to use</param>
         /// <returns></returns>
-        SendGridMessage CreateMessage(string from, string to, IEnumerable<string> cc, string subject, string bodyHtml,
+        SendGridMessage CreateMessage(string from, string fromName, string to, IEnumerable<string> cc, string subject, string bodyHtml,
             string templateName = "");
 
         /// <summary>
         /// Creates a simple message for sending with a custom template and attachment
         /// </summary>
         /// <param name="from">Who the message is from</param>
+        /// <param name="fromName">The name of the sender</param>
         /// <param name="to">Who the message is to</param>
         /// <param name="cc">An optional listing of CC addresses</param>
         /// <param name="fileContent">The content of the attachment in bytes</param>
         /// <param name="fileName">The desired name for the file attachment</param>
         /// <param name="subject">The subject of the message</param>
         /// <param name="bodyHtml">The Email's HTML content</param>
         /// <param name="templateName">The name of the template to use</param>
-        SendGridMessage CreateMessageWithAttachment(string from, string to, IEnumerable<string> cc,
+        SendGridMessage CreateMessageWithAttachment(string from, string fromName, string to, IEnumerable<string> cc,
             byte[] fileContent, string fileName, string subject, string bodyHtml, string templateName = "");
     }
 
@@ -74,15 +66,9 @@ public SendGridMessageBuilder(IHostingEnvironment hostingEnvironment, IEmailTemp
             _serviceOptions = options.Value;
             _logger = logger;
         }
-
-        /// <inheritdoc />
-        public SendGridMessage CreateMessage(string from, string to, string subject, string bodyHtml)
-        {
-            return CreateMessage(from, to, null, subject, bodyHtml);
-        }
-
+        
         /// <inheritdoc />
-        public SendGridMessage CreateMessage(string from, string to, IEnumerable<string> cc, string subject, string bodyHtml, string templateName = "")
+        public SendGridMessage CreateMessage(string from, string fromName, string to, IEnumerable<string> cc, string subject, string bodyHtml, string templateName = "")
         {
             //Validate inputs
             if (string.IsNullOrEmpty(from))
@@ -96,6 +82,8 @@ public SendGridMessage CreateMessage(string from, string to, IEnumerable<string>
 
             //Get addresses
             var fromAddress = new EmailAddress(from);
+            if (!string.IsNullOrEmpty(fromName))
+                fromAddress.Name = fromName;
             var recipients = new List<EmailAddress> {new EmailAddress(to)};
             if (cc != null)
             {
@@ -135,11 +123,11 @@ public SendGridMessage CreateMessage(string from, string to, IEnumerable<string>
         }
 
         /// <inheritdoc />
-        public SendGridMessage CreateMessageWithAttachment(string from, string to, IEnumerable<string> cc,
+        public SendGridMessage CreateMessageWithAttachment(string from, string fromName, string to, IEnumerable<string> cc,
             byte[] fileContent, string fileName, string subject, string bodyHtml, string templateName = "")
         {
             //Build the  basic message
-            var toSend = CreateMessage(from, to, cc, subject, bodyHtml, templateName);
+            var toSend = CreateMessage(from, fromName, to, cc, subject, bodyHtml, templateName);
 
             //Attach file
             toSend.Attachments = new List<Attachment>

src/NetCore.Utilities.Email.SendGrid/SendGridService.cs

@@ -17,6 +17,11 @@ public interface ISendGridService
         /// </summary>
         string AdminEmail { get; }
 
+        /// <summary>
+        /// Returns the configured administrator name for the SendGrid service
+        /// </summary>
+        string AdminName { get; }
+
         /// <summary>
         ///     Shortcut for sending an email to the administrator, only requiring the subject and body.
         /// </summary>
@@ -76,6 +81,9 @@ public class SendGridService : ISendGridService
 
         /// <inheritdoc />
         public string AdminEmail => _serviceOptions?.AdminEmail;
+
+        /// <inheritdoc />
+        public string AdminName => _serviceOptions?.AdminName;
 
         /// <summary>
         ///     DI Capable Constructor for SendGrid message delivery using MimeKit/MailKit
@@ -114,7 +122,7 @@ public bool SendMessage(string toAddress, string subject, string bodyHtml)
         public bool SendMessage(string toAddress, IEnumerable<string> ccAddressList, string subject, string bodyHtml, string templateName = "", string senderKeyName = "")
         {
             //Get the message to send
-            var toSend = _messageBuilder.CreateMessage(_serviceOptions.AdminEmail, toAddress, ccAddressList, subject,
+            var toSend = _messageBuilder.CreateMessage(_serviceOptions.AdminEmail, _serviceOptions.AdminName, toAddress, ccAddressList, subject,
                 bodyHtml, templateName);
 
             //Determine the key to use
@@ -130,7 +138,7 @@ public bool SendMessage(string toAddress, IEnumerable<string> ccAddressList, str
         public bool SendMessageWithAttachment(string toAddress, IEnumerable<string> ccAddressList, string subject, byte[] fileContent, string fileName, string bodyHtml, string templateName = "", string senderKeyName = "")
         {
             //Get the message to send
-            var toSend = _messageBuilder.CreateMessageWithAttachment(_serviceOptions.AdminEmail, toAddress,
+            var toSend = _messageBuilder.CreateMessageWithAttachment(_serviceOptions.AdminEmail, _serviceOptions.AdminName, toAddress,
                 ccAddressList, fileContent, fileName, subject, bodyHtml, templateName);
 
             //Determine the key to use

src/NetCore.Utilities.Email.SendGrid/SendGridServiceOptions.cs

@@ -15,12 +15,18 @@ public class SendGridServiceOptions
         public string AdminEmail { get; set; }
 
         /// <summary>
-        /// The SendGrid API key that needs to 
+        ///     An optional name for the administrative user
+        /// </summary>
+        [Display(Name = "Admin Name")]
+        public string AdminName { get; set; }
+
+        /// <summary>
+        ///     The SendGrid API key that needs to
         /// </summary>
         public string SendGridApiKey { get; set; }
 
         /// <summary>
-        /// Optional additional API Keys for sending outbound emails
+        ///     Optional additional API Keys for sending outbound emails
         /// </summary>
         public Dictionary<string, string> AdditionalApiKeys { get; set; }