Function __global->mail

Definitions

sources_custom/phpstub.php

  • Send an e-mail.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: bool

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$to string No No required parameter N/A N/A The TO address
$subject string No No required parameter N/A N/A The subject
$message string No No required parameter N/A N/A The message
$additional_headers string No No Blank (empty string) N/A N/A Additional headers
$additional_flags mixed No No Blank (empty string) N/A N/A Additional stuff to send to sendmail executable (array or string)

Returns

  • Success status
  • Type: boolean
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Send an e-mail.
 *
 * @param  string $to The TO address
 * @param  string $subject The subject
 * @param  string $message The message
 * @param  string $additional_headers Additional headers
 * @param  mixed $additional_flags Additional stuff to send to sendmail executable (array or string)
 * @return boolean Success status
 */

function mail(string $to, string $subject, string $message, string $additional_headers = '', $additional_flags = '') : bool