function User::setEmail

Same name and namespace in other branches
  1. 8.9.x core/modules/user/src/Entity/User.php \Drupal\user\Entity\User::setEmail()
  2. 10 core/modules/user/src/Entity/User.php \Drupal\user\Entity\User::setEmail()
  3. 11.x core/modules/user/src/Entity/User.php \Drupal\user\Entity\User::setEmail()

Sets the email address of the user.

Parameters

string $mail: The new email address of the user.

Return value

$this The called user entity.

Overrides UserInterface::setEmail

File

core/modules/user/src/Entity/User.php, line 244

Class

User
Defines the user entity class.

Namespace

Drupal\user\Entity

Code

public function setEmail($mail) {
    $this->get('mail')->value = $mail;
    return $this;
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.