Function Mail_dispatcher_base->build_mail_components

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?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$subject_line string No No required parameter N/A N/A The subject of the mail in plain text
$message_raw LONG_TEXT No No required parameter N/A N/A The message, as Comcode
$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
$lang LANGUAGE_NAME No No required parameter N/A N/A Language
$theme ID_TEXT No No required parameter N/A N/A Theme
$resource_guid ID_TEXT No No required parameter N/A N/A The GUID of this mail message (blank: none)

Returns

  • A huge ordered list of mail components
  • 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  string $subject_line The subject of the mail in plain text
 * @param  LONG_TEXT $message_raw The message, as Comcode
 * @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  LANGUAGE_NAME $lang Language
 * @param  ID_TEXT $theme Theme
 * @param  ID_TEXT $resource_guid The GUID of this mail message (blank: none)
 * @return array A huge ordered list of mail components
 */
protected function build_mail_components(string $subject_line, string $message_raw, array $to_emails, array $to_names, string $from_email, string $from_name, string $lang, string $theme, string $resource_guid) : array