PasswordRecovery.MailDefinition Property (System.Web.UI.WebControls)

Switch View

MailDefinition Property

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

PasswordRecovery..::.MailDefinition Property

Gets a reference to a collection of properties that define the characteristics of e-mail messages used to send new or recovered passwords to users.

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

Syntax

Visual Basic (Declaration)

<PersistenceModeAttribute(PersistenceMode.InnerProperty)> _
<ThemeableAttribute(False)> _
Public ReadOnly Property MailDefinition As MailDefinition

Visual Basic (Usage)

Dim instance As PasswordRecovery
Dim value As MailDefinition

value = instance.MailDefinition

[PersistenceModeAttribute(PersistenceMode.InnerProperty)]
[ThemeableAttribute(false)]
public MailDefinition MailDefinition { get; }

Visual C++

[PersistenceModeAttribute(PersistenceMode::InnerProperty)]
[ThemeableAttribute(false)]
public:
property MailDefinition^ MailDefinition {
    MailDefinition^ get ();
}

JScript

public function get MailDefinition () : MailDefinition

Property Value

Type: System.Web.UI.WebControls..::.MailDefinition
A reference to a MailDefinition that contains properties that define the characteristics of e-mail messages used to send users their passwords.

Remarks

The MailDefinition property returns a reference to a group of properties that you use to define format and content of the password e-mail message sent to users. Common settings include the subject line and the sender's return address. For a complete list of properties, see the MailDefinition class.

This property is read-only; however, you can set the properties of the MailDefinition object it returns. You can set these properties declaratively in the form Property-Subproperty, where Subproperty represents a property of the MailDefinition class (for example, MailDefinition-Subject). You can also set the properties programmatically in the form Property.Subproperty (for example, MailDefinition.Subject).

This property cannot be set by themes or style sheet themes. For more information, see ThemeableAttribute and ASP.NET Themes and Skins Overview.

When the e-mail message is created from the MailDefinition object, it will make the substitutions shown in the following table. The substitution text is case-insensitive.

Substitution text	Replaced with
<% UserName %>	The Web site user name of the user.
<% Password %>	The recovered password for the user.

If the IsBodyHtml property of the MailDefinition object is true, the contents of the mail message will be HTML encoded to guard against cross-site scripting security vulnerabilities for the message recipient.

Examples

The following code example uses the SendingMail event to define the password e-mail message by setting subproperties of the MailDefinition property.

Visual Basic

<%@ page language="VB" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

  Sub PasswordRecovery1_SendingMail(ByVal sender As Object, ByVal e As System.Web.UI.WebControls.MailMessageEventArgs)

    e.Message.IsBodyHtml = False
    e.Message.Subject = "New password on Web site."

  End Sub

</script>

<html  >
  <head runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
    <form id="form1" runat="server">
      <asp:passwordrecovery
         id="PasswordRecovery1" 
         runat="server" 
         maildefinition-from="userAdmin@your.site.name.here"
         onsendingmail="PasswordRecovery1_SendingMail">
      </asp:passwordrecovery>
    </form>
  </body>
</html>

<%@ page language="C#" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

  void PasswordRecovery1_SendingMail(object sender, MailMessageEventArgs e)
  {
    e.Message.IsBodyHtml = false;
    e.Message.Subject = "New password on Web site.";
  }

</script>

<html  >
  <head runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
    <form id="form1" runat="server">
      <asp:passwordrecovery 
         id="PasswordRecovery1" 
         runat="server"
         maildefinition-from="userAdmin@your.site.name.here"
         onsendingmail="PasswordRecovery1_SendingMail">
      </asp:passwordrecovery>
    </form>
  </body>
</html>

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0

Reference

PasswordRecovery Class

PasswordRecovery Members

System.Web.UI.WebControls Namespace

MailDefinition

Other Resources

ASP.NET Login Controls Overview