public function PhpMail::mail in Drupal 8

Same name and namespace in other branches

1. 9 core/lib/Drupal/Core/Mail/Plugin/Mail/PhpMail.php \Drupal\Core\Mail\Plugin\Mail\PhpMail::mail()

Sends an email message.

Parameters

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

Return value

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

Overrides MailInterface::mail

See also

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

\Drupal\Core\Mail\MailManagerInterface::mail()

2 methods override PhpMail::mail()

TestMailCollector::mail in core/lib/Drupal/Core/Mail/Plugin/Mail/TestMailCollector.php

Sends an email message.

TestPhpMailFailure::mail in core/modules/system/tests/modules/system_mail_failure_test/src/Plugin/Mail/TestPhpMailFailure.php

Sends an email message.

File

core/lib/Drupal/Core/Mail/Plugin/Mail/PhpMail.php, line 68

Class

PhpMail

Defines the default Drupal mail backend, using PHP's native mail() function.

Namespace

Drupal\Core\Mail\Plugin\Mail

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 = [];
  foreach ($message['headers'] as $name => $value) {
    $mimeheaders[] = $name . ': ' . Unicode::mimeHeaderEncode($value);
  }
  $line_endings = Settings::get('mail_line_endings', PHP_EOL);

  // Prepare mail commands.
  $mail_subject = Unicode::mimeHeaderEncode($message['subject']);

  // Note: email uses CRLF for line-endings. PHP's API requires LF
  // on Unix and CRLF on Windows. Drupal 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 = implode("\n", $mimeheaders);
  $request = \Drupal::request();

  // 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 (!$request->server
    ->has('WINDIR') && strpos($request->server
    ->get('SERVER_SOFTWARE'), 'Win32') === FALSE) {

    // 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.
    // We validate the return path, unless it is equal to the site mail, which
    // we assume to be safe.
    $site_mail = $this->configFactory
      ->get('system.site')
      ->get('mail');
    $additional_headers = isset($message['Return-Path']) && ($site_mail === $message['Return-Path'] || static::_isShellSafe($message['Return-Path'])) ? '-f' . $message['Return-Path'] : '';
    $mail_result = @mail($message['to'], $mail_subject, $mail_body, $mail_headers, $additional_headers);
  }
  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;
}