Merge pull request #5376 from mdmontesinos/feat-mailkit

feat: replace System.Net.Mail with MailKit (#5372)
This commit is contained in:
Shaun Walker
2025-07-07 12:40:05 -04:00
committed by GitHub
2 changed files with 33 additions and 26 deletions

View File

@ -1,9 +1,13 @@
using System; using System;
using System.Collections.Generic; using System.Collections.Generic;
using System.Linq; using System.Linq;
using System.Net;
using System.Net.Mail; using MailKit.Net.Smtp;
using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.DependencyInjection;
using MimeKit;
using Oqtane.Models; using Oqtane.Models;
using Oqtane.Repository; using Oqtane.Repository;
using Oqtane.Shared; using Oqtane.Shared;
@ -48,18 +52,17 @@ namespace Oqtane.Infrastructure
settingRepository.GetSettingValue(settings, "SMTPPort", "") != "" && settingRepository.GetSettingValue(settings, "SMTPPort", "") != "" &&
settingRepository.GetSettingValue(settings, "SMTPSender", "") != "") settingRepository.GetSettingValue(settings, "SMTPSender", "") != "")
{ {
// construct SMTP Client // construct SMTP Client
var client = new SmtpClient() using var client = new SmtpClient();
{
DeliveryMethod = SmtpDeliveryMethod.Network, client.Connect(host: settingRepository.GetSettingValue(settings, "SMTPHost", ""),
UseDefaultCredentials = false, port: int.Parse(settingRepository.GetSettingValue(settings, "SMTPPort", "")),
Host = settingRepository.GetSettingValue(settings, "SMTPHost", ""), options: bool.Parse(settingRepository.GetSettingValue(settings, "SMTPSSL", "False")) ? MailKit.Security.SecureSocketOptions.StartTls : MailKit.Security.SecureSocketOptions.None);
Port = int.Parse(settingRepository.GetSettingValue(settings, "SMTPPort", "")),
EnableSsl = bool.Parse(settingRepository.GetSettingValue(settings, "SMTPSSL", "False"))
};
if (settingRepository.GetSettingValue(settings, "SMTPUsername", "") != "" && settingRepository.GetSettingValue(settings, "SMTPPassword", "") != "") if (settingRepository.GetSettingValue(settings, "SMTPUsername", "") != "" && settingRepository.GetSettingValue(settings, "SMTPPassword", "") != "")
{ {
client.Credentials = new NetworkCredential(settingRepository.GetSettingValue(settings, "SMTPUsername", ""), settingRepository.GetSettingValue(settings, "SMTPPassword", "")); client.Authenticate(settingRepository.GetSettingValue(settings, "SMTPUsername", ""),
settingRepository.GetSettingValue(settings, "SMTPPassword", ""));
} }
// iterate through undelivered notifications // iterate through undelivered notifications
@ -88,7 +91,7 @@ namespace Oqtane.Infrastructure
} }
// validate recipient // validate recipient
if (string.IsNullOrEmpty(notification.ToEmail) || !MailAddress.TryCreate(notification.ToEmail, out _)) if (string.IsNullOrEmpty(notification.ToEmail) || !MailboxAddress.TryParse(notification.ToEmail, out _))
{ {
log += $"NotificationId: {notification.NotificationId} - Has Missing Or Invalid Recipient {notification.ToEmail}<br />"; log += $"NotificationId: {notification.NotificationId} - Has Missing Or Invalid Recipient {notification.ToEmail}<br />";
notification.IsDeleted = true; notification.IsDeleted = true;
@ -96,50 +99,52 @@ namespace Oqtane.Infrastructure
} }
else else
{ {
MailMessage mailMessage = new MailMessage(); MimeMessage mailMessage = new MimeMessage();
// sender // sender
if (settingRepository.GetSettingValue(settings, "SMTPRelay", "False") == "True" && !string.IsNullOrEmpty(notification.FromEmail)) if (settingRepository.GetSettingValue(settings, "SMTPRelay", "False") == "True" && !string.IsNullOrEmpty(notification.FromEmail))
{ {
if (!string.IsNullOrEmpty(notification.FromDisplayName)) if (!string.IsNullOrEmpty(notification.FromDisplayName))
{ {
mailMessage.From = new MailAddress(notification.FromEmail, notification.FromDisplayName); mailMessage.From.Add(new MailboxAddress(notification.FromDisplayName, notification.FromEmail));
} }
else else
{ {
mailMessage.From = new MailAddress(notification.FromEmail); mailMessage.From.Add(new MailboxAddress("", notification.FromEmail));
} }
} }
else else
{ {
mailMessage.From = new MailAddress(settingRepository.GetSettingValue(settings, "SMTPSender", ""), (!string.IsNullOrEmpty(notification.FromDisplayName)) ? notification.FromDisplayName : site.Name); mailMessage.From.Add(new MailboxAddress((!string.IsNullOrEmpty(notification.FromDisplayName)) ? notification.FromDisplayName : site.Name,
settingRepository.GetSettingValue(settings, "SMTPSender", "")));
} }
// recipient // recipient
if (!string.IsNullOrEmpty(notification.ToDisplayName)) if (!string.IsNullOrEmpty(notification.ToDisplayName))
{ {
mailMessage.To.Add(new MailAddress(notification.ToEmail, notification.ToDisplayName)); mailMessage.To.Add(new MailboxAddress(notification.ToDisplayName, notification.ToEmail));
} }
else else
{ {
mailMessage.To.Add(new MailAddress(notification.ToEmail)); mailMessage.To.Add(new MailboxAddress("", notification.ToEmail));
} }
// subject // subject
mailMessage.Subject = notification.Subject; mailMessage.Subject = notification.Subject;
//body //body
mailMessage.Body = notification.Body; var bodyText = notification.Body;
if (!mailMessage.Body.Contains("<") || !mailMessage.Body.Contains(">"))
if (!bodyText.Contains('<') || !bodyText.Contains('>'))
{ {
// plain text messages should convert line breaks to HTML tags to preserve formatting // plain text messages should convert line breaks to HTML tags to preserve formatting
mailMessage.Body = mailMessage.Body.Replace("\n", "<br />"); bodyText = bodyText.Replace("\n", "<br />");
} }
// encoding mailMessage.Body = new TextPart("html", System.Text.Encoding.UTF8)
mailMessage.SubjectEncoding = System.Text.Encoding.UTF8; {
mailMessage.BodyEncoding = System.Text.Encoding.UTF8; Text = bodyText
mailMessage.IsBodyHtml = true; };
// send mail // send mail
try try
@ -157,6 +162,7 @@ namespace Oqtane.Infrastructure
} }
} }
} }
client.Disconnect(true);
log += "Notifications Delivered: " + sent + "<br />"; log += "Notifications Delivered: " + sent + "<br />";
} }
else else

View File

@ -34,6 +34,7 @@
<EmbeddedResource Include="Scripts\MigrateTenant.sql" /> <EmbeddedResource Include="Scripts\MigrateTenant.sql" />
</ItemGroup> </ItemGroup>
<ItemGroup> <ItemGroup>
<PackageReference Include="MailKit" Version="4.13.0" />
<PackageReference Include="Microsoft.AspNetCore.Components.WebAssembly.Server" Version="9.0.5" /> <PackageReference Include="Microsoft.AspNetCore.Components.WebAssembly.Server" Version="9.0.5" />
<PackageReference Include="Microsoft.AspNetCore.Identity.EntityFrameworkCore" Version="9.0.5" /> <PackageReference Include="Microsoft.AspNetCore.Identity.EntityFrameworkCore" Version="9.0.5" />
<PackageReference Include="Microsoft.Data.SqlClient" Version="6.0.2" /> <PackageReference Include="Microsoft.Data.SqlClient" Version="6.0.2" />