Merge pull request #46 from IowaComputerGurus/feature/fixes

Feature/fixes

.github/workflows/ci-build.yml

@@ -46,10 +46,10 @@ jobs:
     env:
       solution-path: './src/NetCore.Utilities.Email.Smtp.sln'
     steps:
-      - name: Set up JDK 11
+      - name: Set up JDK 17
         uses: actions/setup-java@v3
         with:
-          java-version: 11
+          java-version: 17
           distribution: zulu
 
       - uses: actions/checkout@v3
@@ -90,8 +90,8 @@ jobs:
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
         shell: powershell
         run: |
-          .\.sonar\scanner\dotnet-sonarscanner begin /k:"IowaComputerGurus_netcore.utilities.email.smtp" /o:"iowacomputergurus-github" /d:sonar.login="${{ secrets.SONAR_TOKEN }}" /d:sonar.host.url="https://sonarcloud.io"
+          .\.sonar\scanner\dotnet-sonarscanner begin /k:"IowaComputerGurus_netcore.utilities.email.smtp" /o:"iowacomputergurus-github" /d:sonar.token="${{ secrets.SONAR_TOKEN }}" /d:sonar.host.url="https://sonarcloud.io"
           dotnet restore "${{ env.solution-path }}"
           dotnet build "${{ env.solution-path }}" --no-restore --configuration Release -p:version=${{ steps.gitversion.outputs.majorMinorPatch }}
           dotnet test "${{ env.solution-path }}" --no-build --configuration Release --collect "XPlat Code Coverage" -- DataCollectionRunSettings.DataCollectors.DataCollector.Configuration.Format=opencover --logger "trx;LogFileName=unittests.trx"
-          .\.sonar\scanner\dotnet-sonarscanner end /d:sonar.login="${{ secrets.SONAR_TOKEN }}"
+          .\.sonar\scanner\dotnet-sonarscanner end /d:sonar.token="${{ secrets.SONAR_TOKEN }}"

src/NetCore.Utilities.Email.Smtp.Tests/MimeMessageFactoryTests.cs

@@ -14,7 +14,7 @@ public class MimeMessageFactoryTests
         private readonly Mock<ILogger<MimeMessageFactory>> _loggerMock;
         private readonly IMimeMessageFactory _factory;
         private readonly Mock<IEmailTemplateFactory> _emailTemplateFactoryMock;
-        private readonly Mock<IHostingEnvironment> _hostingEnvironment;
+        private readonly Mock<IHostEnvironment> _hostingEnvironment;
         private readonly SmtpServiceOptions _options = new SmtpServiceOptions()
         {
             AdminEmail = "admin@test.com",
@@ -30,7 +30,7 @@ public class MimeMessageFactoryTests
         public MimeMessageFactoryTests()
         {
             _loggerMock = new Mock<ILogger<MimeMessageFactory>>();
-            _hostingEnvironment = new Mock<IHostingEnvironment>();
+            _hostingEnvironment = new Mock<IHostEnvironment>();
             _emailTemplateFactoryMock = new Mock<IEmailTemplateFactory>();
             _factory = new MimeMessageFactory(new OptionsWrapper<SmtpServiceOptions>(_options), _loggerMock.Object, _hostingEnvironment.Object, _emailTemplateFactoryMock.Object);
         }

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

@@ -7,17 +7,17 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="coverlet.collector" Version="3.1.2">
+    <PackageReference Include="coverlet.collector" Version="6.0.0">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
-    <PackageReference Include="Microsoft.AspNetCore.Hosting.Abstractions" Version="2.2.0" />
     <PackageReference Include="Microsoft.Extensions.Configuration" Version="6.0.0" />
     <PackageReference Include="Microsoft.Extensions.Configuration.Json" Version="6.0.0" />
+    <PackageReference Include="Microsoft.Extensions.Hosting.Abstractions" Version="6.0.0" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.1.0" />
-    <PackageReference Include="Moq" Version="4.16.1" />
-    <PackageReference Include="xunit" Version="2.4.1" />
-    <PackageReference Include="xunit.runner.visualstudio" Version="2.4.3">
+    <PackageReference Include="Moq" Version="4.20.69" />
+    <PackageReference Include="xunit" Version="2.5.0" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="2.5.0">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
     </PackageReference>

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

@@ -1,4 +1,5 @@
 using System.Collections.Generic;
+using System.Linq;
 using System.Text;
 using Microsoft.Extensions.Options;
 using MimeKit;
@@ -117,6 +118,31 @@ public void SendMessage_WithoutCCRecipients_ShouldSend_DefaultingFromAddress()
             _mimeKitServiceMock.Verify(k => k.SendEmail(mimeMessage));
         }
 
+        [Fact]
+        public void SendMessageWithReplyTo_WithoutCCRecipients_ShouldSend_DefaultingFromAddress()
+        {
+            //Arrange
+            var replyTo = "me@me.com";
+            var replyToName = "Bob";
+            var to = "tester@test.com";
+            var subject = "test";
+            var message = "message";
+            var mimeMessage = new MimeMessage();
+            _mimeMessageFactoryMock
+                .Setup(f => f.CreateFromMessage(_options.AdminEmail, _options.AdminName, to, null, subject, message, ""))
+                .Returns(mimeMessage).Verifiable();
+
+            //Act
+            _service.SendWithReplyTo(replyTo, replyToName, to, subject, message);
+
+            //Verify
+            Assert.Equal(1, mimeMessage.ReplyTo.Count);
+            var replyToAsAdded = mimeMessage.ReplyTo.First();
+            Assert.Equal("\"Bob\" <me@me.com>", replyToAsAdded.ToString());
+            _mimeMessageFactoryMock.Verify();
+            _mimeKitServiceMock.Verify(k => k.SendEmail(mimeMessage));
+        }
+
         [Fact]
         public void SendMessage_WithCCRecipients_ShouldSend_DefaultingFromAddress()
         {
@@ -138,6 +164,32 @@ public void SendMessage_WithCCRecipients_ShouldSend_DefaultingFromAddress()
             _mimeKitServiceMock.Verify(k => k.SendEmail(mimeMessage));
         }
 
+        [Fact]
+        public void SendMessageWithReplyTo_WithCCRecipients_ShouldSend_DefaultingFromAddress()
+        {
+            //Arrange
+            var replyTo = "me@me.com";
+            var replyToName = "Bob";
+            var to = "tester@test.com";
+            var cc = new List<string> { "Person1@test.com" };
+            var subject = "test";
+            var message = "message";
+            var mimeMessage = new MimeMessage();
+            _mimeMessageFactoryMock
+                .Setup(f => f.CreateFromMessage(_options.AdminEmail, _options.AdminName, to, cc, subject, message, ""))
+                .Returns(mimeMessage).Verifiable();
+
+            //Act
+            _service.SendWithReplyTo(replyTo, replyToName, to, cc, subject, message);
+
+            //Verify
+            Assert.Equal(1, mimeMessage.ReplyTo.Count);
+            var replyToAsAdded = mimeMessage.ReplyTo.First();
+            Assert.Equal("\"Bob\" <me@me.com>", replyToAsAdded.ToString());
+            _mimeMessageFactoryMock.Verify();
+            _mimeKitServiceMock.Verify(k => k.SendEmail(mimeMessage));
+        }
+
         [Fact]
         public void SendMessageWithAttachment_ShouldSend_DefaultingFromAddress()
         {
@@ -183,6 +235,33 @@ public void SendMessage_ShouldPassOptionalTemplateName_ToMessageMethods()
             _mimeKitServiceMock.Verify(k => k.SendEmail(mimeMessage));
         }
 
+        [Fact]
+        public void SendMessageWithReplyTo_ShouldPassOptionalTemplateName_ToMessageMethods()
+        {
+            //Arrange
+            var replyTo = "me@me.com";
+            var replyToName = "Bob";
+            var to = "tester@test.com";
+            var cc = new List<string> { "Person1@test.com" };
+            var subject = "test";
+            var message = "message";
+            var requestedTemplate = "Test";
+            var mimeMessage = new MimeMessage();
+            _mimeMessageFactoryMock
+                .Setup(f => f.CreateFromMessage(_options.AdminEmail, _options.AdminName, to, cc, subject, message, requestedTemplate))
+                .Returns(mimeMessage).Verifiable();
+
+            //Act
+            _service.SendWithReplyTo(replyTo, replyToName, to, cc, subject, message, null, requestedTemplate);
+
+            //Assets
+            Assert.Equal(1, mimeMessage.ReplyTo.Count);
+            var replyToAsAdded = mimeMessage.ReplyTo.First();
+            Assert.Equal("\"Bob\" <me@me.com>", replyToAsAdded.ToString());
+            _mimeMessageFactoryMock.Verify();
+            _mimeKitServiceMock.Verify(k => k.SendEmail(mimeMessage));
+        }
+
         [Fact]
         public void SendMessageWithAttachment_ShouldPassOptionalTemplateName_ToMessageMethods()
         {

src/NetCore.Utilities.Email.Smtp.Tests/StartupExtensiosTests.cs

@@ -1,6 +1,6 @@
-using Microsoft.AspNetCore.Hosting;
-using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Hosting;
 using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Options;
 using Moq;
@@ -45,8 +45,7 @@ public void ServiceCollection_ShouldRegisterMimeKitService()
             var configuration = new ConfigurationBuilder()
                 .AddJsonFile("appsettings.json")
                 .Build();
-            collection.AddSingleton(new Mock<Microsoft.Extensions.Hosting.IHostingEnvironment>().Object);
-            collection.AddSingleton(new Mock<IHostingEnvironment>().Object);
+            collection.AddSingleton(new Mock<IHostEnvironment>().Object);
             collection.UseIcgNetCoreUtilitiesEmailSmtp(configuration);
             var services = collection.BuildServiceProvider();
 
@@ -66,8 +65,7 @@ public void ServiceCollection_ShouldRegisterMimeMessageFactory()
             var configuration = new ConfigurationBuilder()
                 .AddJsonFile("appsettings.json")
                 .Build();
-            collection.AddSingleton(new Mock<Microsoft.Extensions.Hosting.IHostingEnvironment>().Object);
-            collection.AddSingleton(new Mock<IHostingEnvironment>().Object);
+            collection.AddSingleton(new Mock<IHostEnvironment>().Object);
             collection.AddSingleton(new Mock<ILogger<MimeMessageFactory>>().Object);
             collection.UseIcgNetCoreUtilitiesEmailSmtp(configuration);
             var services = collection.BuildServiceProvider();
@@ -88,8 +86,7 @@ public void ServiceCollection_ShouldRegisterSmtpService()
             var configuration = new ConfigurationBuilder()
                 .AddJsonFile("appsettings.json")
                 .Build();
-            collection.AddSingleton(new Mock<Microsoft.Extensions.Hosting.IHostingEnvironment>().Object);
-            collection.AddSingleton(new Mock<IHostingEnvironment>().Object);
+            collection.AddSingleton(new Mock<IHostEnvironment>().Object);
             collection.AddSingleton(new Mock<ILogger<MimeMessageFactory>>().Object);
             collection.UseIcgNetCoreUtilitiesEmailSmtp(configuration);
             var services = collection.BuildServiceProvider();

src/NetCore.Utilities.Email.Smtp/MimeMessageFactory.cs

@@ -57,7 +57,7 @@ public interface IMimeMessageFactory
     /// <inheritdoc />
     public class MimeMessageFactory : IMimeMessageFactory
     {
-        private readonly IHostingEnvironment _hostingEnvironment;
+        private readonly IHostEnvironment _hostingEnvironment;
         private readonly IEmailTemplateFactory _emailTemplateFactory;
         private readonly SmtpServiceOptions _serviceOptions;
         private readonly ILogger _logger;
@@ -69,7 +69,7 @@ public class MimeMessageFactory : IMimeMessageFactory
         /// <param name="logger">An instance of ILogger for recording</param>
         /// <param name="hostingEnvironment">Current environment information</param>
         /// <param name="emailTemplateFactory">The ICG Email Template Factory for formatting messages</param>
-        public MimeMessageFactory(IOptions<SmtpServiceOptions> serviceOptions, ILogger<MimeMessageFactory> logger, IHostingEnvironment hostingEnvironment, IEmailTemplateFactory emailTemplateFactory)
+        public MimeMessageFactory(IOptions<SmtpServiceOptions> serviceOptions, ILogger<MimeMessageFactory> logger, IHostEnvironment hostingEnvironment, IEmailTemplateFactory emailTemplateFactory)
         {
             _serviceOptions = serviceOptions.Value;
             _logger = logger;

src/NetCore.Utilities.Email.Smtp/NetCore.Utilities.Email.Smtp.csproj

@@ -33,10 +33,10 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="icg.netcore.utilities.email" Version="4.0.4" />
+    <PackageReference Include="icg.netcore.utilities.email" Version="6.2.0" />
     <PackageReference Include="MailKit" Version="2.15.0" />
-    <PackageReference Include="Microsoft.AspNetCore.Hosting.Abstractions" Version="2.2.0" />
     <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="6.0.0" />
+    <PackageReference Include="Microsoft.Extensions.Hosting.Abstractions" Version="6.0.0" />
     <PackageReference Include="Microsoft.Extensions.Logging" Version="6.0.0" />
     <PackageReference Include="Microsoft.Extensions.Options" Version="6.0.0" />
     <PackageReference Include="Microsoft.Extensions.Options.ConfigurationExtensions" Version="6.0.0" />

src/NetCore.Utilities.Email.Smtp/SmtpService.cs

@@ -1,5 +1,7 @@
-using System.Collections.Generic;
+using System;
+using System.Collections.Generic;
 using Microsoft.Extensions.Options;
+using MimeKit;
 
 namespace ICG.NetCore.Utilities.Email.Smtp
 {
@@ -114,5 +116,65 @@ public bool SendMessage(string toAddress, IEnumerable<string> ccAddressList, str
 
             return true;
         }
+
+        /// <inheritdoc />
+        public bool SendWithReplyTo(string replyToAddress, string replyToName, string toAddress, string subject, string bodyHtml)
+        {
+            //Call full overload
+            return SendWithReplyTo(replyToAddress, replyToName, toAddress, null, subject, bodyHtml);
+        }
+
+        /// <inheritdoc />
+        public bool SendWithReplyTo(string replyToAddress, string replyToName, string toAddress, string subject, string bodyHtml, List<KeyValuePair<string, string>> tokens)
+        {
+            //Call full overload
+            return SendWithReplyTo(replyToAddress, replyToName, toAddress, null, subject, bodyHtml, null, "");
+        }
+
+        /// <inheritdoc />
+        public bool SendWithReplyTo(string replyToAddress, string replyToName, string toAddress, IEnumerable<string> ccAddressList, string subject, string bodyHtml)
+        {
+            //Call full overload
+            return SendWithReplyTo(replyToAddress, replyToName, toAddress, ccAddressList, subject, bodyHtml, null, "");
+        }
+
+        /// <inheritdoc />
+        public bool SendWithReplyTo(string replyToAddress, string replyToName, string toAddress, IEnumerable<string> ccAddressList, string subject, string bodyHtml, List<KeyValuePair<string, string>> tokens)
+        {
+            //Call full overload
+            return SendWithReplyTo(replyToAddress, replyToName, toAddress, ccAddressList, subject, bodyHtml, tokens, "");
+        }
+
+        /// <inheritdoc />
+        public bool SendWithReplyTo(string replyToAddress, string replyToName, string toAddress, IEnumerable<string> ccAddressList, string subject, string bodyHtml, List<KeyValuePair<string, string>> tokens, string templateName, string senderKeyName = "")
+        {
+            if (string.IsNullOrEmpty(replyToAddress))
+                throw new ArgumentNullException(nameof(replyToAddress));
+
+            if (tokens != null)
+            {
+                foreach (var item in tokens)
+                {
+                    bodyHtml = bodyHtml.Replace(item.Key, item.Value);
+                }
+            }
+
+            //Get the message to send
+            var toSend = _mimeMessageFactory.CreateFromMessage(_serviceOptions.AdminEmail, _serviceOptions.AdminName, toAddress, ccAddressList,
+                subject, bodyHtml, templateName);
+
+            //Add the reply to if needed
+            if (!string.IsNullOrEmpty(replyToAddress))
+            {
+                var address = MailboxAddress.Parse(replyToAddress);
+                if(!string.IsNullOrEmpty(replyToName))
+                    address.Name = replyToName;
+                toSend.ReplyTo.Add(address);
+            }
+
+            //Send
+            _mimeKitService.SendEmail(toSend);
+            return true;
+        }
     }
 }