diff options
Diffstat (limited to 'lib/Emails.Transactional.Plugin/README.md')
-rw-r--r-- | lib/Emails.Transactional.Plugin/README.md | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/lib/Emails.Transactional.Plugin/README.md b/lib/Emails.Transactional.Plugin/README.md index c8d6c5f..c527c50 100644 --- a/lib/Emails.Transactional.Plugin/README.md +++ b/lib/Emails.Transactional.Plugin/README.md @@ -1,5 +1,8 @@ -# Emails.Transactional.Client -*Client library for sending transactional emails to an internal transactional email server* +# Emails.Transactional +*Essentials framework plugin for compiling and sending templated transactional emails via an OAuth2 enabled API* + +### Brief +This dynamically loaded plugin allows OAuth2 enabled rest clients to send a tranasactional email requests along with a template file name and template variables. The **Fluid** template is retrieved from a configured S3 object storage by it''s template name, validated, compiled, and sent to the configured SMTP server. Transactions and SMTP results are stored in the configured database backend. #### 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. |