Function EmailIntegration->is_non_human_email

Definitions

sources/mail_integration.php

  • See if we need to skip over an e-mail message, due to it not being from a human.
  • Visibility: protected
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: bool

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$subject string No No required parameter N/A N/A Subject line
$_body_text ?string No No required parameter N/A N/A E-mail body in text format (null: not present)
$_body_html ?string No No required parameter N/A N/A E-mail body in HTML format (null: not present)
$full_header string No No required parameter N/A N/A Message headers
$from_email EMAIL No No required parameter N/A N/A From address

Returns

  • Whether it should not be processed
  • Type: boolean
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * See if we need to skip over an e-mail message, due to it not being from a human.
 *
 * @param  string $subject Subject line
 * @param  ?string $_body_text E-mail body in text format (null: not present)
 * @param  ?string $_body_html E-mail body in HTML format (null: not present)
 * @param  string $full_header Message headers
 * @param  EMAIL $from_email From address
 * @return boolean Whether it should not be processed
 */
protected function is_non_human_email(string $subject, ?string $_body_text, ?string $_body_html, string $full_header, string $from_email) : bool