Why does the MailDefinition class require a System.Web.UI.Control?

Question

When creating a MailMessage object by calling the "CreateMailMessage" method on the MailDefinition class, the third parameter is an object of type System.Web.UI.Control.

MailDefinition mail = new MailDefinition();

ListDictionary replacements = new ListDictionary();
replacements.Add("<%myname%>", "John");

mail.BodyFileName = "~/App_Data/Emails/SomeEmail.txt";
mail.From = "me@example.com";
mail.Subject = "Hello";

MailMessage message = mail.CreateMailMessage("example@example.com,", replacements, );

Why is that?
And in the case that I don't have an object of that type, what should I pass instead? Just a new Control object?

Control control = new Control();

UPDATE

I would highly recommend using Razor to build email templates. It has great syntax, works great, and doesn't have any weird dependencies!

Why aren't you using MailMessage message = new MailMessage()? — Alexander Kahoun, Apr 13 '09 at 14:53

score 5 · Accepted Answer · answered Apr 13 '09 at 14:51

5

Usually you just pass this as the control.

MailMessage message = mail.CreateMailMessage("example@example.com,", replacements, this);

As for the reason why, here is what MSDN says:

The owner parameter indicates which control is the parent of the MailDefinition control. It determines which directory to search for the text file specified in the BodyFileName property.

answered Apr 13 '09 at 14:51

Andrew Hare

344,730
71
640
635

1

And what if I'm not running this from an ASPX page, but from an APP_CODE class? – John B Apr 13 '09 at 14:56
Then you need to pass in a reference to the current control into the code that is creating the mail message. – Andrew Hare Apr 13 '09 at 15:00

score 3 · Answer 2 · answered Jan 26 '12 at 11:19

3

The CreateMailMessage function internally uses the specified Control to query its AppRelativeTemplateSourceDirectory property and its OpenFile method to read the contents of the body (specified in the BodyFileName property of the MailDefinition).

Seems poor design and unnecessary tight coupling for me.

answered Jan 26 '12 at 11:19

György Balássy

2,938
1
28
23

2

Indeed! But with the advent of the Razor templating engine, it doesn't really matter anymore :P http://razorengine.codeplex.com/ in case you've been living under a rock :) – John B Jan 26 '12 at 18:26
@JohnBubriski Can I use ***RazorEngine*** in _ASP.NET_ **WebForms** application ? – Kiquenet Oct 07 '15 at 07:47

score 2 · Answer 3 · answered Feb 26 '15 at 20:59

2

You can also just do this:

MailMessage message = this.Mail.CreateMailMessage("no-reply@example.com", dictionary, new System.Web.UI.Control());

answered Feb 26 '15 at 20:59

Gašper Sladič

867
2
15
32

score 1 · Answer 4 · answered Jul 28 '10 at 00:25

1

I have been using new LiteralControl() for the 3rd parameter because my messages are being sent from a Workflow. It works. But I do not have an answer for "Why".

answered Jul 28 '10 at 00:25

Scott Rippey

15,614
5
70
85

score 0 · Answer 5 · answered Apr 13 '09 at 15:01

0

It sounds like you may not need to use the MailDefinition class at all if you're not binding to any controls. To simply send an email over smtp, you should use a System.Net.Mail.SmtpClient with a System.Net.Mail.MailMessage.

answered Apr 13 '09 at 15:01

Todd

620
4
13

8

Basically, I'm using the MailDefinition class for its replacement abilities. – John B Apr 13 '09 at 15:08
Razor engine IMO is the new best practice way. – The Muffin Man Feb 23 '14 at 04:12

Why does the MailDefinition class require a System.Web.UI.Control?

5 Answers5