Same name and namespace in other branches
  1. 4.6.x includes/common.inc \valid_email_address()
  2. 4.7.x includes/common.inc \valid_email_address()
  3. 5.x includes/common.inc \valid_email_address()
  4. 6.x includes/common.inc \valid_email_address()
  5. 8.9.x core/includes/common.inc \valid_email_address()

Verifies the syntax of the given e-mail address.

This uses the PHP e-mail validation filter. However, a module may override this by implementing hook_valid_email_address_alter(&$valid, $mail).

Parameters

$mail: A string containing an e-mail address.

Return value

TRUE if the address is in a valid format.

See also

hook_valid_email_address_alter()

Related topics

4 calls to valid_email_address()
comment_form_validate in modules/comment/comment.module
Validate comment form submissions.
system_send_email_action_validate in modules/system/system.module
Validate system_send_email_action form submissions.
user_validate_mail in modules/user/user.module
Validates a user's email address.
_openid_invalid_openid_transition in modules/openid/openid.inc
Provides transition for accounts with possibly invalid OpenID identifiers in authmap.

File

includes/common.inc, line 1292
Common functions that many Drupal modules will need to reference.

Code

function valid_email_address($mail) {
  $valid = (bool) filter_var($mail, FILTER_VALIDATE_EMAIL);
  drupal_alter('valid_email_address', $valid, $mail);
  return $valid;
}