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

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

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

10
use Drupal\Component\Utility\Settings;
11
use Drupal\Core\Mail\MailInterface;
12

13
/**
14 15 16 17 18 19 20
 * 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.")
 * )
21
 */
22 23
class PhpMail implements MailInterface {

24
  /**
25
   * Concatenates and wraps the e-mail body for plain-text mails.
26
   *
27
   * @param array $message
28 29
   *   A message array, as described in hook_mail_alter().
   *
30
   * @return array
31 32 33 34 35 36 37 38 39
   *   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']);
40

41 42 43
    return $message;
  }

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

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

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

114
    return $mail_result;
115 116
  }
}