3 // +----------------------------------------------------------------------+
5 // +----------------------------------------------------------------------+
6 // | Copyright (c) 1997-2003 The PHP Group |
7 // +----------------------------------------------------------------------+
8 // | This source file is subject to version 2.02 of the PHP license, |
9 // | that is bundled with this package in the file LICENSE, and is |
10 // | available at through the world-wide-web at |
11 // | http://www.php.net/license/2_02.txt. |
12 // | If you did not receive a copy of the PHP license and are unable to |
13 // | obtain it through the world-wide-web, please send a note to |
14 // | license@php.net so we can mail you a copy immediately. |
15 // +----------------------------------------------------------------------+
16 // | Author: Chuck Hagenbuch <chuck@horde.org> |
17 // +----------------------------------------------------------------------+
20 * Sendmail implementation of the PEAR Mail:: interface.
25 class Mail_sendmail extends Mail {
28 * The location of the sendmail or sendmail wrapper binary on the
32 var $sendmail_path = '/usr/sbin/sendmail';
35 * Any extra command-line parameters to pass to the sendmail or
36 * sendmail wrapper binary.
39 var $sendmail_args = '-i';
44 * Instantiates a new Mail_sendmail:: object based on the parameters
45 * passed in. It looks for the following parameters:
46 * sendmail_path The location of the sendmail binary on the
47 * filesystem. Defaults to '/usr/sbin/sendmail'.
49 * sendmail_args Any extra parameters to pass to the sendmail
50 * or sendmail wrapper binary.
52 * If a parameter is present in the $params array, it replaces the
55 * @param array $params Hash containing any parameters different from the
58 public function __construct($params)
60 if (isset($params['sendmail_path'])) {
61 $this->sendmail_path = $params['sendmail_path'];
63 if (isset($params['sendmail_args'])) {
64 $this->sendmail_args = $params['sendmail_args'];
68 * Because we need to pass message headers to the sendmail program on
69 * the commandline, we can't guarantee the use of the standard "\r\n"
70 * separator. Instead, we use the system's native line separator.
72 if (defined('PHP_EOL')) {
75 $this->sep = (strpos(PHP_OS, 'WIN') === false) ? "\n" : "\r\n";
80 * Implements Mail::send() function using the sendmail
81 * command-line binary.
83 * @param mixed $recipients Either a comma-seperated list of recipients
84 * (RFC822 compliant), or an array of recipients,
85 * each RFC822 valid. This may contain recipients not
86 * specified in the headers, for Bcc:, resending
89 * @param array $headers The array of headers to send with the mail, in an
90 * associative array, where the array key is the
91 * header name (ie, 'Subject'), and the array value
92 * is the header value (ie, 'test'). The header
93 * produced from those values would be 'Subject:
96 * @param string $body The full text of the message body, including any
99 * @return mixed Returns true on success, or a PEAR_Error
100 * containing a descriptive error message on
103 public function send($recipients, $headers, $body)
105 if (!is_array($headers)) {
106 return PEAR::raiseError('$headers must be an array');
109 $result = $this->_sanitizeHeaders($headers);
110 if (is_a($result, 'PEAR_Error')) {
114 $recipients = $this->parseRecipients($recipients);
115 if (is_a($recipients, 'PEAR_Error')) {
118 $recipients = implode(' ', array_map('escapeshellarg', $recipients));
120 $headerElements = $this->prepareHeaders($headers);
121 if (is_a($headerElements, 'PEAR_Error')) {
122 return $headerElements;
124 list($from, $text_headers) = $headerElements;
126 /* Since few MTAs are going to allow this header to be forged
127 * unless it's in the MAIL FROM: exchange, we'll use
128 * Return-Path instead of From: if it's set. */
129 if (!empty($headers['Return-Path'])) {
130 $from = $headers['Return-Path'];
134 return PEAR::raiseError('No from address given.');
135 } elseif (strpos($from, ' ') !== false ||
136 strpos($from, ';') !== false ||
137 strpos($from, '&') !== false ||
138 strpos($from, '`') !== false) {
139 return PEAR::raiseError('From address specified with dangerous characters.');
142 $from = escapeshellarg($from); // Security bug #16200
144 $mail = @popen($this->sendmail_path . (!empty($this->sendmail_args) ? ' ' . $this->sendmail_args : '') . " -f$from -- $recipients", 'w');
146 return PEAR::raiseError('Failed to open sendmail [' . $this->sendmail_path . '] for execution.');
149 // Write the headers following by two newlines: one to end the headers
150 // section and a second to separate the headers block from the body.
151 fputs($mail, $text_headers . $this->sep . $this->sep);
154 $result = pclose($mail);
155 if (version_compare(phpversion(), '4.2.3') == -1) {
156 // With older php versions, we need to shift the pclose
157 // result to get the exit code.
158 $result = $result >> 8 & 0xFF;
162 return PEAR::raiseError('sendmail returned error code ' . $result,