MailMessageEventArgs Class

.NET Framework (current version)

Provides data for e-mail–related events.

Namespace: System.Web.UI.WebControls
Assembly: System.Web (in System.Web.dll)

Inheritance Hierarchy

System::Object
System::EventArgs
System.Web.UI.WebControls::LoginCancelEventArgs
System.Web.UI.WebControls::MailMessageEventArgs

Syntax

C++

public ref class MailMessageEventArgs : LoginCancelEventArgs

Constructors

	Name	Description
	MailMessageEventArgs(MailMessage^)	Creates a new instance of the MailMessageEventArgs class.

Properties

	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.

Methods

	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 the default hash function. (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.

Examples

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.

C++

No code example is currently available or this language may not be supported.

Version Information

.NET Framework
Available since 2.0

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.