PhpMail.php 3.81 KB
Newer Older
1 2 3 4
<?php

/**
 * @file
5
 * Contains Drupal\Core\Mail\Plugin\Mail\PhpMail.
6 7
 */

8 9 10
namespace Drupal\Core\Mail\Plugin\Mail;

use Drupal\Core\Mail\MailInterface;
11

12
/**
13 14 15 16 17 18 19
 * Defines the default Drupal mail backend, using PHP's native mail() function.
 *
 * @Mail(
 *   id = "php_mail",
 *   label = @Translation("Default PHP mailer"),
 *   description = @Translation("Sends the message as plain text, using PHP's native mail() function.")
 * )
20
 */
21 22
class PhpMail implements MailInterface {

23
  /**
24
   * Concatenates and wraps the e-mail body for plain-text mails.
25
   *
26
   * @param array $message
27 28
   *   A message array, as described in hook_mail_alter().
   *
29
   * @return array
30 31 32 33 34 35 36 37 38
   *   The formatted $message.
   */
  public function format(array $message) {
    // Join the body array into one string.
    $message['body'] = implode("\n\n", $message['body']);
    // Convert any HTML to plain-text.
    $message['body'] = drupal_html_to_text($message['body']);
    // Wrap the mail body for sending.
    $message['body'] = drupal_wrap_mail($message['body']);
39

40 41 42
    return $message;
  }

43
  /**
44
   * Sends an e-mail message.
45
   *
46
   * @param array $message
47
   *   A message array, as described in hook_mail_alter().
48 49
   *
   * @return bool
50
   *   TRUE if the mail was successfully accepted, otherwise FALSE.
51 52 53
   *
   * @see http://php.net/manual/en/function.mail.php
   * @see drupal_mail()
54 55
   */
  public function mail(array $message) {
56 57
    // If 'Return-Path' isn't already set in php.ini, we pass it separately
    // as an additional parameter instead of in the header.
58
    if (isset($message['headers']['Return-Path'])) {
59 60 61 62 63 64
      $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']);
      }
    }
65 66 67 68
    $mimeheaders = array();
    foreach ($message['headers'] as $name => $value) {
      $mimeheaders[] = $name . ': ' . mime_header_encode($value);
    }
69
    $line_endings = settings()->get('mail_line_endings', PHP_EOL);
70 71 72 73 74
    // Prepare mail commands.
    $mail_subject = mime_header_encode($message['subject']);
    // Note: e-mail 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
75
    // override this, adjust $settings['mail_line_endings'] in settings.php.
76 77 78 79
    $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);
80

81 82
    $request = \Drupal::request();

83 84 85
    // 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.
86
    if (!$request->server->has('WINDIR') && strpos($request->server->get('SERVER_SOFTWARE'), 'Win32') === FALSE) {
87 88 89 90 91 92 93 94 95 96 97
      // 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_headers = isset($message['Return-Path']) ? '-f' . $message['Return-Path'] : '';
      $mail_result = @mail(
        $message['to'],
        $mail_subject,
        $mail_body,
        $mail_headers,
        $additional_headers
      );
98 99
    }
    else {
100 101 102 103 104
      // 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(
105 106 107 108 109
        $message['to'],
        $mail_subject,
        $mail_body,
        $mail_headers
      );
110
      ini_set('sendmail_from', $old_from);
111
    }
112

113
    return $mail_result;
114 115
  }
}