ChangePassword.OnSendMailError(SendMailErrorEventArgs) Method

Reference

Definition

Namespace:: System.Web.UI.WebControls

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Raises the SendMailError event when an email message cannot be sent to the user.

protected:
 virtual void OnSendMailError(System::Web::UI::WebControls::SendMailErrorEventArgs ^ e);

protected virtual void OnSendMailError (System.Web.UI.WebControls.SendMailErrorEventArgs e);

abstract member OnSendMailError : System.Web.UI.WebControls.SendMailErrorEventArgs -> unit
override this.OnSendMailError : System.Web.UI.WebControls.SendMailErrorEventArgs -> unit

Protected Overridable Sub OnSendMailError (e As SendMailErrorEventArgs)

Parameters

e: SendMailErrorEventArgs

A SendMailErrorEventArgs object containing the event data.

Remarks

The OnSendMailError method is called when the SMTP mail system raises an exception while attempting to send an email message after a user has changed a password.

Examine the Exception property of the SendMailErrorEventArgs object passed as the e parameter to determine the actual cause of the exception. The most common reason is a configuration error in the smtp section of the Web.config file.

You must set the Handled property of the object passed as the e parameter to true to signal that the exception has been taken care of; otherwise, the exception is thrown again.

Raising an event invokes the event handler through a delegate. For more information, see Server Event Handling in ASP.NET Web Forms Pages.

The OnSendMailError 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 the OnSendMailError(SendMailErrorEventArgs) method in a derived class, be sure to call the OnSendMailError(SendMailErrorEventArgs) method for the base class so that registered delegates receive the event.

Applies to

Dela via