Azure Email Communication Services (Lombiq Technologies: OCORE-129)

OrchardCore.sln

@@ -507,6 +507,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OrchardCore.Sms", "src\Orch
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "OrchardCore.Sms.Core", "src\OrchardCore\OrchardCore.Sms.Core\OrchardCore.Sms.Core.csproj", "{20356393-B16D-466C-8203-877A534E287D}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "OrchardCore.Email.Azure", "src\OrchardCore.Modules\OrchardCore.Email.Azure\OrchardCore.Email.Azure.csproj", "{91DD6469-20AE-4F94-AF49-C13E8FCA4343}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -1335,6 +1337,10 @@ Global
 		{20356393-B16D-466C-8203-877A534E287D}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{20356393-B16D-466C-8203-877A534E287D}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{20356393-B16D-466C-8203-877A534E287D}.Release|Any CPU.Build.0 = Release|Any CPU
+		{91DD6469-20AE-4F94-AF49-C13E8FCA4343}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{91DD6469-20AE-4F94-AF49-C13E8FCA4343}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{91DD6469-20AE-4F94-AF49-C13E8FCA4343}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{91DD6469-20AE-4F94-AF49-C13E8FCA4343}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -1566,6 +1572,7 @@ Global
 		{2D93F509-1FB3-4E22-92F0-588D0EFBA921} = {F23AC6C2-DE44-4699-999D-3C478EF3D691}
 		{CBF6DB53-FD0C-47F8-9E60-A1D247ACFD05} = {A066395F-6F73-45DC-B5A6-B4E306110DCE}
 		{20356393-B16D-466C-8203-877A534E287D} = {F23AC6C2-DE44-4699-999D-3C478EF3D691}
+		{91DD6469-20AE-4F94-AF49-C13E8FCA4343} = {A066395F-6F73-45DC-B5A6-B4E306110DCE}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {46A1D25A-78D1-4476-9CBF-25B75E296341}

src/OrchardCore.Build/Dependencies.AspNetCore.props

@@ -48,6 +48,7 @@
   <!-- 'Microsoft.Extensions' packages that are not included in the ASP.NET Core shared framework -->
   <ItemGroup>
     <PackageManagement Include="Microsoft.Extensions.Caching.StackExchangeRedis" Version="$(MicrosoftExtensionsPackagesVersion)" />
+    <PackageManagement Include="Microsoft.Extensions.Diagnostics.Testing" Version="$(MicrosoftExtensionsPackagesVersion)" />
     <PackageManagement Include="Microsoft.Extensions.Http.Polly" Version="$(MicrosoftExtensionsPackagesVersion)" />
   </ItemGroup>
 

src/OrchardCore.Build/Dependencies.props

@@ -12,6 +12,7 @@
     <PackageManagement Include="AWSSDK.S3" Version="3.7.104.11" />
     <PackageManagement Include="AWSSDK.Extensions.NETCore.Setup" Version="3.7.7" />
     <PackageManagement Include="AWSSDK.SecurityToken" Version="3.7.101.60" />
+    <PackageManagement Include="Azure.Communication.Email" Version="1.0.1" />
     <PackageManagement Include="Azure.Extensions.AspNetCore.Configuration.Secrets" Version="1.3.0" />
     <PackageManagement Include="Azure.Extensions.AspNetCore.DataProtection.Blobs" Version="1.3.2" />
     <PackageManagement Include="Azure.Identity" Version="1.10.4" />

src/OrchardCore.Cms.Web/appsettings.json

@@ -32,6 +32,10 @@
     //  "BlobName": "", // Optional, defaults to Sites/tenant_name/DataProtectionKeys.xml. Templatable, refer docs.
     //  "CreateContainer": true // Creates the container during app startup if it does not already exist.
     //},
+    //"OrchardCore_Email_Azure": {
+    //  "DefaultSender": "",
+    //  "ConnectionString": "" // Set to your Azure Communication Service email connection string.
+    //},
     // See https://docs.orchardcore.net/en/latest/docs/reference/modules/Markdown/#markdown-configuration
     //"OrchardCore_Markdown": {
     //  "Extensions": "nohtml+advanced"

src/OrchardCore.Modules/OrchardCore.Email.Azure/AdminMenu.cs

@@ -0,0 +1,36 @@
+using System;
+using System.Threading.Tasks;
+using Microsoft.Extensions.Localization;
+using OrchardCore.Navigation;
+
+namespace OrchardCore.Email.Azure
+{
+    public class AdminMenu : INavigationProvider
+    {
+        protected readonly IStringLocalizer S;
+
+        public AdminMenu(IStringLocalizer<AdminMenu> localizer)
+        {
+            S = localizer;
+        }
+
+        public Task BuildNavigationAsync(string name, NavigationBuilder builder)
+        {
+            if (!string.Equals(name, "admin", StringComparison.OrdinalIgnoreCase))
+                return Task.CompletedTask;
+
+            builder
+                .Add(S["Configuration"], configuration => configuration
+                    .Add(S["Settings"], settings => settings
+                        .Add(S["Email"], S["Email"].PrefixPosition(), email => email
+                            .AddClass("email").Id("email")
+                            .Add(S["Azure Email Settings"], S["Azure Email Settings"].PrefixPosition(), options => options
+                                .Action("Options", "Admin", new { area = "OrchardCore.Email.Azure" })
+                                .Permission(Permissions.ViewAzureEmailOptions)
+                                .LocalNav())
+                )));
+
+            return Task.CompletedTask;
+        }
+    }
+}

src/OrchardCore.Modules/OrchardCore.Email.Azure/AzureEmailSettings.cs

@@ -0,0 +1,13 @@
+namespace OrchardCore.Email.Azure
+{
+    /// <summary>
+    /// Represents a settings for Azure email.
+    /// </summary>
+    public class AzureEmailSettings : EmailSettings
+    {
+        /// <summary>
+        /// Gets or sets the connection string.
+        /// </summary>
+        public string ConnectionString { get; set; }
+    }
+}

src/OrchardCore.Modules/OrchardCore.Email.Azure/Controllers/AdminController.cs

@@ -0,0 +1,36 @@
+using System.Threading.Tasks;
+using Microsoft.AspNetCore.Authorization;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.Extensions.Options;
+using OrchardCore.Email.Azure.ViewModels;
+
+namespace OrchardCore.Email.Azure.Controllers
+{
+    public class AdminController : Controller
+    {
+        private readonly IAuthorizationService _authorizationService;
+        private readonly AzureEmailSettings _options;
+
+        public AdminController(IAuthorizationService authorizationService, IOptions<AzureEmailSettings> options)
+        {
+            _authorizationService = authorizationService;
+            _options = options.Value;
+        }
+
+        public async Task<IActionResult> Options()
+        {
+            if (!await _authorizationService.AuthorizeAsync(User, Permissions.ViewAzureEmailOptions))
+            {
+                return Forbid();
+            }
+
+            var model = new OptionsViewModel
+            {
+                DefaultSender = _options.DefaultSender,
+                ConnectionString = _options.ConnectionString
+            };
+
+            return View(model);
+        }
+    }
+}

src/OrchardCore.Modules/OrchardCore.Email.Azure/Extensions/OrchardCoreBuilderExtensions.cs

@@ -0,0 +1,21 @@
+using Microsoft.Extensions.Configuration;
+using OrchardCore.Email.Azure;
+using OrchardCore.Environment.Shell.Configuration;
+
+namespace Microsoft.Extensions.DependencyInjection
+{
+    public static class OrchardCoreBuilderExtensions
+    {
+        public static OrchardCoreBuilder ConfigureAzureEmailSettings(this OrchardCoreBuilder builder)
+        {
+            builder.ConfigureServices((tenantServices, serviceProvider) =>
+            {
+                var configurationSection = serviceProvider.GetRequiredService<IShellConfiguration>().GetSection("OrchardCore_Email_Azure");
+
+                tenantServices.PostConfigure<AzureEmailSettings>(settings => configurationSection.Bind(settings));
+            });
+
+            return builder;
+        }
+    }
+}

src/OrchardCore.Modules/OrchardCore.Email.Azure/Manifest.cs

@@ -0,0 +1,11 @@
+using OrchardCore.Modules.Manifest;
+
+[assembly: Module(
+    Name = "Azure Email Communication Services",
+    Author = ManifestConstants.OrchardCoreTeam,
+    Website = ManifestConstants.OrchardCoreWebsite,
+    Version = ManifestConstants.OrchardCoreVersion,
+    Description = "Provides email settings configuration and a default email service based on Azure Communication Services (ACS).",
+    Dependencies = ["OrchardCore.Email"],
+    Category = "Messaging"
+)]

src/OrchardCore.Modules/OrchardCore.Email.Azure/OrchardCore.Email.Azure.csproj

@@ -0,0 +1,30 @@
+<Project Sdk="Microsoft.NET.Sdk.Razor">
+
+  <PropertyGroup>
+    <AddRazorSupportForMvc>true</AddRazorSupportForMvc>
+    <!-- NuGet properties-->
+    <Title>OrchardCore Email</Title>
+    <Description>$(OCFrameworkDescription)
+
+      Provides email settings configuration and a default email service based on SMTP.</Description>
+    <PackageTags>$(PackageTags) OrchardCoreFramework</PackageTags>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <FrameworkReference Include="Microsoft.AspNetCore.App" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\..\OrchardCore\OrchardCore.Admin.Abstractions\OrchardCore.Admin.Abstractions.csproj" />
+    <ProjectReference Include="..\..\OrchardCore\OrchardCore.DisplayManagement\OrchardCore.DisplayManagement.csproj" />
+    <ProjectReference Include="..\..\OrchardCore\OrchardCore.Email.Core\OrchardCore.Email.Core.csproj" />
+    <ProjectReference Include="..\..\OrchardCore\OrchardCore.Navigation.Core\OrchardCore.Navigation.Core.csproj" />
+    <ProjectReference Include="..\..\OrchardCore\OrchardCore.Module.Targets\OrchardCore.Module.Targets.csproj" />
+    <ProjectReference Include="..\..\OrchardCore\OrchardCore.ResourceManagement\OrchardCore.ResourceManagement.csproj" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Azure.Communication.Email" />
+  </ItemGroup>
+
+</Project>

src/OrchardCore.Modules/OrchardCore.Email.Azure/Permissions.cs

@@ -0,0 +1,33 @@
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading.Tasks;
+using OrchardCore.Security.Permissions;
+
+namespace OrchardCore.Email.Azure
+{
+    public class Permissions : IPermissionProvider
+    {
+        public static readonly Permission ViewAzureEmailOptions = new(nameof(ViewAzureEmailOptions), "View Azure Email Options");
+
+        public Task<IEnumerable<Permission>> GetPermissionsAsync()
+        {
+            return Task.FromResult(new[]
+            {
+                ViewAzureEmailOptions,
+            }
+            .AsEnumerable());
+        }
+
+        public IEnumerable<PermissionStereotype> GetDefaultStereotypes()
+        {
+            return new[]
+            {
+                new PermissionStereotype
+                {
+                    Name = "Administrator",
+                    Permissions = new[] { ViewAzureEmailOptions },
+                },
+            };
+        }
+    }
+}

src/OrchardCore.Modules/OrchardCore.Email.Azure/Services/AzureEmailService.cs

@@ -0,0 +1,71 @@
+using System;
+using System.Threading.Tasks;
+using Azure;
+using Azure.Communication.Email;
+using Microsoft.Extensions.Localization;
+using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Options;
+using OrchardCore.Email.Services;
+
+namespace OrchardCore.Email.Azure.Services;
+
+public class AzureEmailService : EmailServiceBase<AzureEmailSettings>
+{
+    /// <summary>
+    /// Initializes a new instance of a <see cref="AzureEmailService"/>.
+    /// </summary>
+    /// <param name="options">The <see cref="IOptions{AzureEmailSettings}"/>.</param>
+    /// <param name="logger">The <see cref="ILogger{AzureEmailService}"/>.</param>
+    /// <param name="stringLocalizer">The <see cref="IStringLocalizer{AzureEmailService}"/>.</param>
+    public AzureEmailService(
+        IOptions<AzureEmailSettings> options,
+        ILogger<AzureEmailService> logger,
+        IStringLocalizer<AzureEmailService> stringLocalizer) : base(options, logger, stringLocalizer)
+    {
+    }
+
+    public async override Task<EmailResult> SendAsync(MailMessage message)
+    {
+        if (message == null)
+        {
+            throw new ArgumentNullException(nameof(message));
+        }
+
+        if (Settings == null)
+        {
+            return EmailResult.Failed(S["Azure Email settings must be configured before an email can be sent."]);
+        }
+
+        EmailResult result;
+        var client = new EmailClient(Settings.ConnectionString);
+
+        try
+        {
+            var senderAddress = string.IsNullOrWhiteSpace(message.From)
+                ? Settings.DefaultSender
+                : message.From;
+
+            if (!string.IsNullOrWhiteSpace(senderAddress))
+            {
+                message.From = senderAddress;
+            }
+
+            var htmlContent = message.IsHtmlBody
+                ? message.Body
+                : null;
+            var plainTextContent = message.IsHtmlBody
+                ? null
+                : message.Body;
+
+            await client.SendAsync(WaitUntil.Completed, senderAddress, message.To, message.Subject, htmlContent, plainTextContent: plainTextContent);
+
+            result = EmailResult.Success;
+        }
+        catch (Exception ex)
+        {
+            result = EmailResult.Failed(S["An error occurred while sending an email: '{0}'", ex.Message]);
+        }
+
+        return result;
+    }
+}

src/OrchardCore.Modules/OrchardCore.Email.Azure/Services/AzureEmailSettingsConfiguration.cs

@@ -0,0 +1,33 @@
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.Options;
+using OrchardCore.Email.Azure;
+using OrchardCore.Environment.Shell.Configuration;
+using OrchardCore.Entities;
+using OrchardCore.Settings;
+
+namespace OrchardCore.Email.Services
+{
+    public class AzureEmailSettingsConfiguration : IConfigureOptions<AzureEmailSettings>
+    {
+        private readonly IShellConfiguration _shellConfiguration;
+        private readonly ISiteService _site;
+
+        public AzureEmailSettingsConfiguration(IShellConfiguration shellConfiguration, ISiteService site)
+        {
+            _shellConfiguration = shellConfiguration;
+            _site = site;
+        }
+
+        public void Configure(AzureEmailSettings options)
+        {
+            var section = _shellConfiguration.GetSection("OrchardCore_Email_Azure");
+
+            var emailSettings = _site.GetSiteSettingsAsync()
+                .GetAwaiter().GetResult()
+                .As<EmailSettings>();
+
+            options.DefaultSender = section.GetValue(nameof(options.DefaultSender), emailSettings.DefaultSender);
+            options.ConnectionString = section.GetValue(nameof(options.ConnectionString), string.Empty);
+        }
+    }
+}