Function Mail_dispatcher_base->_dispatch

Definitions

sources/mail.php

  • Implementation-specific e-mail dispatcher, passed with pre-prepared/tidied e-mail component details for us to use.
  • Visibility: protected
  • Is abstract?: Yes
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$to_emails array No No required parameter N/A N/A To e-mail addresses
$to_names array No No required parameter N/A N/A To names
$from_email EMAIL No No required parameter N/A N/A Reply-to e-mail address
$from_name string No No required parameter N/A N/A From name
$subject_wrapped string No No required parameter N/A N/A Subject line
$headers string No No required parameter N/A N/A Headers to use
$sending_message string No No required parameter N/A N/A Full MIME message
$charset string No No required parameter N/A N/A Character set to use
$html_evaluated string No No required parameter N/A N/A Full HTML message (is also inside $sending_message, so we won't use this unless we are not using $sending_message)
$message_plain ?string No No required parameter N/A N/A Full text message (is also inside $sending_message, so we won't use this unless we are not using $sending_message) (null: HTML only)

Returns

  • A pair: Whether it worked, and an error message
  • Type: array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Implementation-specific e-mail dispatcher, passed with pre-prepared/tidied e-mail component details for us to use.
 *
 * @param  array $to_emails To e-mail addresses
 * @param  array $to_names To names
 * @param  EMAIL $from_email Reply-to e-mail address
 * @param  string $from_name From name
 * @param  string $subject_wrapped Subject line
 * @param  string $headers Headers to use
 * @param  string $sending_message Full MIME message
 * @param  string $charset Character set to use
 * @param  string $html_evaluated Full HTML message (is also inside $sending_message, so we won't use this unless we are not using $sending_message)
 * @param  ?string $message_plain Full text message (is also inside $sending_message, so we won't use this unless we are not using $sending_message) (null: HTML only)
 * @return array A pair: Whether it worked, and an error message
 */
abstract protected function _dispatch(array $to_emails, array $to_names, string $from_email, string $from_name, string $subject_wrapped, string $headers, string $sending_message, string $charset, string $html_evaluated, ?string $message_plain) : array