CreateUserWizard.OnSendMailError Method (SendMailErrorEventArgs)
Raises the SendMailError event when e-mail cannot be sent to the new user.
Assembly: System.Web (in System.Web.dll)
abstract OnSendMailError : e:SendMailErrorEventArgs -> unit override OnSendMailError : e:SendMailErrorEventArgs -> unit
Parameters
- e
-
Type:
System.Web.UI.WebControls.SendMailErrorEventArgs
A SendMailErrorEventArgs containing the event data.
The OnSendMailError method is called when the SMTP mail system raises an exception while attempting to send e-mail to the new user.
Examine the Exception property of the SendMailErrorEventArgs object passed as the e parameter to determine the actual cause of the exception. The most common problem is a configuration error in the <smtpMail> section of the Web.config file.
You must set the Handled property of the SendMailErrorEventArgs object passed as the e parameter to signal that the exception that caused the OnSendMailError method to be called has been taken care of, otherwise the exception is re-thrown.
Raising an event invokes the event handler through a delegate. For more information, see Handling and Raising Events.
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 OnSendMailError in a derived class, be sure to call the base class’s OnSendMailError method so that registered delegates receive the event.
The following code example defines a custom CreateUserWizard object that logs e-mail errors to a site-specific logging function.
The following code example demonstrates a Web page that uses the CustomCreateUserWizard.
Available since 2.0