153f15e530699a5ff52e6342cd8b90ba5d6de68e
[squirrelmail.git] / functions / smtp.php
1 <?php
2 /** smtp.php
3 **
4 ** This contains all the functions needed to send messages through
5 ** an smtp server or sendmail.
6 **
7 ** $Id$
8 **/
9
10 if (defined('smtp_php'))
11 return;
12 define('smtp_php', true);
13
14 require_once('../functions/addressbook.php');
15 require_once('../functions/plugin.php');
16
17 global $username, $popuser, $domain;
18
19 // This should most probably go to some initialization...
20 if (ereg("^([^@%/]+)[@%/](.+)$", $username, $usernamedata)) {
21 $popuser = $usernamedata[1];
22 $domain = $usernamedata[2];
23 unset($usernamedata);
24 } else {
25 $popuser = $username;
26 }
27 // We need domain for smtp
28 if (!$domain)
29 $domain = getenv('HOSTNAME');
30
31 // Returns true only if this message is multipart
32 function isMultipart () {
33 global $attachments;
34
35 if (count($attachments)>0)
36 return true;
37 else
38 return false;
39 }
40
41 // looks up aliases in the addressbook and expands them to
42 // the full address.
43 // Adds @$domain if it wasn't in the address book and if it
44 // doesn't have an @ symbol in it
45 function expandAddrs ($array) {
46 global $domain;
47
48 // don't show errors -- kinda critical that we don't see
49 // them here since the redirect won't work if we do show them
50 $abook = addressbook_init(false);
51 for ($i=0; $i < count($array); $i++) {
52 $result = $abook->lookup($array[$i]);
53 $ret = "";
54 if (isset($result['email'])) {
55 if (isset($result['name'])) {
56 $ret = '"'.$result['name'].'" ';
57 }
58 $ret .= '<'.$result['email'].'>';
59 $array[$i] = $ret;
60 }
61 else
62 {
63 if (strpos($array[$i], '@') === false)
64 $array[$i] .= '@' . $domain;
65 $array[$i] = '<' . $array[$i] . '>';
66 }
67 }
68 return $array;
69 }
70
71 // Attach the files that are due to be attached
72 function attachFiles ($fp) {
73 global $attachments, $attachment_dir;
74
75 $length = 0;
76
77 if (isMultipart()) {
78 foreach ($attachments as $info)
79 {
80 if (isset($info['type']))
81 $filetype = $info['type'];
82 else
83 $filetype = 'application/octet-stream';
84
85 $header = '--'.mimeBoundary()."\r\n";
86 $header .= "Content-Type: $filetype; name=\"" .
87 $info['remotefilename'] . "\"\r\n";
88 $header .= "Content-Disposition: attachment; filename=\"" .
89 $info['remotefilename'] . "\"\r\n";
90
91 // Use 'rb' for NT systems -- read binary
92 // Unix doesn't care -- everything's binary! :-)
93 $file = fopen ($attachment_dir . $info['localfilename'], 'rb');
94 if (substr($filetype, 0, 5) == 'text/' ||
95 $filetype == 'message/rfc822') {
96 $header .= "\r\n";
97 fputs ($fp, $header);
98 $length += strlen($header);
99 while ($tmp = fgets($file, 4096)) {
100 $tmp = str_replace("\r\n", "\n", $tmp);
101 $tmp = str_replace("\r", "\n", $tmp);
102 $tmp = str_replace("\n", "\r\n", $tmp);
103 if (feof($fp) && substr($tmp, -2) != "\r\n")
104 $tmp .= "\r\n";
105 fputs($fp, $tmp);
106 $length += strlen($tmp);
107 }
108 } else {
109 $header .= "Content-Transfer-Encoding: base64\r\n\r\n";
110 fputs ($fp, $header);
111 $length += strlen($header);
112 while ($tmp = fread($file, 570)) {
113 $encoded = chunk_split(base64_encode($tmp));
114 $length += strlen($encoded);
115 fputs ($fp, $encoded);
116 }
117 }
118 fclose ($file);
119 }
120 }
121
122 return $length;
123 }
124
125 // Delete files that are uploaded for attaching
126 function deleteAttachments() {
127 global $attachments, $attachment_dir;
128
129 if (isMultipart()) {
130 reset($attachments);
131 while (list($localname, $remotename) = each($attachments)) {
132 if (!ereg ("\\/", $localname)) {
133 unlink ($attachment_dir.$localname);
134 unlink ($attachment_dir.$localname.'.info');
135 }
136 }
137 }
138 }
139
140 // Return a nice MIME-boundary
141 function mimeBoundary () {
142 static $mimeBoundaryString;
143
144 if ($mimeBoundaryString == "") {
145 $mimeBoundaryString = "----=_" .
146 GenerateRandomString(60, '\'()+,-./:=?_', 7);
147 }
148
149 return $mimeBoundaryString;
150 }
151
152 /* Time offset for correct timezone */
153 function timezone () {
154 global $invert_time;
155
156 $diff_second = date('Z');
157 if ($invert_time)
158 $diff_second = - $diff_second;
159 if ($diff_second > 0)
160 $sign = '+';
161 else
162 $sign = '-';
163
164 $diff_second = abs($diff_second);
165
166 $diff_hour = floor ($diff_second / 3600);
167 $diff_minute = floor (($diff_second-3600*$diff_hour) / 60);
168
169 $zonename = '('.strftime('%Z').')';
170 $result = sprintf ("%s%02d%02d %s", $sign, $diff_hour, $diff_minute, $zonename);
171 return ($result);
172 }
173
174 /* Print all the needed RFC822 headers */
175 function write822Header ($fp, $t, $c, $b, $subject, $more_headers) {
176 global $REMOTE_ADDR, $SERVER_NAME, $REMOTE_PORT;
177 global $data_dir, $username, $popuser, $domain, $version, $useSendmail;
178 global $default_charset, $HTTP_VIA, $HTTP_X_FORWARDED_FOR;
179 global $REMOTE_HOST, $identity;
180
181 // Storing the header to make sure the header is the same
182 // everytime the header is printed.
183 static $header, $headerlength;
184
185 if ($header == '') {
186 $to = expandAddrs(parseAddrs($t));
187 $cc = expandAddrs(parseAddrs($c));
188 $bcc = expandAddrs(parseAddrs($b));
189 if (isset($identity) && $identity != 'default')
190 {
191 $reply_to = getPref($data_dir, $username, 'reply_to' . $identity);
192 $from = getPref($data_dir, $username, 'full_name' . $identity);
193 $from_addr = getPref($data_dir, $username, 'email_address' . $identity);
194 }
195 else
196 {
197 $reply_to = getPref($data_dir, $username, 'reply_to');
198 $from = getPref($data_dir, $username, 'full_name');
199 $from_addr = getPref($data_dir, $username, 'email_address');
200 }
201
202 if ($from_addr == '')
203 $from_addr = $popuser.'@'.$domain;
204
205 $to_list = getLineOfAddrs($to);
206 $cc_list = getLineOfAddrs($cc);
207 $bcc_list = getLineOfAddrs($bcc);
208
209 /* Encoding 8-bit characters and making from line */
210 $subject = encodeHeader($subject);
211 if ($from == '')
212 $from = "<$from_addr>";
213 else
214 $from = '"' . encodeHeader($from) . "\" <$from_addr>";
215
216 /* This creates an RFC 822 date */
217 $date = date("D, j M Y H:i:s ", mktime()) . timezone();
218
219 /* Create a message-id */
220 $message_id = '<' . $REMOTE_PORT . '.' . $REMOTE_ADDR . '.';
221 $message_id .= time() . '.squirrel@' . $SERVER_NAME .'>';
222
223 /* Make an RFC822 Received: line */
224 if (isset($REMOTE_HOST))
225 $received_from = "$REMOTE_HOST ([$REMOTE_ADDR])";
226 else
227 $received_from = $REMOTE_ADDR;
228
229 if (isset($HTTP_VIA) || isset ($HTTP_X_FORWARDED_FOR)) {
230 if ($HTTP_X_FORWARDED_FOR == '')
231 $HTTP_X_FORWARDED_FOR = 'unknown';
232 $received_from .= " (proxying for $HTTP_X_FORWARDED_FOR)";
233 }
234
235 $header = "Received: from $received_from\r\n";
236 $header .= " (SquirrelMail authenticated user $username)\r\n";
237 $header .= " by $SERVER_NAME with HTTP;\r\n";
238 $header .= " $date\r\n";
239
240 /* Insert the rest of the header fields */
241 $header .= "Message-ID: $message_id\r\n";
242 $header .= "Date: $date\r\n";
243 $header .= "Subject: $subject\r\n";
244 $header .= "From: $from\r\n";
245 $header .= "To: $to_list\r\n"; // Who it's TO
246
247 /* Insert headers from the $more_headers array */
248 if(is_array($more_headers)) {
249 reset($more_headers);
250 while(list($h_name, $h_val) = each($more_headers)) {
251 $header .= sprintf("%s: %s\r\n", $h_name, $h_val);
252 }
253 }
254
255 if ($cc_list) {
256 $header .= "Cc: $cc_list\r\n"; // Who the CCs are
257 }
258
259 if ($reply_to != '')
260 $header .= "Reply-To: $reply_to\r\n";
261
262 if ($useSendmail) {
263 if ($bcc_list) {
264 // BCCs is removed from header by sendmail
265 $header .= "Bcc: $bcc_list\r\n";
266 }
267 }
268
269 $header .= "X-Mailer: SquirrelMail (version $version)\r\n"; // Identify SquirrelMail
270
271 // Do the MIME-stuff
272 $header .= "MIME-Version: 1.0\r\n";
273
274 if (isMultipart()) {
275 $header .= 'Content-Type: multipart/mixed; boundary="';
276 $header .= mimeBoundary();
277 $header .= "\"\r\n";
278 } else {
279 if ($default_charset != '')
280 $header .= "Content-Type: text/plain; charset=$default_charset\r\n";
281 else
282 $header .= "Content-Type: text/plain;\r\n";
283 $header .= "Content-Transfer-Encoding: 8bit\r\n";
284 }
285 $header .= "\r\n"; // One blank line to separate header and body
286
287 $headerlength = strlen($header);
288 }
289
290 // Write the header
291 fputs ($fp, $header);
292
293 return $headerlength;
294 }
295
296 // Send the body
297 function writeBody ($fp, $passedBody) {
298 global $default_charset;
299
300 $attachmentlength = 0;
301
302 if (isMultipart()) {
303 $body = '--'.mimeBoundary()."\r\n";
304
305 if ($default_charset != "")
306 $body .= "Content-Type: text/plain; charset=$default_charset\r\n";
307 else
308 $body .= "Content-Type: text/plain\r\n";
309
310 $body .= "Content-Transfer-Encoding: 8bit\r\n\r\n";
311 $body .= $passedBody . "\r\n\r\n";
312 fputs ($fp, $body);
313
314 $attachmentlength = attachFiles($fp);
315
316 if (!isset($postbody)) $postbody = "";
317 $postbody .= "\r\n--".mimeBoundary()."--\r\n\r\n";
318 fputs ($fp, $postbody);
319 } else {
320 $body = $passedBody . "\r\n";
321 fputs ($fp, $body);
322 $postbody = "\r\n";
323 fputs ($fp, $postbody);
324 }
325
326 return (strlen($body) + strlen($postbody) + $attachmentlength);
327 }
328
329 // Send mail using the sendmail command
330 function sendSendmail($t, $c, $b, $subject, $body, $more_headers) {
331 global $sendmail_path, $popuser, $username, $domain;
332
333 // Build envelope sender address. Make sure it doesn't contain
334 // spaces or other "weird" chars that would allow a user to
335 // exploit the shell/pipe it is used in.
336 $envelopefrom = "$popuser@$domain";
337 $envelopefrom = ereg_replace("[[:blank:]]",'', $envelopefrom);
338 $envelopefrom = ereg_replace("[[:space:]]",'', $envelopefrom);
339 $envelopefrom = ereg_replace("[[:cntrl:]]",'', $envelopefrom);
340
341 // open pipe to sendmail or qmail-inject (qmail-inject doesn't accept -t param)
342 if (strstr($sendmail_path, "qmail-inject")) {
343 $fp = popen (escapeshellcmd("$sendmail_path -f$envelopefrom"), "w");
344 } else {
345 $fp = popen (escapeshellcmd("$sendmail_path -t -f$envelopefrom"), "w");
346 }
347
348 $headerlength = write822Header ($fp, $t, $c, $b, $subject, $more_headers);
349 $bodylength = writeBody($fp, $body);
350
351 pclose($fp);
352
353 return ($headerlength + $bodylength);
354 }
355
356 function smtpReadData($smtpConnection) {
357 $read = fgets($smtpConnection, 1024);
358 $counter = 0;
359 while ($read) {
360 echo $read . '<BR>';
361 $data[$counter] = $read;
362 $read = fgets($smtpConnection, 1024);
363 $counter++;
364 }
365 }
366
367 function sendSMTP($t, $c, $b, $subject, $body, $more_headers) {
368 global $username, $popuser, $domain, $version, $smtpServerAddress,
369 $smtpPort, $data_dir, $color, $use_authenticated_smtp, $identity,
370 $key, $onetimepad;
371
372 $to = expandAddrs(parseAddrs($t));
373 $cc = expandAddrs(parseAddrs($c));
374 $bcc = expandAddrs(parseAddrs($b));
375 if (isset($identity) && $identity != 'default')
376 $from_addr = getPref($data_dir, $username, 'email_address' . $identity);
377 else
378 $from_addr = getPref($data_dir, $username, 'email_address');
379
380 if (!$from_addr)
381 $from_addr = "$popuser@$domain";
382
383 $smtpConnection = fsockopen($smtpServerAddress, $smtpPort, $errorNumber, $errorString);
384 if (!$smtpConnection) {
385 echo 'Error connecting to SMTP Server.<br>';
386 echo "$errorNumber : $errorString<br>";
387 exit;
388 }
389 $tmp = fgets($smtpConnection, 1024);
390 if (errorCheck($tmp, $smtpConnection)!=5) return(0);
391
392 $to_list = getLineOfAddrs($to);
393 $cc_list = getLineOfAddrs($cc);
394
395 /** Lets introduce ourselves */
396 if (! isset ($use_authenticated_smtp) || $use_authenticated_smtp == false) {
397 fputs($smtpConnection, "HELO $domain\r\n");
398 $tmp = fgets($smtpConnection, 1024);
399 if (errorCheck($tmp, $smtpConnection)!=5) return(0);
400 } else {
401 fputs($smtpConnection, "EHLO $domain\r\n");
402 $tmp = fgets($smtpConnection, 1024);
403 if (errorCheck($tmp, $smtpConnection)!=5) return(0);
404
405 fputs($smtpConnection, "AUTH LOGIN\r\n");
406 $tmp = fgets($smtpConnection, 1024);
407 if (errorCheck($tmp, $smtpConnection)!=5) return(0);
408
409 fputs($smtpConnection, base64_encode ($username) . "\r\n");
410 $tmp = fgets($smtpConnection, 1024);
411 if (errorCheck($tmp, $smtpConnection)!=5) return(0);
412
413 fputs($smtpConnection, base64_encode (OneTimePadDecrypt($key, $onetimepad)) . "\r\n");
414 $tmp = fgets($smtpConnection, 1024);
415 if (errorCheck($tmp, $smtpConnection)!=5) return(0);
416 }
417
418 /** Ok, who is sending the message? */
419 fputs($smtpConnection, "MAIL FROM: <$from_addr>\r\n");
420 $tmp = fgets($smtpConnection, 1024);
421 if (errorCheck($tmp, $smtpConnection)!=5) return(0);
422
423 /** send who the recipients are */
424 for ($i = 0; $i < count($to); $i++) {
425 fputs($smtpConnection, "RCPT TO: $to[$i]\r\n");
426 $tmp = fgets($smtpConnection, 1024);
427 if (errorCheck($tmp, $smtpConnection)!=5) return(0);
428 }
429 for ($i = 0; $i < count($cc); $i++) {
430 fputs($smtpConnection, "RCPT TO: $cc[$i]\r\n");
431 $tmp = fgets($smtpConnection, 1024);
432 if (errorCheck($tmp, $smtpConnection)!=5) return(0);
433 }
434 for ($i = 0; $i < count($bcc); $i++) {
435 fputs($smtpConnection, "RCPT TO: $bcc[$i]\r\n");
436 $tmp = fgets($smtpConnection, 1024);
437 if (errorCheck($tmp, $smtpConnection)!=5) return(0);
438 }
439
440 /** Lets start sending the actual message */
441 fputs($smtpConnection, "DATA\r\n");
442 $tmp = fgets($smtpConnection, 1024);
443 if (errorCheck($tmp, $smtpConnection)!=5) return(0);
444
445 // Send the message
446 $headerlength = write822Header ($smtpConnection, $t, $c, $b, $subject, $more_headers);
447 $bodylength = writeBody($smtpConnection, $body);
448
449 fputs($smtpConnection, ".\r\n"); // end the DATA part
450 $tmp = fgets($smtpConnection, 1024);
451 $num = errorCheck($tmp, $smtpConnection, true);
452 if ($num != 250) {
453 $tmp = nl2br(htmlspecialchars($tmp));
454 displayPageHeader($color, 'None');
455 include_once('../functions/display_messages.php');
456 $msg = "Message not sent!<br>\nReason given: $tmp";
457 plain_error_message($msg, $color);
458 return(0);
459 }
460
461 fputs($smtpConnection, "QUIT\r\n"); // log off
462
463 fclose($smtpConnection);
464
465 return ($headerlength + $bodylength);
466 }
467
468
469 function errorCheck($line, $smtpConnection, $verbose = false) {
470 global $color;
471
472 // Read new lines on a multiline response
473 $lines = $line;
474 while(ereg("^[0-9]+-", $line)) {
475 $line = fgets($smtpConnection, 1024);
476 $lines .= $line;
477 }
478
479 // Status: 0 = fatal
480 // 5 = ok
481
482 $err_num = substr($line, 0, strpos($line, " "));
483 switch ($err_num) {
484 case 500: $message = 'Syntax error; command not recognized';
485 $status = 0;
486 break;
487 case 501: $message = 'Syntax error in parameters or arguments';
488 $status = 0;
489 break;
490 case 502: $message = 'Command not implemented';
491 $status = 0;
492 break;
493 case 503: $message = 'Bad sequence of commands';
494 $status = 0;
495 break;
496 case 504: $message = 'Command parameter not implemented';
497 $status = 0;
498 break;
499
500
501 case 211: $message = 'System status, or system help reply';
502 $status = 5;
503 break;
504 case 214: $message = 'Help message';
505 $status = 5;
506 break;
507
508
509 case 220: $message = 'Service ready';
510 $status = 5;
511 break;
512 case 221: $message = 'Service closing transmission channel';
513 $status = 5;
514 break;
515 case 421: $message = 'Service not available, closing chanel';
516 $status = 0;
517 break;
518
519 case 235: return(5); break;
520 case 250: $message = 'Requested mail action okay, completed';
521 $status = 5;
522 break;
523 case 251: $message = 'User not local; will forward';
524 $status = 5;
525 break;
526 case 334: return(5); break;
527 case 450: $message = 'Requested mail action not taken: mailbox unavailable';
528 $status = 0;
529 break;
530 case 550: $message = 'Requested action not taken: mailbox unavailable';
531 $status = 0;
532 break;
533 case 451: $message = 'Requested action aborted: error in processing';
534 $status = 0;
535 break;
536 case 551: $message = 'User not local; please try forwarding';
537 $status = 0;
538 break;
539 case 452: $message = 'Requested action not taken: insufficient system storage';
540 $status = 0;
541 break;
542 case 552: $message = 'Requested mail action aborted: exceeding storage allocation';
543 $status = 0;
544 break;
545 case 553: $message = 'Requested action not taken: mailbox name not allowed';
546 $status = 0;
547 break;
548 case 354: $message = 'Start mail input; end with .';
549 $status = 5;
550 break;
551 case 554: $message = 'Transaction failed';
552 $status = 0;
553 break;
554 default: $message = 'Unknown response: '. nl2br(htmlspecialchars($lines));
555 $status = 0;
556 $error_num = '001';
557 break;
558 }
559
560 if ($status == 0) {
561 include_once('../functions/page_header.php');
562 displayPageHeader($color, 'None');
563 include_once('../functions/display_messages.php');
564 $lines = nl2br(htmlspecialchars($lines));
565 $msg = $message . "<br>\nServer replied: $lines";
566 plain_error_message($msg, $color);
567 }
568 if (! $verbose) return $status;
569 return $err_num;
570 }
571
572 function sendMessage($t, $c, $b, $subject, $body, $reply_id, $prio = 3) {
573 global $useSendmail, $msg_id, $is_reply, $mailbox, $onetimepad;
574 global $data_dir, $username, $domain, $key, $version, $sent_folder, $imapServerAddress, $imapPort;
575 global $default_use_priority;
576 global $more_headers;
577 $more_headers = Array();
578
579 do_hook("smtp_send");
580
581 $imap_stream = sqimap_login($username, $key, $imapServerAddress, $imapPort, 1);
582
583 if (isset($reply_id) && $reply_id) {
584 sqimap_mailbox_select ($imap_stream, $mailbox);
585 sqimap_messages_flag ($imap_stream, $reply_id, $reply_id, 'Answered');
586
587 // Insert In-Reply-To and References headers if the
588 // message-id of the message we reply to is set (longer than "<>")
589 // The References header should really be the old Referenced header
590 // with the message ID appended, but it can be only the message ID too.
591 $hdr = sqimap_get_small_header ($imap_stream, $reply_id, false);
592 if(strlen($hdr->message_id) > 2) {
593 $more_headers['In-Reply-To'] = $hdr->message_id;
594 $more_headers['References'] = $hdr->message_id;
595 }
596 }
597 if ($default_use_priority) {
598 $more_headers = array_merge($more_headers, createPriorityHeaders($prio));
599 }
600
601 // In order to remove the problem of users not able to create
602 // messages with "." on a blank line, RFC821 has made provision
603 // in section 4.5.2 (Transparency).
604 $body = ereg_replace("\n\\.", "\n..", $body);
605 $body = ereg_replace("^\\.", "..", $body);
606
607 // this is to catch all plain \n instances and
608 // replace them with \r\n. All newlines were converted
609 // into just \n inside the compose.php file.
610 $body = ereg_replace("\n", "\r\n", $body);
611
612 if ($useSendmail) {
613 $length = sendSendmail($t, $c, $b, $subject, $body, $more_headers);
614 } else {
615 $length = sendSMTP($t, $c, $b, $subject, $body, $more_headers);
616 }
617
618 if (sqimap_mailbox_exists ($imap_stream, $sent_folder)) {
619 sqimap_append ($imap_stream, $sent_folder, $length);
620 write822Header ($imap_stream, $t, $c, $b, $subject, $more_headers);
621 writeBody ($imap_stream, $body);
622 sqimap_append_done ($imap_stream);
623 }
624 sqimap_logout($imap_stream);
625 // Delete the files uploaded for attaching (if any).
626 // only if $length != 0 (if there was no error)
627 if ($length)
628 ClearAttachments();
629
630 return $length;
631 }
632
633 function createPriorityHeaders($prio) {
634 $prio_headers = Array();
635 $prio_headers["X-Priority"] = $prio;
636
637 switch($prio) {
638 case 1: $prio_headers["Importance"] = "High";
639 $prio_headers["X-MSMail-Priority"] = "High";
640 break;
641
642 case 3: $prio_headers["Importance"] = "Normal";
643 $prio_headers["X-MSMail-Priority"] = "Normal";
644 break;
645
646 case 5:
647 $prio_headers["Importance"] = "Low";
648 $prio_headers["X-MSMail-Priority"] = "Low";
649 break;
650 }
651 return $prio_headers;
652 }
653 ?>