从 C# Web 应用程序发送电子邮件的最佳架构方式是什么？

Question

我正在开发一个即将上线的 Web 应用程序，我现在正试图找出处理从该应用程序发送电子邮件的最佳方法。我完全了解如何使用 MailMessage 和 SmtpClient 类从应用程序发送电子邮件，但是我的问题来自不同的角度。在这个项目之前，我工作的主要目的是支持在我之前开发的旧应用程序。在这些应用程序中，当他们需要发送电子邮件时，他们会将任何消息硬编码到实际消息中，并将所有 HTML 标记直接嵌入到 C# 代码中。

我正在开发的应用程序将有一个用于发送电子邮件的模板，作为一种样式容器，并且不同的消息将嵌入到模板的主要内容 div 中。我想避免在这个应用程序中对这些模板进行硬编码，所以我一直在尝试找出布局我的项目的最佳方式。我曾想过使用 t4 模板，并将不同的 t4 读入应用程序，并应用具有指定参数的 String.Format 以将名称/电子邮件添加到要发送的消息中。但是，我不确定这是不是最好的方法。

我的另一个想法是为每种类型的消息定义一个类，但这最终会再次硬编码消息，正如我所说的我不想这样做。

我的问题是，您过去是如何处理这个问题的？什么有效，什么无效，出于什么原因？我在网上查遍了所有内容，但要么只有关于如何发送消息的内容，要么我没有使用正确的 Google 强力词。

Answer 1

我是这样做的：

• 使用 ViewModel 和 Razor 模板以通常的方式对其进行编码
• 通过创建电子邮件，使用http://razorengine.codeplex.com/ 加载和解析模板
• 如果您想在线程中发送电子邮件，请注意不要使用 Html 和 Url 助手，因为它们依赖于您在这种情况下没有的 HttpContext。如果需要，构建您自己的助手。

例如，如果您的应用程序中有一个 ViewModel Car 显示在某处，您也可以将此 ViewModel 用作 Razor 模板中的@model 用于电子邮件。

Answer 2

我不得不这样做几次。我最初使用基于我认为 Rick Strahl 博客文章的 ASP.Net 模板引擎。它奏效了，但我总是遇到一些问题。

我转而使用NVelocity 模板引擎，发现它是一种非常简单的创建和维护电子邮件模板的方法。还有许多其他模板引擎，我怀疑下次我可能会认真看看Razorengine。

将值合并到模板中的代码：

private string Merge(ManualTypeEnum manualType, Object mergeValues)
{
    var body = "";
    var templateFile = string.Format("{0}MailTemplate.vm", manualType);
    var velocity = new VelocityEngine();
    var props = new ExtendedProperties();
    props.AddProperty("file.resource.loader.path", Config.EmailTemplatePath);
    velocity.Init(props);
    var template = velocity.GetTemplate(templateFile);
    var context = new VelocityContext();
    context.Put("Change", mergeValues);
    using (var writer = new StringWriter())
    {
        template.Merge(context, writer);
        body = writer.ToString();
    }
    return body;
}

要合并的值作为匿名对象传递，并且可以包括各种类型，包括列表等，例如

var emailBody = Merge(newDocument.ManualType, new
{
    ManualType = newDocument.ManualType.ToString(),
    Message = change.Message,
    NewTitle = newDocument.Title ?? "",
    NewVersion = newDocument.Version ?? "",
    Contact = From,
    Changes = change.ToList(),
});