Function Hook_Health_Check->get_mail_domains

Definitions

sources/health_check.php

  • Get a list of e-mail domains the site uses.
  • Visibility: protected
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$include_all boolean No No True N/A N/A Include all e-mail domains, as opposed to just the main outgoing one

Returns

  • Map of e-mail domains to e-mail addresses on the domain
  • Type: array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get a list of e-mail domains the site uses.
 *
 * @param  boolean $include_all Include all e-mail domains, as opposed to just the main outgoing one
 * @return array Map of e-mail domains to e-mail addresses on the domain
 */

protected function get_mail_domains(bool $include_all = true) : array