functions/mailbox.php

   1 <?
   2    /**
   3     **  mailbox.php
   4     **
   5     **  This contains functions that request information about a mailbox.  Including
   6     **  reading and parsing headers, getting folder information, etc.
   7     **
   8     **/
   9
  10    function selectMailbox($imapConnection, $mailbox, &$numberOfMessages) {
  11       // select mailbox
  12       fputs($imapConnection, "mailboxSelect SELECT \"$mailbox\"\n");
  13       $data = imapReadData($imapConnection, "mailboxSelect");
  14       for ($i = 0; $i < count($data); $i++) {
  15          if (substr(Chop($data[$i]), -6) == "EXISTS") {
  16             $array = explode(" ", $data[$i]);
  17             $numberOfMessages = $array[1];
  18          }
  19       }
  20    }
  21
  22    function unseenMessages($imapConnection, &$numUnseen) {
  23       fputs($imapConnection, "1 SEARCH UNSEEN NOT DELETED\n");
  24       $read = fgets($imapConnection, 1024);
  25       $unseen = false;
  26
  27       if (strlen($read) > 10) {
  28          $unseen = true;
  29          $ary = explode(" ", $read);
  30          $numUnseen = count($ary) - 2;
  31       }
  32       else {
  33          $unseen = false;
  34          $numUnseen = 0;
  35       }
  36
  37       $read = fgets($imapConnection, 1024);
  38       return $unseen;
  39    }
  40
  41    /**  This function sends a request to the IMAP server for headers, 50 at a time
  42     **  until $end is reached.  I originally had it do them all at one time, but found
  43     **  it slightly faster to do it this way.
  44     **
  45     **  Originally we had getMessageHeaders get the headers for one message at a time.
  46     **  Doing it in bunches gave us a speed increase from 9 seconds (for a box of 800
  47     **  messages) to about 3.5 seconds.
  48     **/
  49    function getMessageHeaders($imapConnection, $start, $end, &$from, &$subject, &$date) {
  50       $rel_start = $start;
  51       if (($start > $end) || ($start < 1)) {
  52          echo "Error in message header fetching.  Start message: $start, End message: $end<BR>";
  53          exit;
  54       }
  55
  56       $pos = 0;
  57       while ($rel_start <= $end) {
  58          if ($end - $rel_start > 50) {
  59             $rel_end = $rel_start + 49;
  60          } else {
  61             $rel_end = $end;
  62          }
  63          fputs($imapConnection, "messageFetch FETCH $rel_start:$rel_end RFC822.HEADER.LINES (From Subject Date)\n");
  64          $read = fgets($imapConnection, 1024);
  65
  66          while ((substr($read, 0, 15) != "messageFetch OK") && (substr($read, 0, 16) != "messageFetch BAD")) {
  67
  68             if (substr($read, 0, 5) == "From:") {
  69                $read = encodeEmailAddr("$read");
  70                $from[$pos] = substr($read, 5, strlen($read) - 6);
  71             }
  72             else if (substr($read, 0, 5) == "Date:") {
  73                $read = ereg_replace("<", "&lt;", $read);
  74                $read = ereg_replace(">", "&gt;", $read);
  75                $date[$pos] = substr($read, 5, strlen($read) - 6);
  76             }
  77             else if (substr($read, 0, 8) == "Subject:") {
  78                $read = ereg_replace("<", "&lt;", $read);
  79                $read = ereg_replace(">", "&gt;", $read);
  80                $subject[$pos] = substr($read, 8, strlen($read) - 9);
  81                if (strlen(Chop($subject[$pos])) == 0)
  82                   $subject[$pos] = "(no subject)";
  83             }
  84             else if (substr($read, 0, 1) == ")") {
  85                if ($subject[$pos] == "")
  86                   $subject[$pos] = "(no subject)";
  87                else if ($from[$pos] == "")
  88                   $from[$pos] = "(unknown sender)";
  89                else if ($date[$pos] == "")
  90                   $from[$pos] = gettimeofday();
  91
  92                $pos++;
  93             }
  94
  95             $read = fgets($imapConnection, 1024);
  96          }
  97          $rel_start = $rel_start + 50;
  98       }
  99    }
 100
 101    function encodeEmailAddr($string) {
 102       $string = ereg_replace("<", "EMAILSTART--", $string);
 103       $string = ereg_replace(">", "--EMAILEND", $string);
 104       return $string;
 105    }
 106
 107    function setMessageFlag($imapConnection, $i, $q, $flag) {
 108       fputs($imapConnection, "messageStore STORE $i:$q +FLAGS (\\$flag)\n");
 109    }
 110
 111    /**  This function gets the flags for message $j.  It does only one message at a
 112     **  time, rather than doing groups of messages (like getMessageHeaders does).
 113     **  I found it one or two seconds quicker (on a box of 800 messages) to do it
 114     **  individually.  I'm not sure why it happens like that, but that's what my
 115     **  testing found.  Perhaps later I will be proven wrong and this will change.
 116     **/
 117    function getMessageFlags($imapConnection, $j, &$flags) {
 118       /**   * 2 FETCH (FLAGS (\Answered \Seen))   */
 119       fputs($imapConnection, "messageFetch FETCH $j:$j FLAGS\n");
 120       $read = fgets($imapConnection, 1024);
 121       $count = 0;
 122       while ((substr($read, 0, 15) != "messageFetch OK") && (substr($read, 0, 16) != "messageFetch BAD")) {
 123          if (strpos($read, "FLAGS")) {
 124             $read = ereg_replace("\(", "", $read);
 125             $read = ereg_replace("\)", "", $read);
 126             $read = substr($read, strpos($read, "FLAGS")+6, strlen($read));
 127             $read = trim($read);
 128             $flags = explode(" ", $read);;
 129             $s = 0;
 130             while ($s < count($flags)) {
 131                $flags[$s] = substr($flags[$s], 1, strlen($flags[$s]));
 132                $s++;
 133             }
 134          } else {
 135             $flags[0] = "None";
 136          }
 137          $count++;
 138          $read = fgets($imapConnection, 1024);
 139       }
 140    }
 141
 142    function decodeEmailAddr($sender) {
 143       $emailAddr = getEmailAddr($sender);
 144       if (strpos($emailAddr, "EMAILSTART--")) {
 145
 146          $emailAddr = ereg_replace("EMAILSTART--", "", $emailAddr);
 147          $emailAddr = ereg_replace("--EMAILEND", "", $emailAddr);
 148       } else {
 149          $emailAddr = $emailAddr;
 150       }
 151       return $emailAddr;
 152    }
 153
 154    function getEmailAddr($sender) {
 155       if (strpos($sender, "EMAILSTART--") == false)
 156          return "$sender";
 157
 158       $emailStart = strpos($sender, "EMAILSTART--") + 12;
 159       $emailAddr = substr($sender, $emailStart, strlen($sender));
 160       $emailAddr = substr($emailAddr, 0, strpos($emailAddr, "--EMAILEND"));
 161
 162       return $emailAddr;
 163    }
 164
 165    function getSender($sender) {
 166       if (strpos($sender, "EMAILSTART--") == false)
 167          return "$sender";
 168
 169       $first = substr($sender, 0, strpos($sender, "EMAILSTART--"));
 170       $second = substr($sender, strpos($sender, "--EMAILEND") +10, strlen($sender));
 171       return "$first $second";
 172    }
 173
 174    function getSenderName($sender) {
 175       $name = getSender($sender);
 176       $emailAddr = getEmailAddr($sender);
 177       $emailStart = strpos($emailAddr, "EMAILSTART--");
 178       $emailEnd = strpos($emailAddr, "--EMAILEND") - 10;
 179
 180       if (($emailAddr == "") && ($name == "")) {
 181          $from = $sender;
 182       }
 183       else if ((strstr($name, "?") != false) || (strstr($name, "$") != false) || (strstr($name, "%") != false)){
 184          $emailAddr = ereg_replace("EMAILSTART--", "", $emailAddr);
 185          $emailAddr = ereg_replace("--EMAILEND", "", $emailAddr);
 186          $from = $emailAddr;
 187       }
 188       else if (strlen($name) > 0) {
 189          $from = $name;
 190       }
 191       else if (strlen($emailAddr > 0)) {
 192          $emailAddr = ereg_replace("EMAILSTART--", "", $emailAddr);
 193          $emailAddr = ereg_replace("--EMAILEND", "", $emailAddr);
 194          $from = $emailAddr;
 195       }
 196
 197       $from = trim($from);
 198
 199       // strip out any quotes if they exist
 200       if ((strlen($from) > 0) && ($from[0] == "\"") && ($from[strlen($from) - 1] == "\""))
 201          $from = substr($from, 1, strlen($from) - 2);
 202
 203       return $from;
 204    }
 205
 206    /** returns "true" if the copy was completed successfully.
 207     ** returns "false" with an error message if unsuccessful.
 208     **/
 209    function copyMessages($imapConnection, $from_id, $to_id, $folder) {
 210       fputs($imapConnection, "mailboxStore COPY $from_id:$to_id \"$folder\"\n");
 211       $read = fgets($imapConnection, 1024);
 212       while ((substr($read, 0, 15) != "mailboxStore OK") && (substr($read, 0, 15) != "mailboxStore NO")) {
 213          $read = fgets($imapConnection, 1024);
 214       }
 215
 216       if (substr($read, 0, 15) == "mailboxStore NO") {
 217          return false;
 218       } else if (substr($read, 0, 15) == "mailboxStore OK") {
 219          return true;
 220       }
 221
 222       echo "UNKNOWN ERROR copying messages $from_id to $to_id to folder $folder.<BR>";
 223       return false;
 224    }
 225
 226    /** expunges a mailbox **/
 227    function expungeBox($imapConnection, $mailbox) {
 228       selectMailbox($imapConnection, $mailbox, $num);
 229       fputs($imapConnection, "1 EXPUNGE\n");
 230       imapReadData($imapConnection, "1", true, $response, $message);
 231    }
 232
 233    function getFolderNameMinusINBOX($mailbox, $del) {
 234       $inbox = "INBOX" . $del;
 235       if (substr($mailbox, 0, strlen($inbox)) == $inbox)
 236          $box = substr($mailbox, strlen($inbox), strlen($mailbox));
 237       else
 238          $box = $mailbox;
 239
 240       return $box;
 241    }
 242
 243    /** This function gets all the information about a message.  Including Header and body **/
 244    function fetchMessage($imapConnection, $id, $mailbox) {
 245       $message["INFO"]["ID"] = $id;
 246       $message["INFO"]["MAILBOX"] = $mailbox;
 247       $message["HEADER"] = fetchHeader($imapConnection, $id);
 248       $message["ENTITIES"] = fetchBody($imapConnection, $message["HEADER"]["BOUNDARY"], $id, $message["HEADER"]["TYPE0"], $message["HEADER"]["TYPE1"]);
 249       return $message;
 250    }
 251
 252    function fetchHeader($imapConnection, $id) {
 253       fputs($imapConnection, "messageFetch FETCH $id:$id RFC822.HEADER\n");
 254       $read = fgets($imapConnection, 1024);
 255
 256       /** defaults... if the don't get overwritten, it will display text **/
 257       $header["TYPE0"] = "text";
 258       $header["TYPE1"] = "plain";
 259       $header["ENCODING"] = "us-ascii";
 260       while ((substr($read, 0, 15) != "messageFetch OK") && (substr($read, 0, 16) != "messageFetch BAD")) {
 261          /** MIME-VERSION **/
 262          if (substr($read, 0, 17) == "MIME-Version: 1.0") {
 263             $header["MIME"] = true;
 264             $read = fgets($imapConnection, 1024);
 265          }
 266
 267          /** ENCODING TYPE **/
 268          else if (substr(strtolower($read[$i]), 0, 26) == "content-transfer-encoding:") {
 269             $header["ENCODING"] = strtolower(trim(substr($read[$i], 26)));
 270          }
 271
 272          /** CONTENT-TYPE **/
 273          else if (substr($read, 0, 13) == "Content-Type:") {
 274             $cont = strtolower(trim(substr($read, 13)));
 275             if (strpos($cont, ";"))
 276                $cont = substr($cont, 0, strpos($cont, ";"));
 277
 278             if (strpos($cont, "/")) {
 279                $header["TYPE0"] = substr($cont, 0, strpos($cont, "/"));
 280                $header["TYPE1"] = substr($cont, strpos($cont, "/")+1);
 281             } else {
 282                $header["TYPE0"] = $cont;
 283             }
 284
 285             $line = $read;
 286             $read = fgets($imapConnection, 1024);
 287             while ( (substr(substr($read, 0, strpos($read, " ")), -1) != ":") && (trim($read) != "") && (trim($read) != ")")) {
 288                str_replace("\n", "", $line);
 289                str_replace("\n", "", $read);
 290                $line = "$line $read";
 291                $read = fgets($imapConnection, 1024);
 292             }
 293
 294             /** Detect the boundary of a multipart message **/
 295             if (strpos(strtolower(trim($line)), "boundary=")) {
 296                $pos = strpos($line, "boundary=") + 9;
 297                $bound = trim($line);
 298                if (strpos($line, " ", $pos) > 0) {
 299                   $bound = substr($bound, $pos, strpos($line, " ", $pos));
 300                } else {
 301                   $bound = substr($bound, $pos);
 302                }
 303                $bound = str_replace("\"", "", $bound);
 304                $header["BOUNDARY"] = $bound;
 305             }
 306
 307             /** Detect the charset **/
 308             if (strpos(strtolower(trim($line)), "charset=")) {
 309                $pos = strpos($line, "charset=") + 8;
 310                $charset = trim($line);
 311                if (strpos($line, " ", $pos) > 0) {
 312                   $charset = substr($charset, $pos, strpos($line, " ", $pos));
 313                } else {
 314                   $charset = substr($charset, $pos);
 315                }
 316                $charset = str_replace("\"", "", $charset);
 317                $header["CHARSET"] = $charset;
 318             } else {
 319                $header["CHARSET"] = "us-ascii";
 320             }
 321
 322             /** Detects filename if any **/
 323             if (strpos(strtolower(trim($line)), "name=")) {
 324                $pos = strpos($line, "name=") + 5;
 325                $name = trim($line);
 326                if (strpos($line, " ", $pos) > 0) {
 327                   $name = substr($name, $pos, strpos($line, " ", $pos));
 328                } else {
 329                   $name = substr($name, $pos);
 330                }
 331                $name = str_replace("\"", "", $name);
 332                $header["FILENAME"] = $name;
 333             }
 334          }
 335
 336          /** REPLY-TO **/
 337          else if (strtolower(substr($read, 0, 9)) == "reply-to:") {
 338             $header["REPLYTO"] = trim(substr($read, 9, strlen($read)));
 339             $read = fgets($imapConnection, 1024);
 340          }
 341
 342          /** FROM **/
 343          else if (strtolower(substr($read, 0, 5)) == "from:") {
 344             $header["FROM"] = trim(substr($read, 5, strlen($read) - 6));
 345             if ($header["REPLYTO"] == "")
 346                $header["REPLYTO"] = $header["FROM"];
 347             $read = fgets($imapConnection, 1024);
 348          }
 349          /** DATE **/
 350          else if (strtolower(substr($read, 0, 5)) == "date:") {
 351             $d = substr($read, 5, strlen($read) - 6);
 352             $d = trim($d);
 353             $d = ereg_replace("  ", " ", $d);
 354             $d = explode(" ", $d);
 355             $header["DATE"] = getTimeStamp($d);
 356             $read = fgets($imapConnection, 1024);
 357          }
 358          /** SUBJECT **/
 359          else if (strtolower(substr($read, 0, 8)) == "subject:") {
 360             $header["SUBJECT"] = trim(substr($read, 8, strlen($read) - 9));
 361             if (strlen(Chop($header["SUBJECT"])) == 0)
 362                $header["SUBJECT"] = "(no subject)";
 363             $read = fgets($imapConnection, 1024);
 364          }
 365          /** CC **/
 366          else if (strtolower(substr($read, 0, 3)) == "cc:") {
 367             $pos = 0;
 368             $header["CC"][$pos] = trim(substr($read, 4));
 369             $read = fgets($imapConnection, 1024);
 370             while ((substr($read, 0, 1) == " ") && (trim($read) != "")) {
 371                $pos++;
 372                $header["CC"][$pos] = trim($read);
 373                $read = fgets($imapConnection, 1024);
 374             }
 375          }
 376          /** TO **/
 377          else if (strtolower(substr($read, 0, 3)) == "to:") {
 378             $pos = 0;
 379             $header["TO"][$pos] = trim(substr($read, 4));
 380             $read = fgets($imapConnection, 1024);
 381             while ((substr($read, 0, 1) == " ")  && (trim($read) != "")){
 382                $pos++;
 383                $header["TO"][$pos] = trim($read);
 384                $read = fgets($imapConnection, 1024);
 385             }
 386          }
 387
 388          /** ERROR CORRECTION **/
 389          else if (substr($read, 0, 1) == ")") {
 390             if ($header["SUBJECT"] == "")
 391                 $header["SUBJECT"] = "(no subject)";
 392
 393             if ($header["FROM"] == "")
 394                 $header["FROM"] = "(unknown sender)";
 395
 396             if ($header["DATE"] == "")
 397                 $header["DATE"] = time();
 398             $read = fgets($imapConnection, 1024);
 399          }
 400          else {
 401             $read = fgets($imapConnection, 1024);
 402          }
 403       }
 404       return $header;
 405    }
 406
 407    function fetchBody($imapConnection, $bound, $id, $type0, $type1) {
 408       /** This first part reads in the full body of the message **/
 409       fputs($imapConnection, "messageFetch FETCH $id:$id BODY[TEXT]\n");
 410       $read = fgets($imapConnection, 1024);
 411
 412       $count = 0;
 413       while ((substr($read, 0, 15) != "messageFetch OK") && (substr($read, 0, 16) != "messageFetch BAD")) {
 414          $body[$count] = $read;
 415          $count++;
 416
 417          $read = fgets($imapConnection, 1024);
 418       }
 419
 420       /** this deletes the first line, and the last two (imap stuff we ignore) **/
 421       $i = 0;
 422       $j = 0;
 423       while ($i < count($body)) {
 424          if ( ($i != 0) && ($i != count($body) - 1) && ($i != count($body)) ) {
 425             $bodytmp[$j] = $body[$i];
 426             $j++;
 427          }
 428          $i++;
 429       }
 430       $body = $bodytmp;
 431
 432       /** Now, lets work out the MIME stuff **/
 433       /** (needs mime.php included)         **/
 434       return decodeMime($body, $bound, $type0, $type1);
 435    }
 436
 437    function fetchEntityHeader($imapConnection, &$read, &$type0, &$type1, &$bound, &$encoding, &$charset, &$filename) {
 438       /** defaults... if the don't get overwritten, it will display text **/
 439       $type0 = "text";
 440       $type1 = "plain";
 441       $encoding = "us-ascii";
 442       $i = 0;
 443       while (trim($read[$i]) != "") {
 444          if (substr(strtolower($read[$i]), 0, 26) == "content-transfer-encoding:") {
 445             $encoding = strtolower(trim(substr($read[$i], 26)));
 446
 447          } else if (substr($read[$i], 0, 13) == "Content-Type:") {
 448             $cont = strtolower(trim(substr($read[$i], 13)));
 449             if (strpos($cont, ";"))
 450                $cont = substr($cont, 0, strpos($cont, ";"));
 451
 452             if (strpos($cont, "/")) {
 453                $type0 = substr($cont, 0, strpos($cont, "/"));
 454                $type1 = substr($cont, strpos($cont, "/")+1);
 455             } else {
 456                $type0 = $cont;
 457             }
 458
 459             $read[$i] = trim($read[$i]);
 460             $line = $read[$i];
 461             $i++;
 462             while ( (substr(substr($read[$i], 0, strpos($read[$i], " ")), -1) != ":") && (trim($read[$i]) != "") && (trim($read[$i]) != ")")) {
 463                str_replace("\n", "", $line);
 464                str_replace("\n", "", $read[$i]);
 465                $line = "$line $read[$i]";
 466                $i++;
 467                $read[$i] = trim($read[$i]);
 468             }
 469             $i--;
 470
 471             /** Detect the boundary of a multipart message **/
 472             if (strpos(strtolower(trim($line)), "boundary=")) {
 473                $pos = strpos($line, "boundary=") + 9;
 474                $bound = trim($line);
 475                if (strpos($line, " ", $pos) > 0) {
 476                   $bound = substr($bound, $pos, strpos($line, " ", $pos));
 477                } else {
 478                   $bound = substr($bound, $pos);
 479                }
 480                $bound = str_replace("\"", "", $bound);
 481             }
 482
 483             /** Detect the charset **/
 484             if (strpos(strtolower(trim($line)), "charset=")) {
 485                $pos = strpos($line, "charset=") + 8;
 486                $charset = trim($line);
 487                if (strpos($line, " ", $pos) > 0) {
 488                   $charset = substr($charset, $pos, strpos($line, " ", $pos));
 489                } else {
 490                   $charset = substr($charset, $pos);
 491                }
 492                $charset = str_replace("\"", "", $charset);
 493             }
 494
 495             /** Detects filename if any **/
 496             if (strpos(strtolower(trim($line)), "name=")) {
 497                $pos = strpos($line, "name=") + 5;
 498                $name = trim($line);
 499                if (strpos($line, " ", $pos) > 0) {
 500                   $name = substr($name, $pos, strpos($line, " ", $pos));
 501                } else {
 502                   $name = substr($name, $pos);
 503                }
 504                $name = str_replace("\"", "", $name);
 505                $filename = $name;
 506             }
 507          }
 508          $i++;
 509       }
 510
 511       /** remove the header from the entity **/
 512       $i = 0;
 513       while (trim($read[$i]) != "") {
 514          $i++;
 515       }
 516       $i++;
 517
 518       for ($p = 0; $i < count($read); $p++) {
 519          $entity[$p] = $read[$i];
 520          $i++;
 521       }
 522
 523       $read = $entity;
 524    }
 525
 526 ?>