A .NET package that generates clean, responsive HTML e-mails for sending transactional mail. This package is inspired by https://github.com/eladnava/mailgen

Demo

These e-mails were generated using the built-in default theme.

Usage

First, install the package using NuGet:

dotnet add package Mailgen

Then, use the following code to generate an e-mail:

using Mailgen;
using Mailgen.Dtos;
using Mailgen.Templates.Models;

var createMailGeneratorDto = new CreateMailGeneratorDto
{
    Options = new TemplateOptionsModel
    {
        Product = new ProductModel
        {
            CopyrightLeft = "© 2024",
            CopyrightRight = "All rights reserved.",
            Link = "https://github.com/hsndmr",
            Name = "Example Product"
        }
    }
};


var mailGenerator = new MailGenerator(new HtmlGeneratorFactory(), createMailGeneratorDto);
var generateMailDto = new GenerateMailDto<Item>
{
    Body = new TemplateBodyModel<Item>
    {
        Title = "Hi John Appleseed,",
        Intros =
        [
            "Your order has been processed successfully."
        ],
        Tables = new List<TableModel<Item>>
        {
            new()
            {
                Columns =
                [
                    new TableColumnModel<Item>
                    {
                        Header = "Item",
                        ValueSelector = item => item.Name,
                        Width = "20%"
                    },
                    new TableColumnModel<Item>
                    {
                        Header = "Description",
                        ValueSelector = item => item.Description
                    },
                    new TableColumnModel<Item>
                    {
                        Header = "Price",
                        ValueSelector = item => item.Price,
                        Width = "15%",
                        Align = "right"
                    }
                ],
                Rows =
                [
                    new Item
                    {
                        Name = "Node.js",
                        Description = "Event-driven I/O server-side JavaScript environment based on V8.",
                        Price = "$10.99"
                    },
                    new Item
                    {
                        Name = "Mailgen",
                        Description = "A .NET library for generating HTML emails.",
                        Price = "$1.99"
                    }
                ]
            }
        },
        Actions =
        [
            new ActionModel
            {
                Instructions = "You can check the status of your order and more in your dashboard:",
                Button = new ButtonModel
                {
                    Color = "#22BC66",
                    Text = "Go to Dashboard",
                    Link = "https://github.com/hsndmr"
                }
            }
        ],
        Outro =
        [
            "We thank you for your purchase."
        ],
        Signature = "Yours truly"
    }
};

var html = await mailGenerator.GenerateMail(generateMailDto);

Console.WriteLine(html);

This code would output the following HTML template:

Example

• Example