Razorエンジン https://github.com/Antaris/RazorEngine を使用して、メールテンプレートの本文を解析しています。レイアウトを定義して他の.cshtmlファイルを含めることはできますか?たとえば、一般的なヘッダーとフッターです。
次の2つの投稿を利用して、一般的なテンプレートとレイアウトを機能させました。
これは私の解決策です:
ソリューション1:Layout
_Layoutを設定して使用
@{
_Layout = "Layout.cshtml";
ViewBag.Title = Model.Title;
}
フッター
@section Footer
{
@RenderPart("Footer.cshtml")
}
Layout.cshtml
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html>
<head>
</head>
<body>
<div id="content">
@RenderBody()
</div>
@if (IsSectionDefined("Footer"))
{
<div id="footer">
@RenderSection("Footer")
</div>
}
</body>
</html>
TemplateBaseExtensions
RenderBaseメソッドを使用してTemplateBaseを拡張する
public abstract class TemplateBaseExtensions<T> : TemplateBase<T>
{
public string RenderPart(string templateName, object model = null)
{
string path = Path.Combine(AppDomain.CurrentDomain.SetupInformation.ApplicationBase, "Templates", templateName);
return Razor.Parse(File.ReadAllText(path), model);
}
}
Razor Config
BaseTemplateTypeをTemplateBaseExtensionsクラスに設定します
TemplateServiceConfiguration templateConfig = new TemplateServiceConfiguration
{
BaseTemplateType = typeof(TemplateBaseExtensions<>)
};
Razor.SetTemplateService(new TemplateService(templateConfig));
Editソリューション2:
TemplateResolverを使用している場合。 RenderPartは必要ありません。代わりに@Includeを使用してください
フッター
@section Footer
{
@Include("Footer.cshtml")
}
リゾルバー
public class TemplateResolver : ITemplateResolver
{
public string Resolve(string name)
{
if (name == null)
{
throw new ArgumentNullException("name");
}
string path = Path.Combine(AppDomain.CurrentDomain.SetupInformation.ApplicationBase, "Templates", name);
return File.ReadAllText(path, System.Text.Encoding.Default);
}
}
Config
TemplateServiceConfiguration templateConfig = new TemplateServiceConfiguration
{
Resolver = new TemplateResolver()
};
Razor.SetTemplateService(new TemplateService(templateConfig));
マフィンマンによる更新テンプレートを指定して文字列をレンダリングします
var templateResolver = Razor.Resolve("Registration.cshtml");
return templateResolver.Run(new ExecuteContext());
また、私はこのリンクの他の人と一緒に https://github.com/Antaris/RazorEngine/issues/61 は_Layout
の使用に問題がありましたが、Layout
は機能しました。
'_Layout'は古い構文です。今後のリリースで「レイアウト」に更新されました。
RazorEngineでレイアウトを実装する最も簡単な方法は、レイアウトの@RenderBody()でテンプレートが返すものを置き換えることです。
var finalHtml = layout.Replace(@"@RenderBody()", templateHtml);
例:
あなたの_ Layout.cshtmlと典型的な@RenderBody()
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html>
<head>
</head>
<body>
<div>
@RenderBody()
</div>
</body>
</html>
あなたのRazorEngineテンプレートMyTemplate.cshtml
@using RazorEngine.Templating
@inherits TemplateBase<myviewmodel>
<h1>Hello People</h1>
<p>@Model</p>
そして、RazorEngineテンプレートを呼び出す場所:
var TemplateFolderPath = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "EmailTemplates");
var template = File.ReadAllText(Path.Combine(TemplateFolderPath,"MyTemplate.cshtml"));
var layout = File.ReadAllText(Path.Combine(TemplateFolderPath, "_Layout.cshtml"));
var templateService = new TemplateService();
var templateHtml = templateService.Parse(template, myModel, null, null);
var finalHtml = layout.Replace(@"@RenderBody()", templateHtml);
Razorを使用すると、多くのことが簡単に行えます。ただし、この特定のプロジェクトは、Razorエンジンに関する多くの作業を抽象化しているようです(これは良い点と悪い点の両方です)。あなたの状況では、独自のRazorソリューションを実装する方がはるかに良いように思われ(実際にはそれほど悪くはありません)、テンプレートで例外をスローしたり、他のコンテンツを簡単に取り込んだりできます。
例えば;独自のソリューションをローリングすると、かみそりテンプレートの基本クラスを作成できます。これにより、他のテンプレートを呼び出すことで「部分ビュー」を取り込む機能を公開できます。さらに、特定のプロパティがnullの場合、モデルチェックを実行して例外をスローできます。
メール機能を実装する完全カスタムソリューション。
RazorEngineのnugetパケットを追加
Create _Layout Template(.cshtml):
<html>
<body style="margin: 0; padding: 0;">
<div style="width:100%; display:block; float:left; height:100%;">
<table cellpadding="0" cellspacing="0" border="0" align="center" width="100%">
<tr>
<td width="37" style="background-color: #ffffff;"></td>
<td width="200" style="background-color: #ffffff">
<a href="@Url("")">Send Mail Logo</a>
</td>
<td style="background-color: #ffffff;">
</td>
<td width="126" style="background-color: #ffffff;">
<img src="@Url("Images/mail/social-media.png")" alt="" width="126" height="73" border="0" usemap="#Map" />
</td>
</tr>
</table>
<table cellpadding="0" cellspacing="0" border="0" align="center" width="100%">
<tr height="7">
<td style="background-color: #ffffff;" colspan="3"></td>
</tr>
<tr height="54">
<td colspan="3"></td>
</tr>
<tr>
<td width="37"> </td>
<td style="font-family: Myriad, 'Helvetica Neue',Arial,Helvetica,sans-serif; font-size: 11pt; color: #6b6c6f; line-height: 24px;">
{{BODY}}
</td>
<td width="37"> </td>
</tr>
<tr height="55">
<td style="line-height: 0;" colspan="3"> </td>
</tr>
<tr height="11">
<td background="@Url("/Images/mail/dotted-line.png")" colspan="3" style="line-height: 0;"> </td>
</tr>
</table>
</div>
<map name="Map" id="Map">
<area shape="rect" coords="28,29,51,51" href="#" alt="Twitter" />
<area shape="rect" coords="56,28,78,52" href="#" alt="Google+" />
<area shape="rect" coords="84,28,104,51" href="#" alt="LinkedIn" />
</map>
</body>
</html>
ConfirmEmailテンプレートを作成(.cshtml):
@using yourProjectnamespace.LanguageResources.Mail
@model ConfirmEmail
@MailTemplateResource.YouHaveLoggedIn
<a href="@Url(string.Format("/User/Confirmemail?EmailId={0}", Model.UserId))">@MailTemplateResource.ClickHere</a>
CustomTemplateBaseクラスを作成します:
public class CustomTemplateBase<T> : TemplateBase<T>
{
public string Url(string url)
{
return MailConfiguration.BaseUrl + url.TrimStart('/');
}
}
Create EmbeddedTemplateManager class:
内部クラスEmbeddedTemplateManager:ITemplateManager {読み取り専用のプライベート文字列ns;
public EmbeddedTemplateManager(string @namespace)
{
ns = @namespace;
}
public ITemplateSource Resolve(ITemplateKey key)
{
var resourceName = $"{ns}.{key.Name}.cshtml";
string content;
using (var stream = Assembly.GetExecutingAssembly().GetManifestResourceStream(resourceName))
using (var streamReader = new StreamReader(stream))
{
content = streamReader.ReadToEnd();
}
return new LoadedTemplateSource(content);
}
public ITemplateKey GetKey(string name, ResolveType resolveType, ITemplateKey context)
{
return new NameOnlyTemplateKey(name, resolveType, context);
}
public void AddDynamic(ITemplateKey key, ITemplateSource source)
{
throw new NotImplementedException("");
}
}
メールクラスの作成:
public class Mail
{
private static readonly IRazorEngineService RazorEngine;
static Mail()
{
var config = new TemplateServiceConfiguration
{
BaseTemplateType = typeof(CustomTemplateBase<>),
TemplateManager = new EmbeddedTemplateManager(typeof(Mail).Namespace + ".Templates"),
Namespaces = { "Add CurrentProjectName", "Add CurrentProjectName .Models" },
CachingProvider = new DefaultCachingProvider()
};
RazorEngine = RazorEngineService.Create(config);
}
public Mail(string templateName)
{
TemplateName = templateName;
ViewBag = new DynamicViewBag();
}
public string TemplateName { get; set; }
public object Model { get; set; }
public DynamicViewBag ViewBag { get; set; }
public string GenerateBody()
{
var layout = RazorEngine.RunCompile("_Layout", model: null);
var body = RazorEngine.RunCompile(TemplateName, Model.GetType(), Model);
return layout.Replace("{{BODY}}", body);
}
public MailMessage Send(Guid key, string to, string subject, string cc = null)
{
var email = new MailMessage()
{
From = MailConfiguration.From,
Body = GenerateBody(),
IsBodyHtml = true,
Subject = subject,
BodyEncoding = Encoding.UTF8
};
email.Headers.Add("X-MC-Metadata", "{ \"key\": \"" + key.ToString("N") + "\" }");
foreach (var sendTo in to.Split(' ', ',', ';'))
{
email.To.Add(sendTo);
}
if (cc != null)
{
foreach (var sendCC in cc.Split(' ', ',', ';'))
{
email.CC.Add(sendCC);
}
}
var smtp = new MailClient().SmtpClient;
smtp.EnableSsl = true;
smtp.Send(email);
return email;
}
}
public class Mail<TModel> : Mail where TModel : class
{
public Mail(string templateName, TModel mailModel) : base(templateName)
{
Model = mailModel;
}
}
Create MailClient Class:
public class MailClient
{
public MailClient()
{
SmtpClient = new SmtpClient(MailConfiguration.Host)
{
Port = MailConfiguration.Port,
Credentials = new NetworkCredential
{
UserName = MailConfiguration.UserName,
Password = MailConfiguration.Password
}
};
}
public SmtpClient SmtpClient { get; }
}
Create MailConfiguration Class:
public class MailConfiguration
{
private static string GetAppSetting(string key)
{
var element = ConfigurationManager.AppSettings["Mail:" + key];
return element ?? string.Empty;
}
public static string BaseUrl => GetAppSetting("BaseUrl");
public static string Host => GetAppSetting("Host");
public static int Port => Int32.Parse(GetAppSetting("Port"));
public static string UserName => GetAppSetting("Username");
public static string Password => GetAppSetting("Password");
public static MailAddress From => new MailAddress(GetAppSetting("From"));
}
MailSender Class:
MailSerderクラスにメソッドを実装し、リポジトリまたはコントローラーでMailSerderメソッドを呼び出します。
Create public class MailSender : IMailSender
{
public MailSender()
{
}
public void SendConfirmEmail(string emailId, Guid userId)
{
var confirmEmail = new ConfirmEmail
{
UserId = userId
};
ConfirmEmail(emailId, MailResource.YourRegistration, confirmEmail);
}
private void ConfirmEmail(string recipient,string subject,ConfirmEmail model)
{
var key = Guid.NewGuid();
var mail = new Mail<ConfirmEmail>("ConfirmEmail", model);
mail.ViewBag.AddValue("Recipient", recipient);
var sentMail = mail.Send(key, recipient, subject);
}
}