MailMessageEventArgs Class
Provides data for e-mail–related events.
System.EventArgs
System.Web.UI.WebControls.LoginCancelEventArgs
System.Web.UI.WebControls.MailMessageEventArgs
Assembly: System.Web (in System.Web.dll)
The MailMessageEventArgs type exposes the following members.
| Name | Description | |
|---|---|---|
|
Cancel | Gets or sets a value indicating whether the event should be canceled. (Inherited from LoginCancelEventArgs.) |
|
|
Message | Gets the e-mail message contents. |
| Name | Description | |
|---|---|---|
|
Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
|
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
|
|
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
|
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
The MailMessageEventArgs class provides access to the MailMessage object that contains the e-mail message. Because the MailMessageEventArgs class is derived from the LoginCancelEventArgs class, you can cancel sending an e-mail message in your event handler by setting the Cancel property to true.
The following code example demonstrates how to use the MailMessageEventArgs class in an e-mail message event handler to change the contents of the message before it is sent.
<%@ page language="C#" %> <%@ Import namespace="Samples.AspNet.CS.Controls" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <script runat="server"> void Page_Init(object sender, EventArgs e) { PasswordRecoveryOnBeforeSendingEmail passwordRecoveryControl = new PasswordRecoveryOnBeforeSendingEmail(); passwordRecoveryControl.ID = "passwordRecoveryControl"; passwordRecoveryControl.MailDefinition.From = "userAdmin@your.site.name.here"; PlaceHolder1.Controls.Add(passwordRecoveryControl); } </script> <html xmlns="http://www.w3.org/1999/xhtml" > <head runat="server"> <title>ASP.NET Example</title> </head> <body> <form id="form1" runat="server"> <asp:placeholder id="PlaceHolder1" runat="server"></asp:placeholder> </form> </body> </html>
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
