PommaLabs.Liquimail.AspNetCore
2.5.0
Prefix Reserved
See the version list below for details.
dotnet add package PommaLabs.Liquimail.AspNetCore --version 2.5.0
NuGet\Install-Package PommaLabs.Liquimail.AspNetCore -Version 2.5.0
<PackageReference Include="PommaLabs.Liquimail.AspNetCore" Version="2.5.0" />
paket add PommaLabs.Liquimail.AspNetCore --version 2.5.0
#r "nuget: PommaLabs.Liquimail.AspNetCore, 2.5.0"
// Install PommaLabs.Liquimail.AspNetCore as a Cake Addin #addin nuget:?package=PommaLabs.Liquimail.AspNetCore&version=2.5.0 // Install PommaLabs.Liquimail.AspNetCore as a Cake Tool #tool nuget:?package=PommaLabs.Liquimail.AspNetCore&version=2.5.0
Liquimail
Liquimail implements glue code to use Liquid templates with MailKit.
Library is feature complete and no further development is planned on this project, except for routine maintenance and bug fixes.
Liquimail templates are processed using DotLiquid library and mail messages are sent with MailKit.
Liquid templates can be stored in three different ways:
- Local file system,
- Embedded resources,
- SQL database table.
A fake, in-memory mail sender is also provided in order to easily perform unit tests.
Table of Contents
Install
NuGet package PommaLabs.Liquimail is available for download:
dotnet add package PommaLabs.Liquimail
Another package, PommLabs.Liquimail.AspNetCore, which is focused on ASP.NET Core integrations, is also available for download:
dotnet add package PommaLabs.Liquimail.AspNetCore
Usage
Liquimail exposes two main interfaces:
- IMailSender, which actually sends mail messages.
- IMailTemplatesManager, which loads mail templates.
Configuring the first interface is mandatory, while the second one is needed
only when using SendMail overloads which use the templating system based on DotLiquid.
Maintainers
Contributing
MRs accepted.
Small note: If editing the README, please conform to the standard-readme specification.
Editing
Visual Studio Code, with Remote Containers extension, is the recommended way to work on this project.
A development container has been configured with all required tools.
Visual Studio Community is also supported
and an updated solution file, liquimail.sln, has been provided.
Restoring dependencies
When opening the development container, dependencies should be automatically restored.
Anyway, dependencies can be restored with following command:
dotnet restore
Running tests
Tests can be run with following command:
dotnet test
Tests can also be run with following command, which collects coverage information:
./build.sh --target run-tests
License
MIT © 2018-2022 Alessio Parma
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 is compatible. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
-
net6.0
- PommaLabs.Liquimail (>= 2.5.0)
-
net7.0
- PommaLabs.Liquimail (>= 2.5.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.