This documentation is archived and is not being maintained.

Membership.FindUsersByEmail Method (String)

Gets a collection of membership users where the e-mail address contains the specified e-mail address to match.

Namespace:  System.Web.Security
Assembly:  System.Web (in System.Web.dll)

'Declaration
Public Shared Function FindUsersByEmail ( _
	emailToMatch As String _
) As MembershipUserCollection
'Usage
Dim emailToMatch As String 
Dim returnValue As MembershipUserCollection 

returnValue = Membership.FindUsersByEmail(emailToMatch)

Parameters

emailToMatch
Type: System.String

The e-mail address to search for.

Return Value

Type: System.Web.Security.MembershipUserCollection
A MembershipUserCollection that contains all users that match the emailToMatch parameter.
Leading and trailing spaces are trimmed from the emailToMatch parameter value.

FindUsersByEmail returns a list of membership users where the e-mail address matches the supplied emailToMatch for the configured applicationName.

The SqlMembershipProvider performs its search using a LIKE clause against the emailToMatch parameter. Any wildcards that are supported by SQL Server in LIKE clauses can be used in the emailToMatch parameter value.

The following code example uses the FindUsersByEmail method to retrieve membership user information from the membership database based on user input and displays the results in pages of data.

Security noteSecurity Note:

This example contains a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see Script Exploits Overview.

<%@ Page Language="VB" %>
<%@ Import Namespace="System.Web.Security" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

Public Sub GoButton_OnClick(sender As Object, args As EventArgs)
  UserGrid.DataSource = Membership.FindUsersByEmail(EmailTextBox.Text)
  UserGrid.DataBind()
End Sub

</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
<title>Sample: Find Users by Email</title>
</head>
<body>

<form id="form1" runat="server">
  <h3>User List</h3>

  E-mail address to Search for: 
    <asp:TextBox id="EmailTextBox" runat="server" />
    <asp:Button id="GoButton" Text=" Go " OnClick="GoButton_OnClick" runat="server" /><br />

  <asp:DataGrid id="UserGrid" runat="server"
                CellPadding="2" CellSpacing="1"
                Gridlines="Both">
    <HeaderStyle BackColor="darkblue" ForeColor="white" />
  </asp:DataGrid>

</form>

</body>
</html>

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.

.NET Framework

Supported in: 3.5, 3.0, 2.0
Show: