Есть ли лучший способ сгенерировать электронную почту HTML на C # (для отправки через 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>");

и так далее и тому подобное?

Вы можете использовать класс MailDefinition .

Вот как вы его используете:

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());

Кроме того, я написал сообщение в блоге о том, как сгенерировать тело сообщения электронной почты в формате HTML на C # с использованием шаблонов с использованием класса MailDefinition .

Используйте класс 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();

Обновленный ответ :

В документации для SmtpClientкласса, использованного в этом ответе, теперь говорится: «Устаревший» («SmtpClient и его сеть типов плохо спроектированы, мы настоятельно рекомендуем вам использовать https://github.com/jstedfast/MailKit и https: // github .com / jstedfast / MimeKit вместо ")".

Источник: https://www.infoq.com/news/2017/04/MailKit-MimeKit-Official

Оригинальный ответ :

Использование класса MailDefinition - неправильный подход. Да, это удобно, но это также примитивно и зависит от элементов управления веб-интерфейсом - это не имеет смысла для того, что обычно является задачей на стороне сервера.

Представленный ниже подход основан на документации MSDN и публикации Куреши на 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();
}

Я использую 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));

Он также работает с коллекциями, см. Некоторые онлайн-примеры .

Я бы рекомендовал использовать какие-то шаблоны. Есть несколько разных способов подойти к этому, но по сути держать шаблон электронного письма где-нибудь (на диске, в базе данных и т. Д.) И просто вставлять ключевые данные (IE: имя получателя и т. Д.) В шаблон.

Это гораздо более гибкий подход, поскольку он означает, что вы можете изменять шаблон по мере необходимости, не изменяя код. По моему опыту, вы, вероятно, получите запросы на изменение шаблонов от конечных пользователей. Если вы хотите сделать все возможное, вы можете включить редактор шаблонов.

В качестве альтернативы MailDefinition взгляните на RazorEngine https://github.com/Antaris/RazorEngine .

Похоже, это лучшее решение.

Приписывается ...

как отправить электронное письмо с шаблоном электронной почты С #

Например

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>

Направление сюда

Дорогой Фред,

Первая часть тела письма идет сюда

Создание подобного HTML вручную, вероятно, лучший способ, если разметка не слишком сложна. Конструктор строк начинает окупаться с точки зрения эффективности только после трех конкатенаций, так что для действительно простых вещей подойдет строка + строка.

Помимо этого, вы можете начать использовать элементы управления html (System.Web.UI.HtmlControls) и отображать их, таким образом вы можете иногда наследовать их и создавать свои собственные классы для сложной условной компоновки.

Возможно, вы захотите взглянуть на некоторые из доступных на данный момент фреймворков шаблонов. Некоторые из них являются побочными продуктами в результате MVC, но это не обязательно. Спарк хороший.

Если вам не нужна зависимость от полной .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 из приложения.

Коммерческая версия, которую я использую в производстве и которая упрощает обслуживание, - это движок шаблонов LimiLabs , использующий его более 3 лет и позволяющий мне вносить изменения в текстовый шаблон без необходимости обновлять код (заявления об отказе, ссылки и т. Д.) - это может быть так просто, как

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

Стоит взглянуть, как и я; после попытки различных ответов, упомянутых здесь.