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