Function Mail_dispatcher_base->tidy_parameters

Definitions

sources/mail.php

  • Tidy up complex input data, and make some conclusions. Returns by reference.
  • Visibility: protected
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
&$subject_line string Yes No required parameter N/A N/A The subject of the mail in plain text
&$message_raw LONG_TEXT Yes No required parameter N/A N/A The message, as Comcode
&$to_emails ?array Yes No required parameter N/A N/A The destination (recipient) e-mail address(es) [array of strings] (null: site staff address)
&$to_names ?mixed Yes No required parameter N/A N/A The recipient name(s). Array or string. (null: site name)
&$from_email EMAIL Yes No required parameter N/A N/A Reply-to e-mail address
&$from_name string Yes No required parameter N/A N/A From name
&$lang LANGUAGE_NAME Yes No required parameter N/A N/A Language
&$theme ID_TEXT Yes No required parameter N/A N/A Theme

Preview

Code (PHP)

/**
 * Tidy up complex input data, and make some conclusions. Returns by reference.
 *
 * @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 The destination (recipient) e-mail address(es) [array of strings] (null: site staff address)
 * @param  ?mixed $to_names The recipient name(s). Array or string. (null: site name)
 * @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
 */
protected function tidy_parameters(string &$subject_line, string &$message_raw, ?array &$to_emails, &$to_names, string &$from_email, string &$from_name, string &$lang, string &$theme)