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

OrchardCore.sln

@@ -427,8 +427,12 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OrchardCore.AuditTrail.Abst
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OrchardCore.AuditTrail", "src\OrchardCore.Modules\OrchardCore.AuditTrail\OrchardCore.AuditTrail.csproj", "{67509F89-E3D6-4FF9-98EC-A9519937A364}"
 EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OrchardCore.Email.Azure", "src\OrchardCore.Modules\OrchardCore.Email.Azure\OrchardCore.Email.Azure.csproj", "{91DD6469-20AE-4F94-AF49-C13E8FCA4343}"
+EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OrchardCore.Email.Core", "src\OrchardCore\OrchardCore.Email.Core\OrchardCore.Email.Core.csproj", "{D00CF459-396D-49C9-92E2-3FD3C2A59847}"
 EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OrchardCore.Email.Smtp", "src\OrchardCore.Modules\OrchardCore.Email.Smtp\OrchardCore.Email.Smtp.csproj", "{44BF04A1-5C0C-4773-9C1E-FE1013841857}"
+EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "OrchardCore", "OrchardCore", "{2BC850C3-9846-47E1-9068-AC0A8E5537AC}"
 	ProjectSection(SolutionItems) = preProject
 		src\OrchardCore\Directory.Build.props = src\OrchardCore\Directory.Build.props
@@ -511,9 +515,9 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OrchardCore.Search.AzureAI"
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OrchardCore.Search.AzureAI.Core", "src\OrchardCore\OrchardCore.Search.AzureAI.Core\OrchardCore.Search.AzureAI.Core.csproj", "{E9428DE8-5D81-4359-BF84-31435041FF1A}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "OrchardCore.Media.Indexing.Pdf", "src\OrchardCore.Modules\OrchardCore.Media.Indexing.Pdf\OrchardCore.Media.Indexing.Pdf.csproj", "{95187E6A-5B74-4475-8FEB-758ACD012DCC}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OrchardCore.Media.Indexing.Pdf", "src\OrchardCore.Modules\OrchardCore.Media.Indexing.Pdf\OrchardCore.Media.Indexing.Pdf.csproj", "{95187E6A-5B74-4475-8FEB-758ACD012DCC}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "OrchardCore.Media.Indexing.OpenXML", "src\OrchardCore.Modules\OrchardCore.Media.Indexing.OpenXML\OrchardCore.Media.Indexing.OpenXML.csproj", "{47777735-7432-4CCA-A8C5-672E9EE65121}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OrchardCore.Media.Indexing.OpenXML", "src\OrchardCore.Modules\OrchardCore.Media.Indexing.OpenXML\OrchardCore.Media.Indexing.OpenXML.csproj", "{47777735-7432-4CCA-A8C5-672E9EE65121}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
@@ -1233,10 +1237,18 @@ Global
 		{67509F89-E3D6-4FF9-98EC-A9519937A364}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{67509F89-E3D6-4FF9-98EC-A9519937A364}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{67509F89-E3D6-4FF9-98EC-A9519937A364}.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
 		{D00CF459-396D-49C9-92E2-3FD3C2A59847}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{D00CF459-396D-49C9-92E2-3FD3C2A59847}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{D00CF459-396D-49C9-92E2-3FD3C2A59847}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{D00CF459-396D-49C9-92E2-3FD3C2A59847}.Release|Any CPU.Build.0 = Release|Any CPU
+		{44BF04A1-5C0C-4773-9C1E-FE1013841857}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{44BF04A1-5C0C-4773-9C1E-FE1013841857}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{44BF04A1-5C0C-4773-9C1E-FE1013841857}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{44BF04A1-5C0C-4773-9C1E-FE1013841857}.Release|Any CPU.Build.0 = Release|Any CPU
 		{7F31D1A5-2B6F-448A-9337-482F876B85EF}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{7F31D1A5-2B6F-448A-9337-482F876B85EF}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{7F31D1A5-2B6F-448A-9337-482F876B85EF}.Release|Any CPU.ActiveCfg = Release|Any CPU
@@ -1556,7 +1568,9 @@ Global
 		{AB47A65C-7BA9-4CE7-BA73-285EB7A2CEFD} = {F23AC6C2-DE44-4699-999D-3C478EF3D691}
 		{442C544F-6587-4FA5-8459-710ED8492AD4} = {F23AC6C2-DE44-4699-999D-3C478EF3D691}
 		{67509F89-E3D6-4FF9-98EC-A9519937A364} = {A066395F-6F73-45DC-B5A6-B4E306110DCE}
+		{91DD6469-20AE-4F94-AF49-C13E8FCA4343} = {A066395F-6F73-45DC-B5A6-B4E306110DCE}
 		{D00CF459-396D-49C9-92E2-3FD3C2A59847} = {F23AC6C2-DE44-4699-999D-3C478EF3D691}
+		{44BF04A1-5C0C-4773-9C1E-FE1013841857} = {A066395F-6F73-45DC-B5A6-B4E306110DCE}
 		{2BC850C3-9846-47E1-9068-AC0A8E5537AC} = {184139CF-C4AB-4FBE-AE19-54C8B3FE5C5E}
 		{85EF279B-8F35-476D-9BBD-F503F20712B5} = {184139CF-C4AB-4FBE-AE19-54C8B3FE5C5E}
 		{21F459C1-494E-41C9-B221-6C102774A47F} = {184139CF-C4AB-4FBE-AE19-54C8B3FE5C5E}

mkdocs.yml

@@ -197,6 +197,7 @@ nav:
       - Core Modules:
           - Audit Trail: docs/reference/modules/AuditTrail/README.md
           - Auto Setup: docs/reference/modules/AutoSetup/README.md
+          - Azure Email: docs/reference/modules/Email.Azure/README.md
           - Features: docs/reference/modules/Features/README.md
           - Contents: docs/reference/modules/Contents/README.md
           - Configuration: docs/reference/core/Configuration/README.md
@@ -229,6 +230,7 @@ nav:
           - Security: docs/reference/modules/Security/README.md
           - Setup: docs/reference/modules/Setup/README.md
           - Shells: docs/reference/core/Shells/README.md
+          - SMTP Email: docs/reference/modules/Email.Smtp/README.md
           - Tenants: docs/reference/modules/Tenants/README.md
           - Workflows: docs/reference/modules/Workflows/README.md
           - DataProtection (Azure Storage): docs/reference/modules/DataProtection.Azure/README.md

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,29 @@
     //  "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": {
+    //  "DefaultSender": ""
+    //},
+    //"OrchardCore_Email_Azure": {
+    //  "DefaultSender": "",
+    //  "ConnectionString": "" // Set to your Azure Communication Service email connection string.
+    //},
+    //"OrchardCore_Email_Smtp": {
+    //  "DefaultSender": "",
+    //  "DeliveryMethod": "Network",
+    //  "PickupDirectoryLocation": "",
+    //  "Host": "localhost",
+    //  "Port": 25,
+    //  // Uncomment if SMTP server runs through a proxy server
+    //  //"ProxyHost": "proxy.domain.com",
+    //  //"ProxyPort": 5050,
+    //  "EncryptionMethod": "SSLTLS",
+    //  "AutoSelectEncryption": false,
+    //  "UseDefaultCredentials": false,
+    //  "RequireCredentials": true,
+    //  "Username": "",
+    //  "Password": ""
+    //},
     // See https://docs.orchardcore.net/en/latest/docs/reference/modules/Markdown/#markdown-configuration
     //"OrchardCore_Markdown": {
     //  "Extensions": "nohtml+advanced"
@@ -201,22 +224,6 @@
     //"OrchardCore_HealthChecks": {
     //  "Url": "/health/live"
     //},
-    //"OrchardCore_Email": {
-    //  "DefaultSender": "",
-    //  "DeliveryMethod": "Network",
-    //  "PickupDirectoryLocation": "",
-    //  "Host": "localhost",
-    //  "Port": 25,
-    //  // Uncomment if SMTP server runs through a proxy server
-    //  //"ProxyHost": "proxy.domain.com",
-    //  //"ProxyPort": 5050,
-    //  "EncryptionMethod": "SSLTLS",
-    //  "AutoSelectEncryption": false,
-    //  "UseDefaultCredentials": false,
-    //  "RequireCredentials": true,
-    //  "Username": "",
-    //  "Password": ""
-    //},
     //"OrchardCore_ReverseProxy": {
     //  "ForwardedHeaders": "None"
     //},

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

@@ -0,0 +1,37 @@
+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/AzureEmailConstants.cs

@@ -0,0 +1,6 @@
+namespace OrchardCore.Email.Azure;
+
+public static class AzureEmailConstants
+{
+    public static readonly string EmailDeliveryServiceName = "azure";
+}

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

@@ -0,0 +1,12 @@
+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,35 @@
+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,20 @@
+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",
+    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,29 @@
+<Project Sdk="Microsoft.NET.Sdk.Razor">
+
+  <PropertyGroup>
+    <AddRazorSupportForMvc>true</AddRazorSupportForMvc>
+    <!-- NuGet properties-->
+    <Title>OrchardCore Azure Email</Title>
+    <Description>$(OCFrameworkDescription)
+
+      Provides email settings configuration and a default email service based on Azure Communication Services.</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" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Azure.Communication.Email" />
+  </ItemGroup>
+
+</Project>

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

@@ -0,0 +1,32 @@
+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 },
+            },
+        };
+    }
+}