CreateUserWizard.OnSendingMail Method (MailMessageEventArgs)
Raises the SendingMail event before an e-mail message is sent to a new user.
Assembly: System.Web (in System.Web.dll)
Parameters
- e
-
Type:
System.Web.UI.WebControls.MailMessageEventArgs
A MailMessageEventArgs containing the event data.
Use the OnSendingMail method to modify the e-mail message sent to new users. The Message property of the MailMessageEventArgs object passed as the e parameter contains the MailMessage object that will be sent to the new user. Modify the properties of the MailMessage object to modify the e-mail message.
E-mail messages are only created when the BodyFileName property of the MailDefinition object specified by the MailDefinition property points to a valid file name.
Raising an event invokes the event handler through a delegate. For more information, see Handling and Raising Events.
The OnSendingMail method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.
Notes to Inheritors:
When overriding OnSendingMail in a derived class, be sure to call the base class’s OnSendingMail method so that registered delegates receive the event.
The following code example defines a custom CreateUserWizard control that uses the OnSendingMail method to modify the text of the e-mail sent to new users. This example requires a text file named MailFile.txt that contains the following text.
Your account was set up on our Web site with the following: Username: <%UserName%> To reset your password, you must answer the following question: Password Question: <%PasswordQuestion%> Password Answer: <%PasswordAnswer%> Thank you for creating an account with our Web site.
<%@ Page Language="VB"%> <%@ Import namespace="Samples.AspNet.VB.Controls" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <script runat="server"> Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs) Dim createUser As New CustomCreateUserWizard Placeholder1.Controls.Add(createUser) End Sub </script> <html xmlns="http://www.w3.org/1999/xhtml" > <head runat="server"> <title>CreateUserWizard.OnSendingMail sample</title> </head> <body> <form id="form1" runat="server"> <div> <asp:placeholder id="Placeholder1" runat="server" > </asp:placeholder> </div> </form> </body> </html>
Available since 2.0