User

A user associated with a file in Google Drive. Users can be accessed from `https://developers.google.com/apps-script/reference/drive/file#getEditors()`, `https://developers.google.com/apps-script/reference/drive/folder#getViewers()`, and other methods.

```javascript
// Log the email address of all users who have edit access to a file.
const file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
const editors = file.getEditors();
for (let i = 0; i < editors.length; i++) {
  Logger.log(editors[i].getEmail());
}
```

### Methods

| Method | Return type | Brief description |
|---|---|---|
| `https://developers.google.com/apps-script/reference/drive/user#getDomain()` | `String|null` | Gets the domain name associated with the user's account. |
| `https://developers.google.com/apps-script/reference/drive/user#getEmail()` | `String|null` | Gets the user's email address. |
| `https://developers.google.com/apps-script/reference/drive/user#getName()` | `String|null` | Gets the user's name. |
| `https://developers.google.com/apps-script/reference/drive/user#getPhotoUrl()` | `String|null` | Gets the URL for the user's photo. |

### Deprecated methods

| Method | Return type | Brief description |
|---|---|---|
| `https://developers.google.com/apps-script/reference/drive/user#getUserLoginId()` | `String` | Gets the user's email address. |

## Detailed documentation

### `getDomain()`

Gets the domain name associated with the user's account.

```javascript
// Log the domain names associated with all users who have edit access to a
// file.
const file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
const editors = file.getEditors();
for (let i = 0; i < editors.length; i++) {
  Logger.log(editors[i].getDomain());
}
```

#### Return


`String|null` --- the domain name associated with the user's account

*** ** * ** ***

### `getEmail()`

Gets the user's email address. The user's email address is only available if the user has
chosen to share the address from the Google+ account settings page, or if the user belongs to
the same domain as the user running the script and the domain administrator has allowed all
users within the domain to see other users' email addresses.

```javascript
// Log the email address of all users who have edit access to a file.
const file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
const editors = file.getEditors();
for (let i = 0; i < editors.length; i++) {
  Logger.log(editors[i].getEmail());
}
```

#### Return


`String|null` --- the user's email's address, or a blank string if the email address is not available

*** ** * ** ***

### `getName()`

Gets the user's name. This method returns `null` if the user's name is not available.

```javascript
// Log the names of all users who have edit access to a file.
const file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
const editors = file.getEditors();
for (let i = 0; i < editors.length; i++) {
  Logger.log(editors[i].getName());
}
```

#### Return


`String|null` --- the user's name, or `null` if the name is not available

*** ** * ** ***

### `getPhotoUrl()`

Gets the URL for the user's photo. This method returns `null` if the user's photo is not
available.

```javascript
// Log the URLs for the photos of all users who have edit access to a file.
const file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
const editors = file.getEditors();
for (let i = 0; i < editors.length; i++) {
  Logger.log(editors[i].getPhotoUrl());
}
```

#### Return


`String|null` --- the URL for the user's photo, or `null` if the photo is not available

## Deprecated methods

### `getUserLoginId()`


**Deprecated.** As of June 24, 2013, replaced by `https://developers.google.com/apps-script/reference/drive/user#getEmail()`.

Gets the user's email address.

```javascript
// Log the email address of the person running the script.
Logger.log(Session.getActiveUser().getUserLoginId());
```

#### Return


`String` --- The user's email's address.