functions/imap_mailbox.php

   1 <?php
   2    /**
   3     **  imap_mailbox.php
   4     **
   5     **  This impliments all functions that manipulate mailboxes
   6     **/
   7
   8    /******************************************************************************
   9     **  Expunges a mailbox
  10     ******************************************************************************/
  11    function sqimap_mailbox_expunge ($imap_stream, $mailbox) {
  12       sqimap_mailbox_select ($imap_stream, $mailbox);
  13       fputs ($imap_stream, "a001 EXPUNGE\r\n");
  14       $read = sqimap_read_data($imap_stream, "a001", true, $response, $message);
  15    }
  16
  17
  18    /******************************************************************************
  19     **  Checks whether or not the specified mailbox exists
  20     ******************************************************************************/
  21    function sqimap_mailbox_exists ($imap_stream, $mailbox) {
  22       $boxes = sqimap_mailbox_list ($imap_stream);
  23       $found = false;
  24       for ($i = 0; $i < count ($boxes); $i++) {
  25          if ($boxes[$i]["unformatted"] == $mailbox)
  26             $found = true;
  27       }
  28       return $found;
  29    }
  30
  31
  32
  33    /******************************************************************************
  34     **  Selects a mailbox
  35     ******************************************************************************/
  36    function sqimap_mailbox_select ($imap_stream, $mailbox) {
  37       fputs ($imap_stream, "a001 SELECT \"$mailbox\"\r\n");
  38       $read = sqimap_read_data($imap_stream, "a001", true, $response, $message);
  39    }
  40
  41
  42
  43    /******************************************************************************
  44     **  Creates a folder
  45     ******************************************************************************/
  46    function sqimap_mailbox_create ($imap_stream, $mailbox, $type) {
  47       if (strtolower($type) == "noselect") {
  48          $dm = sqimap_get_delimiter($imap_stream);
  49          $mailbox = $mailbox.$dm;
  50       }
  51       fputs ($imap_stream, "a001 CREATE \"$mailbox\"\r\n");
  52       $read_ary = sqimap_read_data($imap_stream, "a001", true, $response, $message);
  53
  54       sqimap_subscribe ($imap_stream, $mailbox);
  55    }
  56
  57
  58
  59    /******************************************************************************
  60     **  Subscribes to an existing folder
  61     ******************************************************************************/
  62    function sqimap_subscribe ($imap_stream, $mailbox) {
  63       fputs ($imap_stream, "a001 SUBSCRIBE \"$mailbox\"\r\n");
  64       $read_ary = sqimap_read_data($imap_stream, "a001", true, $response, $message);
  65    }
  66
  67
  68
  69
  70    /******************************************************************************
  71     **  Unsubscribes to an existing folder
  72     ******************************************************************************/
  73    function sqimap_unsubscribe ($imap_stream, $mailbox) {
  74       fputs ($imap_stream, "a001 UNSUBSCRIBE \"$mailbox\"\r\n");
  75       $read_ary = sqimap_read_data($imap_stream, "a001", true, $response, $message);
  76    }
  77
  78
  79
  80
  81    /******************************************************************************
  82     **  This function simply deletes the given folder
  83     ******************************************************************************/
  84    function sqimap_mailbox_delete ($imap_stream, $mailbox) {
  85       fputs ($imap_stream, "a001 DELETE \"$mailbox\"\r\n");
  86       $read_ary = sqimap_read_data($imap_stream, "a001", true, $response, $message);
  87       sqimap_unsubscribe ($imap_stream, $mailbox);
  88    }
  89
  90
  91    /******************************************************************************
  92     **  Formats a mailbox into 4 parts for the $boxes array
  93     ******************************************************************************/
  94    function sqimap_mailbox_parse ($line, $dm) {
  95       for ($g=0; $g < count($line); $g++) {
  96          $boxes[$g]["raw"] = $line[$g];
  97
  98          $mailbox = find_mailbox_name($line[$g]);
  99          $dm_count = countCharInString($mailbox, $dm);
 100          if (substr($mailbox, -1) == $dm)
 101             $dm_count--;
 102
 103          for ($j = 0; $j < $dm_count; $j++)
 104             $boxes[$g]["formatted"] = $boxes[$g]["formatted"] . "  ";
 105          $boxes[$g]["formatted"] .= readShortMailboxName($mailbox, $dm);
 106
 107          $boxes[$g]["unformatted-dm"] = $mailbox;
 108          if (substr($mailbox, -1) == $dm)
 109             $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
 110          $boxes[$g]["unformatted"] = $mailbox;
 111          $boxes[$g]["id"] = $g;
 112
 113          $flags = substr($line[$g], strpos($line[$g], "(")+1);
 114          $flags = substr($flags, 0, strpos($flags, ")"));
 115          $flags = str_replace("\\", "", $flags);
 116          $flags = trim(strtolower($flags));
 117          if ($flags) {
 118             $boxes[$g]["flags"] = explode(" ", $flags);
 119          }
 120
 121       }
 122       return $boxes;
 123    }
 124
 125    /******************************************************************************
 126     **  Returns sorted mailbox lists in several different ways.
 127     **  The array returned looks like this:
 128     ******************************************************************************/
 129    function sqimap_mailbox_list ($imap_stream) {
 130       global $load_prefs_php, $prefs_php, $config_php, $data_dir, $username;
 131
 132       $inbox_in_list = false;
 133       $inbox_subscribed = false;
 134
 135       if (!isset($load_prefs_php)) include "../src/load_prefs.php";
 136       else global $folder_prefix;
 137       if (!function_exists ("ary_sort")) include "../functions/array.php";
 138
 139       $dm = sqimap_get_delimiter ($imap_stream);
 140
 141       /** LIST array **/
 142       fputs ($imap_stream, "a001 LIST \"\" \"$folder_prefix*\"\r\n");
 143       $list_ary = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
 144       for ($i=0;$i < count($list_ary); $i++) {
 145          $sorted_list_ary[$i]["name"] = find_mailbox_name($list_ary[$i]);
 146          $sorted_list_ary[$i]["raw"]  = $list_ary[$i];
 147          if ($sorted_list_ary[$i]["name"] == "INBOX")
 148             $inbox_in_list = true;
 149       }
 150       if (isset($sorted_list_ary)) {
 151          $list_sorted = array_cleave ($sorted_list_ary, "name");
 152          asort($list_sorted);
 153       }
 154
 155
 156       /** LSUB array **/
 157       $inbox_subscribed = false;
 158       fputs ($imap_stream, "a001 LSUB \"\" \"*\"\r\n");
 159       $lsub_ary = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
 160       for ($i=0;$i < count($lsub_ary); $i++) {
 161          $sorted_lsub_ary[$i] = find_mailbox_name($lsub_ary[$i]);
 162          if (substr($sorted_lsub_ary[$i], -1) == $dm)
 163             $sorted_lsub_ary[$i] = substr($sorted_lsub_ary[$i], 0, strlen($sorted_lsub_ary[$i])-1);
 164          if ($sorted_lsub_ary[$i] == "INBOX")
 165             $inbox_subscribed = true;
 166       }
 167       if (isset($sorted_lsub_ary)) {
 168          sort($sorted_lsub_ary);
 169       }
 170
 171
 172       /** Just in case they're not subscribed to their inbox, we'll get it for them anyway **/
 173       if ($inbox_subscribed == false || $inbox_in_list == false) {
 174          fputs ($imap_stream, "a001 LIST \"\" \"INBOX\"\r\n");
 175          $inbox_ary = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
 176          $merged[0] = $inbox_ary[0];
 177          $k = 1;
 178       } else {
 179          $k = 0;
 180       }
 181
 182       $i = $j = 0;
 183
 184       if (isset($list_sorted) && isset($sorted_lsub_ary)) {
 185               reset ($list_sorted);
 186               for (reset($list_sorted); $key = key($list_sorted), isset($key);) {
 187                  if ($sorted_lsub_ary[$i] == $list_sorted[$key]) {
 188                     $merged[$k] = $sorted_list_ary[$key]["raw"];
 189                     $k++;
 190                     $i++;
 191                     next($list_sorted);
 192                  } else if ($sorted_lsub_ary[$i] < $list_sorted[$key]) {
 193                     $i++;
 194                  } else {
 195                     next($list_sorted);
 196                  }
 197               }
 198       }
 199
 200       return sqimap_mailbox_parse ($merged, $dm);
 201    }
 202
 203 /*
 204       $original = $boxes;
 205
 206       for ($i = 0; $i < count($original); $i++) {
 207          $boxes[$i]["unformatted"] = strtolower($boxes[$i]["unformatted"]);
 208       }
 209
 210       $boxes = ary_sort($boxes, "unformatted", 1);
 211
 212       for ($i = 0; $i < count($boxes); $i++) {
 213          for ($j = 0; $j < count($original); $j++) {
 214             if ($boxes[$i]["id"] == $original[$j]["id"]) {
 215                $boxes[$i] = $original[$j];
 216             }
 217          }
 218       }
 219
 220
 221       for ($i = 0; $i < count($boxes); $i++) {
 222          if ($boxes[$i]["unformatted"] == $special_folders[0]) {
 223             $boxesnew[0] = $boxes[$i];
 224             $boxes[$i]["used"] = true;
 225          }
 226       }
 227
 228       if ($list_special_folders_first == true) {
 229          for ($i = 0; $i < count($boxes); $i++) {
 230             for ($j = 1; $j < count($special_folders); $j++) {
 231                if (substr($boxes[$i]["unformatted"], 0, strlen($special_folders[$j])) == $special_folders[$j]) {
 232                   $pos = count($boxesnew);
 233                   $boxesnew[$pos] = $boxes[$i];
 234                   $boxes[$i]["used"] = true;
 235                }
 236             }
 237          }
 238       }
 239
 240       for ($i = 0; $i < count($boxes); $i++) {
 241          if (($boxes[$i]["unformatted"] != $special_folders[0]) &&
 242              ($boxes[$i]["used"] == false))  {
 243             $pos = count($boxesnew);
 244             $boxesnew[$pos] = $boxes[$i];
 245             $boxes[$i]["used"] = true;
 246          }
 247       }
 248
 249       return $boxesnew;
 250    }
 251    */
 252
 253    /******************************************************************************
 254     **  Returns a list of all folders, subscribed or not
 255     ******************************************************************************/
 256    function sqimap_mailbox_list_all ($imap_stream) {
 257       global $special_folders, $list_special_folders_first, $folder_prefix;
 258
 259       if (!function_exists ("ary_sort"))
 260          include ("../functions/array.php");
 261
 262       $dm = sqimap_get_delimiter ($imap_stream);
 263
 264       fputs ($imap_stream, "a001 LIST \"$folder_prefix\" *\r\n");
 265       $read_ary = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
 266       $g = 0;
 267       $phase = "inbox";
 268       for ($i = 0; $i < count($read_ary); $i++) {
 269          if (substr ($read_ary[$i], 0, 4) != "a001") {
 270             $boxes[$g]["raw"] = $read_ary[$i];
 271
 272             $mailbox = find_mailbox_name($read_ary[$i]);
 273             $dm_count = countCharInString($mailbox, $dm);
 274             if (substr($mailbox, -1) == $dm)
 275                $dm_count--;
 276
 277             for ($j = 0; $j < $dm_count; $j++)
 278                $boxes[$g]["formatted"] = $boxes[$g]["formatted"] . "  ";
 279             $boxes[$g]["formatted"] .= readShortMailboxName($mailbox, $dm);
 280
 281             $boxes[$g]["unformatted-dm"] = $mailbox;
 282             if (substr($mailbox, -1) == $dm)
 283                $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
 284             $boxes[$g]["unformatted"] = $mailbox;
 285             $boxes[$g]["id"] = $g;
 286
 287             /** Now lets get the flags for this mailbox **/
 288             fputs ($imap_stream, "a002 LIST \"\" \"$mailbox\"\r\n");
 289             $read_mlbx = sqimap_read_data ($imap_stream, "a002", true, $response, $message);
 290
 291             $flags = substr($read_mlbx[0], strpos($read_mlbx[0], "(")+1);
 292             $flags = substr($flags, 0, strpos($flags, ")"));
 293             $flags = str_replace("\\", "", $flags);
 294             $flags = trim(strtolower($flags));
 295             if ($flags) {
 296                $boxes[$g]["flags"] = explode(" ", $flags);
 297             }
 298          }
 299          $g++;
 300       }
 301       $boxes = ary_sort ($boxes, "unformatted", 1);
 302       return $boxes;
 303    }
 304
 305 ?>