FindUsersByEmail Method

SqlMembershipProvider.FindUsersByEmail Method

Returns a collection of membership users for which the e-mail address field contains the specified e-mail address.

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

public override MembershipUserCollection FindUsersByEmail(
	string emailToMatch,
	int pageIndex,
	int pageSize,
	out int totalRecords


Type: System.String
The e-mail address to search for.
Type: System.Int32
The index of the page of results to return. pageIndex is zero-based.
Type: System.Int32
The size of the page of results to return.
Type: System.Int32%
The total number of matched users.

Return Value

Type: System.Web.Security.MembershipUserCollection
A MembershipUserCollection that contains a page of pageSize MembershipUser objects beginning at the page specified by pageIndex.


emailToMatch is longer than 256 characters.

- or -

pageIndex is less than zero.

- or -

pageSize is less than one.

- or -

pageIndex multiplied by pageSize plus pageSize minus one exceeds Int32.MaxValue.

FindUsersByEmail returns a list of membership users in which the e-mail address contains a match with the supplied emailToMatch for the configured ApplicationName.

The SqlMembershipProvider searches for a user name that matches the emailToMatch parameter value, using the LIKE clause. SQL Server wildcard characters can be included in the parameter value. For example, if the emailToMatch parameter is set to "", then information for users with the e-mail address "" is returned, if it exists. If the emailToMatch parameter is set to "", then information for users with the e-mail address "", "", "", and so on is returned.

The results returned by FindUsersByEmail are constrained by the pageIndex and pageSize parameters. The pageSize parameter identifies the maximum number of MembershipUser objects to return in the MembershipUserCollection. The pageIndex parameter identifies which page of results to return, where zero identifies the first page. The totalRecords parameter is an out parameter that is set to the total number of membership users for the configured applicationName. For example, if there are 13 users for the configured applicationName, and the pageIndex value was 1 with a pageSize of 5, the MembershipUserCollection returned would contain the sixth through tenth users returned. The totalRecords parameter would be set to 13.

Leading and trailing spaces are trimmed from the emailToMatch parameter value.

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


This example uses the Membership class to call the SqlMembershipProvider specified as the defaultProvider in the Web.config file. If you need to access the default provider as the type SqlMembershipProvider, you can cast the Provider property of the Membership class. To access other configured providers as a specific provider type, you can access them by their configured name with the Providers property of the Membership class and cast them as the specific provider type.

<%@ Page Language="C#" %>
<%@ Import Namespace="System.Web.Security" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
<script runat="server">

int pageSize = 5;
int totalUsers;
int totalPages;
int currentPage = 1;

private void GetUsers()
  UserGrid.DataSource = Membership.FindUsersByEmail(EmailTextBox.Text, 
                          currentPage - 1, pageSize, out totalUsers);
  totalPages = ((totalUsers - 1) / pageSize) + 1;

  // Ensure that we do not navigate past the last page of users.

  if (currentPage > totalPages)
    currentPage = totalPages;

  CurrentPageLabel.Text = currentPage.ToString();
  TotalPagesLabel.Text = totalPages.ToString();

  if (currentPage == totalPages)
    NextButton.Visible = false;
    NextButton.Visible = true;

  if (currentPage == 1)
    PreviousButton.Visible = false;
    PreviousButton.Visible = true;

  if (totalUsers <= 0)
    NavigationPanel.Visible = false;
    NavigationPanel.Visible = true;

public void NextButton_OnClick(object sender, EventArgs args)
  currentPage = Convert.ToInt32(CurrentPageLabel.Text);

public void PreviousButton_OnClick(object sender, EventArgs args)
  currentPage = Convert.ToInt32(CurrentPageLabel.Text);

public void GoButton_OnClick(object sender, EventArgs args)
  currentPage = 1;

<html xmlns="" >
<title>Sample: Find Users by Email</title>

<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:Panel id="NavigationPanel" Visible="false" runat="server">
    <table border="0" cellpadding="3" cellspacing="3">
        <td style="width:100">Page <asp:Label id="CurrentPageLabel" runat="server" />
            of <asp:Label id="TotalPagesLabel" runat="server" /></td>
        <td style="width:60"><asp:LinkButton id="PreviousButton" Text="< Prev"
                            OnClick="PreviousButton_OnClick" runat="server" /></td>
        <td style="width:60"><asp:LinkButton id="NextButton" Text="Next >"
                            OnClick="NextButton_OnClick" runat="server" /></td>

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



.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

Community Additions

© 2015 Microsoft