* Upgraded to Cofoundry v0.10 pre-release

HeyJoel · HeyJoel · commit 1bb5f87344b0 · 2022-03-02T16:41:14.000Z
* Added example project
diff --git a/.gitignore b/.gitignore
@@ -101,4 +101,7 @@ src/.vs
 
 # Cake Build
 /tools
-/artifacts
+/artifacts
+
+appsettings.local.json
+APP_Data/
diff --git a/src/Cofoundry.Plugins.Mail.MailKit.sln b/src/Cofoundry.Plugins.Mail.MailKit.sln
@@ -1,9 +1,13 @@
 ﻿
 Microsoft Visual Studio Solution File, Format Version 12.00
-# Visual Studio 15
-VisualStudioVersion = 15.0.26430.13
+# Visual Studio Version 16
+VisualStudioVersion = 16.0.32126.315
 MinimumVisualStudioVersion = 10.0.40219.1
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Cofoundry.Plugins.Mail.MailKit", "Cofoundry.Plugins.Mail.MailKit\Cofoundry.Plugins.Mail.MailKit.csproj", "{8D628D8E-3AD8-4259-B08A-C7CC0FCC609D}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Cofoundry.Plugins.Mail.MailKit", "Cofoundry.Plugins.Mail.MailKit\Cofoundry.Plugins.Mail.MailKit.csproj", "{8D628D8E-3AD8-4259-B08A-C7CC0FCC609D}"
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Samples", "Samples", "{DBD04643-D345-4DF5-AD0A-9A179649A4CA}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "MailKitExample", "MailKitExample\MailKitExample.csproj", "{B78AFB4C-1ECF-4E72-AE5E-BC6638CE12C2}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
@@ -15,8 +19,18 @@ Global
 		{8D628D8E-3AD8-4259-B08A-C7CC0FCC609D}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{8D628D8E-3AD8-4259-B08A-C7CC0FCC609D}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{8D628D8E-3AD8-4259-B08A-C7CC0FCC609D}.Release|Any CPU.Build.0 = Release|Any CPU
+		{B78AFB4C-1ECF-4E72-AE5E-BC6638CE12C2}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{B78AFB4C-1ECF-4E72-AE5E-BC6638CE12C2}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{B78AFB4C-1ECF-4E72-AE5E-BC6638CE12C2}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{B78AFB4C-1ECF-4E72-AE5E-BC6638CE12C2}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
 	EndGlobalSection
+	GlobalSection(NestedProjects) = preSolution
+		{B78AFB4C-1ECF-4E72-AE5E-BC6638CE12C2} = {DBD04643-D345-4DF5-AD0A-9A179649A4CA}
+	EndGlobalSection
+	GlobalSection(ExtensibilityGlobals) = postSolution
+		SolutionGuid = {795B0D5E-1717-4A6C-8111-2FE1E07DF4B6}
+	EndGlobalSection
 EndGlobal
diff --git a/src/Cofoundry.Plugins.Mail.MailKit/Bootstrap/MailKitDependencyRegistration.cs b/src/Cofoundry.Plugins.Mail.MailKit/Bootstrap/MailKitDependencyRegistration.cs
@@ -17,7 +17,7 @@ public void Register(IContainerRegister container)
             var overrideOptions = RegistrationOptions.Override();
 
             container
-                .Register<IMailDispatchService, MailKitMailDispatchService>(overrideOptions)
+                .Register<IMailDispatchSession, MailKitMailDispatchSession>(overrideOptions)
                 .Register<ISmtpClientConnectionConfiguration, SmtpClientConnectionConfiguration>()
                 ; 
         }
diff --git a/src/Cofoundry.Plugins.Mail.MailKit/Cofoundry.Plugins.Mail.MailKit.csproj b/src/Cofoundry.Plugins.Mail.MailKit/Cofoundry.Plugins.Mail.MailKit.csproj
@@ -16,8 +16,8 @@
   </PropertyGroup>
   
   <ItemGroup>
-    <PackageReference Include="Cofoundry.Core" Version="0.9.2" />
-    <PackageReference Include="MailKit" Version="2.10.1" />
+    <PackageReference Include="Cofoundry.Core" Version="0.9.3-reworking-user-a0100" />
+    <PackageReference Include="MailKit" Version="3.1.1" />
   </ItemGroup>
 
 </Project>
diff --git a/src/Cofoundry.Plugins.Mail.MailKit/MailKitMailDispatchService.cs b/src/Cofoundry.Plugins.Mail.MailKit/MailKitMailDispatchService.cs
diff --git a/src/Cofoundry.Plugins.Mail.MailKit/MailKitMailDispatchSession.cs b/src/Cofoundry.Plugins.Mail.MailKit/MailKitMailDispatchSession.cs
@@ -6,8 +6,6 @@
 using System;
 using System.Collections.Generic;
 using System.IO;
-using System.Linq;
-using System.Text;
 using System.Threading.Tasks;
 
 namespace Cofoundry.Plugins.Mail.MailKit
@@ -16,7 +14,7 @@ namespace Cofoundry.Plugins.Mail.MailKit
     /// Mail dispatch session that uses System.Net.Mail to
     /// dispatch email.
     /// </summary>
-    public class MilKitMailDispatchSession : IMailDispatchSession
+    public class MailKitMailDispatchSession : IMailDispatchSession
     {
         private readonly Queue<MimeMessage> _mailQueue = new Queue<MimeMessage>();
         private readonly Lazy<SmtpClient> _mailClient;
@@ -26,7 +24,7 @@ public class MilKitMailDispatchSession : IMailDispatchSession
 
         private bool isDisposing = false;
 
-        public MilKitMailDispatchSession(
+        public MailKitMailDispatchSession(
             MailSettings mailSettings,
             IPathResolver pathResolver,
             ISmtpClientConnectionConfiguration smtpClientConnectionConfiguration
@@ -82,8 +80,6 @@ public void Dispose()
             }
         }
 
-        #region private methods
-
         private void ValidateNotDisposed()
         {
             if (isDisposing)
@@ -121,7 +117,7 @@ private SmtpClient CreateSmtpMailClient()
             if (isDisposing) return null;
             return new SmtpClient();
         }
-        
+
         private MimeMessage FormatMessage(MailMessage message)
         {
             if (message == null) throw new ArgumentNullException(nameof(message));
@@ -196,7 +192,7 @@ private MailboxAddress CreateMailAddress(string email, string displayName)
             {
                 if (string.IsNullOrEmpty(displayName))
                 {
-                    mailAddress = new MailboxAddress(email);
+                    mailAddress = new MailboxAddress(null, email);
                 }
                 else
                 {
@@ -226,7 +222,5 @@ private string GetMailDropPath()
 
             return mailDropDirectory;
         }
-
-        #endregion
     }
 }
diff --git a/src/MailKitExample/Cofoundry/MailTemplates/ExampleMailTemplate.cs b/src/MailKitExample/Cofoundry/MailTemplates/ExampleMailTemplate.cs
@@ -0,0 +1,33 @@
+﻿using Cofoundry.Core.Mail;
+
+namespace MailKitExample
+{
+    /// <summary>
+    /// Each email consists of a template class and a set of
+    /// template files. The template class is used as the view 
+    /// model and so you can include any custom propeties that
+    /// want to make available in the template views.
+    /// </summary>
+    public class ExampleMailTemplate : IMailTemplate
+    {
+        /// <summary>
+        /// Full path to the view file. This should not include the type part 
+        /// or file extension (i.e. '_html.cshml' or '_text.cshml') because this 
+        /// is automatically added.
+        /// 
+        /// You can place your templates wherever you like e.g. in the Cofoudry 
+        /// folder as we do here, or in the Views folder.
+        /// </summary>
+        public string ViewFile => "~/Cofoundry/MailTemplates/ExampleMailTemplate";
+
+        /// <summary>
+        /// Used as the subject line in the email.
+        /// </summary>
+        public string Subject => "Example Mail";
+
+        /// <summary>
+        /// This is a custom property to hold some data that we'd like to render in our view file.
+        /// </summary>
+        public string Message { get; set; }
+    }
+}
diff --git a/src/MailKitExample/Cofoundry/MailTemplates/ExampleMailTemplate_html.cshtml b/src/MailKitExample/Cofoundry/MailTemplates/ExampleMailTemplate_html.cshtml
@@ -0,0 +1,15 @@
+﻿@model MailKitExample.ExampleMailTemplate
+@*
+    You can define either an html or plain text template, or both.
+    The html template should have "_html" appended to the file name.
+*@
+@{
+    Layout = null;
+}
+<h1>@Model.Subject</h1>
+<p>
+   Message:
+</p>
+<p>
+    @Model.Message
+</p>
diff --git a/src/MailKitExample/Cofoundry/MailTemplates/ExampleMailTemplate_text.cshtml b/src/MailKitExample/Cofoundry/MailTemplates/ExampleMailTemplate_text.cshtml
@@ -0,0 +1,17 @@
+﻿@model MailKitExample.ExampleMailTemplate
+@*
+    You can define either an html or plain text template, or both.
+    The plain text template should have "_text" appended to the file name.
+    If both templates are defined then a multi-part email is sent, where the
+    plain text template is displayed when HTML is not permitted.
+*@
+@{
+    Layout = null;
+}
+@Model.Subject
+
+Message:
+
+-------------------------------------------------
+@Model.Message
+--------------------------------------------------
diff --git a/src/MailKitExample/MailKitExample.csproj b/src/MailKitExample/MailKitExample.csproj
@@ -0,0 +1,15 @@
+<Project Sdk="Microsoft.NET.Sdk.Web">
+
+  <PropertyGroup>
+    <TargetFramework>netcoreapp3.1</TargetFramework>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Cofoundry.Web.Admin" Version="0.9.3-reworking-user-a0100" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\Cofoundry.Plugins.Mail.MailKit\Cofoundry.Plugins.Mail.MailKit.csproj" />
+  </ItemGroup>
+  
+</Project>
diff --git a/src/MailKitExample/Pages/Index.cshtml b/src/MailKitExample/Pages/Index.cshtml
@@ -0,0 +1,35 @@
+﻿@page
+@model IndexModel
+
+<div class="row justify-content-center">
+    <form method="post" class="col col-8">
+        <h1 class="mb-4">Send a message</h1>
+
+        @if (Model.Result != null)
+        { 
+            <div class="alert alert-success" role="alert">
+                @Model.Result
+            </div>
+        }
+
+        <div class="mb-3">
+            <label asp-for="EmailAddress" class="form-label"></label>
+            <input asp-for="EmailAddress" class="form-control">
+            <span asp-validation-for="EmailAddress" class="text-danger"></span>
+        </div>
+        <div class="mb-3">
+            <label asp-for="DisplayName" class="form-label"></label>
+            <input asp-for="DisplayName" class="form-control">
+            <span asp-validation-for="DisplayName" class="text-danger"></span>
+        </div>
+        <div class="mb-3">
+            <label asp-for="Message" class="form-label"></label>
+            <textarea asp-for="Message" class="form-control"></textarea>
+            <span asp-validation-for="EmailAddress" class="text-danger"></span>
+        </div>
+
+        <div asp-validation-summary="ModelOnly" class="mb-3 text-danger"></div>
+
+        <button type="submit" class="btn btn-primary">Send</button>
+    </form>
+</div>
diff --git a/src/MailKitExample/Pages/Index.cshtml.cs b/src/MailKitExample/Pages/Index.cshtml.cs
@@ -0,0 +1,51 @@
+﻿using Cofoundry.Core.Mail;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.AspNetCore.Mvc.RazorPages;
+using System.ComponentModel.DataAnnotations;
+using System.Threading.Tasks;
+
+namespace MailKitExample.Pages
+{
+    public class IndexModel : PageModel
+    {
+        private readonly IMailService _mailService;
+
+        public IndexModel(IMailService mailService)
+        {
+            _mailService = mailService;
+        }
+
+        [BindProperty]
+        [Required]
+        [EmailAddress]
+        [DataType(DataType.EmailAddress)]
+        public string EmailAddress { get; set; }
+
+        [BindProperty]
+        public string DisplayName { get; set; }
+
+        [BindProperty]
+        [Required]
+        public string Message { get; set; }
+
+        public string Result { get; set; }
+
+        public void OnGet()
+        {
+        }
+
+        public async Task OnPost()
+        {
+            if (!ModelState.IsValid) return;
+
+            var template = new ExampleMailTemplate()
+            {
+                Message = Message
+            };
+
+            await _mailService.SendAsync(EmailAddress, template);
+
+            Result = $"Message sent to {EmailAddress}";
+        }
+    }
+}
diff --git a/src/MailKitExample/Pages/Shared/_Layout.cshtml b/src/MailKitExample/Pages/Shared/_Layout.cshtml
@@ -0,0 +1,24 @@
+﻿<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+    <title>SendGrid Example</title>
+    <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.1.3/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-1BmE4kWBq78iYhFldvKuhfTAU6auU8tT94WrHftjDbrCEXSU1oBoqyl2QvZ6jIW3" crossorigin="anonymous">
+</head>
+<body>
+    <div class="container mb-5">
+
+        <nav class="navbar navbar-expand-lg navbar-light bg-light mb-5">
+            <div class="container-fluid">
+                <a class="navbar-brand" href="/">MailKit Example</a>
+            </div>
+        </nav>
+
+        @RenderBody()
+
+    </div>
+
+    <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.1.3/dist/js/bootstrap.bundle.min.js" integrity="sha384-ka7Sk0Gln4gmtz2MlQnikT1wXgYsOg+OMhuP+IlRH9sENBO0LRn5q+8nbTov4+1p" crossorigin="anonymous"></script>
+</body>
+</html>
diff --git a/src/MailKitExample/Pages/_ViewImports.cshtml b/src/MailKitExample/Pages/_ViewImports.cshtml
@@ -0,0 +1,3 @@
+@using MailKitExample
+@namespace MailKitExample.Pages
+@addTagHelper *, Microsoft.AspNetCore.Mvc.TagHelpers
diff --git a/src/MailKitExample/Pages/_ViewStart.cshtml b/src/MailKitExample/Pages/_ViewStart.cshtml
@@ -0,0 +1,3 @@
+﻿@{
+    Layout = "_Layout";
+}
diff --git a/src/MailKitExample/Program.cs b/src/MailKitExample/Program.cs
diff --git a/src/MailKitExample/Properties/launchSettings.json b/src/MailKitExample/Properties/launchSettings.json
diff --git a/src/MailKitExample/Startup.cs b/src/MailKitExample/Startup.cs
diff --git a/src/MailKitExample/appsettings.Development.json b/src/MailKitExample/appsettings.Development.json
diff --git a/src/MailKitExample/appsettings.json b/src/MailKitExample/appsettings.json

Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ public void Register(IContainerRegister container)`
`17`	`17`	`var overrideOptions = RegistrationOptions.Override();`
`18`	`18`
`19`	`19`	`container`
`20`		`- .Register<IMailDispatchService, MailKitMailDispatchService>(overrideOptions)`
	`20`	`+ .Register<IMailDispatchSession, MailKitMailDispatchSession>(overrideOptions)`
`21`	`21`	`.Register<ISmtpClientConnectionConfiguration, SmtpClientConnectionConfiguration>()`
`22`	`22`	`;`
`23`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,8 +6,6 @@`
`6`	`6`	`using System;`
`7`	`7`	`using System.Collections.Generic;`
`8`	`8`	`using System.IO;`
`9`		`-using System.Linq;`
`10`		`-using System.Text;`
`11`	`9`	`using System.Threading.Tasks;`
`12`	`10`
`13`	`11`	`namespace Cofoundry.Plugins.Mail.MailKit`
`@@ -16,7 +14,7 @@ namespace Cofoundry.Plugins.Mail.MailKit`
`16`	`14`	`/// Mail dispatch session that uses System.Net.Mail to`
`17`	`15`	`/// dispatch email.`
`18`	`16`	`/// </summary>`
`19`		`- public class MilKitMailDispatchSession : IMailDispatchSession`
	`17`	`+ public class MailKitMailDispatchSession : IMailDispatchSession`
`20`	`18`	`{`
`21`	`19`	`private readonly Queue<MimeMessage> _mailQueue = new Queue<MimeMessage>();`
`22`	`20`	`private readonly Lazy<SmtpClient> _mailClient;`
`@@ -26,7 +24,7 @@ public class MilKitMailDispatchSession : IMailDispatchSession`
`26`	`24`
`27`	`25`	`private bool isDisposing = false;`
`28`	`26`
`29`		`- public MilKitMailDispatchSession(`
	`27`	`+ public MailKitMailDispatchSession(`
`30`	`28`	`MailSettings mailSettings,`
`31`	`29`	`IPathResolver pathResolver,`
`32`	`30`	`ISmtpClientConnectionConfiguration smtpClientConnectionConfiguration`
`@@ -82,8 +80,6 @@ public void Dispose()`
`82`	`80`	`}`
`83`	`81`	`}`
`84`	`82`
`85`		`- #region private methods`
`86`		`-`
`87`	`83`	`private void ValidateNotDisposed()`
`88`	`84`	`{`
`89`	`85`	`if (isDisposing)`
`@@ -121,7 +117,7 @@ private SmtpClient CreateSmtpMailClient()`
`121`	`117`	`if (isDisposing) return null;`
`122`	`118`	`return new SmtpClient();`
`123`	`119`	`}`
`124`		`-`
	`120`	`+`
`125`	`121`	`private MimeMessage FormatMessage(MailMessage message)`
`126`	`122`	`{`
`127`	`123`	`if (message == null) throw new ArgumentNullException(nameof(message));`
`@@ -196,7 +192,7 @@ private MailboxAddress CreateMailAddress(string email, string displayName)`
`196`	`192`	`{`
`197`	`193`	`if (string.IsNullOrEmpty(displayName))`
`198`	`194`	`{`
`199`		`- mailAddress = new MailboxAddress(email);`
	`195`	`+ mailAddress = new MailboxAddress(null, email);`
`200`	`196`	`}`
`201`	`197`	`else`
`202`	`198`	`{`
`@@ -226,7 +222,5 @@ private string GetMailDropPath()`
`226`	`222`
`227`	`223`	`return mailDropDirectory;`
`228`	`224`	`}`
`229`		`-`
`230`		`- #endregion`
`231`	`225`	`}`
`232`	`226`	`}`