{"id":520,"date":"2010-02-19T17:47:38","date_gmt":"2010-02-19T15:47:38","guid":{"rendered":"http:\/\/www.limilabs.com\/blog\/?p=520"},"modified":"2019-03-15T16:51:20","modified_gmt":"2019-03-15T14:51:20","slug":"email-template-engine","status":"publish","type":"post","link":"https:\/\/www.limilabs.com\/blog\/email-template-engine","title":{"rendered":"Email template engine"},"content":{"rendered":"

Newest version of Mail.dll email library for .NET<\/a> includes easy to use template engine.<\/p>\n

It allows you to easily create html template for your emails:
\n\"\"<\/p>\n

Loading and rendering such template requires one line of code:<\/p>\n

\r\n\/\/ C# version\r\n\r\nContact templateData = ...;\r\n\r\n string html = Template\r\n     .FromFile("template.txt")\r\n     .DataFrom(templateData )\r\n     .Render();\r\n<\/pre>\n
\r\n' VB.NET version\r\n\r\nDim templateData As Contact = ....\r\n\r\nDim html As String = Template _\r\n     .FromFile("template.txt") _\r\n     .DataFrom(templateData) _\r\n     .Render()\r\n<\/pre>\n
This is how the template looks like:<\/p>\n
\r\n<html>\r\n<head>\r\n    <title>Your order<\/title>\r\n<\/head>\r\n<body>\r\n\tHi [FirstName] [LastName],\r\n\t<br \/>\r\n\t<p>\r\n\tYour account [if Verified]has[else]<strong>has not<\/strong>[end] been verified. <br\/>\r\n\tYour password is: [Password].\r\n\t<\/p>\r\n\t<p>\r\n\tHere are your orders:\r\n\t<\/p>\r\n\t[foreach Orders]\r\n\t\t<p>\r\n\t\tOrder sent to <strong>[Street]<\/strong>:\r\n\t\t<\/p>\r\n\t\t<table style="width: 30%;">\r\n\t\t\t[foreach Items]\r\n\t\t\t\t<tr style="background-color: #E0ECFF;">\r\n\t\t\t\t\t<td>[Name]<\/td><td>[Price]<\/td>\r\n\t\t\t\t<\/tr>\r\n\t\t\t[end]\r\n\t\t<\/table>\r\n\t[end]\r\n\t<p>\r\n\t\tThank you for your orders.\r\n\t<p>\r\n<\/body>\r\n<\/html>\r\n<\/pre>\n
Here’s the sample code that loads, fills the template and sends it using Mail.dll:<\/p>\n
\r\n\/\/ C# version\r\n\r\nstring rendered = Template\r\n    .FromFile("template.txt")\r\n    .DataFrom(templateData)\r\n    .Render();\r\n\r\nMailBuilder builder = new MailBuilder();\r\nbuilder.Html = rendered;\r\nbuilder.Subject = "Your order";\r\nbuilder.From.Add(new MailBox("alice@mail.com", "Alice"));\r\nbuilder.To.Add(new MailBox("bob@mail.com", "Bob"));\r\nIMail email = builder.Create();\r\n\r\nusing (Smtp client = new Smtp())\r\n{\r\n    client.ConnectSSL("smtp.example.org");\r\n    client.UseBestLogin("alice@example.org", "password");\r\n    client.SendMessage(email);\r\n    client.Close();\r\n}\r\n<\/pre>\n
\r\n\/\/ C# fluent interface version\r\n\r\nusing Fluent = Limilabs.Mail.Fluent;\r\n\r\nFluent.Mail.Html(Template\r\n              .FromFile("template.txt")\r\n              .DataFrom(templateData)\r\n              .Render())\r\n    .From(new MailBox("alice@mail.com", "Alice"))\r\n    .To(new MailBox("bob@mail.com", "Bob"))\r\n    .Subject("Your order")\r\n    .UsingNewSmtp()\r\n    .WithCredentials("alice@example.org", "password")\r\n    .Server("smtp.example.org")\r\n    .WithSSL()\r\n    .Send();\r\n<\/pre>\n
\r\n' VB.NET version\r\n\r\n    Dim rendered As String = Template _\r\n        .FromFile("template.txt") _\r\n        .DataFrom(templateData) _\r\n        .Render()\r\n\r\n    Dim builder As MailBuilder = New MailBuilder()\r\n    builder.Html = rendered\r\n    builder.Subject = "Your order"\r\n    builder.From.Add(New MailBox("alice@mail.com", "Alice"))\r\n    builder.[To].Add(New MailBox("bob@mail.com", "Bob"))\r\n    Dim email As IMail = builder.Create()\r\n\r\n    Using client As Smtp = New Smtp()\r\n        client.ConnectSSL("smtp.example.org")\r\n        client.UseBestLogin("alice@example.org", "password")\r\n        client.SendMessage(email)\r\n        client.Close()\r\n    End Using\r\n<\/pre>\n
\r\n' VB.NET fluent interface version\r\n\r\nImports Fluent = Limilabs.Mail.Fluent;\r\n\r\nFluent.Mail.Html(Template _\r\n               .FromFile("template.txt") _\r\n               .DataFrom(templateData) _\r\n               .Render()) _\r\n     .From(New MailBox("alice@mail.com", "Alice")) _\r\n     .[To](New MailBox("bob@mail.com", "Bob")) _\r\n     .Subject("Your order") _\r\n     .UsingNewSmtp() _\r\n     .WithCredentials("alice@example.org", "password") _\r\n     .Server("smtp.example.org") _\r\n     .WithSSL() _\r\n     .Send()\r\n<\/pre>\n
You can also specify text version of the message, by using Text(string)<\/em> method. In most cases this is unnecessary, as Mail.dll automatically extracts plain text from html and adds the plain text version to the email message.<\/p>\n
And this is how the data (templateData <\/em> variable), used by the template, look like:<\/p>\n
\r\n\/\/ C# version\r\n\r\npublic class Contact\r\n{\r\n    public List<order> Orders { get; private set; }\r\n\r\n    public string FirstName { get; set; }\r\n    public string LastName { get; set; }\r\n    public bool Verified;\r\n    private string Password { get; set; }\r\n\r\n    public Contact()\r\n    {\r\n        Orders = new List<order>();\r\n    }\r\n} ;\r\n<\/pre>\n
\r\n' VB.NET version\r\n\r\nPublic Class Contact\r\n\tPublic Property Orders() As List(Of Order)\r\n\t\tGet\r\n\t\t\tReturn m_Orders\r\n\t\tEnd Get\r\n\t\tPrivate Set\r\n\t\t\tm_Orders = Value\r\n\t\tEnd Set\r\n\tEnd Property\r\n\tPrivate m_Orders As List(Of Order)\r\n\r\n\tPublic Property FirstName() As String\r\n\t\tGet\r\n\t\t\tReturn m_FirstName\r\n\t\tEnd Get\r\n\t\tSet\r\n\t\t\tm_FirstName = Value\r\n\t\tEnd Set\r\n\tEnd Property\r\n\tPrivate m_FirstName As String\r\n\tPublic Property LastName() As String\r\n\t\tGet\r\n\t\t\tReturn m_LastName\r\n\t\tEnd Get\r\n\t\tSet\r\n\t\t\tm_LastName = Value\r\n\t\tEnd Set\r\n\tEnd Property\r\n\tPrivate m_LastName As String\r\n\tPublic Verified As Boolean\r\n\tPrivate Property Password() As String\r\n\t\tGet\r\n\t\t\tReturn m_Password\r\n\t\tEnd Get\r\n\t\tSet\r\n\t\t\tm_Password = Value\r\n\t\tEnd Set\r\n\tEnd Property\r\n\tPrivate m_Password As String\r\n\r\n\tPublic Sub New()\r\n\t\tOrders = New List(Of Order)()\r\n\tEnd Sub\r\nEnd Class\r\n<\/pre>\n","protected":false},"excerpt":{"rendered":"
Newest version of Mail.dll email library for .NET includes easy to use template engine. It allows you to easily create html template for your emails: Loading and rendering such template requires one line of code: \/\/ C# version Contact templateData = …; string html = Template .FromFile("template.txt") .DataFrom(templateData ) .Render(); ‘ VB.NET version Dim templateData […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[4],"tags":[33,50,57],"class_list":["post-520","post","type-post","status-publish","format-standard","hentry","category-mail-dll","tag-email-component","tag-smtp","tag-vb-net"],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/www.limilabs.com\/blog\/wp-json\/wp\/v2\/posts\/520"}],"collection":[{"href":"https:\/\/www.limilabs.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.limilabs.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.limilabs.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.limilabs.com\/blog\/wp-json\/wp\/v2\/comments?post=520"}],"version-history":[{"count":6,"href":"https:\/\/www.limilabs.com\/blog\/wp-json\/wp\/v2\/posts\/520\/revisions"}],"predecessor-version":[{"id":5479,"href":"https:\/\/www.limilabs.com\/blog\/wp-json\/wp\/v2\/posts\/520\/revisions\/5479"}],"wp:attachment":[{"href":"https:\/\/www.limilabs.com\/blog\/wp-json\/wp\/v2\/media?parent=520"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.limilabs.com\/blog\/wp-json\/wp\/v2\/categories?post=520"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.limilabs.com\/blog\/wp-json\/wp\/v2\/tags?post=520"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}