Use Razor for Email Template outside ASP.NET MVC

原文发布时间为：2011-09-15 —— 来源于本人的百度文章 [由搬家工具导入]

http://kazimanzurrashid.com/posts/use-razor-for-email-template-outside-asp-dot-net-mvc

So the ASP.NET MVC 3 RTM is out and the real icon of this release is the Razor View Engine. The best thing of Razor is that unlike its predecessor(webforms) it is not tied with the web environment, we can easily host it outside the web and use it as template engine for various purpose. The project that I am currently working on needs to send bulk emails at various point of the application, since the numbers can be hundreds or literary thousands I want to host it outside the web application so that it does add unnecessary overheads to the web application. In this post, I will show you you the code that I am using to generate these mails, you can download the complete code with MSpec specs from the bottom of the post.

Lets say, in your application you want to send a welcome mail to user, whenever s/he registers. To send the mail you can use the following code:

123456789101112131415publicvirtualvoidSendWelcomeMail(stringname, stringpassword, stringemail){ varmodel = new { From = Configuration.FromAddress, To = email, Name = name, Password = password, LogOnUrl = Configuration.LogOnUrl() }; varmail = TemplateEngine.Execute(Configuration.SendWelcomeMailTemplateName, model); Sender.Send(mail);}

And here is the template that it will use to generate the actual mail content:

123456789101112131415161718@{ From = Model.From; To.Add(Model.To); Subject = "Welcome to my mysite.com";}<html><head> <title>Welcome to mysite.com</title></head><body> Dear @Model.Name, An account has been created for you. Your account is FREE and allows you to perform bla bla features. To login and complete your profile, please go to: <ahref="@Model.LogOnUrl">@Model.LogOnUrl</a> Your User ID is your email address and password is: @Model.Password</body></html>

The code is very simple, first we are creating an anonymous object as model, you can also use strongly typed as well as the new dynamic object, next we are using the template engine to generate the output and at last the mail object is passed to the mail sender for dispatching it. In the template the model is that we passed from the method is exposed as the dynamic object. Behind the scene the template uses a base class which has some of the common properties that we often use for setting the mail:

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556publicabstractclassEmailTemplate : IEmailTemplate{ privatereadonlyStringBuilderbuffer; [DebuggerStepThrough] protectedEmailTemplate() { To = newList<string>(); ReplyTo = newList<string>(); CC = newList<string>(); Bcc = newList<string>(); Headers = newDictionary<string, string>(StringComparer.OrdinalIgnoreCase); buffer = newStringBuilder(); } publicstringFrom { get; set; } publicstringSender { get; set; } publicICollection<string> To { get; privateset; } publicICollection<string> ReplyTo { get; privateset; } publicICollection<string> CC { get; privateset; } publicICollection<string> Bcc { get; privateset; } publicIDictionary<string, string> Headers { get; privateset; } publicstringSubject { get; set; } publicstringBody { get{ returnbuffer.ToString(); } } protecteddynamic Model { get; privateset; } publicvoidSetModel(dynamic model) { Model = model; } publicabstractvoidExecute(); publicvirtualvoidWrite(objectvalue) { WriteLiteral(value); } publicvirtualvoidWriteLiteral(objectvalue) { buffer.Append(value); }}

It is also possible to compose a mail which contains both text and html format, so that the mail client which supports html should use the html version and the unsupported client could use the plain version. To compose a multi formatted mail you will have to use three templates the shared template will contain the common properties like From/To/Subject etc. and the other two will contain the actually body. For example, to use the above mail in multi format we will create the following templates:

Shared Template12345@{ From = Model.From; To.Add(Model.To); Subject = "Welcome to mysite.com";}Html Template12345678910111213<html><head> <title>Welcome to mysite.com</title></head><body> Dear @Model.Name, An account has been created for you. Your account is FREE and allows you to perform bla bla features. To login and complete your profile, please go to: <ahref="@Model.LogOnUrl">@Model.LogOnUrl</a> Your User ID is your email address and password is: @Model.Password</body></html>Text Template1234567891011Dear @Model.Name, An account has been created for you. Your account is FREE and allows you to perform bla bla features. To login and complete your profile, please go to: @Model.LogOnUrl Your User ID is your email address and password is: @Model.Password

Now, when the mail is sent it should look like the following:

123456789101112131415161718192021222324252627282930313233343536X-Sender: me@myself.comX-Receiver: jon@smith.comMIME-Version: 1.0From: me@myself.comTo: jon@smith.comDate: 15 Jan 2011 12:42:41 +0600Subject: Welcome to mysite.comContent-Type: multipart/alternative; boundary=--boundary_0_9202367d-977d-49b5-ab86-2bb3ed1bfc76 ----boundary_0_9202367d-977d-49b5-ab86-2bb3ed1bfc76Content-Type: text/htmlContent-Transfer-Encoding: base64 PGh0bWw+DQo8aGVhZD4NCiAgICA8dGl0bGU+V2VsY29tZSB0byBteXNpdGUuY29tPC90aXRsZT4NCjwvaGVhZD4NCjxib2R5Pg0KICAgIDxwPkRlYXIgSm9uIFNtaXRoLDwvcD4NCiAgICA8cD5BbiBhY2NvdW50IGhhcyBiZWVuIGNyZWF0ZWQgZm9yIHlvdS48L3A+DQogICAgPHA+WW91ciBhY2NvdW50IGlzIEZSRUUgYW5kIGFsbG93cyB5b3UgdG8gcGVyZm9ybSBibGEgYmxhIGZlYXR1cmVzLjwvcD4NCiAgICA8cD5UbyBsb2dpbiBhbmQgY29tcGxldGUgeW91ciBwcm9maWxlLCBwbGVhc2UgZ28gdG86PC9wPg0KICAgIDxwPjxhIGhyZWY9Imh0dHA6Ly9teWNvbXBhbnkuY29tL2xvZ29uIj5odHRwOi8vbXljb21wYW55LmNvbS9sb2dvbjwvYT48L3A+DQogICAgPHA+WW91ciBVc2VyIElEIGlzIHlvdXIgZW1haWwgYWRkcmVzcyBhbmQgcGFzc3dvcmQgaXM6IH4hQWdjMmQjNzwvcD4NCjwvYm9keT4NCjwvaHRtbD4=----boundary_0_9202367d-977d-49b5-ab86-2bb3ed1bfc76Content-Type: text/plainContent-Transfer-Encoding: base64 RGVhciBKb24gU21pdGgsDQoNCkFuIGFjY291bnQgaGFzIGJlZW4gY3JlYXRlZCBmb3IgeW91Lg0KDQpZb3VyIGFjY291bnQgaXMgRlJFRSBhbmQgYWxsb3dzIHlvdSB0byBwZXJmb3JtIGJsYSBibGEgZmVhdHVyZXMuDQoNClRvIGxvZ2luIGFuZCBjb21wbGV0ZSB5b3VyIHByb2ZpbGUsIHBsZWFzZSBnbyB0bzoNCg0KaHR0cDovL215Y29tcGFueS5jb20vbG9nb24NCg0KWW91ciBVc2VyIElEIGlzIHlvdXIgZW1haWwgYWRkcmVzcyBhbmQgcGFzc3dvcmQgaXM6IH4hQWdjMmQjNw==----boundary_0_9202367d-977d-49b5-ab86-2bb3ed1bfc76--

Currently it uses templates which are stored in the file system, but it is extensible enough to store the templates in other mediums like database. Like ASP.NET it compiles the templates to .NET types when first time it is requested, but it does not have the cache invalidation support like asp.net, may be I will add it in future.

That’s it for today.

Download:EmailTemplate.zip

巴特西

Use Razor for Email Template outside ASP.NET MVC

最新文章

热门文章