在 C# 中生成 HTML 电子邮件正文

Question

在 C# 中生成 HTML 电子邮件（通过 System.Net.Mail 发送）是否有比使用 Stringbuilder 执行以下操作更好的方法：

string userName = "John Doe";
StringBuilder mailBody = new StringBuilder();
mailBody.AppendFormat("<h1>Heading Here</h1>");
mailBody.AppendFormat("Dear {0}," userName);
mailBody.AppendFormat("<br />");
mailBody.AppendFormat("<p>First part of the email body goes here</p>");

等等，等等？

Answer 1

我在生产中使用并且易于维护的商业版本是LimiLabs Template Engine，已经使用了 3 年以上，并且允许我更改文本模板而无需更新代码（免责声明、链接等）。 ) - 它可以很简单

Contact templateData = ...; 
string html = Template
     .FromFile("template.txt")
     .DataFrom(templateData )
     .Render();

值得一看，就像我一样；在尝试了这里提到的各种答案之后。

Answer 2

作为 MailDefinition 的替代方案，请查看 RazorEngine https://github.com/Antaris/RazorEngine。

这看起来是一个更好的解决方案。

归因于...

how to send email wth email template c#

例如

using RazorEngine;
using RazorEngine.Templating;
using System;

namespace RazorEngineTest
{
    class Program
    {
        static void Main(string[] args)
        {
    string template =
    @"<h1>Heading Here</h1>
Dear @Model.UserName,
<br />
<p>First part of the email body goes here</p>";

    const string templateKey = "tpl";

    // Better to compile once
    Engine.Razor.AddTemplate(templateKey, template);
    Engine.Razor.Compile(templateKey);

    // Run is quicker than compile and run
    string output = Engine.Razor.Run(
        templateKey, 
        model: new
        {
            UserName = "Fred"
        });

    Console.WriteLine(output);
        }
    }
}

哪些输出...

<h1>Heading Here</h1>
Dear Fred,
<br />
<p>First part of the email body goes here</p>

Heading Here

尊敬的 Fred，

电子邮件的第一部分 身体在这里

Answer 3

更新答案：

SmtpClient（此答案中使用的类）的文档现在显示为“已过时（“SmtpClient 及其类型网络设计不佳，我们强烈建议您改用https://github.com/jstedfast/MailKit 和https://github.com/jstedfast/MimeKit”）' .

来源：https://www.infoq.com/news/2017/04/MailKit-MimeKit-Official

原答案：

使用 MailDefinition 类是错误的方法。是的，它很方便，但它也是原始的并且依赖于 Web UI 控件——这对于通常是服务器端任务的东西没有意义。

下面介绍的方法基于 MSDN 文档和Qureshi's post on CodeProject.com。

注意：此示例从嵌入式资源中提取 HTML 文件、图像和附件，但使用其他替代方法来获取这些元素的流也可以，例如硬编码字符串、本地文件等。

Stream htmlStream = null;
Stream imageStream = null;
Stream fileStream = null;
try
{
    // Create the message.
    var from = new MailAddress(FROM_EMAIL, FROM_NAME);
    var to = new MailAddress(TO_EMAIL, TO_NAME);
    var msg = new MailMessage(from, to);
    msg.Subject = SUBJECT;
    msg.SubjectEncoding = Encoding.UTF8;
 
    // Get the HTML from an embedded resource.
    var assembly = Assembly.GetExecutingAssembly();
    htmlStream = assembly.GetManifestResourceStream(HTML_RESOURCE_PATH);
 
    // Perform replacements on the HTML file (if you're using it as a template).
    var reader = new StreamReader(htmlStream);
    var body = reader
        .ReadToEnd()
        .Replace("%TEMPLATE_TOKEN1%", TOKEN1_VALUE)
        .Replace("%TEMPLATE_TOKEN2%", TOKEN2_VALUE); // and so on...
 
    // Create an alternate view and add it to the email.
    var altView = AlternateView.CreateAlternateViewFromString(body, null, MediaTypeNames.Text.Html);
    msg.AlternateViews.Add(altView);
 
    // Get the image from an embedded resource. The <img> tag in the HTML is:
    //     <img src="pid:IMAGE.PNG">
    imageStream = assembly.GetManifestResourceStream(IMAGE_RESOURCE_PATH);
    var linkedImage = new LinkedResource(imageStream, "image/png");
    linkedImage.ContentId = "IMAGE.PNG";
    altView.LinkedResources.Add(linkedImage);
 
    // Get the attachment from an embedded resource.
    fileStream = assembly.GetManifestResourceStream(FILE_RESOURCE_PATH);
    var file = new Attachment(fileStream, MediaTypeNames.Application.Pdf);
    file.Name = "FILE.PDF";
    msg.Attachments.Add(file);
 
    // Send the email
    var client = new SmtpClient(...);
    client.Credentials = new NetworkCredential(...);
    client.Send(msg);
}
finally
{
    if (fileStream != null) fileStream.Dispose();
    if (imageStream != null) imageStream.Dispose();
    if (htmlStream != null) htmlStream.Dispose();
}

Answer 4

您可以使用MailDefinition class。

这是你使用它的方式：

MailDefinition md = new MailDefinition();
md.From = "test@domain.com";
md.IsBodyHtml = true;
md.Subject = "Test of MailDefinition";

ListDictionary replacements = new ListDictionary();
replacements.Add("{name}", "Martin");
replacements.Add("{country}", "Denmark");

string body = "<div>Hello {name} You're from {country}.</div>";

MailMessage msg = md.CreateMailMessage("you@anywhere.com", replacements, body, new System.Web.UI.Control());

另外，我写了一篇关于如何generate HTML e-mail body in C# using templates using the MailDefinition class 的博文。

Answer 5

我使用dotLiquid 来完成这项任务。

它需要一个模板，并用匿名对象的内容填充特殊标识符。

//define template
String templateSource = "<h1>{{Heading}}</h1>Dear {{UserName}},<br/><p>First part of the email body goes here");
Template bodyTemplate = Template.Parse(templateSource); // Parses and compiles the template source

//Create DTO for the renderer
var bodyDto = new {
    Heading = "Heading Here",
    UserName = userName
};
String bodyText = bodyTemplate.Render(Hash.FromAnonymousObject(bodyDto));

它也适用于集合，请参阅some online examples。

Answer 6

如果您不想依赖完整的 .NET Framework，还有一个库可以让您的代码看起来像：

string userName = "John Doe";

var mailBody = new HTML {
    new H(1) {
        "Heading Here"
    },
    new P {
        string.Format("Dear {0},", userName),
        new Br()
    },
    new P {
        "First part of the email body goes here"
    }
};

string htmlString = mailBody.Render();

它是开源的，你可以从http://sourceforge.net/projects/htmlplusplus/下载它

免责声明：我是这个库的作者，它是为解决同样的问题而编写的——从应用程序发送 HTML 电子邮件。

Answer 7

您可能想看看目前可用的一些模板框架。其中一些是 MVC 的衍生产品，但这不是必需的。 Spark 不错。

Answer 8

使用 System.Web.UI.HtmlTextWriter 类。

StringWriter writer = new StringWriter();
HtmlTextWriter html = new HtmlTextWriter(writer);

html.RenderBeginTag(HtmlTextWriterTag.H1);
html.WriteEncodedText("Heading Here");
html.RenderEndTag();
html.WriteEncodedText(String.Format("Dear {0}", userName));
html.WriteBreak();
html.RenderBeginTag(HtmlTextWriterTag.P);
html.WriteEncodedText("First part of the email body goes here");
html.RenderEndTag();
html.Flush();

string htmlString = writer.ToString();

对于包含创建样式属性的广泛 HTML，HtmlTextWriter 可能是最好的方法。然而，它使用起来可能有点笨拙，一些开发人员喜欢标记本身易于阅读，但 HtmlTextWriter 关于缩进的选择有点奇怪。

在这个例子中，你也可以非常有效地使用 XmlTextWriter：-

writer = new StringWriter();
XmlTextWriter xml = new XmlTextWriter(writer);
xml.Formatting = Formatting.Indented;
xml.WriteElementString("h1", "Heading Here");
xml.WriteString(String.Format("Dear {0}", userName));
xml.WriteStartElement("br");
xml.WriteEndElement();
xml.WriteElementString("p", "First part of the email body goes here");
xml.Flush();

Answer 9

只要标记不太复杂，像这样发出手工构建的 html 可能是最好的方法。 stringbuilder 仅在大约三个连接之后才开始在效率方面给您回报，所以对于非常简单的东西 string + string 就可以了。

除此之外，您可以开始使用 html 控件 (System.Web.UI.HtmlControls) 并渲染它们，这样您有时可以继承它们并为复杂的条件布局创建自己的类。

Answer 10

我会推荐使用某种模板。有多种不同的方法可以解决这个问题，但本质上是在某个位置（在磁盘上、在数据库中等）保存电子邮件模板，并简单地将关键数据（IE：收件人姓名等）插入到模板中。

这要灵活得多，因为这意味着您可以根据需要更改模板，而无需更改代码。根据我的经验，您可能会收到最终用户更改模板的请求。如果你想全力以赴，你可以包括一个模板编辑器。