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
• Usage
• Maintainers
• Contributing
  • Editing
  • Restoring dependencies
  • Running tests
• License

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

@pomma89.

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