Function Hook_health_check_email->do_spf_check

Definitions

sources/hooks/systems/health_checks/email.php

  • Find whether SPF on a domain is working.
  • Visibility: protected
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: bool

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$domain string No No required parameter N/A N/A The domain name
$self_domain string No No required parameter N/A N/A Domain of sending server to match against
$self_ip string No No required parameter N/A N/A IP address of sending server to match against

Returns

  • Whether the check matches (null: N/A)
  • Type: ?boolean
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Find whether SPF on a domain is working.
 *
 * @param  string $domain The domain name
 * @param  string $self_domain Domain of sending server to match against
 * @param  string $self_ip IP address of sending server to match against
 * @return ?boolean Whether the check matches (null: N/A)
 */

protected function do_spf_check(string $domain, string $self_domain, string $self_ip) : ?bool