7 user.module user_load_by_mail($mail)
8 user.module user_load_by_mail($mail)

Fetch a user object by email address.

Parameters

$mail: String with the account's e-mail address.

Return value

A fully-loaded $user object upon successful user load or FALSE if user cannot be loaded.

See also

user_load_multiple()

2 calls to user_load_by_mail()
system_send_email_action in modules/system/system.module
Sends an e-mail message.
_update_cron_notify in modules/update/update.fetch.inc
Performs any notifications that should be done once cron fetches new data.

File

modules/user/user.module, line 381
Enables the user registration and login system.

Code

function user_load_by_mail($mail) {
  $users = user_load_multiple(array(), array('mail' => $mail));
  return reset($users);
}

Comments

Looking through backported code and noticed this succinct D6 equivalent:

<?php
 $user
= user_load(array('mail'=> 'dries@example.com'));
?>

If you use this to check if a user exists, beware that an empty string will return the anonymous user.

What a shame that this does not do a case insensitive check. It makes the function basically useless. If anyone wants to really check whether an email address is registered or fetch that user, they must write their own function similar to what user_account_form_validate() does in user.module (it does a db_select() with db_like(), rather than using this function).

In an ideal world, this function would do that, and user_account_form_validate() would call it.

Disregard my comment. I tested this function and it appears to be case insensitive, although this may be dependent on the collation of the database (MySQL by default should do a case insensitive search with a basic WHERE mail = 'something@example.com'.

Calling user_load_by_mail(NULL) returns the Anonymous user, not FALSE as I had expected.

You might want to watch for this.