public function DefaultMailSystem::mail

Send an email message, using Backdrop variables and default settings.

Parameters

$message: A message array, as described in hook_mail_alter().

Return value

TRUE if the mail was successfully accepted, otherwise FALSE.:

Overrides MailSystemInterface::mail

See also

http://php.net/manual/function.mail.php

backdrop_mail()

File

core/modules/system/system.mail.inc, line 41

Backdrop core implementations of MailSystemInterface.

Class

DefaultMailSystem

The default Backdrop mail backend using PHP's mail function.

Code

public function mail(array $message) {
  // If 'Return-Path' isn't already set in php.ini, we pass it separately
  // as an additional parameter instead of in the header.
  if (isset($message['headers']['Return-Path'])) {
    $return_path_set = strpos(ini_get('sendmail_path'), ' -f');
    if (!$return_path_set) {
      $message['Return-Path'] = $message['headers']['Return-Path'];
      unset($message['headers']['Return-Path']);
    }
  }
  $mimeheaders = array();
  foreach ($message['headers'] as $name => $value) {
    $mimeheaders[] = $name . ': ' . mime_header_encode($value);
  }
  $line_endings = settings_get('mail_line_endings', MAIL_LINE_ENDINGS);
  // Prepare mail commands.
  $mail_subject = mime_header_encode($message['subject']);
  // Note: email uses CRLF for line-endings. PHP's API requires LF
  // on Unix and CRLF on Windows. Backdrop automatically guesses the
  // line-ending format appropriate for your system. If you need to
  // override this, adjust $settings['mail_line_endings'] in settings.php.
  $mail_body = preg_replace('@\r?\n@', $line_endings, $message['body']);
  // For headers, PHP's API suggests that we use CRLF normally,
  // but some MTAs incorrectly replace LF with CRLF. See #234403.
  $mail_headers = join("\n", $mimeheaders);

  // We suppress warnings and notices from mail() because of issues on some
  // hosts. The return value of this method will still indicate whether mail
  // was sent successfully.
  if (!isset($_SERVER['WINDIR']) && strpos($_SERVER['SERVER_SOFTWARE'], 'Win32') === FALSE) {
    // We validate the return path, unless it is equal to the site mail, which
    // we assume to be safe.
    $additional_params = NULL;
    if (isset($message['Return-Path']) && (config_get('system.core', 'site_mail') === $message['Return-Path'] || self::_isShellSafe($message['Return-Path']))) {
      // On most non-Windows systems, the "-f" option to the sendmail command
      // is used to set the Return-Path. There is no space between -f and
      // the value of the return path.
      $additional_params = '-f' . $message['Return-Path'];
    }

    $mail_result = @mail(
    $message['to'], 
    $mail_subject, 
    $mail_body, 
    $mail_headers, 
    $additional_params
    );
  }
  else {
    // On Windows, PHP will use the value of sendmail_from for the
    // Return-Path header.
    $old_from = ini_get('sendmail_from');
    ini_set('sendmail_from', $message['Return-Path']);
    $mail_result = @mail(
    $message['to'], 
    $mail_subject, 
    $mail_body, 
    $mail_headers
    );
    ini_set('sendmail_from', $old_from);
  }
  return $mail_result;
}