SP.UserCollection.getByEmail Method (sp.js)

  • Article

Gets the user with the specified email address.

Applies to: apps for SharePoint | SharePoint Foundation 2013 | SharePoint Server 2013

SP.UserCollection.getByEmail()

Parameters

  • emailAddress
    Type: String

    A string that contains the email address of the user.

Return value

Type: SP.User

Remarks

The value of the emailAddress parameter cannot be null, empty, or greater than 255 characters in length.

REST resource endpoint

See UserCollection resource for more information.

Endpoint URI structure

http://<sitecollection>/<site>/_api/web/sitegroups(groupid)/users/getByEmail(emailAddress)

HTTP requests

This resource supports the following HTTP commands:

  • POST

GET syntax

GET http://<sitecollection>/<site>/_api/web/sitegroups(groupid)/users/getByEmail(emailAddress)

POST syntax

POST http://<sitecollection>/<site>/_api/web/sitegroups(groupid)/users/getByEmail(emailAddress)

Resource parameters

  • emailAddress