functions/imap_messages.php

   1 <?
   2    /**
   3     **  imap_messages.php
   4     **
   5     **  This implements functions that manipulate messages
   6     **/
   7
   8    /******************************************************************************
   9     **  Copies specified messages to specified folder
  10     ******************************************************************************/
  11    function sqimap_messages_copy ($imap_stream, $start, $end, $mailbox) {
  12       fputs ($imap_stream, "a001 COPY $start:$end \"$mailbox\"\r\n");
  13       $read = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
  14    }
  15
  16    /******************************************************************************
  17     **  Deletes specified messages and moves them to trash if possible
  18     ******************************************************************************/
  19    function sqimap_messages_delete ($imap_stream, $start, $end, $mailbox) {
  20       global $move_to_trash, $trash_folder, $auto_expunge;
  21
  22       if (($move_to_trash == true) && (sqimap_mailbox_exists($imap_stream, $trash_folder))) {
  23          sqimap_messages_copy ($imap_stream, $start, $end, $trash_folder);
  24          sqimap_messages_flag ($imap_stream, $start, $end, "Deleted");
  25       } else {
  26          sqimap_messages_flag ($imap_stream, $start, $end, "Deleted");
  27       }
  28    }
  29
  30    /******************************************************************************
  31     **  Sets the specified messages with specified flag
  32     ******************************************************************************/
  33    function sqimap_messages_flag ($imap_stream, $start, $end, $flag) {
  34       fputs ($imap_stream, "a001 STORE $start:$end +FLAGS (\\$flag)\r\n");
  35       $read = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
  36
  37    }
  38
  39    /******************************************************************************
  40     **  Returns some general header information -- FROM, DATE, and SUBJECT
  41     ******************************************************************************/
  42    function sqimap_get_small_header ($imap_stream, $id, &$from, &$subject, &$date) {
  43       fputs ($imap_stream, "a001 FETCH $id:$id RFC822.HEADER.LINES (From Subject Date)\r\n");
  44       $read = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
  45
  46       for ($i = 0; $i < count($read); $i++) {
  47          if (strtolower(substr($read[$i], 0, 5)) == "from:") {
  48             $from = sqimap_find_displayable_name(substr($read[$i], 5));
  49          } else if (strtolower(substr($read[$i], 0, 5)) == "date:") {
  50             $date = substr($read[$i], 5);
  51          } else if (strtolower(substr($read[$i], 0, 8)) == "subject:") {
  52             $subject = htmlspecialchars(substr($read[$i], 8));
  53             if (strlen(trim($subject)) == 0)
  54                $subject = _("(no subject)");
  55          }
  56       }
  57    }
  58
  59    /******************************************************************************
  60     **  Returns the flags for the specified messages
  61     ******************************************************************************/
  62    function sqimap_get_flags ($imap_stream, $i) {
  63       fputs ($imap_stream, "a001 FETCH $i:$i FLAGS\r\n");
  64       $read = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
  65       if (strpos($read[0], "FLAGS")) {
  66          $tmp = ereg_replace("\(", "", $read[0]);
  67          $tmp = ereg_replace("\)", "", $tmp);
  68          $tmp = str_replace("\\", "", $tmp);
  69          $tmp = substr($tmp, strpos($tmp, "FLAGS")+6, strlen($tmp));
  70          $tmp = trim($tmp);
  71          $flags = explode(" ", $tmp);
  72       } else {
  73          $flags[0] = "None";
  74       }
  75       return $flags;
  76    }
  77
  78    /******************************************************************************
  79     **  Returns a message array with all the information about a message.  See
  80     **  the documentation folder for more information about this array.
  81     ******************************************************************************/
  82    function sqimap_get_message ($imap_stream, $id, $mailbox) {
  83       $message["INFO"]["ID"] = $id;
  84       $message["INFO"]["MAILBOX"] = $mailbox;
  85       $message["HEADER"] = sqimap_get_message_header($imap_stream, $id);
  86       $message["ENTITIES"] = sqimap_get_message_body($imap_stream, $message["HEADER"]["BOUNDARY"], $id, $message["HEADER"]["TYPE0"], $message["HEADER"]["TYPE1"], $message["HEADER"]["ENCODING"], $message["HEADER"]["CHARSET"]);
  87       return $message;
  88    }
  89
  90    /******************************************************************************
  91     **  Wrapper function that reformats the header information.
  92     ******************************************************************************/
  93    function sqimap_get_message_header ($imap_stream, $id) {
  94       fputs ($imap_stream, "a001 FETCH $id:$id BODY[HEADER]\r\n");
  95       $read = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
  96
  97       return sqimap_get_header($imap_stream, $read);
  98    }
  99
 100    /******************************************************************************
 101     **  Wrapper function that returns entity headers for use by decodeMime
 102     ******************************************************************************/
 103    function sqimap_get_entity_header ($imap_stream, &$read, &$type0, &$type1, &$bound, &$encoding, &$charset, &$filename) {
 104       $header = sqimap_get_header($imap_stream, $read);
 105       $type0 = $header["TYPE0"];
 106       $type1 = $header["TYPE1"];
 107       $bound = $header["BOUNDARY"];
 108       $encoding = $header["ENCODING"];
 109       $charset = $header["CHARSET"];
 110       $filename = $header["FILENAME"];
 111    }
 112
 113    /******************************************************************************
 114     **  Queries the IMAP server and gets all header information.
 115     ******************************************************************************/
 116    function sqimap_get_header ($imap_stream, $read) {
 117       $i = 0;
 118       // Set up some defaults
 119       $header["TYPE0"] = "text";
 120       $header["TYPE1"] = "plain";
 121       $header["CHARSET"] = "us-ascii";
 122
 123       while ($i < count($read)) {
 124          if (substr($read[$i], 0, 17) == "MIME-Version: 1.0") {
 125             $header["MIME"] = true;
 126             $i++;
 127          }
 128
 129          /** ENCODING TYPE **/
 130          else if (substr(strtolower($read[$i]), 0, 26) == "content-transfer-encoding:") {
 131             $header["ENCODING"] = strtolower(trim(substr($read[$i], 26)));
 132             $i++;
 133          }
 134
 135          /** CONTENT-TYPE **/
 136          else if (strtolower(substr($read[$i], 0, 13)) == "content-type:") {
 137             $cont = strtolower(trim(substr($read[$i], 13)));
 138             if (strpos($cont, ";"))
 139                $cont = substr($cont, 0, strpos($cont, ";"));
 140
 141
 142             if (strpos($cont, "/")) {
 143                $header["TYPE0"] = substr($cont, 0, strpos($cont, "/"));
 144                $header["TYPE1"] = substr($cont, strpos($cont, "/")+1);
 145             } else {
 146                $header["TYPE0"] = $cont;
 147             }
 148
 149
 150             $line = $read[$i];
 151             $i++;
 152             while ( (substr(substr($read[$i], 0, strpos($read[$i], " ")), -1) != ":") && (trim($read[$i]) != "") && (trim($read[$i]) != ")")) {
 153                str_replace("\n", "", $line);
 154                str_replace("\n", "", $read[$i]);
 155                $line = "$line $read[$i]";
 156                $i++;
 157             }
 158
 159             /** Detect the boundary of a multipart message **/
 160             if (strpos(strtolower(trim($line)), "boundary=")) {
 161                $pos = strpos(strtolower($line), "boundary=") + 9;
 162                $bound = trim($line);
 163                if (strpos($line, " ", $pos) > 0) {
 164                   $bound = substr($bound, $pos, strpos($line, " ", $pos));
 165                } else {
 166                   $bound = substr($bound, $pos);
 167                }
 168                $bound = str_replace("\"", "", $bound);
 169                $header["BOUNDARY"] = $bound;
 170             }
 171
 172             /** Detect the charset **/
 173             if (strpos(strtolower(trim($line)), "charset=")) {
 174                $pos = strpos($line, "charset=") + 8;
 175                $charset = trim($line);
 176                if (strpos($line, " ", $pos) > 0) {
 177                   $charset = substr($charset, $pos, strpos($line, " ", $pos));
 178                } else {
 179                   $charset = substr($charset, $pos);
 180                }
 181                $charset = str_replace("\"", "", $charset);
 182                $header["CHARSET"] = $charset;
 183             } else {
 184                $header["CHARSET"] = "us-ascii";
 185             }
 186
 187          }
 188
 189          else if (strtolower(substr($read[$i], 0, 20)) == "content-disposition:") {
 190             /** Add better dontent-disposition support **/
 191
 192             $line = $read[$i];
 193             $i++;
 194             while ( (substr(substr($read[$i], 0, strpos($read[$i], " ")), -1) != ":") && (trim($read[$i]) != "") && (trim($read[$i]) != ")")) {
 195                str_replace("\n", "", $line);
 196                str_replace("\n", "", $read[$i]);
 197                $line = "$line $read[$i]";
 198                $i++;
 199             }
 200
 201             /** Detects filename if any **/
 202             if (strpos(strtolower(trim($line)), "filename=")) {
 203                $pos = strpos($line, "filename=") + 9;
 204                $name = trim($line);
 205                if (strpos($line, " ", $pos) > 0) {
 206                   $name = substr($name, $pos, strpos($line, " ", $pos));
 207                } else {
 208                   $name = substr($name, $pos);
 209                }
 210                $name = str_replace("\"", "", $name);
 211                $header["FILENAME"] = $name;
 212             }
 213          }
 214
 215          /** REPLY-TO **/
 216          else if (strtolower(substr($read[$i], 0, 9)) == "reply-to:") {
 217             $header["REPLYTO"] = trim(substr($read[$i], 9, strlen($read[$i])));
 218             $i++;
 219          }
 220
 221          /** FROM **/
 222          else if (strtolower(substr($read[$i], 0, 5)) == "from:") {
 223             $header["FROM"] = trim(substr($read[$i], 5, strlen($read[$i]) - 6));
 224             if ($header["REPLYTO"] == "")
 225                $header["REPLYTO"] = $header["FROM"];
 226             $i++;
 227          }
 228          /** DATE **/
 229          else if (strtolower(substr($read[$i], 0, 5)) == "date:") {
 230             $d = substr($read[$i], 5);
 231             $d = trim($d);
 232             $d = ereg_replace("  ", " ", $d);
 233             $d = explode(" ", $d);
 234             $header["DATE"] = getTimeStamp($d);
 235             $i++;
 236          }
 237          /** SUBJECT **/
 238          else if (strtolower(substr($read[$i], 0, 8)) == "subject:") {
 239             $header["SUBJECT"] = trim(substr($read[$i], 8, strlen($read[$i]) - 9));
 240             if (strlen(Chop($header["SUBJECT"])) == 0)
 241                $header["SUBJECT"] = _("(no subject)");
 242             $i++;
 243          }
 244          /** CC **/
 245          else if (strtolower(substr($read[$i], 0, 3)) == "cc:") {
 246             $pos = 0;
 247             $header["CC"][$pos] = trim(substr($read[$i], 4));
 248             $i++;
 249             while ((substr($read[$i], 0, 1) == " ") && (trim($read[$i]) != "")) {
 250                $pos++;
 251                $header["CC"][$pos] = trim($read[$i]);
 252                $i++;
 253             }
 254          }
 255          /** TO **/
 256          else if (strtolower(substr($read[$i], 0, 3)) == "to:") {
 257             $pos = 0;
 258             $header["TO"][$pos] = trim(substr($read[$i], 4));
 259             $i++;
 260             while ((substr($read[$i], 0, 1) == " ")  && (trim($read[$i]) != "")){
 261                $pos++;
 262                $header["TO"][$pos] = trim($read[$i]);
 263                $i++;
 264             }
 265          }
 266          /** MESSAGE ID **/
 267          else if (strtolower(substr($read[$i], 0, 11)) == "message-id:") {
 268             $header["MESSAGE-ID"] = trim(substr($read[$i], 11));
 269             $i++;
 270          }
 271
 272
 273          /** ERROR CORRECTION **/
 274          else if (substr($read[$i], 0, 1) == ")") {
 275             if ($header["SUBJECT"] == "")
 276                 $header["SUBJECT"] = _("(no subject)");
 277
 278             if ($header["FROM"] == "")
 279                 $header["FROM"] = _("(unknown sender)");
 280
 281             if ($header["DATE"] == "")
 282                 $header["DATE"] = time();
 283             $i++;
 284          }
 285          else {
 286             $i++;
 287          }
 288       }
 289       return $header;
 290    }
 291
 292
 293    /******************************************************************************
 294     **  Returns the body of a message.
 295     ******************************************************************************/
 296    function sqimap_get_message_body ($imap_stream, $bound, $id, $type0, $type1, $encoding, $charset) {
 297       fputs ($imap_stream, "a001 FETCH $id:$id BODY[TEXT]\r\n");
 298       $read = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
 299
 300       $i = 0;
 301       $j = 0;
 302       while ($i < count($read)-1) {
 303          if ( ($i != 0) ) {
 304             $bodytmp[$j] = $read[$i];
 305             $j++;
 306          }
 307          $i++;
 308       }
 309       $body = $bodytmp;
 310
 311       return decodeMime($body, $bound, $type0, $type1, $encoding, $charset);
 312    }
 313 ?>