ActiveDirectoryMembershipProvider.GetUserNameByEmail Method

Gets the user name associated with the specified e-mail address.

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

public override string GetUserNameByEmail (
	string email
)
public String GetUserNameByEmail (
	String email
)
public override function GetUserNameByEmail (
	email : String
) : String
Not applicable.

Parameters

email

The e-mail address to search for.

Return Value

The user name associated with the specified e-mail address.

Exception typeCondition

ArgumentException

email exceeds 256 characters

- or -

after trimming, email is empty.

ProviderException

More than one user exists in the data store with the same e-mail address and the RequiresUniqueEmail property value is true.

This method is called by the Membership class to retrieve a user name from the Active Directory data store based on the e-mail address for the user.

If more than one user in the membership data store has the same e-mail address, the first user name encountered is returned. You can set the requiresUniqueEmail attribute of the membership Element (ASP.NET Settings Schema) element to true in the application configuration file to ensure that each e-mail address in the database is unique.

Leading and trailing spaces are trimmed from the email parameter value. If the e-mail address is empty after trimming, an ArgumentException is thrown. If the e-mail address is a null reference (Nothing in Visual Basic), all user names in the Active Directory data store are searched, and the first user name is returned.

We recommend that you do not enable searching on production systems until you have confirmed that the search queries issued by the ActiveDirectoryMembershipProvider class do not adversely impact your directory server's performance.

NoteImportant:

The GetUserNameByEmail method will run even when the EnableSearchMethods property is false.

Since the ActiveDirectoryMembershipProvider class is designed for a stateless Web environment, it is unable to use the paging optimizations exposed by the underlying System.DirectoryServices APIs. This means that paging operations during searches against large directories are very expensive and should be avoided. Search operations are always issued against the directory server configured in the connection string, or an automatically selected server in the case of a connection string pointing at a domain. The provider does not use a global catalog for its search methods.

The provider uses a subtree search starting at the search point specified in the connection string. See the ActiveDirectoryMembershipProvider class topic for more information about connection strings.

Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

ADD
Show: