Function __global->send_recommendation_email

Definitions

sources/recommend.php

  • Sends out a recommendation e-mail.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$name string No No required parameter N/A N/A Recommenders name
$email_address mixed No No required parameter N/A N/A Their e-mail address (string or array of alternates)
$message string No No required parameter N/A N/A The recommendation message
$is_invite boolean No No False N/A N/A Whether this is an invitation
$recommender_email ?EMAIL No No Null N/A N/A Email address of the recommender (null: current user's)
$subject ?string No No Null N/A N/A The subject (null: default)
$names ?array No No Null N/A N/A List of names (null: use e-mail addresses as names)

Preview

Code (PHP)

/**
 * Sends out a recommendation e-mail.
 *
 * @param  string $name Recommenders name
 * @param  mixed $email_address Their e-mail address (string or array of alternates)
 * @param  string $message The recommendation message
 * @param  boolean $is_invite Whether this is an invitation
 * @param  ?EMAIL $recommender_email Email address of the recommender (null: current user's)
 * @param  ?string $subject The subject (null: default)
 * @param  ?array $names List of names (null: use e-mail addresses as names)
 */
function send_recommendation_email(string $name, $email_address, string $message, bool $is_invite = false, ?string $recommender_email = null, ?string $subject = null, ?array $names = null)