4 +-----------------------------------------------------------------------+
5 | program/include/rcube_smtp.php |
7 | This file is part of the Roundcube Webmail client |
8 | Copyright (C) 2005-2010, Roundcube Dev. - Switzerland |
9 | Licensed under the GNU GPL |
12 | Provide SMTP functionality using socket connections |
14 +-----------------------------------------------------------------------+
15 | Author: Thomas Bruederli <roundcube@gmail.com> |
16 +-----------------------------------------------------------------------+
18 $Id: rcube_smtp.php 4666 2011-04-17 09:34:02Z alec $
22 // define headers delimiter
23 define('SMTP_MIME_CRLF', "\r\n");
26 * Class to provide SMTP functionality using PEAR Net_SMTP
29 * @author Thomas Bruederli <roundcube@gmail.com>
30 * @author Aleksander Machniak <alec@alec.pl>
41 * SMTP Connection and authentication
43 * @param string Server host
44 * @param string Server port
45 * @param string User name
46 * @param string Password
48 * @return bool Returns true on success, or false on error
50 public function connect($host=null, $port=null, $user=null, $pass=null)
52 $RCMAIL = rcmail::get_instance();
54 // disconnect/destroy $this->conn
57 // reset error/response var
58 $this->error = $this->response = null;
60 // let plugins alter smtp connection config
61 $CONFIG = $RCMAIL->plugins->exec_hook('smtp_connect', array(
62 'smtp_server' => $host ? $host : $RCMAIL->config->get('smtp_server'),
63 'smtp_port' => $port ? $port : $RCMAIL->config->get('smtp_port', 25),
64 'smtp_user' => $user ? $user : $RCMAIL->config->get('smtp_user'),
65 'smtp_pass' => $pass ? $pass : $RCMAIL->config->get('smtp_pass'),
66 'smtp_auth_cid' => $RCMAIL->config->get('smtp_auth_cid'),
67 'smtp_auth_pw' => $RCMAIL->config->get('smtp_auth_pw'),
68 'smtp_auth_type' => $RCMAIL->config->get('smtp_auth_type'),
69 'smtp_helo_host' => $RCMAIL->config->get('smtp_helo_host'),
70 'smtp_timeout' => $RCMAIL->config->get('smtp_timeout'),
73 $smtp_host = rcube_parse_host($CONFIG['smtp_server']);
74 // when called from Installer it's possible to have empty $smtp_host here
75 if (!$smtp_host) $smtp_host = 'localhost';
76 $smtp_port = is_numeric($CONFIG['smtp_port']) ? $CONFIG['smtp_port'] : 25;
77 $smtp_host_url = parse_url($smtp_host);
80 if (isset($smtp_host_url['host']) && isset($smtp_host_url['port']))
82 $smtp_host = $smtp_host_url['host'];
83 $smtp_port = $smtp_host_url['port'];
87 if (isset($smtp_host_url['host']) && isset($smtp_host_url['scheme']))
88 $smtp_host = sprintf('%s://%s', $smtp_host_url['scheme'], $smtp_host_url['host']);
90 // remove TLS prefix and set flag for use in Net_SMTP::auth()
91 if (preg_match('#^tls://#i', $smtp_host)) {
92 $smtp_host = preg_replace('#^tls://#i', '', $smtp_host);
96 if (!empty($CONFIG['smtp_helo_host']))
97 $helo_host = $CONFIG['smtp_helo_host'];
98 else if (!empty($_SERVER['SERVER_NAME']))
99 $helo_host = preg_replace('/:\d+$/', '', $_SERVER['SERVER_NAME']);
101 $helo_host = 'localhost';
104 $smtp_host = rcube_idn_to_ascii($smtp_host);
106 $this->conn = new Net_SMTP($smtp_host, $smtp_port, $helo_host);
108 if ($RCMAIL->config->get('smtp_debug'))
109 $this->conn->setDebug(true, array($this, 'debug_handler'));
111 // try to connect to server and exit on failure
112 $result = $this->conn->connect($smtp_timeout);
114 if (PEAR::isError($result)) {
115 $this->response[] = "Connection failed: ".$result->getMessage();
116 $this->error = array('label' => 'smtpconnerror', 'vars' => array('code' => $this->conn->_code));
121 // workaround for timeout bug in Net_SMTP 1.5.[0-1] (#1487843)
122 if (method_exists($this->conn, 'setTimeout')
123 && ($timeout = ini_get('default_socket_timeout'))
125 $this->conn->setTimeout($timeout);
128 $smtp_user = str_replace('%u', $_SESSION['username'], $CONFIG['smtp_user']);
129 $smtp_pass = str_replace('%p', $RCMAIL->decrypt($_SESSION['password']), $CONFIG['smtp_pass']);
130 $smtp_auth_type = empty($CONFIG['smtp_auth_type']) ? NULL : $CONFIG['smtp_auth_type'];
132 if (!empty($CONFIG['smtp_auth_cid'])) {
133 $smtp_authz = $smtp_user;
134 $smtp_user = $CONFIG['smtp_auth_cid'];
135 $smtp_pass = $CONFIG['smtp_auth_pw'];
138 // attempt to authenticate to the SMTP server
139 if ($smtp_user && $smtp_pass)
142 if (strpos($smtp_user, '@')) {
143 $smtp_user = rcube_idn_to_ascii($smtp_user);
146 $result = $this->conn->auth($smtp_user, $smtp_pass, $smtp_auth_type, $use_tls, $smtp_authz);
148 if (PEAR::isError($result))
150 $this->error = array('label' => 'smtpautherror', 'vars' => array('code' => $this->conn->_code));
151 $this->response[] .= 'Authentication failure: ' . $result->getMessage() . ' (Code: ' . $result->getCode() . ')';
163 * Function for sending mail
165 * @param string Sender e-Mail address
167 * @param mixed Either a comma-seperated list of recipients
168 * (RFC822 compliant), or an array of recipients,
169 * each RFC822 valid. This may contain recipients not
170 * specified in the headers, for Bcc:, resending
172 * @param mixed The message headers to send with the mail
173 * Either as an associative array or a finally
175 * @param mixed The full text of the message body, including any Mime parts
177 * @param array Delivery options (e.g. DSN request)
179 * @return bool Returns true on success, or false on error
181 public function send_mail($from, $recipients, &$headers, &$body, $opts=null)
183 if (!is_object($this->conn))
186 // prepare message headers as string
187 if (is_array($headers))
189 if (!($headerElements = $this->_prepare_headers($headers))) {
194 list($from, $text_headers) = $headerElements;
196 else if (is_string($headers))
197 $text_headers = $headers;
201 $this->response[] = "Invalid message headers";
205 // exit if no from address is given
209 $this->response[] = "No From address has been provided";
213 // RFC3461: Delivery Status Notification
215 $exts = $this->conn->getServiceExtensions();
217 if (!isset($exts['DSN'])) {
218 $this->error = array('label' => 'smtpdsnerror');
219 $this->response[] = "DSN not supported";
223 $from_params = 'RET=HDRS';
224 $recipient_params = 'NOTIFY=SUCCESS,FAILURE';
227 // RFC2298.3: remove envelope sender address
228 if (preg_match('/Content-Type: multipart\/report/', $text_headers)
229 && preg_match('/report-type=disposition-notification/', $text_headers)
235 if (PEAR::isError($this->conn->mailFrom($from, $from_params)))
237 $err = $this->conn->getResponse();
238 $this->error = array('label' => 'smtpfromerror', 'vars' => array(
239 'from' => $from, 'code' => $this->conn->_code, 'msg' => $err[1]));
240 $this->response[] = "Failed to set sender '$from'";
245 // prepare list of recipients
246 $recipients = $this->_parse_rfc822($recipients);
247 if (PEAR::isError($recipients))
249 $this->error = array('label' => 'smtprecipientserror');
254 // set mail recipients
255 foreach ($recipients as $recipient)
257 if (PEAR::isError($this->conn->rcptTo($recipient, $recipient_params))) {
258 $err = $this->conn->getResponse();
259 $this->error = array('label' => 'smtptoerror', 'vars' => array(
260 'to' => $recipient, 'code' => $this->conn->_code, 'msg' => $err[1]));
261 $this->response[] = "Failed to add recipient '$recipient'";
267 if (is_resource($body))
271 $text_headers = preg_replace('/[\r\n]+$/', '', $text_headers);
273 // Concatenate headers and body so it can be passed by reference to SMTP_CONN->data
274 // so preg_replace in SMTP_CONN->quotedata will store a reference instead of a copy.
275 // We are still forced to make another copy here for a couple ticks so we don't really
276 // get to save a copy in the method call.
277 $data = $text_headers . "\r\n" . $body;
279 // unset old vars to save data and so we can pass into SMTP_CONN->data by reference.
280 unset($text_headers, $body);
283 // Send the message's headers and the body as SMTP data.
284 if (PEAR::isError($result = $this->conn->data($data, $text_headers)))
286 $err = $this->conn->getResponse();
287 if (!in_array($err[0], array(354, 250, 221)))
288 $msg = sprintf('[%d] %s', $err[0], $err[1]);
290 $msg = $result->getMessage();
292 $this->error = array('label' => 'smtperror', 'vars' => array('msg' => $msg));
293 $this->response[] = "Failed to send data";
298 $this->response[] = join(': ', $this->conn->getResponse());
304 * Reset the global SMTP connection
307 public function reset()
309 if (is_object($this->conn))
315 * Disconnect the global SMTP connection
318 public function disconnect()
320 if (is_object($this->conn)) {
321 $this->conn->disconnect();
328 * This is our own debug handler for the SMTP connection
331 public function debug_handler(&$smtp, $message)
333 write_log('smtp', preg_replace('/\r\n$/', '', $message));
341 public function get_error()
348 * Get server response messages array
351 public function get_response()
353 return $this->response;
358 * Take an array of mail headers and return a string containing
359 * text usable in sending a message.
361 * @param array $headers The array of headers to prepare, in an associative
362 * array, where the array key is the header name (ie,
363 * 'Subject'), and the array value is the header
364 * value (ie, 'test'). The header produced from those
365 * values would be 'Subject: test'.
367 * @return mixed Returns false if it encounters a bad address,
368 * otherwise returns an array containing two
369 * elements: Any From: address found in the headers,
370 * and the plain text version of the headers.
373 private function _prepare_headers($headers)
378 foreach ($headers as $key => $value)
380 if (strcasecmp($key, 'From') === 0)
382 $addresses = $this->_parse_rfc822($value);
384 if (is_array($addresses))
385 $from = $addresses[0];
387 // Reject envelope From: addresses with spaces.
388 if (strstr($from, ' '))
391 $lines[] = $key . ': ' . $value;
393 else if (strcasecmp($key, 'Received') === 0)
396 if (is_array($value))
398 foreach ($value as $line)
399 $received[] = $key . ': ' . $line;
403 $received[] = $key . ': ' . $value;
406 // Put Received: headers at the top. Spam detectors often
407 // flag messages with Received: headers after the Subject:
409 $lines = array_merge($received, $lines);
413 // If $value is an array (i.e., a list of addresses), convert
414 // it to a comma-delimited string of its elements (addresses).
415 if (is_array($value))
416 $value = implode(', ', $value);
418 $lines[] = $key . ': ' . $value;
422 return array($from, join(SMTP_MIME_CRLF, $lines) . SMTP_MIME_CRLF);
426 * Take a set of recipients and parse them, returning an array of
427 * bare addresses (forward paths) that can be passed to sendmail
428 * or an smtp server with the rcpt to: command.
430 * @param mixed Either a comma-seperated list of recipients
431 * (RFC822 compliant), or an array of recipients,
434 * @return array An array of forward paths (bare addresses).
437 private function _parse_rfc822($recipients)
439 // if we're passed an array, assume addresses are valid and implode them before parsing.
440 if (is_array($recipients))
441 $recipients = implode(', ', $recipients);
443 $addresses = array();
444 $recipients = rcube_explode_quoted_string(',', $recipients);
447 while (list($k, $recipient) = each($recipients))
449 $a = explode(" ", $recipient);
450 while (list($k2, $word) = each($a))
452 if (strpos($word, "@") > 0 && $word[strlen($word)-1] != '"')
454 $word = preg_replace('/^<|>$/', '', trim($word));
455 if (in_array($word, $addresses)===false)
456 array_push($addresses, $word);