Function __global->is_valid_email_address

Definitions

sources/type_sanitisation.php

  • Find whether the specified address is a well-formed e-mail address or not.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: bool

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$string string No No required parameter N/A N/A The string to test (Note: This is typed string, not e-mail, because it has to function on failure + we could make an infinite loop)

Returns

  • Whether the string is an e-mail address or not
  • Type: boolean
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Find whether the specified address is a well-formed e-mail address or not.
 *
 * @param  string $string The string to test (Note: This is typed string, not e-mail, because it has to function on failure + we could make an infinite loop)
 * @return boolean Whether the string is an e-mail address or not
 */

function is_valid_email_address(string $string) : bool