aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLibravatar vnugent <public@vaughnnugent.com>2023-08-28 21:54:26 -0400
committerLibravatar vnugent <public@vaughnnugent.com>2023-08-28 21:54:26 -0400
commitb153adbd86e226ad805c2edbb90e4032d386a1b0 (patch)
tree9d3e5d7f2966c66e0264001cb38c67f74d6cf707
parent964e81b81cdb430ecee8f67a68e3c616b3f339aa (diff)
Refactor overhaul, data extensions & Resend.com support
-rw-r--r--emails.transactional.build.sln18
-rw-r--r--lib/Emails.Transactional.Client/src/ClientExtensions.cs79
-rw-r--r--lib/Emails.Transactional.Client/src/EmailTransactionRequest.cs33
-rw-r--r--lib/Emails.Transactional.Client/src/Emails.Transactional.Client.csproj6
-rw-r--r--lib/Emails.Transactional.Client/src/Plugins/TEmailConfig.cs (renamed from lib/Emails.Transactional.Extensions/src/TEmailConfig.cs)164
-rw-r--r--lib/Emails.Transactional.Client/src/Plugins/TransactionalEmailExtensions.cs (renamed from lib/Emails.Transactional.Extensions/src/TransactionalEmailExtensions.cs)39
-rw-r--r--lib/Emails.Transactional.Client/src/TransactionResult.cs35
-rw-r--r--lib/Emails.Transactional.Client/src/TransactionalEmailConfig.cs25
-rw-r--r--lib/Emails.Transactional.Client/src/ValidationErrorMessage.cs7
-rw-r--r--lib/Emails.Transactional.Extensions/LICENSE.txt195
-rw-r--r--lib/Emails.Transactional.Extensions/README.md8
-rw-r--r--lib/Emails.Transactional.Extensions/build.readme.md0
-rw-r--r--lib/Emails.Transactional.Extensions/src/Emails.Transactional.Client.Extensions.csproj42
-rw-r--r--lib/Emails.Transactional.Plugin/src/Api Endpoints/SendEndpoint.cs289
-rw-r--r--lib/Emails.Transactional.Plugin/src/EmailDbCtx.cs12
-rw-r--r--lib/Emails.Transactional.Plugin/src/EmailTransaction.cs14
-rw-r--r--lib/Emails.Transactional.Plugin/src/Emails.Transactional.csproj (renamed from lib/Emails.Transactional.Plugin/src/Transactional Emails.csproj)4
-rw-r--r--lib/Emails.Transactional.Plugin/src/Endpoints/SendEndpoint.cs160
-rw-r--r--lib/Emails.Transactional.Plugin/src/MinioStorage.cs166
-rw-r--r--lib/Emails.Transactional.Plugin/src/Mta/IEmailMessageData.cs38
-rw-r--r--lib/Emails.Transactional.Plugin/src/Mta/IMailTransferAgent.cs44
-rw-r--r--lib/Emails.Transactional.Plugin/src/Mta/MailTransferAgent.cs57
-rw-r--r--lib/Emails.Transactional.Plugin/src/Mta/MtaResult.cs33
-rw-r--r--lib/Emails.Transactional.Plugin/src/Mta/ResendMta.cs224
-rw-r--r--lib/Emails.Transactional.Plugin/src/Mta/SmtpProvider.cs (renamed from lib/Emails.Transactional.Plugin/src/SmtpProvider.cs)91
-rw-r--r--lib/Emails.Transactional.Plugin/src/TEmailEntryPoint.cs10
-rw-r--r--lib/Emails.Transactional.Plugin/src/Templates/EmailTemplateStore.cs148
-rw-r--r--lib/Emails.Transactional.Plugin/src/Templates/IEmailTemplate.cs42
-rw-r--r--lib/Emails.Transactional.Plugin/src/Templates/ITemplateStorage.cs45
-rw-r--r--lib/Emails.Transactional.Plugin/src/Templates/TemplateLookupFailedException.cs43
-rw-r--r--lib/Emails.Transactional.Plugin/src/Transactions/EmailTransactionValidator.cs12
-rw-r--r--lib/Emails.Transactional.Plugin/src/Transactions/TransactionResult.cs18
-rw-r--r--lib/Emails.Transactional.Plugin/src/Transactions/TransactionStore.cs64
33 files changed, 1317 insertions, 848 deletions
diff --git a/emails.transactional.build.sln b/emails.transactional.build.sln
index 3fd2b99..681a2f8 100644
--- a/emails.transactional.build.sln
+++ b/emails.transactional.build.sln
@@ -5,10 +5,6 @@ VisualStudioVersion = 17.0.31903.59
MinimumVisualStudioVersion = 10.0.40219.1
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Emails.Transactional.Client", "lib\Emails.Transactional.Client\src\Emails.Transactional.Client.csproj", "{A13E6674-10A6-44FC-AEA2-A56A1ABBB3BF}"
EndProject
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Emails.Transactional.Client.Extensions", "lib\Emails.Transactional.Extensions\src\Emails.Transactional.Client.Extensions.csproj", "{260663D6-4BFA-40B3-9701-9F06DC1122D9}"
-EndProject
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Transactional Emails", "lib\Emails.Transactional.Plugin\src\Transactional Emails.csproj", "{462870DE-6AAC-44D7-B236-8AB8880CA9E1}"
-EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{2D8E6F6E-6E65-41FF-A556-A8BED246003C}"
ProjectSection(SolutionItems) = preProject
.gitattributes = .gitattributes
@@ -21,6 +17,8 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
Taskfile.yaml = Taskfile.yaml
EndProjectSection
EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Emails.Transactional", "lib\Emails.Transactional.Plugin\src\Emails.Transactional.csproj", "{ABB20897-57CB-4A07-B732-A8394B6D08CA}"
+EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
@@ -31,14 +29,10 @@ Global
{A13E6674-10A6-44FC-AEA2-A56A1ABBB3BF}.Debug|Any CPU.Build.0 = Debug|Any CPU
{A13E6674-10A6-44FC-AEA2-A56A1ABBB3BF}.Release|Any CPU.ActiveCfg = Release|Any CPU
{A13E6674-10A6-44FC-AEA2-A56A1ABBB3BF}.Release|Any CPU.Build.0 = Release|Any CPU
- {260663D6-4BFA-40B3-9701-9F06DC1122D9}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
- {260663D6-4BFA-40B3-9701-9F06DC1122D9}.Debug|Any CPU.Build.0 = Debug|Any CPU
- {260663D6-4BFA-40B3-9701-9F06DC1122D9}.Release|Any CPU.ActiveCfg = Release|Any CPU
- {260663D6-4BFA-40B3-9701-9F06DC1122D9}.Release|Any CPU.Build.0 = Release|Any CPU
- {462870DE-6AAC-44D7-B236-8AB8880CA9E1}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
- {462870DE-6AAC-44D7-B236-8AB8880CA9E1}.Debug|Any CPU.Build.0 = Debug|Any CPU
- {462870DE-6AAC-44D7-B236-8AB8880CA9E1}.Release|Any CPU.ActiveCfg = Release|Any CPU
- {462870DE-6AAC-44D7-B236-8AB8880CA9E1}.Release|Any CPU.Build.0 = Release|Any CPU
+ {ABB20897-57CB-4A07-B732-A8394B6D08CA}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {ABB20897-57CB-4A07-B732-A8394B6D08CA}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {ABB20897-57CB-4A07-B732-A8394B6D08CA}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {ABB20897-57CB-4A07-B732-A8394B6D08CA}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
diff --git a/lib/Emails.Transactional.Client/src/ClientExtensions.cs b/lib/Emails.Transactional.Client/src/ClientExtensions.cs
deleted file mode 100644
index 5c6fb12..0000000
--- a/lib/Emails.Transactional.Client/src/ClientExtensions.cs
+++ /dev/null
@@ -1,79 +0,0 @@
-/*
-* Copyright (c) 2022 Vaughn Nugent
-*
-* Library: VNLib
-* Package: Emails.Transactional.Client
-* File: ClientExtensions.cs
-*
-* ClientExtensions.cs is part of Emails.Transactional.Client which is part of the larger
-* VNLib collection of libraries and utilities.
-*
-* Emails.Transactional.Client is free software: you can redistribute it and/or modify
-* it under the terms of the GNU General Public License as published
-* by the Free Software Foundation, either version 2 of the License,
-* or (at your option) any later version.
-*
-* Emails.Transactional.Client is distributed in the hope that it will be useful,
-* but WITHOUT ANY WARRANTY; without even the implied warranty of
-* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-* General Public License for more details.
-*
-* You should have received a copy of the GNU General Public License
-* along with Emails.Transactional.Client. If not, see http://www.gnu.org/licenses/.
-*/
-
-using System;
-
-using System.Net;
-using System.Threading;
-using System.Threading.Tasks;
-
-using Emails.Transactional.Client.Exceptions;
-
-using RestSharp;
-
-namespace Emails.Transactional.Client
-{
- /// <summary>
- /// Contains extension methods to send emails on remote transational email servers
- /// </summary>
- public static class ClientExtensions
- {
- private const Method DEFAULT_SEND_METHOD = Method.Post;
-
- /// <summary>
- /// Asynchronously begins an email transaction against the mail server with the specified
- /// transaction request.
- /// </summary>
- /// <param name="client"></param>
- /// <param name="transaction">The <see cref="EmailTransactionRequest"/> to submit</param>
- /// <param name="token">A cancelaion token to cancel the operation</param>
- /// <returns>A task that represents the async send operation</returns>
- /// <exception cref="ValidationFailedException"></exception>
- /// <exception cref="InvalidAuthorizationException"></exception>
- /// <exception cref="InvalidTransactionRequestException"></exception>
- /// <exception cref="InvalidTransactionResponseException"></exception>
- public static async Task<TransactionResult?> SendEmailAsync(this RestClient client, EmailTransactionRequest transaction, CancellationToken token = default)
- {
- //Init the new request
- RestRequest request = new(transaction.Endpoint, DEFAULT_SEND_METHOD)
- {
- //Json request
- RequestFormat = DataFormat.Json
- };
- //add/serialze the transacion request
- request.AddJsonBody(transaction);
- //Exec the tranasction on the client
- RestResponse<TransactionResult> response = await client.ExecuteAsync<TransactionResult>(request, token);
- //parse the response body
- return response.StatusCode switch
- {
- HttpStatusCode.Unauthorized or HttpStatusCode.Forbidden => throw new InvalidAuthorizationException("The server did not accept the current authorization", response),
- HttpStatusCode.BadRequest => throw new InvalidTransactionRequestException(response),
- HttpStatusCode.UnprocessableEntity => throw new ValidationFailedException(response.Data!),
- HttpStatusCode.OK => response.Data,
- _ => throw new InvalidTransactionResponseException("Unhandled status code", response),
- };
- }
- }
-}
diff --git a/lib/Emails.Transactional.Client/src/EmailTransactionRequest.cs b/lib/Emails.Transactional.Client/src/EmailTransactionRequest.cs
index d6b1ebe..fb1be29 100644
--- a/lib/Emails.Transactional.Client/src/EmailTransactionRequest.cs
+++ b/lib/Emails.Transactional.Client/src/EmailTransactionRequest.cs
@@ -1,5 +1,5 @@
/*
-* Copyright (c) 2022 Vaughn Nugent
+* Copyright (c) 2023 Vaughn Nugent
*
* Library: VNLib
* Package: Emails.Transactional.Client
@@ -35,28 +35,26 @@ namespace Emails.Transactional.Client
public class EmailTransactionRequest
{
/// <summary>
- /// The transactional send endpoint address
- /// </summary>
- [JsonIgnore]
- public Uri Endpoint { get; init; }
- /// <summary>
/// A dictionary of email addresses/names of
/// users to send this email to
/// </summary>
[JsonPropertyName("to")]
public Dictionary<string, string> ToAddresses { get; set; }
+
/// <summary>
/// A dictionary of email addresses/names of
/// users to carbon copy this email to
/// </summary>
[JsonPropertyName("cc")]
public Dictionary<string, string> CcAddresses { get; set; }
+
/// <summary>
/// A dictionary of email addresses/names of
/// users to blind carbon copy this email to
/// </summary>
[JsonPropertyName("bcc")]
public Dictionary<string, string> BccAddresses { get; set; }
+
/// <summary>
/// A dictionary of variables to substitute into the liquid
/// email template
@@ -75,11 +73,13 @@ namespace Emails.Transactional.Client
/// </summary>
[JsonPropertyName("template_id")]
public string TemplateId { get; set; }
+
/// <summary>
/// The system from email name. NOTE: This is a protected value
/// </summary>
[JsonPropertyName("from_name")]
public string FromName { get; set; }
+
/// <summary>
/// The system from email address. NOTE: This is a protected value
/// </summary>
@@ -95,6 +95,7 @@ namespace Emails.Transactional.Client
{
this.TemplateId = templateId ?? throw new ArgumentNullException(nameof(templateId));
}
+
/// <summary>
/// Creates a new email transaction with the specified email template
/// and a single recipient
@@ -108,55 +109,65 @@ namespace Emails.Transactional.Client
this.TemplateId = templateId ?? throw new ArgumentNullException(nameof(templateId));
AddToAddress(toName, toAddress);
}
+
/// <summary>
/// Adds a recipient to the To email address dictionary
/// </summary>
/// <param name="toName">The name of the user to send the email to</param>
/// <param name="toAddress">The unique email address of the user to add to the recipient collection</param>
- public void AddToAddress(string toName, string toAddress)
+ public EmailTransactionRequest AddToAddress(string toName, string toAddress)
{
ToAddresses ??= new(1);
ToAddresses.Add(toAddress, toName);
+ return this;
}
+
/// <summary>
/// Adds a recipient to the To email address dictionary
/// </summary>
/// <param name="toAddress">The unique email address of the user to add to the recipient collection</param>
- public void AddToAddress(string toAddress)
+ public EmailTransactionRequest AddToAddress(string toAddress)
{
string name = toAddress.Split('@')[0];
AddToAddress(name, toAddress);
+ return this;
}
+
/// <summary>
/// Adds a carbon copy recipient to the current cc dictionary
/// </summary>
/// <param name="ccName">The name of the recipient</param>
/// <param name="ccAddress">The unique email address of the bcc recipient</param>
- public void AddCcAddress(string ccName, string ccAddress)
+ public EmailTransactionRequest AddCcAddress(string ccName, string ccAddress)
{
CcAddresses ??= new(1);
CcAddresses.Add(ccAddress, ccName);
+ return this;
}
+
/// <summary>
/// Adds a blind carbon copy recipient to the current bcc dictionary
/// </summary>
/// <param name="bccName">The name of the recipient</param>
/// <param name="bccAddress">The unique email address of the bcc recipient</param>
- public void AddBccAddress(string bccName, string bccAddress)
+ public EmailTransactionRequest AddBccAddress(string bccName, string bccAddress)
{
BccAddresses ??= new(1);
BccAddresses.Add(bccAddress, bccName);
+ return this;
}
+
/// <summary>
/// Adds a liquid template variable to be subsituted by the template
/// renderer.
/// </summary>
/// <param name="varName">The unique name of the variable to add to the collection</param>
/// <param name="varValue">The value if the variable that will be substituted into the template</param>
- public void AddVariable(string varName, string varValue)
+ public EmailTransactionRequest AddVariable(string varName, string varValue)
{
Variables ??= new(1);
Variables.Add(varName, varValue);
+ return this;
}
}
}
diff --git a/lib/Emails.Transactional.Client/src/Emails.Transactional.Client.csproj b/lib/Emails.Transactional.Client/src/Emails.Transactional.Client.csproj
index c74bff3..a6d027a 100644
--- a/lib/Emails.Transactional.Client/src/Emails.Transactional.Client.csproj
+++ b/lib/Emails.Transactional.Client/src/Emails.Transactional.Client.csproj
@@ -39,7 +39,11 @@
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference>
- <PackageReference Include="RestSharp" Version="110.2.0" />
+ </ItemGroup>
+
+ <ItemGroup>
+ <ProjectReference Include="..\..\..\..\..\core\lib\Net.Rest.Client\src\VNLib.Net.Rest.Client.csproj" />
+ <ProjectReference Include="..\..\..\..\Extensions\lib\VNLib.Plugins.Extensions.Loading\src\VNLib.Plugins.Extensions.Loading.csproj" />
</ItemGroup>
</Project>
diff --git a/lib/Emails.Transactional.Extensions/src/TEmailConfig.cs b/lib/Emails.Transactional.Client/src/Plugins/TEmailConfig.cs
index 7642283..ef02e01 100644
--- a/lib/Emails.Transactional.Extensions/src/TEmailConfig.cs
+++ b/lib/Emails.Transactional.Client/src/Plugins/TEmailConfig.cs
@@ -2,18 +2,18 @@
* Copyright (c) 2023 Vaughn Nugent
*
* Library: VNLib
-* Package: Emails.Transactional.Client.Extensions
+* Package: Emails.Transactional.Client
* File: TEmailConfig.cs
*
-* TEmailConfig.cs is part of Emails.Transactional.Client.Extensions which is part of the larger
+* TEmailConfig.cs is part of Emails.Transactional.Client which is part of the larger
* VNLib collection of libraries and utilities.
*
-* Emails.Transactional.Client.Extensions is free software: you can redistribute it and/or modify
+* Emails.Transactional.Client is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
-* Emails.Transactional.Client.Extensions is distributed in the hope that it will be useful,
+* Emails.Transactional.Client is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
@@ -22,24 +22,30 @@
* along with this program. If not, see https://www.gnu.org/licenses/.
*/
+using System;
using System.Text;
+using System.Threading;
+using System.Threading.Tasks;
+using System.Collections.Generic;
using System.Text.Json.Serialization;
using RestSharp;
using VNLib.Utils.Logging;
+using VNLib.Net.Http;
using VNLib.Plugins;
using VNLib.Net.Rest.Client;
using VNLib.Net.Rest.Client.OAuth2;
+using VNLib.Net.Rest.Client.Construction;
using VNLib.Plugins.Extensions.Loading;
-namespace Emails.Transactional.Client.Extensions
+namespace Emails.Transactional.Client.Plugins
{
/// <summary>
/// Provides transactional emails based on templates and variable complilation. Should be loaded as a singleton for a plugin
/// </summary>
[ConfigurationName(EMAIL_CONFIG_KEY)]
- public class TEmailConfig : TransactionalEmailConfig, IDisposable
+ public class TEmailConfig : TransactionalEmailConfig
{
const string DEFAULT_USER_AGENT = "VN Transactional Email System";
@@ -48,30 +54,24 @@ namespace Emails.Transactional.Client.Extensions
public const int DEFAULT_MAX_CLIENTS = 5;
public const int DEFAULT_CLIENT_TIMEOUT_MS = 10000;
-
- private bool disposedValue;
-
- private readonly OAuth2Authenticator _authenticator;
+
/// <summary>
- /// A shared <see cref="VNLib.Net.Rest.Client.RestClientPool"/> for renting configuraed
- /// <see cref="RestClient"/>
+ /// The email connection site adapter instance
/// </summary>
- public RestClientPool RestClientPool { get; }
+ public IRestSiteAdapter SiteAdapter { get; }
/// <summary>
/// A global from email address name
/// </summary>
- public string EmailFromName { get; }
+ public string EmailFromName => MailConfig.EmailFromName!;
/// <summary>
/// A global from email address
/// </summary>
- public string EmailFromAddress { get; }
+ public string EmailFromAddress => MailConfig.EmailFromAddress!;
- private readonly IAsyncLazy<string> _clientId;
- private readonly IAsyncLazy<string> _clientSecret;
-
+ private readonly JsonConfig MailConfig;
/// <summary>
/// Intialzies the singleton using the <see cref="LoadingExtensions"/>
@@ -82,79 +82,102 @@ namespace Emails.Transactional.Client.Extensions
public TEmailConfig(PluginBase plugin, IConfigScope config)
{
//The current config scope should be the required data, so we can deserialze it
- JsonConfig mailConfig = config.DeserialzeAndValidate<JsonConfig>();
+ MailConfig = config.DeserialzeAndValidate<JsonConfig>();
//Get required templates
Dictionary<string, string> templates = plugin.GetConfig(REQUIRED_EMAIL_TEMPALTE_CONFIG_KEY).Deserialze<Dictionary<string, string>>();
- EmailFromName = mailConfig.EmailFromName!;
- EmailFromAddress = mailConfig.EmailFromAddress!;
-
if (plugin.IsDebug())
{
plugin.Log.Debug("Required email templates {t}", templates);
}
- //Options for auth token endpoint
- RestClientOptions clientOptions = new()
- {
- AllowMultipleDefaultParametersWithSameName = true,
- //Server supports compression
- AutomaticDecompression = System.Net.DecompressionMethods.All,
- PreAuthenticate = false,
- Encoding = Encoding.UTF8,
- MaxTimeout = mailConfig.TimeoutMs,
- UserAgent = mailConfig.UserAgent,
- //Server should not redirect
- FollowRedirects = false
- };
-
- //Init Oauth authenticator
- _authenticator = new(clientOptions, OAuthCredentialGet, mailConfig.TokenServerUri.ToString());
-
- //Create client pool
- RestClientPool = new(mailConfig.MaxClients, clientOptions, authenticator: _authenticator);
-
//Init templates and service url
- WithTemplates(templates)
- .WithUrl(mailConfig.ServiceUri);
+ WithTemplates(templates);
- //Load oauth secrets
- _clientId = plugin.GetSecretAsync("email_client_id")
- .ToLazy(static s => s.Result.ToString());
+ //Load site adapter
+ EmailSiteAdapter adapter = plugin.GetOrCreateSingleton<EmailSiteAdapter>();
- _clientSecret = plugin.GetSecretAsync("email_client_secret")
- .ToLazy(static s => s.Result.ToString());
- }
+ //Add request endpoint
+ adapter.DefineSingleEndpoint()
+ .WithEndpoint<EmailTransactionRequest>()
+ .WithMethod(Method.Post)
+ .WithUrl(MailConfig.ServiceEndpoint)
+ .WithHeader("Content-Type", HttpHelpers.GetContentTypeString(VNLib.Net.Http.ContentType.Json))
+ //Add message body as json
+ .WithModifier((e, re) => re.AddJsonBody(e, RestSharp.ContentType.Json));
- private Credential OAuthCredentialGet()
- {
- //Create new credential
- return Credential.Create(_clientId.Value, _clientSecret.Value);
+ SiteAdapter = adapter;
}
- ///<inheritdoc/>
- protected virtual void Dispose(bool disposing)
+
+ [ConfigurationName(EMAIL_CONFIG_KEY)]
+ internal sealed class EmailSiteAdapter : RestSiteAdapterBase, IDisposable
{
- if (!disposedValue)
+ private readonly IAsyncLazy<string> _clientId;
+ private readonly IAsyncLazy<string> _clientSecret;
+ private readonly OAuth2Authenticator _authenticator;
+
+ protected override RestClientPool Pool { get; }
+
+ public EmailSiteAdapter(PluginBase plugin, IConfigScope config)
{
- if (disposing)
+ //The current config scope should be the required data, so we can deserialze it
+ JsonConfig mailConfig = config.DeserialzeAndValidate<JsonConfig>();
+
+ //Options for auth token endpoint
+ RestClientOptions clientOptions = new()
{
- _authenticator.Dispose();
- RestClientPool.Dispose();
- }
+ AllowMultipleDefaultParametersWithSameName = true,
+ //Server supports compression
+ AutomaticDecompression = System.Net.DecompressionMethods.All,
+ PreAuthenticate = false,
+ Encoding = Encoding.UTF8,
+ MaxTimeout = mailConfig.TimeoutMs,
+ UserAgent = mailConfig.UserAgent,
+ //Server should not redirect
+ FollowRedirects = false
+ };
+
+ //Setup authenticator
+ _authenticator = new(clientOptions, OAuthCredentialGet, mailConfig.TokenServerUri.ToString());
+
+ Pool = new(mailConfig.MaxClients, clientOptions, authenticator: _authenticator);
+
- disposedValue = true;
+ //Load oauth secrets
+ _clientId = plugin.GetSecretAsync("email_client_id")
+ .ToLazy(static s => s.Result.ToString());
+
+ _clientSecret = plugin.GetSecretAsync("email_client_secret")
+ .ToLazy(static s => s.Result.ToString());
}
- }
- void IDisposable.Dispose()
- {
- // Do not change this code. Put cleanup code in 'Dispose(bool disposing)' method
- Dispose(disposing: true);
- GC.SuppressFinalize(this);
+ public override void OnResponse(RestResponse response)
+ {
+ //Handle rate limiting responses
+ }
+
+ public override Task WaitAsync(CancellationToken cancellation = default)
+ {
+ //Handle rate limiting, delays
+ return Task.CompletedTask;
+ }
+
+ private Credential OAuthCredentialGet()
+ {
+ //Create new credential
+ return Credential.Create(_clientId.Value, _clientSecret.Value);
+ }
+
+ public void Dispose()
+ {
+ _authenticator.Dispose();
+ Pool.Dispose();
+ }
}
+
private sealed class JsonConfig : IOnConfigValidation
{
[JsonPropertyName("from_name")]
@@ -180,7 +203,7 @@ namespace Emails.Transactional.Client.Extensions
[JsonIgnore]
- public Uri ServiceUri => new(ServiceUrl!);
+ public Uri ServiceEndpoint => new(ServiceUrl!);
[JsonIgnore]
public Uri TokenServerUri => new(AuthUrl!);
@@ -189,7 +212,7 @@ namespace Emails.Transactional.Client.Extensions
{
_ = EmailFromName ?? throw new KeyNotFoundException("Missing required mail configuration key 'from_name'");
_ = EmailFromAddress ?? throw new KeyNotFoundException("Missing required mail configuration key 'from_address'");
- _ = ServiceUri ?? throw new KeyNotFoundException("Missing required mail configuration key 'email_url'");
+ _ = ServiceEndpoint ?? throw new KeyNotFoundException("Missing required mail configuration key 'email_url'");
_ = AuthUrl ?? throw new KeyNotFoundException("Missing required mail configuration key 'auth_url'");
if (MaxClients < 1)
@@ -203,5 +226,6 @@ namespace Emails.Transactional.Client.Extensions
}
}
}
+
}
} \ No newline at end of file
diff --git a/lib/Emails.Transactional.Extensions/src/TransactionalEmailExtensions.cs b/lib/Emails.Transactional.Client/src/Plugins/TransactionalEmailExtensions.cs
index e6cf3ed..db08ddf 100644
--- a/lib/Emails.Transactional.Extensions/src/TransactionalEmailExtensions.cs
+++ b/lib/Emails.Transactional.Client/src/Plugins/TransactionalEmailExtensions.cs
@@ -2,18 +2,18 @@
* Copyright (c) 2023 Vaughn Nugent
*
* Library: VNLib
-* Package: Emails.Transactional.Client.Extensions
+* Package: Emails.Transactional.Client
* File: TransactionalEmailExtensions.cs
*
-* TransactionalEmailExtensions.cs is part of Emails.Transactional.Client.Extensions which
+* TransactionalEmailExtensions.cs is part of Emails.Transactional.Client which
* is part of the larger VNLib collection of libraries and utilities.
*
-* Emails.Transactional.Client.Extensions is free software: you can redistribute it and/or modify
+* Emails.Transactional.Client is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
-* Emails.Transactional.Client.Extensions is distributed in the hope that it will be useful,
+* Emails.Transactional.Client is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
@@ -22,11 +22,19 @@
* along with this program. If not, see https://www.gnu.org/licenses/.
*/
+using System;
+using System.Net;
+using System.Threading;
+using System.Threading.Tasks;
-using VNLib.Net.Rest.Client;
+using RestSharp;
+using Emails.Transactional.Client.Exceptions;
-namespace Emails.Transactional.Client.Extensions
+using VNLib.Net.Rest.Client.Construction;
+
+
+namespace Emails.Transactional.Client.Plugins
{
/// <summary>
@@ -41,13 +49,24 @@ namespace Emails.Transactional.Client.Extensions
/// </summary>
/// <param name="config"></param>
/// <param name="request">The <see cref="EmailTransactionRequest"/> request to send to the server</param>
+ /// <param name="cancellation">A <see cref="CancellationToken"/> for cancelling the request</param>
/// <returns>A task the resolves the <see cref="TransactionResult"/> of the request</returns>
- public static async Task<TransactionResult> SendEmailAsync(this TransactionalEmailConfig config, EmailTransactionRequest request)
+ public static async Task<TransactionResult> SendEmailAsync(this TransactionalEmailConfig config, EmailTransactionRequest request, CancellationToken cancellation = default)
{
+ _ = config ?? throw new ArgumentNullException(nameof(config));
+
//Get a new client contract from the configuration's pool assuming its a EmailSystemConfig class
- using ClientContract client = ((TEmailConfig)config).RestClientPool.Lease();
- //Send the email and await the result before releasing the client
- return await client.Resource.SendEmailAsync(request);
+ RestResponse<TransactionResult> response = await ((TEmailConfig)config).SiteAdapter.ExecuteAsync<EmailTransactionRequest, TransactionResult>(request, cancellation);
+
+ //parse the response body
+ return response.StatusCode switch
+ {
+ HttpStatusCode.Unauthorized or HttpStatusCode.Forbidden => throw new InvalidAuthorizationException("The server did not accept the current authorization", response),
+ HttpStatusCode.BadRequest => throw new InvalidTransactionRequestException(response),
+ HttpStatusCode.UnprocessableEntity => throw new ValidationFailedException(response.Data!),
+ HttpStatusCode.OK => response.Data!,
+ _ => throw new InvalidTransactionResponseException("Unhandled status code", response),
+ };
}
}
} \ No newline at end of file
diff --git a/lib/Emails.Transactional.Client/src/TransactionResult.cs b/lib/Emails.Transactional.Client/src/TransactionResult.cs
index 279e0d2..836885f 100644
--- a/lib/Emails.Transactional.Client/src/TransactionResult.cs
+++ b/lib/Emails.Transactional.Client/src/TransactionResult.cs
@@ -1,5 +1,5 @@
/*
-* Copyright (c) 2022 Vaughn Nugent
+* Copyright (c) 2023 Vaughn Nugent
*
* Library: VNLib
* Package: Emails.Transactional.Client
@@ -22,30 +22,47 @@
* along with Emails.Transactional.Client. If not, see http://www.gnu.org/licenses/.
*/
+using System;
using System.Collections.Generic;
using System.Text.Json.Serialization;
+using VNLib.Plugins;
+
namespace Emails.Transactional.Client
{
/// <summary>
/// A JSON serializable object that contains the results of the transaction
/// </summary>
- public class TransactionResult
+ public class TransactionResult : WebMessage
{
+ /// <summary>
+ /// The unique identifier for the transaction
+ /// </summary>
[JsonPropertyName("transaction_id")]
- public string TransactionId { get; set; }
+ public string TransactionId { get; set; } = string.Empty;
+
+ /// <summary>
+ /// The raw SMTP result if SMTP was used
+ /// </summary>
[JsonPropertyName("smtp_status")]
- public string SmtpStatus { get; set; }
- [JsonPropertyName("success")]
- public bool Success { get; set; }
+ public string? SmtpStatus { get; set; }
+ /// <summary>
+ /// A system specific error code
+ /// </summary>
[JsonPropertyName("error_code")]
- public string ErrorCode { get; set; }
+ public string? ErrorCode { get; set; }
+ /// <summary>
+ /// A string description of the error
+ /// </summary>
[JsonPropertyName("error_description")]
- public string ErrorDescription { get; set; }
+ public string? ErrorDescription { get; set; }
+ /// <summary>
+ /// A collection of server validation errors
+ /// </summary>
[JsonPropertyName("errors")]
- public ICollection<ValidationErrorMessage> ValidationErrors { get; set; }
+ public ICollection<ValidationErrorMessage> ValidationErrors { get; set; } = Array.Empty<ValidationErrorMessage>();
}
}
diff --git a/lib/Emails.Transactional.Client/src/TransactionalEmailConfig.cs b/lib/Emails.Transactional.Client/src/TransactionalEmailConfig.cs
index 1ce5459..1de61dd 100644
--- a/lib/Emails.Transactional.Client/src/TransactionalEmailConfig.cs
+++ b/lib/Emails.Transactional.Client/src/TransactionalEmailConfig.cs
@@ -1,5 +1,5 @@
/*
-* Copyright (c) 2022 Vaughn Nugent
+* Copyright (c) 2023 Vaughn Nugent
*
* Library: VNLib
* Package: Emails.Transactional.Client
@@ -33,26 +33,10 @@ namespace Emails.Transactional.Client
public class TransactionalEmailConfig
{
/// <summary>
- /// The server transaction endpoint location
- /// </summary>
- public Uri ServiceLocation { get; private set; }
-
- /// <summary>
/// An email id template/translation table for email template-ids
/// </summary>
public IReadOnlyDictionary<string, string> TemplateIdLookup { get; private set; }
-
- /// <summary>
- /// Adds the mail service location to the current instance
- /// </summary>
- /// <param name="serviceLocation">The address of the remote server transaction endpoint</param>
- /// <returns>A referrence to the current object (fluent api)</returns>
- /// <exception cref="ArgumentNullException"></exception>
- public TransactionalEmailConfig WithUrl(Uri serviceLocation)
- {
- ServiceLocation = serviceLocation ?? throw new ArgumentNullException(nameof(serviceLocation));
- return this;
- }
+
/// <summary>
/// Sets the template lookup table for the current instance
/// </summary>
@@ -77,10 +61,7 @@ namespace Emails.Transactional.Client
{
//get the template from its template name
string templateId = TemplateIdLookup[templateName];
- return new EmailTransactionRequest(templateId)
- {
- Endpoint = this.ServiceLocation
- };
+ return new EmailTransactionRequest(templateId);
}
}
}
diff --git a/lib/Emails.Transactional.Client/src/ValidationErrorMessage.cs b/lib/Emails.Transactional.Client/src/ValidationErrorMessage.cs
index e2e5f44..09da1b4 100644
--- a/lib/Emails.Transactional.Client/src/ValidationErrorMessage.cs
+++ b/lib/Emails.Transactional.Client/src/ValidationErrorMessage.cs
@@ -1,5 +1,5 @@
/*
-* Copyright (c) 2022 Vaughn Nugent
+* Copyright (c) 2023 Vaughn Nugent
*
* Library: VNLib
* Package: Emails.Transactional.Client
@@ -35,11 +35,12 @@ namespace Emails.Transactional.Client
/// The name of the propery that was invalid
/// </summary>
[JsonPropertyName("property")]
- public string PropertyName { get; set; }
+ public string PropertyName { get; set; } = string.Empty;
+
/// <summary>
/// The message that
/// </summary>
[JsonPropertyName("message")]
- public string ErrorMessage { get; set; }
+ public string ErrorMessage { get; set; } = string.Empty;
}
}
diff --git a/lib/Emails.Transactional.Extensions/LICENSE.txt b/lib/Emails.Transactional.Extensions/LICENSE.txt
deleted file mode 100644
index 147bcd6..0000000
--- a/lib/Emails.Transactional.Extensions/LICENSE.txt
+++ /dev/null
@@ -1,195 +0,0 @@
-Copyright (c) 2022 Vaughn Nugent
-
-Contact information
- Name: Vaughn Nugent
- Email: public[at]vaughnnugent[dot]com
- Website: https://www.vaughnnugent.com
-
-The software in this repository is licensed under the GNU Affero GPL version 3.0 (or any later version).
-
-GNU AFFERO GENERAL PUBLIC LICENSE
-
-Version 3, 19 November 2007
-
-Copyright © 2007 Free Software Foundation, Inc. <https://fsf.org/>
-Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
-Preamble
-
-The GNU Affero General Public License is a free, copyleft license for software and other kinds of works, specifically designed to ensure cooperation with the community in the case of network server software.
-
-The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, our General Public Licenses are intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users.
-
-When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things.
-
-Developers that use our General Public Licenses protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License which gives you legal permission to copy, distribute and/or modify the software.
-
-A secondary benefit of defending all users' freedom is that improvements made in alternate versions of the program, if they receive widespread use, become available for other developers to incorporate. Many developers of free software are heartened and encouraged by the resulting cooperation. However, in the case of software used on network servers, this result may fail to come about. The GNU General Public License permits making a modified version and letting the public access it on a server without ever releasing its source code to the public.
-
-The GNU Affero General Public License is designed specifically to ensure that, in such cases, the modified source code becomes available to the community. It requires the operator of a network server to provide the source code of the modified version running there to the users of that server. Therefore, public use of a modified version, on a publicly accessible server, gives the public access to the source code of the modified version.
-
-An older license, called the Affero General Public License and published by Affero, was designed to accomplish similar goals. This is a different license, not a version of the Affero GPL, but Affero has released a new version of the Affero GPL which permits relicensing under this license.
-
-The precise terms and conditions for copying, distribution and modification follow.
-TERMS AND CONDITIONS
-0. Definitions.
-
-"This License" refers to version 3 of the GNU Affero General Public License.
-
-"Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks.
-
-"The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations.
-
-To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work.
-
-A "covered work" means either the unmodified Program or a work based on the Program.
-
-To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well.
-
-To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying.
-
-An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion.
-1. Source Code.
-
-The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work.
-
-A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language.
-
-The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it.
-
-The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work.
-
-The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source.
-
-The Corresponding Source for a work in source code form is that same work.
-2. Basic Permissions.
-
-All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law.
-
-You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you.
-
-Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary.
-3. Protecting Users' Legal Rights From Anti-Circumvention Law.
-
-No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures.
-
-When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures.
-4. Conveying Verbatim Copies.
-
-You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program.
-
-You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee.
-5. Conveying Modified Source Versions.
-
-You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions:
-
- a) The work must carry prominent notices stating that you modified it, and giving a relevant date.
- b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices".
- c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it.
- d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so.
-
-A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate.
-6. Conveying Non-Source Forms.
-
-You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways:
-
- a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange.
- b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge.
- c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b.
- d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements.
- e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d.
-
-A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work.
-
-A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product.
-
-"Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made.
-
-If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM).
-
-The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network.
-
-Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying.
-7. Additional Terms.
-
-"Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions.
-
-When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission.
-
-Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms:
-
- a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or
- b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or
- c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or
- d) Limiting the use for publicity purposes of names of licensors or authors of the material; or
- e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or
- f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors.
-
-All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying.
-
-If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms.
-
-Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way.
-8. Termination.
-
-You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11).
-
-However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.
-
-Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.
-
-Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10.
-9. Acceptance Not Required for Having Copies.
-
-You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so.
-10. Automatic Licensing of Downstream Recipients.
-
-Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License.
-
-An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts.
-
-You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it.
-11. Patents.
-
-A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version".
-
-A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License.
-
-Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version.
-
-In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party.
-
-If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid.
-
-If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it.
-
-A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007.
-
-Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law.
-12. No Surrender of Others' Freedom.
-
-If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program.
-13. Remote Network Interaction; Use with the GNU General Public License.
-
-Notwithstanding any other provision of this License, if you modify the Program, your modified version must prominently offer all users interacting with it remotely through a computer network (if your version supports such interaction) an opportunity to receive the Corresponding Source of your version by providing access to the Corresponding Source from a network server at no charge, through some standard or customary means of facilitating copying of software. This Corresponding Source shall include the Corresponding Source for any work covered by version 3 of the GNU General Public License that is incorporated pursuant to the following paragraph.
-
-Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the work with which it is combined will remain governed by version 3 of the GNU General Public License.
-14. Revised Versions of this License.
-
-The Free Software Foundation may publish revised and/or new versions of the GNU Affero General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
-
-Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU Affero General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU Affero General Public License, you may choose any version ever published by the Free Software Foundation.
-
-If the Program specifies that a proxy can decide which future versions of the GNU Affero General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program.
-
-Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version.
-15. Disclaimer of Warranty.
-
-THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
-16. Limitation of Liability.
-
-IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
-17. Interpretation of Sections 15 and 16.
-
-If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee.
-
-END OF TERMS AND CONDITIONS \ No newline at end of file
diff --git a/lib/Emails.Transactional.Extensions/README.md b/lib/Emails.Transactional.Extensions/README.md
deleted file mode 100644
index 4d42de4..0000000
--- a/lib/Emails.Transactional.Extensions/README.md
+++ /dev/null
@@ -1,8 +0,0 @@
-# Emails.Transactional.Client.Extensions
-*An extension library for building transactional email configurations to send programmable emails against a transactional email server*
-
-#### Builds
-Debug build w/ symbols & xml docs, release builds, NuGet packages, and individually packaged source code are available on my [website](https://www.vaughnnugent.com/resources/software). All tar-gzip (.tgz) files will have an associated .sha384 appended checksum of the desired download file.
-
-## License
-Source files in for this project are licensed to you under the GNU Affero General Public License (or any later version). See the LICENSE files for more information. \ No newline at end of file
diff --git a/lib/Emails.Transactional.Extensions/build.readme.md b/lib/Emails.Transactional.Extensions/build.readme.md
deleted file mode 100644
index e69de29..0000000
--- a/lib/Emails.Transactional.Extensions/build.readme.md
+++ /dev/null
diff --git a/lib/Emails.Transactional.Extensions/src/Emails.Transactional.Client.Extensions.csproj b/lib/Emails.Transactional.Extensions/src/Emails.Transactional.Client.Extensions.csproj
deleted file mode 100644
index be0104b..0000000
--- a/lib/Emails.Transactional.Extensions/src/Emails.Transactional.Client.Extensions.csproj
+++ /dev/null
@@ -1,42 +0,0 @@
-<Project Sdk="Microsoft.NET.Sdk">
-
- <PropertyGroup>
- <ImplicitUsings>enable</ImplicitUsings>
- <TargetFramework>net6.0</TargetFramework>
- <RootNamespace>Emails.Transactional.Client.Extensions</RootNamespace>
- <AssemblyName>Emails.Transactional.Client.Extensions</AssemblyName>
- <NeutralLanguage>en-US</NeutralLanguage>
- <Nullable>enable</Nullable>
- <GenerateDocumentationFile>True</GenerateDocumentationFile>
- <AnalysisLevel>latest-all</AnalysisLevel>
- </PropertyGroup>
-
- <PropertyGroup>
- <PackageId>Emails.Transactional.Client.Extensions</PackageId>
- <Authors>Vaughn Nugent</Authors>
- <Company>Vaughn Nugent</Company>
- <Product>VNLib HTTP Library</Product>
- <Description>
- An extension library for building transactional email configurations to send programmable emails against a transactional email server
- </Description>
- <Copyright>Copyright © 2023 Vaughn Nugent</Copyright>
- <PackageProjectUrl>https://www.vaughnnugent.com/resources/software/modules/Emails.Transactional</PackageProjectUrl>
- <RepositoryUrl>https://github.com/VnUgE/Emails.Transactional/tree/master/lib/Emails.Transactional.Extensions</RepositoryUrl>
- </PropertyGroup>
-
-
- <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
- <Deterministic>False</Deterministic>
- </PropertyGroup>
-
- <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
- <Deterministic>False</Deterministic>
- </PropertyGroup>
-
- <ItemGroup>
- <ProjectReference Include="..\..\..\..\..\core\lib\Net.Rest.Client\src\VNLib.Net.Rest.Client.csproj" />
- <ProjectReference Include="..\..\..\..\Extensions\lib\VNLib.Plugins.Extensions.Loading\src\VNLib.Plugins.Extensions.Loading.csproj" />
- <ProjectReference Include="..\..\Emails.Transactional.Client\src\Emails.Transactional.Client.csproj" />
- </ItemGroup>
-
-</Project>
diff --git a/lib/Emails.Transactional.Plugin/src/Api Endpoints/SendEndpoint.cs b/lib/Emails.Transactional.Plugin/src/Api Endpoints/SendEndpoint.cs
deleted file mode 100644
index 1ce6acf..0000000
--- a/lib/Emails.Transactional.Plugin/src/Api Endpoints/SendEndpoint.cs
+++ /dev/null
@@ -1,289 +0,0 @@
-/*
-* Copyright (c) 2023 Vaughn Nugent
-*
-* Library: VNLib
-* Package: Transactional Emails
-* File: SendEndpoint.cs
-*
-* SendEndpoint.cs is part of Transactional Emails which is part of the larger
-* VNLib collection of libraries and utilities.
-*
-* Transactional Emails is free software: you can redistribute it and/or modify
-* it under the terms of the GNU General Public License as published
-* by the Free Software Foundation, either version 2 of the License,
-* or (at your option) any later version.
-*
-* Transactional Emails is distributed in the hope that it will be useful,
-* but WITHOUT ANY WARRANTY; without even the implied warranty of
-* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-* General Public License for more details.
-*
-* You should have received a copy of the GNU General Public License
-* along with Transactional Emails. If not, see http://www.gnu.org/licenses/.
-*/
-
-using System;
-using System.IO;
-using System.Net;
-using System.Text;
-using System.Threading.Tasks;
-using System.Collections.Generic;
-
-using Fluid;
-
-using Minio;
-using Minio.DataModel;
-using Minio.Exceptions;
-
-using MimeKit.Text;
-
-using VNLib.Utils.Extensions;
-using VNLib.Utils.Logging;
-using VNLib.Utils.Memory.Caching;
-using VNLib.Plugins;
-using VNLib.Plugins.Essentials;
-using VNLib.Plugins.Essentials.Extensions;
-using VNLib.Plugins.Essentials.Oauth;
-using VNLib.Plugins.Extensions.Validation;
-using VNLib.Plugins.Extensions.Loading;
-using VNLib.Plugins.Extensions.Loading.Sql;
-
-using Emails.Transactional.Transactions;
-using static Emails.Transactional.TEmailEntryPoint;
-
-namespace Emails.Transactional.Endpoints
-{
- [ConfigurationName("transaction_endpoint")]
- internal class SendEndpoint : O2EndpointBase
- {
- public const string OAUTH2_USER_SCOPE_PERMISSION = "email:send";
-
- private class FluidCache : ICacheable
- {
- public FluidCache(IFluidTemplate temp)
- {
- this.Template = temp;
- }
-
- public IFluidTemplate Template { get; }
-
- DateTime ICacheable.Expires { get; set; }
-
- bool IEquatable<ICacheable>.Equals(ICacheable? other)
- {
- return ReferenceEquals(Template, (other as FluidCache)?.Template);
- }
-
- void ICacheable.Evicted()
- {}
- }
-
- private static readonly EmailTransactionValidator Validator = new();
- private static readonly FluidParser Parser = new();
-
- private readonly string FromAddress;
- private readonly string? BaseObjectPath;
-
- private readonly TransactionStore Transactions;
-
- private readonly Dictionary<string, FluidCache> TemplateCache;
- private readonly TimeSpan TemplateCacheTimeout;
- private readonly MinioClient Client;
- private readonly S3Config S3Config;
-
- private SmtpProvider? EmailService;
-
- public SendEndpoint(PluginBase plugin, IConfigScope config)
- {
- string? path = config["path"].GetString();
- FromAddress = config["from_address"].GetString() ?? throw new KeyNotFoundException("Missing required key 'from_address' in 'transaction_endpoint'");
- TemplateCacheTimeout = config["cache_valid_sec"].GetTimeSpan(TimeParseType.Seconds);
- BaseObjectPath = config["base_object_path"].GetString();
-
- InitPathAndLog(path, plugin.Log);
-
- //Smtp setup
- {
- IConfigScope smtp = plugin.GetConfig("smtp");
- Uri serverUri = new(smtp["server_address"].GetString()!);
- string username = smtp["username"].GetString() ?? throw new KeyNotFoundException("Missing required key 'usename' in 'smtp' config");
- TimeSpan timeout = smtp["timeout_sec"].GetTimeSpan(TimeParseType.Seconds);
-
- //Load SMTP
- _ = plugin.ObserveWork(async () =>
- {
- //Get the password from the secret store
- string password = await plugin.GetSecretAsync("smtp_password").ToLazy(static r => r.Result.ToString());
-
- //Copy the secre to the network credential
- NetworkCredential cred = new(username, password);
-
- //Init email service
- EmailService = new(serverUri, cred, timeout);
- });
- }
-
- //S3 minio setup
- {
- //Init minio s3 client
- S3Config = plugin.TryGetS3Config() ?? throw new KeyNotFoundException("Missing required 's3_config' configuration variable");
- //Init minio from config
- Client = new();
-
- //Load the client when the secret finishes loading
- _ = plugin.ObserveWork(async () =>
- {
- string s3Secret = await plugin.GetSecretAsync("s3_secret").ToLazy(static r => r.Result.ToString());
-
- Client.WithEndpoint(S3Config.ServerAddress)
- .WithCredentials(S3Config.ClientId, s3Secret)
- .WithSSL(S3Config.UseSsl.HasValue && S3Config.UseSsl.Value);
-
- //Accept optional region
- if (!string.IsNullOrWhiteSpace(S3Config.Region))
- {
- Client.WithRegion(S3Config.Region);
- }
-
- //Build client
- Client.Build();
-
- //If the plugin is in debug mode, log requests to logger
- if (plugin.IsDebug())
- {
- Client.SetTraceOn(new ReqLogger(Log));
- }
- });
- }
-
- //Load transactions
- Transactions = new(plugin.GetContextOptions());
-
- TemplateCache = new(20, StringComparer.OrdinalIgnoreCase);
- }
-
-
- protected override async ValueTask<VfReturnType> PostAsync(HttpEntity entity)
- {
- //Make sure the user has the required scope to send an email
- if (!entity.Session.HasScope(OAUTH2_USER_SCOPE_PERMISSION))
- {
- entity.CloseResponseError(HttpStatusCode.Forbidden, ErrorType.InvalidScope, "Your account does not have the required permissions scope");
- return VfReturnType.VirtualSkip;
- }
-
- //Get the transaction request from the client
- EmailTransaction? transaction = await entity.GetJsonFromFileAsync<EmailTransaction>();
- if(transaction == null)
- {
- entity.CloseResponseError(HttpStatusCode.BadRequest, ErrorType.InvalidRequest, "No request body was received");
- return VfReturnType.VirtualSkip;
- }
-
- TransactionResult webm = new()
- {
- Success = false
- };
-
- //Set a default from name/address if not set by user
- transaction.From ??= FromAddress;
- transaction.FromName ??= FromAddress;
- //Specify user-id
- transaction.UserId = entity.Session.UserID;
- //validate the form
- if (!Validator.Validate(transaction, webm))
- {
- //return errors
- entity.CloseResponseJson(HttpStatusCode.UnprocessableEntity, webm);
- return VfReturnType.VirtualSkip;
- }
-
- IFluidTemplate fTemp;
-
- //See if the template is in cache
- if (TemplateCache.TryGetOrEvictRecord(transaction.TemplateId!, out FluidCache? cache) == 1)
- {
- fTemp = cache.Template;
- }
- //Record was evicted or not found
- else
- {
- string? templateData = null;
- try
- {
- //Combine base obj path
- string objPath = string.Concat(BaseObjectPath, transaction.TemplateId);
- //Recover the template from the store
- GetObjectArgs args = new();
- args.WithBucket(S3Config.BaseBucket)
- .WithObject(objPath)
- .WithCallbackStream((stream) =>
- {
- //Read template from stream
- using StreamReader reader = new(stream, Encoding.UTF8, detectEncodingFromByteOrderMarks: false, leaveOpen: true);
- templateData = reader.ReadToEnd();
- });
- //get the template object
- ObjectStat status = await Client.GetObjectAsync(args, entity.EventCancellation);
-
- }
- catch(ObjectNotFoundException)
- {
- entity.CloseResponseError(HttpStatusCode.NotFound, ErrorType.InvalidRequest, "The requested template does not exist");
- return VfReturnType.VirtualSkip;
- }
- catch(MinioException me)
- {
- Log.Error(me);
- return VfReturnType.Error;
- }
-
- //Make sure template data was found
- if (string.IsNullOrWhiteSpace(templateData))
- {
- entity.CloseResponseError(HttpStatusCode.NotFound, ErrorType.InvalidRequest, "The requested template does not exist");
- return VfReturnType.VirtualSkip;
- }
-
- //Try to parse the template
- if (!Parser.TryParse(templateData, out fTemp, out string error))
- {
- Log.Error(error, "Liquid template parsing error");
- return VfReturnType.Error;
- }
-
- //Cache the new template
- TemplateCache.StoreRecord(transaction.TemplateId!, new FluidCache(fTemp), TemplateCacheTimeout);
- }
-
- //Allways add the template name to the model
- transaction.Variables!["template_name"] = transaction.TemplateId!;
-
- //Create a template model
- TemplateContext ctx = new(transaction.Variables);
- //render the template
- string rendered = fTemp.Render(ctx);
- try
- {
- //Send the template
- _ = await EmailService.SendAsync(transaction, rendered, TextFormat.Html, entity.EventCancellation);
- //Set success flag
- webm.Success = true;
- }
- catch (Exception ex)
- {
- Log.Error(ex);
- //Write an error status message to the transaction store
- transaction.Result = ex.Message;
- }
- //Write transaction to db (we need to return the transaction id)
- _ = await Transactions.AddOrUpdateAsync(transaction, entity.EventCancellation);
- //Store the results object
- webm.SmtpStatus = transaction.Result;
- webm.TransactionId = transaction.Id;
- //Return the response object
- entity.CloseResponse(webm);
- return VfReturnType.VirtualSkip;
- }
- }
-}
diff --git a/lib/Emails.Transactional.Plugin/src/EmailDbCtx.cs b/lib/Emails.Transactional.Plugin/src/EmailDbCtx.cs
index 82bf696..de9cc9d 100644
--- a/lib/Emails.Transactional.Plugin/src/EmailDbCtx.cs
+++ b/lib/Emails.Transactional.Plugin/src/EmailDbCtx.cs
@@ -2,24 +2,24 @@
* Copyright (c) 2023 Vaughn Nugent
*
* Library: VNLib
-* Package: Transactional Emails
+* Package: Emails.Transactional
* File: EmailDbCtx.cs
*
-* EmailDbCtx.cs is part of Transactional Emails which is part of the larger
+* EmailDbCtx.cs is part of Emails.Transactional which is part of the larger
* VNLib collection of libraries and utilities.
*
-* Transactional Emails is free software: you can redistribute it and/or modify
+* Emails.Transactional is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published
* by the Free Software Foundation, either version 2 of the License,
* or (at your option) any later version.
*
-* Transactional Emails is distributed in the hope that it will be useful,
+* Emails.Transactional is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
-* along with Transactional Emails. If not, see http://www.gnu.org/licenses/.
+* along with Emails.Transactional. If not, see http://www.gnu.org/licenses/.
*/
using System;
@@ -31,6 +31,8 @@ using VNLib.Plugins.Extensions.Loading.Sql;
namespace Emails.Transactional
{
+
+
internal class EmailDbCtx : TransactionalDbContext, IDbTableDefinition
{
public DbSet<EmailTransaction> EmailTransactions { get; set; }
diff --git a/lib/Emails.Transactional.Plugin/src/EmailTransaction.cs b/lib/Emails.Transactional.Plugin/src/EmailTransaction.cs
index bb7b4a8..5ce2040 100644
--- a/lib/Emails.Transactional.Plugin/src/EmailTransaction.cs
+++ b/lib/Emails.Transactional.Plugin/src/EmailTransaction.cs
@@ -1,25 +1,25 @@
/*
-* Copyright (c) 2022 Vaughn Nugent
+* Copyright (c) 2023 Vaughn Nugent
*
* Library: VNLib
-* Package: Transactional Emails
+* Package: Emails.Transactional
* File: EmailTransaction.cs
*
-* EmailTransaction.cs is part of Transactional Emails which is part of the larger
+* EmailTransaction.cs is part of Emails.Transactional which is part of the larger
* VNLib collection of libraries and utilities.
*
-* Transactional Emails is free software: you can redistribute it and/or modify
+* Emails.Transactional is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published
* by the Free Software Foundation, either version 2 of the License,
* or (at your option) any later version.
*
-* Transactional Emails is distributed in the hope that it will be useful,
+* Emails.Transactional is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
-* along with Transactional Emails. If not, see http://www.gnu.org/licenses/.
+* along with Emails.Transactional. If not, see http://www.gnu.org/licenses/.
*/
using System;
@@ -33,8 +33,6 @@ using VNLib.Plugins.Essentials;
using VNLib.Plugins.Extensions.Data;
using VNLib.Plugins.Extensions.Data.Abstractions;
-#nullable enable
-
namespace Emails.Transactional
{
/// <summary>
diff --git a/lib/Emails.Transactional.Plugin/src/Transactional Emails.csproj b/lib/Emails.Transactional.Plugin/src/Emails.Transactional.csproj
index 647966c..c3aa9f6 100644
--- a/lib/Emails.Transactional.Plugin/src/Transactional Emails.csproj
+++ b/lib/Emails.Transactional.Plugin/src/Emails.Transactional.csproj
@@ -19,7 +19,8 @@
<PackageProjectUrl>https://www.vaughnnugent.com/resources/software/modules/Emails.Transactional</PackageProjectUrl>
<RepositoryUrl>https://github.com/VnUgE/Emails.Transactional/tree/master/lib/Emails.Transactional.Plugin</RepositoryUrl>
<Description>
- Essentials framework plugin for compiling and sending templated transactional emails via an OAuth2 enabled API
+ Essentials framework plugin that creates a transactional email service based on Fluid templates, from an S3 storage system using
+ your existing SMTP server, or a third party transactional email service such as Resend.
</Description>
</PropertyGroup>
@@ -39,6 +40,7 @@
</ItemGroup>
<ItemGroup>
+ <ProjectReference Include="..\..\..\..\..\core\lib\Net.Rest.Client\src\VNLib.Net.Rest.Client.csproj" />
<ProjectReference Include="..\..\..\..\..\core\lib\Plugins.Essentials\src\VNLib.Plugins.Essentials.csproj" />
<ProjectReference Include="..\..\..\..\Extensions\lib\VNLib.Plugins.Extensions.Data\src\VNLib.Plugins.Extensions.Data.csproj" />
<ProjectReference Include="..\..\..\..\Extensions\lib\VNLib.Plugins.Extensions.Loading.Sql\src\VNLib.Plugins.Extensions.Loading.Sql.csproj" />
diff --git a/lib/Emails.Transactional.Plugin/src/Endpoints/SendEndpoint.cs b/lib/Emails.Transactional.Plugin/src/Endpoints/SendEndpoint.cs
new file mode 100644
index 0000000..3e6f940
--- /dev/null
+++ b/lib/Emails.Transactional.Plugin/src/Endpoints/SendEndpoint.cs
@@ -0,0 +1,160 @@
+/*
+* Copyright (c) 2023 Vaughn Nugent
+*
+* Library: VNLib
+* Package: Emails.Transactional
+* File: SendEndpoint.cs
+*
+* SendEndpoint.cs is part of Emails.Transactional which is part of the larger
+* VNLib collection of libraries and utilities.
+*
+* Emails.Transactional is free software: you can redistribute it and/or modify
+* it under the terms of the GNU General Public License as published
+* by the Free Software Foundation, either version 2 of the License,
+* or (at your option) any later version.
+*
+* Emails.Transactional is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+* General Public License for more details.
+*
+* You should have received a copy of the GNU General Public License
+* along with Emails.Transactional. If not, see http://www.gnu.org/licenses/.
+*/
+
+
+using System;
+using System.Net;
+using System.Threading.Tasks;
+
+using VNLib.Utils.Logging;
+using VNLib.Plugins;
+using VNLib.Plugins.Essentials;
+using VNLib.Plugins.Essentials.Extensions;
+using VNLib.Plugins.Essentials.Oauth;
+using VNLib.Plugins.Extensions.Validation;
+using VNLib.Plugins.Extensions.Loading;
+using VNLib.Plugins.Extensions.Loading.Sql;
+using VNLib.Plugins.Extensions.Data.Extensions;
+
+using Emails.Transactional.Mta;
+using Emails.Transactional.Templates;
+using Emails.Transactional.Transactions;
+
+namespace Emails.Transactional.Endpoints
+{
+
+ [ConfigurationName("send_endpoint")]
+ internal class SendEndpoint : O2EndpointBase
+ {
+ public const string OAUTH2_USER_SCOPE_PERMISSION = "email:send";
+
+ private static readonly EmailTransactionValidator Validator = new();
+
+ private readonly string FromAddress;
+
+ private readonly TransactionStore Transactions;
+ private readonly IMailTransferAgent EmailService;
+ private readonly ITemplateStorage Templates;
+
+ public SendEndpoint(PluginBase plugin, IConfigScope config)
+ {
+ string? path = config["path"].GetString();
+ FromAddress = config.GetRequiredProperty("from_address", e => e.GetString()!);
+
+ InitPathAndLog(path, plugin.Log);
+
+ //Load transactions
+ Transactions = new(plugin.GetContextOptions());
+
+ //init ail transfer agent
+ EmailService = plugin.GetOrCreateSingleton<MailTransferAgent>();
+
+ //Load templates
+ Templates = plugin.GetOrCreateSingleton<EmailTemplateStore>();
+ }
+
+ protected override async ValueTask<VfReturnType> PostAsync(HttpEntity entity)
+ {
+ //Make sure the user has the required scope to send an email
+ if (!entity.Session.HasScope(OAUTH2_USER_SCOPE_PERMISSION))
+ {
+ entity.CloseResponseError(HttpStatusCode.Forbidden, ErrorType.InvalidScope, "Your account does not have the required permissions scope");
+ return VfReturnType.VirtualSkip;
+ }
+
+ //Get the transaction request from the client
+ EmailTransaction? transaction = await entity.GetJsonFromFileAsync<EmailTransaction>();
+
+ if(transaction == null)
+ {
+ entity.CloseResponseError(HttpStatusCode.BadRequest, ErrorType.InvalidRequest, "No request body was received");
+ return VfReturnType.VirtualSkip;
+ }
+
+ TransactionResult webm = new()
+ {
+ Success = false
+ };
+
+ //Set a default from name/address if not set by user
+ transaction.From ??= FromAddress;
+ transaction.FromName ??= FromAddress;
+
+ //Specify user-id
+ transaction.UserId = entity.Session.UserID;
+
+ //validate the form
+ if (!Validator.Validate(transaction, webm))
+ {
+ //return errors
+ entity.CloseResponseJson(HttpStatusCode.UnprocessableEntity, webm);
+ return VfReturnType.VirtualSkip;
+ }
+
+ //Always add the template name to the model
+ transaction.Variables!["template_name"] = transaction.TemplateId!;
+
+ try
+ {
+ //Get the template
+ IEmailTemplate template = await Templates.GetTemplateAsync(transaction.TemplateId!, entity.EventCancellation);
+
+ //Render the template with the model
+ IEmailMessageData message = template.RenderTemplate(transaction.Variables!);
+
+ //Send the template
+ MtaResult result = await EmailService.SendEmailAsync(transaction, message, entity.EventCancellation);
+
+ //Set success flag
+ webm.Success = result.Success;
+ webm.SmtpStatus = result.Message;
+ }
+ //Handle a template lookup failure
+ catch(TemplateLookupFailedException ex)
+ {
+ Log.Debug("Failed to fetch template: {err}", transaction.TemplateId, ex.Message);
+
+ entity.CloseResponseError(HttpStatusCode.NotFound, ErrorType.InvalidRequest, "The requested template does not exist");
+ return VfReturnType.VirtualSkip;
+ }
+ catch (Exception ex)
+ {
+ Log.Error(ex);
+
+ //Write an error status message to the transaction store
+ webm.SmtpStatus = transaction.Result = ex.Message;
+ }
+
+ //Write transaction to db (we need to return the transaction id)
+ _ = await Transactions.AddOrUpdateAsync(transaction, entity.EventCancellation);
+
+ //Store the results object
+ webm.TransactionId = transaction.Id;
+
+ //Return the response object
+ entity.CloseResponse(webm);
+ return VfReturnType.VirtualSkip;
+ }
+ }
+}
diff --git a/lib/Emails.Transactional.Plugin/src/MinioStorage.cs b/lib/Emails.Transactional.Plugin/src/MinioStorage.cs
new file mode 100644
index 0000000..8f6dcdf
--- /dev/null
+++ b/lib/Emails.Transactional.Plugin/src/MinioStorage.cs
@@ -0,0 +1,166 @@
+/*
+* Copyright (c) 2023 Vaughn Nugent
+*
+* Library: VNLib
+* Package: Emails.Transactional
+* File: MinioStorage.cs
+*
+* MinioStorage.cs is part of Emails.Transactional which is part of the larger
+* VNLib collection of libraries and utilities.
+*
+* Emails.Transactional is free software: you can redistribute it and/or modify
+* it under the terms of the GNU General Public License as published
+* by the Free Software Foundation, either version 2 of the License,
+* or (at your option) any later version.
+*
+* Emails.Transactional is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+* General Public License for more details.
+*
+* You should have received a copy of the GNU General Public License
+* along with Emails.Transactional. If not, see http://www.gnu.org/licenses/.
+*/
+
+
+using System.IO;
+using System.Threading;
+using System.Threading.Tasks;
+
+using VNLib.Utils.Memory;
+using VNLib.Utils.Logging;
+using VNLib.Utils.Extensions;
+using VNLib.Plugins;
+using VNLib.Plugins.Extensions.Loading;
+using VNLib.Plugins.Extensions.Data.Storage;
+
+using Minio;
+using Minio.DataModel;
+using Minio.DataModel.Tracing;
+
+namespace Emails.Transactional
+{
+
+ [ConfigurationName("s3_config")]
+ internal sealed class MinioStorage : ISimpleFilesystem, IAsyncConfigurable
+ {
+ private readonly MinioClient Client;
+ private readonly S3Config Config;
+
+ public MinioStorage(PluginBase plugin, IConfigScope s3Config)
+ {
+ //Deserialize the config
+ Config = s3Config.Deserialze<S3Config>();
+ Client = new();
+
+ Client.WithEndpoint(Config.ServerAddress)
+ .WithSSL(Config.UseSsl.HasValue && Config.UseSsl.Value)
+ .WithTimeout(10 * 1000);
+
+ //Accept optional region
+ if (!string.IsNullOrWhiteSpace(Config.Region))
+ {
+ Client.WithRegion(Config.Region);
+ }
+
+ //Setup debug trace
+ if (plugin.IsDebug())
+ {
+ Client.SetTraceOn(new ReqLogger(plugin.Log));
+ }
+ }
+
+
+ public string GetExternalFilePath(string filePath)
+ {
+ string path = Path.Combine(Config.BaseBucket!, filePath);
+ //force forward only slashes
+ return path.Replace('\\', '/');
+ }
+
+ ///<inheritdoc/>
+ public async Task ConfigureServiceAsync(PluginBase plugin)
+ {
+ using ISecretResult? secret = await plugin.GetSecretAsync("s3_secret");
+
+ //Build client
+ Client.WithCredentials(Config.ClientId, secret.Result.ToString())
+ .Build();
+ }
+
+ ///<inheritdoc/>
+ public Task DeleteFileAsync(string filePath, CancellationToken cancellation)
+ {
+ string fullPath = GetExternalFilePath(filePath);
+
+ RemoveObjectArgs args = new();
+ args.WithBucket(Config.BaseBucket)
+ .WithObject(fullPath);
+
+ //Remove the object
+ return Client.RemoveObjectAsync(args, cancellation);
+ }
+
+ ///<inheritdoc/>
+ public Task SetFileAsync(string filePath, Stream data, string ct, CancellationToken cancellation)
+ {
+ string fullPath = GetExternalFilePath(filePath);
+
+ PutObjectArgs args = new();
+ args.WithBucket(Config.BaseBucket)
+ .WithContentType(ct)
+ .WithObject(fullPath)
+ .WithObjectSize(data.Length)
+ .WithStreamData(data);
+
+ //Upload the object
+ return Client.PutObjectAsync(args, cancellation);
+ }
+
+ ///<inheritdoc/>
+ public async Task<long> ReadFileAsync(string filePath, Stream output, CancellationToken cancellation)
+ {
+ string fullPath = GetExternalFilePath(filePath);
+
+ //Get the item
+ GetObjectArgs args = new();
+ args.WithBucket(Config.BaseBucket)
+ .WithObject(fullPath)
+ .WithCallbackStream(async (stream, cancellation) =>
+ {
+ //Read the objec to memory
+ await stream.CopyToAsync(output, 4096, MemoryUtil.Shared, cancellation);
+ });
+ try
+ {
+ //Get the post content file
+ ObjectStat stat = await Client.GetObjectAsync(args, cancellation);
+ }
+ catch (Minio.Exceptions.ObjectNotFoundException)
+ {
+ //File not found
+ return -1;
+ }
+ return output.Position;
+ }
+
+
+ internal class ReqLogger : IRequestLogger
+ {
+ private readonly ILogProvider logProvider;
+
+ public ReqLogger(ILogProvider log)
+ {
+ logProvider = log;
+ }
+
+ public void LogRequest(RequestToLog requestToLog, ResponseToLog responseToLog, double durationMs)
+ {
+ logProvider.Debug("S3 result\n{method} {uri} HTTP {ms}ms\nHTTP {status} {message}\n{content}",
+ requestToLog.Method, requestToLog.Resource, durationMs,
+ responseToLog.StatusCode, responseToLog.ErrorMessage, responseToLog.Content
+ );
+ }
+ }
+ }
+}
diff --git a/lib/Emails.Transactional.Plugin/src/Mta/IEmailMessageData.cs b/lib/Emails.Transactional.Plugin/src/Mta/IEmailMessageData.cs
new file mode 100644
index 0000000..8d1b261
--- /dev/null
+++ b/lib/Emails.Transactional.Plugin/src/Mta/IEmailMessageData.cs
@@ -0,0 +1,38 @@
+/*
+* Copyright (c) 2023 Vaughn Nugent
+*
+* Library: VNLib
+* Package: Emails.Transactional
+* File: IEmailMessageData.cs
+*
+* IEmailMessageData.cs is part of Emails.Transactional which is part of the larger
+* VNLib collection of libraries and utilities.
+*
+* Emails.Transactional is free software: you can redistribute it and/or modify
+* it under the terms of the GNU General Public License as published
+* by the Free Software Foundation, either version 2 of the License,
+* or (at your option) any later version.
+*
+* Emails.Transactional is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+* General Public License for more details.
+*
+* You should have received a copy of the GNU General Public License
+* along with Emails.Transactional. If not, see http://www.gnu.org/licenses/.
+*/
+
+namespace Emails.Transactional.Mta
+{
+ /// <summary>
+ /// Represents an email's message body
+ /// </summary>
+ internal interface IEmailMessageData
+ {
+ /// <summary>
+ /// Gets the template data as an HTML string.
+ /// </summary>
+ /// <returns>The template HTML string</returns>
+ string GetHtml();
+ }
+}
diff --git a/lib/Emails.Transactional.Plugin/src/Mta/IMailTransferAgent.cs b/lib/Emails.Transactional.Plugin/src/Mta/IMailTransferAgent.cs
new file mode 100644
index 0000000..3c2e98d
--- /dev/null
+++ b/lib/Emails.Transactional.Plugin/src/Mta/IMailTransferAgent.cs
@@ -0,0 +1,44 @@
+/*
+* Copyright (c) 2023 Vaughn Nugent
+*
+* Library: VNLib
+* Package: Emails.Transactional
+* File: IMailTransferAgent.cs
+*
+* IMailTransferAgent.cs is part of Emails.Transactional which is part of the larger
+* VNLib collection of libraries and utilities.
+*
+* Emails.Transactional is free software: you can redistribute it and/or modify
+* it under the terms of the GNU General Public License as published
+* by the Free Software Foundation, either version 2 of the License,
+* or (at your option) any later version.
+*
+* Emails.Transactional is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+* General Public License for more details.
+*
+* You should have received a copy of the GNU General Public License
+* along with Emails.Transactional. If not, see http://www.gnu.org/licenses/.
+*/
+
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace Emails.Transactional.Mta
+{
+ /// <summary>
+ /// Represents an email transfer agent or mail server.
+ /// </summary>
+ internal interface IMailTransferAgent
+ {
+ /// <summary>
+ /// Sends an email using the specified transaction and template.
+ /// </summary>
+ /// <param name="transaction">The email transaction containing message metadata</param>
+ /// <param name="message">The email message body</param>
+ /// <param name="cancellation">A token to cancel the operation</param>
+ /// <returns>A task that completes with the result of the operation</returns>
+ Task<MtaResult> SendEmailAsync(EmailTransaction transaction, IEmailMessageData message, CancellationToken cancellation = default);
+ }
+}
diff --git a/lib/Emails.Transactional.Plugin/src/Mta/MailTransferAgent.cs b/lib/Emails.Transactional.Plugin/src/Mta/MailTransferAgent.cs
new file mode 100644
index 0000000..ed74646
--- /dev/null
+++ b/lib/Emails.Transactional.Plugin/src/Mta/MailTransferAgent.cs
@@ -0,0 +1,57 @@
+/*
+* Copyright (c) 2023 Vaughn Nugent
+*
+* Library: VNLib
+* Package: Emails.Transactional
+* File: MailTransferAgent.cs
+*
+* MailTransferAgent.cs is part of Emails.Transactional which is part of the larger
+* VNLib collection of libraries and utilities.
+*
+* Emails.Transactional is free software: you can redistribute it and/or modify
+* it under the terms of the GNU General Public License as published
+* by the Free Software Foundation, either version 2 of the License,
+* or (at your option) any later version.
+*
+* Emails.Transactional is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+* General Public License for more details.
+*
+* You should have received a copy of the GNU General Public License
+* along with Emails.Transactional. If not, see http://www.gnu.org/licenses/.
+*/
+
+using System;
+using System.Threading;
+using System.Threading.Tasks;
+
+using VNLib.Plugins;
+using VNLib.Plugins.Extensions.Loading;
+
+namespace Emails.Transactional.Mta
+{
+ [ConfigurationName("mta")]
+ internal sealed class MailTransferAgent: IMailTransferAgent
+ {
+ private readonly IMailTransferAgent _agent;
+
+ public MailTransferAgent(PluginBase plugin, IConfigScope config)
+ {
+ //Recover config
+ string? agentType = config.GetRequiredProperty("type", e => e.GetString())?.ToLowerInvariant();
+
+ _agent = agentType switch
+ {
+ "smtp" => plugin.GetOrCreateSingleton<SmtpProvider>(),
+ "resend" => plugin.GetOrCreateSingleton<ResendMta>(),
+ _ => throw new NotSupportedException("The specified MTA type is not supported"),
+ };
+ }
+
+ public Task<MtaResult> SendEmailAsync(EmailTransaction transaction, IEmailMessageData message, CancellationToken cancellation = default)
+ {
+ return _agent.SendEmailAsync(transaction, message, cancellation);
+ }
+ }
+}
diff --git a/lib/Emails.Transactional.Plugin/src/Mta/MtaResult.cs b/lib/Emails.Transactional.Plugin/src/Mta/MtaResult.cs
new file mode 100644
index 0000000..e7ab771
--- /dev/null
+++ b/lib/Emails.Transactional.Plugin/src/Mta/MtaResult.cs
@@ -0,0 +1,33 @@
+/*
+* Copyright (c) 2023 Vaughn Nugent
+*
+* Library: VNLib
+* Package: Emails.Transactional
+* File: MtaResult.cs
+*
+* MtaResult.cs is part of Emails.Transactional which is part of the larger
+* VNLib collection of libraries and utilities.
+*
+* Emails.Transactional is free software: you can redistribute it and/or modify
+* it under the terms of the GNU General Public License as published
+* by the Free Software Foundation, either version 2 of the License,
+* or (at your option) any later version.
+*
+* Emails.Transactional is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+* General Public License for more details.
+*
+* You should have received a copy of the GNU General Public License
+* along with Emails.Transactional. If not, see http://www.gnu.org/licenses/.
+*/
+
+namespace Emails.Transactional.Mta
+{
+ /// <summary>
+ /// The result of an MTA request
+ /// </summary>
+ /// <param name="Success">A value that indicates if the transfer was successful</param>
+ /// <param name="Message">The result of the operation regardless of the status</param>
+ public readonly record struct MtaResult(bool Success, string? Message);
+}
diff --git a/lib/Emails.Transactional.Plugin/src/Mta/ResendMta.cs b/lib/Emails.Transactional.Plugin/src/Mta/ResendMta.cs
new file mode 100644
index 0000000..3f20aba
--- /dev/null
+++ b/lib/Emails.Transactional.Plugin/src/Mta/ResendMta.cs
@@ -0,0 +1,224 @@
+/*
+* Copyright (c) 2023 Vaughn Nugent
+*
+* Library: VNLib
+* Package: Emails.Transactional
+* File: ResendMta.cs
+*
+* ResendMta.cs is part of Emails.Transactional which is part of the larger
+* VNLib collection of libraries and utilities.
+*
+* Emails.Transactional is free software: you can redistribute it and/or modify
+* it under the terms of the GNU General Public License as published
+* by the Free Software Foundation, either version 2 of the License,
+* or (at your option) any later version.
+*
+* Emails.Transactional is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+* General Public License for more details.
+*
+* You should have received a copy of the GNU General Public License
+* along with Emails.Transactional. If not, see http://www.gnu.org/licenses/.
+*/
+
+using System;
+using System.Net;
+using System.Linq;
+using System.Text;
+using System.Threading;
+using System.Threading.Tasks;
+using System.Text.Json.Serialization;
+
+using RestSharp;
+
+using VNLib.Net.Http;
+using VNLib.Utils.Logging;
+using VNLib.Utils.Extensions;
+using VNLib.Net.Rest.Client.Construction;
+using VNLib.Net.Rest.Client;
+using VNLib.Plugins;
+using VNLib.Plugins.Extensions.Loading;
+using VNLib.Plugins.Extensions.Loading.Events;
+
+using ContentType = VNLib.Net.Http.ContentType;
+
+namespace Emails.Transactional.Mta
+{
+ [ConfigurationName("resend")]
+ internal sealed class ResendMta : IMailTransferAgent
+ {
+ const int ResendMaxPerSecond = 10;
+
+ /*
+ * Resend has a rate limit of 10 request per second,
+ * this timer resets the request counter every second
+ */
+ private int _remainingRequests;
+
+ Task ResetRateLimitAsync(ILogProvider log, CancellationToken pluginExitToken)
+ {
+ //Reset the request counter
+ _remainingRequests = ResendMaxPerSecond;
+ return Task.CompletedTask;
+ }
+
+ private readonly ResendSiteAdapter _resendAdapter;
+ private readonly TimeSpan _rateLimitDelay;
+ private readonly int _rateLimitRetry;
+
+ public ResendMta(PluginBase plugin, IConfigScope config)
+ {
+ int timeoutMs = config.GetRequiredProperty("timeout_ms", e => e.GetInt32());
+ int maxClients = config.GetRequiredProperty("max_clients", e => e.GetInt32());
+ string? userAgent = config.GetProperty("user_agent", e => e.GetString());
+ _rateLimitDelay = config["rate_limit_delay_ms"].GetTimeSpan(TimeParseType.Milliseconds);
+ _rateLimitRetry = config["rate_limit_retry"].GetInt32();
+
+ //Create the resend adapter
+ _resendAdapter = new ResendSiteAdapter(timeoutMs, maxClients, userAgent);
+
+ //Retrieve the access token
+ IAsyncLazy<string> authToken = plugin.GetSecretAsync("resend_token").ToLazy(p => p.Result.ToString());
+
+ //Define the send endpoint
+ //https://resend.com/docs/api-reference/emails/send-email
+ _resendAdapter.DefineSingleEndpoint()
+ .WithEndpoint<ResendEmail>()
+ .WithMethod(Method.Post)
+ .WithUrl("/emails")
+ .WithHeader("Accept", "application/json")
+ .WithHeader("Content-Type", HttpHelpers.GetContentTypeString(ContentType.Json))
+ //Add authorization header on requests
+ .WithHeader("Authorization", e => $"Bearer {authToken.Value}")
+ //Add message body
+ .WithModifier(static (re, r) => r.AddJsonBody(re));
+
+ //Schedule timer to reset the rate limit
+ plugin.ScheduleInterval(ResetRateLimitAsync, TimeSpan.FromSeconds(1));
+ }
+
+ ///<inheritdoc/>
+ public async Task<MtaResult> SendEmailAsync(EmailTransaction transaction, IEmailMessageData message, CancellationToken cancellation = default)
+ {
+ int retryCount = 0;
+
+ while (retryCount < _rateLimitRetry)
+ {
+ //Increment the request counter
+ int newCount = Interlocked.Increment(ref _remainingRequests);
+
+ //if rate limit hasn't been reached, break
+ if (newCount >= 0)
+ {
+ break;
+ }
+
+ retryCount++;
+
+ //Wait for the rate limit delay
+ await Task.Delay(_rateLimitDelay, cancellation);
+ }
+
+ //Create the resend email object
+ ResendEmail email = new(transaction)
+ {
+ Html = message.GetHtml(),
+ };
+
+ //Execute the request
+ RestResponse<ResendResponse> response = await _resendAdapter.ExecuteAsync<ResendEmail, ResendResponse>(email, cancellation);
+
+ if(response.IsSuccessful)
+ {
+ //Store the raw response content data
+ transaction.Result = response.Content;
+ return new MtaResult(true, response.Data?.Id);
+ }
+ else
+ {
+ switch (response.StatusCode)
+ {
+ case HttpStatusCode.UnprocessableEntity:
+ return new MtaResult(false, response.Data?.StatusText);
+ default:
+ return new MtaResult(false, response.Content);
+ }
+ }
+ }
+
+ private sealed record class ResendEmail(EmailTransaction Transaction)
+ {
+ [JsonPropertyName("from")]
+ public string From => $"{Transaction.FromName} <{Transaction.From}>";
+
+ [JsonPropertyName("subject")]
+ public string? Subject => Transaction.Subject;
+
+ [JsonPropertyName("to")]
+ public string[]? To => Transaction.ToAddresses?.Select(static t => $"{t.Value} <{t.Key}>").ToArray();
+
+ [JsonPropertyName("bcc")]
+ public string[]? Bcc => Transaction.BccAddresses?.Select(static t => $"{t.Value} <{t.Key}>").ToArray();
+
+ [JsonPropertyName("cc")]
+ public string[]? Cc => Transaction.CcAddresses?.Select(static t => $"{t.Value} <{t.Key}>").ToArray();
+
+ [JsonPropertyName("reply_to")]
+ public string? ReplyTo => Transaction.ReplyTo == null ? null : $"{Transaction.ReplyToName} <{Transaction.ReplyTo}>";
+
+ [JsonPropertyName("html")]
+ public string Html { get; init; } = "";
+ }
+
+ private sealed class ResendResponse
+ {
+ [JsonPropertyName("id")]
+ public string Id { get; set; } = null!;
+
+ [JsonPropertyName("name")]
+ public string? Name { get; set; }
+
+ [JsonPropertyName("statusCode")]
+ public int StatusCpde { get; set; }
+
+ [JsonPropertyName("message")]
+ public string? StatusText { get; set; }
+ }
+
+ private sealed class ResendSiteAdapter : RestSiteAdapterBase
+ {
+ //Fixed resend api url
+ private const string BaseUrl = "https://api.resend.com";
+
+ ///<inheritdoc/>
+ protected override RestClientPool Pool { get; }
+
+ public ResendSiteAdapter(int maxTimeoutMs, int maxClients, string? userAgent)
+ {
+ RestClientOptions options = new(BaseUrl)
+ {
+ AutomaticDecompression = DecompressionMethods.All,
+ Encoding = Encoding.UTF8,
+ FollowRedirects = false,
+ MaxTimeout = maxTimeoutMs,
+ UserAgent = userAgent,
+ };
+
+ //Create client pool
+ Pool = new RestClientPool(maxClients, options);
+ }
+
+ ///<inheritdoc/>
+ public override void OnResponse(RestResponse response)
+ { }
+
+ ///<inheritdoc/>
+ public override Task WaitAsync(CancellationToken cancellation = default)
+ {
+ //TODO implement rate limit wait
+ return Task.CompletedTask;
+ }
+ }
+ }
+}
diff --git a/lib/Emails.Transactional.Plugin/src/SmtpProvider.cs b/lib/Emails.Transactional.Plugin/src/Mta/SmtpProvider.cs
index b2423ef..78781d4 100644
--- a/lib/Emails.Transactional.Plugin/src/SmtpProvider.cs
+++ b/lib/Emails.Transactional.Plugin/src/Mta/SmtpProvider.cs
@@ -1,29 +1,30 @@
/*
-* Copyright (c) 2022 Vaughn Nugent
+* Copyright (c) 2023 Vaughn Nugent
*
* Library: VNLib
-* Package: Transactional Emails
+* Package: Emails.Transactional
* File: SmtpProvider.cs
*
-* SmtpProvider.cs is part of Transactional Emails which is part of the larger
+* SmtpProvider.cs is part of Emails.Transactional which is part of the larger
* VNLib collection of libraries and utilities.
*
-* Transactional Emails is free software: you can redistribute it and/or modify
+* Emails.Transactional is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published
* by the Free Software Foundation, either version 2 of the License,
* or (at your option) any later version.
*
-* Transactional Emails is distributed in the hope that it will be useful,
+* Emails.Transactional is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
-* along with Transactional Emails. If not, see http://www.gnu.org/licenses/.
+* along with Emails.Transactional. If not, see http://www.gnu.org/licenses/.
*/
using System;
using System.Net;
+using System.Text;
using System.Threading;
using System.Threading.Tasks;
using System.Collections.Generic;
@@ -33,46 +34,61 @@ using MailKit.Net.Smtp;
using MimeKit;
using MimeKit.Text;
-namespace Emails.Transactional
+using VNLib.Utils.Extensions;
+using VNLib.Plugins;
+using VNLib.Plugins.Extensions.Loading;
+
+namespace Emails.Transactional.Mta
{
- internal sealed class SmtpProvider
+
+ [ConfigurationName("smtp")]
+ internal sealed class SmtpProvider : IMailTransferAgent
{
private readonly Uri ServerAddress;
- private readonly ICredentials ServerCreds;
+ private readonly IAsyncLazy<ICredentials> ServerCreds;
private readonly TimeSpan Timeout;
- public SmtpProvider(Uri ServerAddress, ICredentials ServerCreds, TimeSpan Timeout)
+ public SmtpProvider(PluginBase plugin, IConfigScope config)
{
- this.ServerCreds = ServerCreds;
- this.ServerAddress = ServerAddress;
- this.Timeout = Timeout;
+ ServerAddress = config.GetRequiredProperty("server_address", e => new Uri(e.GetString()!));
+ Timeout = config["timeout_ms"].GetTimeSpan(TimeParseType.Milliseconds);
+
+ //Get the client id from the config
+ string clientId = config.GetRequiredProperty("username", e => e.GetString()!);
+
+ //Get the password from the secret store and make it lazy loaded
+ ServerCreds = plugin.GetSecretAsync("smtp_password").ToLazy<ICredentials>(r => new NetworkCredential(clientId, r.Result.ToString()));
}
-
- /// <summary>
- /// Opens a connection to the configured SMTP server and sends the specified email
- /// request transaction on the server. When the operation completes, the transaction's
- /// result property is populated with the result of the operation.
- /// </summary>
- /// <param name="transaction">The transaction data</param>
- /// <param name="messageBody">The content of the message to send</param>
- /// <param name="dataFromat">The format of the body content</param>
- /// <returns>A task that resolves the status of the operation</returns>
- public async Task<string> SendAsync(EmailTransaction transaction, string messageBody, TextFormat dataFromat, CancellationToken cancellation)
+
+
+ ///<inheritdoc/>
+ public async Task<MtaResult> SendEmailAsync(EmailTransaction transaction, IEmailMessageData template, CancellationToken cancellation = default)
{
+ _ = transaction ?? throw new ArgumentNullException(nameof(transaction));
+
+ ICredentials creds = await ServerCreds;
+
//Configured a new message
using MimeMessage message = new()
{
Date = DateTime.UtcNow,
Subject = transaction.Subject
};
+
//From address is the stored from address
message.From.Add(new MailboxAddress(transaction.FromName, transaction.From));
+ if (transaction.ToAddresses == null)
+ {
+ throw new ArgumentException("The transaction must contain at least one To address");
+ }
+
//Add to email addresses
foreach (KeyValuePair<string, string> tos in transaction.ToAddresses)
{
message.To.Add(new MailboxAddress(tos.Value, tos.Key));
}
+
//Add ccs
if (transaction.CcAddresses != null)
{
@@ -81,6 +97,7 @@ namespace Emails.Transactional
message.Cc.Add(new MailboxAddress(ccs.Value, ccs.Key));
}
}
+
//Add bccs
if (transaction.BccAddresses != null)
{
@@ -91,28 +108,36 @@ namespace Emails.Transactional
}
//Use html format since we expect to be reading html templates
- using TextPart body = new(dataFromat)
+ using TextPart body = new(TextFormat.Html)
{
- IsAttachment = false,
- Text = messageBody
+ IsAttachment = false
};
+
+ //Set the body text
+ body.SetText(Encoding.UTF8, template.GetHtml());
+
//Set message body
message.Body = body;
+
//Open a new mail client
using SmtpClient client = new();
+
//Set timeout for senting messages
client.Timeout = (int)Timeout.TotalMilliseconds;
+
//Connect to server
await client.ConnectAsync(ServerAddress, cancellation);
- //Aithenticate
- await client.AuthenticateAsync(ServerCreds, cancellation);
+
+ //Authenticate
+ await client.AuthenticateAsync(creds, cancellation);
+
//Send the email
- string result = await client.SendAsync(message, cancellation);
+ transaction.Result = await client.SendAsync(message, cancellation);
+
//Disconnect from the server
await client.DisconnectAsync(true, CancellationToken.None);
- //Update the transaction
- transaction.Result = result;
- return result;
+
+ return new MtaResult(true, transaction.Result);
}
}
}
diff --git a/lib/Emails.Transactional.Plugin/src/TEmailEntryPoint.cs b/lib/Emails.Transactional.Plugin/src/TEmailEntryPoint.cs
index d6e05a8..1f16777 100644
--- a/lib/Emails.Transactional.Plugin/src/TEmailEntryPoint.cs
+++ b/lib/Emails.Transactional.Plugin/src/TEmailEntryPoint.cs
@@ -2,24 +2,24 @@
* Copyright (c) 2023 Vaughn Nugent
*
* Library: VNLib
-* Package: Transactional Emails
+* Package: Emails.Transactional
* File: TEmailEntryPoint.cs
*
-* TEmailEntryPoint.cs is part of Transactional Emails which is part of the larger
+* TEmailEntryPoint.cs is part of Emails.Transactional which is part of the larger
* VNLib collection of libraries and utilities.
*
-* Transactional Emails is free software: you can redistribute it and/or modify
+* Emails.Transactional is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published
* by the Free Software Foundation, either version 2 of the License,
* or (at your option) any later version.
*
-* Transactional Emails is distributed in the hope that it will be useful,
+* Emails.Transactional is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
-* along with Transactional Emails. If not, see http://www.gnu.org/licenses/.
+* along with Emails.Transactional. If not, see http://www.gnu.org/licenses/.
*/
using System;
diff --git a/lib/Emails.Transactional.Plugin/src/Templates/EmailTemplateStore.cs b/lib/Emails.Transactional.Plugin/src/Templates/EmailTemplateStore.cs
new file mode 100644
index 0000000..d589262
--- /dev/null
+++ b/lib/Emails.Transactional.Plugin/src/Templates/EmailTemplateStore.cs
@@ -0,0 +1,148 @@
+/*
+* Copyright (c) 2023 Vaughn Nugent
+*
+* Library: VNLib
+* Package: Emails.Transactional
+* File: EmailTemplateStore.cs
+*
+* EmailTemplateStore.cs is part of Emails.Transactional which is part of the larger
+* VNLib collection of libraries and utilities.
+*
+* Emails.Transactional is free software: you can redistribute it and/or modify
+* it under the terms of the GNU General Public License as published
+* by the Free Software Foundation, either version 2 of the License,
+* or (at your option) any later version.
+*
+* Emails.Transactional is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+* General Public License for more details.
+*
+* You should have received a copy of the GNU General Public License
+* along with Emails.Transactional. If not, see http://www.gnu.org/licenses/.
+*/
+
+
+using System;
+using System.IO;
+using System.Text;
+using System.Threading;
+using System.Threading.Tasks;
+using System.Collections.Generic;
+
+using Fluid;
+
+using VNLib.Utils.IO;
+using VNLib.Utils.Extensions;
+using VNLib.Utils.Memory.Caching;
+using VNLib.Plugins;
+using VNLib.Plugins.Extensions.Loading;
+using VNLib.Plugins.Extensions.Data.Storage;
+
+using Emails.Transactional.Mta;
+
+namespace Emails.Transactional.Templates
+{
+ [ConfigurationName("templates")]
+ internal sealed class EmailTemplateStore : ITemplateStorage
+ {
+ private readonly FluidParser _parser;
+ private readonly Dictionary<string, EmailTemplate> _templateCache;
+ private readonly ISimpleFilesystem _filesystem;
+ private readonly TimeSpan _cacheValidFor;
+
+ public EmailTemplateStore(PluginBase plugin, IConfigScope config)
+ {
+ _parser = new();
+ _templateCache = new(StringComparer.OrdinalIgnoreCase);
+
+ _cacheValidFor = config["cache_valid_for_sec"].GetTimeSpan(TimeParseType.Seconds);
+ string fsPath = config.GetRequiredProperty("template_path", e => e.GetString()!);
+
+ //Get the filesystem
+ ISimpleFilesystem baseFs = plugin.GetOrCreateSingleton<MinioStorage>();
+
+ //Create a new scope for the base path
+ _filesystem = baseFs.CreateNewScope(fsPath);
+ }
+
+ public Task<IEmailTemplate> GetTemplateAsync(string templateId, CancellationToken cancellation)
+ {
+ //try to get the template from the cache
+ if (_templateCache.TryGetOrEvictRecord(templateId, out EmailTemplate? template) > 0)
+ {
+ return Task.FromResult<IEmailTemplate>(template!);
+ }
+
+ //Load the template from the store
+ return GetTemplateFromStoreAsync(templateId, cancellation);
+ }
+
+ private async Task<IEmailTemplate> GetTemplateFromStoreAsync(string templateId, CancellationToken cancellation)
+ {
+ //memory stream for template data
+ using VnMemoryStream templateData = new();
+
+ //remove leading slash
+ if (templateId.StartsWith('/'))
+ {
+ templateId = templateId[1..];
+ }
+
+ //Recover template data
+ long read = await _filesystem.ReadFileAsync(templateId, templateData, cancellation);
+
+ if(read <= 0)
+ {
+ throw new TemplateLookupFailedException($"Template {templateId} not found");
+ }
+
+ //Rewind the stream
+ templateData.Seek(0, SeekOrigin.Begin);
+
+ //To string
+ string templateString = Encoding.UTF8.GetString(templateData.AsSpan());
+
+ //Try to parse the template and raise exception if it fails
+ if (!_parser.TryParse(templateString, out IFluidTemplate template, out string error))
+ {
+ throw new TemplateLookupFailedException($"A template parse error occured: {error}");
+ }
+
+ //Create new email template
+ EmailTemplate et = new(template);
+
+ //Store template in cache
+ _templateCache.StoreRecord(templateId, et, _cacheValidFor);
+
+ return et;
+ }
+
+ private sealed record class EmailTemplate(IFluidTemplate Template) : IEmailTemplate, ICacheable
+ {
+ ///<inheritdoc/>
+ public DateTime Expires { get; set; }
+
+ ///<inheritdoc/>
+ public bool Equals(ICacheable? other) => ReferenceEquals(this, other);
+
+ ///<inheritdoc/>
+ public void Evicted()
+ { }
+
+ ///<inheritdoc/>
+ public IEmailMessageData RenderTemplate(object variables)
+ {
+ //Create a template model
+ TemplateContext ctx = new(variables);
+ string html = Template.Render(ctx);
+ return new EmailMessageData(html);
+ }
+
+ private sealed record class EmailMessageData(string Rendered) : IEmailMessageData
+ {
+ public string GetHtml() => Rendered;
+ }
+ }
+ }
+}
diff --git a/lib/Emails.Transactional.Plugin/src/Templates/IEmailTemplate.cs b/lib/Emails.Transactional.Plugin/src/Templates/IEmailTemplate.cs
new file mode 100644
index 0000000..3ee12cb
--- /dev/null
+++ b/lib/Emails.Transactional.Plugin/src/Templates/IEmailTemplate.cs
@@ -0,0 +1,42 @@
+/*
+* Copyright (c) 2023 Vaughn Nugent
+*
+* Library: VNLib
+* Package: Emails.Transactional
+* File: IEmailTemplate.cs
+*
+* IEmailTemplate.cs is part of Emails.Transactional which is part of the larger
+* VNLib collection of libraries and utilities.
+*
+* Emails.Transactional is free software: you can redistribute it and/or modify
+* it under the terms of the GNU General Public License as published
+* by the Free Software Foundation, either version 2 of the License,
+* or (at your option) any later version.
+*
+* Emails.Transactional is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+* General Public License for more details.
+*
+* You should have received a copy of the GNU General Public License
+* along with Emails.Transactional. If not, see http://www.gnu.org/licenses/.
+*/
+
+
+using Emails.Transactional.Mta;
+
+namespace Emails.Transactional.Templates
+{
+ /// <summary>
+ /// An abstraction that defines a template for an email
+ /// </summary>
+ internal interface IEmailTemplate
+ {
+ /// <summary>
+ /// Renders a new copy of the template with the specified variables
+ /// </summary>
+ /// <param name="variables">The variable model to compile with the template</param>
+ /// <returns>A new <see cref="IEmailMessageData"/> instance to capture html data from</returns>
+ IEmailMessageData RenderTemplate(object variables);
+ }
+}
diff --git a/lib/Emails.Transactional.Plugin/src/Templates/ITemplateStorage.cs b/lib/Emails.Transactional.Plugin/src/Templates/ITemplateStorage.cs
new file mode 100644
index 0000000..e17e24a
--- /dev/null
+++ b/lib/Emails.Transactional.Plugin/src/Templates/ITemplateStorage.cs
@@ -0,0 +1,45 @@
+/*
+* Copyright (c) 2023 Vaughn Nugent
+*
+* Library: VNLib
+* Package: Emails.Transactional
+* File: ITemplateStorage.cs
+*
+* ITemplateStorage.cs is part of Emails.Transactional which is part of the larger
+* VNLib collection of libraries and utilities.
+*
+* Emails.Transactional is free software: you can redistribute it and/or modify
+* it under the terms of the GNU General Public License as published
+* by the Free Software Foundation, either version 2 of the License,
+* or (at your option) any later version.
+*
+* Emails.Transactional is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+* General Public License for more details.
+*
+* You should have received a copy of the GNU General Public License
+* along with Emails.Transactional. If not, see http://www.gnu.org/licenses/.
+*/
+
+
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace Emails.Transactional.Templates
+{
+ /// <summary>
+ /// An abstraction that defines a storage for email templates
+ /// </summary>
+ internal interface ITemplateStorage
+ {
+ /// <summary>
+ /// Gets an email template from its id
+ /// </summary>
+ /// <param name="templateId">The id of the template to fetch</param>
+ /// <param name="cancellation">A token to cancel the fetch operation</param>
+ /// <returns>A task that completes with the template model instance</returns>
+ /// <exception cref="TemplateLookupFailedException"></exception>
+ Task<IEmailTemplate> GetTemplateAsync(string templateId, CancellationToken cancellation);
+ }
+}
diff --git a/lib/Emails.Transactional.Plugin/src/Templates/TemplateLookupFailedException.cs b/lib/Emails.Transactional.Plugin/src/Templates/TemplateLookupFailedException.cs
new file mode 100644
index 0000000..5e607f3
--- /dev/null
+++ b/lib/Emails.Transactional.Plugin/src/Templates/TemplateLookupFailedException.cs
@@ -0,0 +1,43 @@
+/*
+* Copyright (c) 2023 Vaughn Nugent
+*
+* Library: VNLib
+* Package: Emails.Transactional
+* File: TemplateLookupFailedException.cs
+*
+* TemplateLookupFailedException.cs is part of Emails.Transactional which is
+* part of the larger VNLib collection of libraries and utilities.
+*
+* Emails.Transactional is free software: you can redistribute it and/or modify
+* it under the terms of the GNU General Public License as published
+* by the Free Software Foundation, either version 2 of the License,
+* or (at your option) any later version.
+*
+* Emails.Transactional is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+* General Public License for more details.
+*
+* You should have received a copy of the GNU General Public License
+* along with Emails.Transactional. If not, see http://www.gnu.org/licenses/.
+*/
+
+
+using System;
+
+namespace Emails.Transactional.Templates
+{
+ [Serializable]
+ public class TemplateLookupFailedException : Exception
+ {
+ public TemplateLookupFailedException() { }
+
+ public TemplateLookupFailedException(string message) : base(message) { }
+
+ public TemplateLookupFailedException(string message, Exception inner) : base(message, inner) { }
+
+ protected TemplateLookupFailedException(
+ System.Runtime.Serialization.SerializationInfo info,
+ System.Runtime.Serialization.StreamingContext context) : base(info, context) { }
+ }
+}
diff --git a/lib/Emails.Transactional.Plugin/src/Transactions/EmailTransactionValidator.cs b/lib/Emails.Transactional.Plugin/src/Transactions/EmailTransactionValidator.cs
index 5786efb..d6642d8 100644
--- a/lib/Emails.Transactional.Plugin/src/Transactions/EmailTransactionValidator.cs
+++ b/lib/Emails.Transactional.Plugin/src/Transactions/EmailTransactionValidator.cs
@@ -1,25 +1,25 @@
/*
-* Copyright (c) 2022 Vaughn Nugent
+* Copyright (c) 2023 Vaughn Nugent
*
* Library: VNLib
-* Package: Transactional Emails
+* Package: Emails.Transactional
* File: EmailTransactionValidator.cs
*
-* EmailTransactionValidator.cs is part of Transactional Emails which is part of the larger
+* EmailTransactionValidator.cs is part of Emails.Transactional which is part of the larger
* VNLib collection of libraries and utilities.
*
-* Transactional Emails is free software: you can redistribute it and/or modify
+* Emails.Transactional is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published
* by the Free Software Foundation, either version 2 of the License,
* or (at your option) any later version.
*
-* Transactional Emails is distributed in the hope that it will be useful,
+* Emails.Transactional is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
-* along with Transactional Emails. If not, see http://www.gnu.org/licenses/.
+* along with Emails.Transactional. If not, see http://www.gnu.org/licenses/.
*/
using FluentValidation;
diff --git a/lib/Emails.Transactional.Plugin/src/Transactions/TransactionResult.cs b/lib/Emails.Transactional.Plugin/src/Transactions/TransactionResult.cs
index da97499..93ce549 100644
--- a/lib/Emails.Transactional.Plugin/src/Transactions/TransactionResult.cs
+++ b/lib/Emails.Transactional.Plugin/src/Transactions/TransactionResult.cs
@@ -1,25 +1,25 @@
/*
-* Copyright (c) 2022 Vaughn Nugent
+* Copyright (c) 2023 Vaughn Nugent
*
* Library: VNLib
-* Package: Transactional Emails
+* Package: Emails.Transactional
* File: TransactionResult.cs
*
-* TransactionResult.cs is part of Transactional Emails which is part of the larger
+* TransactionResult.cs is part of Emails.Transactional which is part of the larger
* VNLib collection of libraries and utilities.
*
-* Transactional Emails is free software: you can redistribute it and/or modify
+* Emails.Transactional is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published
* by the Free Software Foundation, either version 2 of the License,
* or (at your option) any later version.
*
-* Transactional Emails is distributed in the hope that it will be useful,
+* Emails.Transactional is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
-* along with Transactional Emails. If not, see http://www.gnu.org/licenses/.
+* along with Emails.Transactional. If not, see http://www.gnu.org/licenses/.
*/
using System.Text.Json.Serialization;
@@ -35,11 +35,5 @@ namespace Emails.Transactional.Transactions
[JsonPropertyName("smtp_status")]
public string? SmtpStatus { get; set; }
-
- [JsonPropertyName("error_code")]
- public string? ErrorCode { get; set; }
-
- [JsonPropertyName("error_description")]
- public string? ErrorDescription { get; set; }
}
}
diff --git a/lib/Emails.Transactional.Plugin/src/Transactions/TransactionStore.cs b/lib/Emails.Transactional.Plugin/src/Transactions/TransactionStore.cs
index 47db7b1..4005f7b 100644
--- a/lib/Emails.Transactional.Plugin/src/Transactions/TransactionStore.cs
+++ b/lib/Emails.Transactional.Plugin/src/Transactions/TransactionStore.cs
@@ -2,24 +2,24 @@
* Copyright (c) 2023 Vaughn Nugent
*
* Library: VNLib
-* Package: Transactional Emails
+* Package: Emails.Transactional
* File: TransactionStore.cs
*
-* TransactionStore.cs is part of Transactional Emails which is part of the larger
+* TransactionStore.cs is part of Emails.Transactional which is part of the larger
* VNLib collection of libraries and utilities.
*
-* Transactional Emails is free software: you can redistribute it and/or modify
+* Emails.Transactional is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published
* by the Free Software Foundation, either version 2 of the License,
* or (at your option) any later version.
*
-* Transactional Emails is distributed in the hope that it will be useful,
+* Emails.Transactional is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
-* along with Transactional Emails. If not, see http://www.gnu.org/licenses/.
+* along with Emails.Transactional. If not, see http://www.gnu.org/licenses/.
*/
using System;
@@ -28,6 +28,7 @@ using System.Linq;
using Microsoft.EntityFrameworkCore;
using VNLib.Plugins.Extensions.Data;
+using VNLib.Plugins.Extensions.Data.Abstractions;
namespace Emails.Transactional.Transactions
{
@@ -41,34 +42,43 @@ namespace Emails.Transactional.Transactions
Options = options;
}
- public override TransactionalDbContext NewContext() => new EmailDbCtx(Options);
-
- public override string RecordIdBuilder => Guid.NewGuid().ToString("N");
+ ///<inheritdoc/>
+ public override IDbContextHandle GetNewContext() => new EmailDbCtx(Options);
- protected override void OnRecordUpdate(EmailTransaction newRecord, EmailTransaction oldRecord)
+ ///<inheritdoc/>
+ public override string GetNewRecordId() => Guid.NewGuid().ToString("N");
+
+ ///<inheritdoc/>
+ public override void OnRecordUpdate(EmailTransaction newRecord, EmailTransaction oldRecord)
{
oldRecord.LastModified = DateTime.UtcNow;
}
-
- protected override IQueryable<EmailTransaction> GetCollectionQueryBuilder(TransactionalDbContext context, params string[] constraints)
- {
- string userId = constraints[0];
- //Get the last transactions for the specifed user
- EmailDbCtx ctx = context as EmailDbCtx;
- return from trans in ctx.EmailTransactions
- where trans.UserId == userId
- orderby trans.LastModified descending
- select trans;
- }
- protected override IQueryable<EmailTransaction> GetSingleQueryBuilder(TransactionalDbContext context, params string[] constraints)
+ public override IDbQueryLookup<EmailTransaction> QueryTable { get; } = new DbQueries();
+
+
+ private sealed record class DbQueries : IDbQueryLookup<EmailTransaction>
{
- string transactionid = constraints[0];
- EmailDbCtx ctx = context as EmailDbCtx;
- //Selet the exact transaction from its id
- return from trans in ctx.EmailTransactions
- where trans.Id == transactionid
- select trans;
+ public IQueryable<EmailTransaction> GetCollectionQueryBuilder(IDbContextHandle context, params string[] constraints)
+ {
+ string userId = constraints[0];
+ //Get the last transactions for the specifed user
+ EmailDbCtx ctx = (context as EmailDbCtx)!;
+ return from trans in ctx.EmailTransactions
+ where trans.UserId == userId
+ orderby trans.LastModified descending
+ select trans;
+ }
+
+ public IQueryable<EmailTransaction> GetSingleQueryBuilder(IDbContextHandle context, params string[] constraints)
+ {
+ string transactionid = constraints[0];
+ EmailDbCtx ctx = (context as EmailDbCtx)!;
+ //Selet the exact transaction from its id
+ return from trans in ctx.EmailTransactions
+ where trans.Id == transactionid
+ select trans;
+ }
}
}
}