functions/imap_mailbox.php

   1 <?php
   2    /**
   3     **  imap_mailbox.php
   4     **
   5     **  This impliments all functions that manipulate mailboxes
   6     **
   7     **  $Id$
   8     **/
   9
  10    if (defined ('imap_mailbox_php'))
  11       return;
  12    define ('imap_mailbox_php', true);
  13
  14    /******************************************************************************
  15     **  Expunges a mailbox
  16     ******************************************************************************/
  17    function sqimap_mailbox_expunge ($imap_stream, $mailbox,$handle_errors = true) {
  18       fputs ($imap_stream, "a001 EXPUNGE\r\n");
  19       $read = sqimap_read_data($imap_stream, "a001", $handle_errors, $response, $message);
  20    }
  21
  22
  23    /******************************************************************************
  24     **  Checks whether or not the specified mailbox exists
  25     ******************************************************************************/
  26    function sqimap_mailbox_exists ($imap_stream, $mailbox) {
  27       if (! isset($mailbox))
  28           return false;
  29       fputs ($imap_stream, "a001 LIST \"\" \"$mailbox\"\r\n");
  30       $mbx = sqimap_read_data($imap_stream, "a001", true, $response, $message);
  31       return isset($mbx[0]);
  32    }
  33
  34    /******************************************************************************
  35     **  Selects a mailbox
  36     ******************************************************************************/
  37    function sqimap_mailbox_select ($imap_stream, $mailbox, $hide=true, $recent=false) {
  38       global $auto_expunge;
  39
  40       fputs ($imap_stream, "a001 SELECT \"$mailbox\"\r\n");
  41              $read = sqimap_read_data($imap_stream, "a001", true, $response, $message);
  42       if ($recent) {
  43          for ($i=0; $i<count($read); $i++) {
  44             if (strpos(strtolower($read[$i]), "recent")) {
  45                $r = explode(" ", $read[$i]);
  46             }
  47          }
  48          return $r[1];
  49       }
  50       if ($auto_expunge) {
  51          fputs ($imap_stream, "a001 EXPUNGE\r\n");
  52          $tmp = sqimap_read_data($imap_stream, "a001", false, $a, $b);
  53       }
  54    }
  55
  56
  57
  58    /******************************************************************************
  59     **  Creates a folder
  60     ******************************************************************************/
  61    function sqimap_mailbox_create ($imap_stream, $mailbox, $type) {
  62       if (strtolower($type) == "noselect") {
  63          $dm = sqimap_get_delimiter($imap_stream);
  64          $mailbox = $mailbox.$dm;
  65       }
  66       fputs ($imap_stream, "a001 CREATE \"$mailbox\"\r\n");
  67       $read_ary = sqimap_read_data($imap_stream, "a001", true, $response, $message);
  68
  69       sqimap_subscribe ($imap_stream, $mailbox);
  70    }
  71
  72
  73
  74    /******************************************************************************
  75     **  Subscribes to an existing folder
  76     ******************************************************************************/
  77    function sqimap_subscribe ($imap_stream, $mailbox) {
  78       fputs ($imap_stream, "a001 SUBSCRIBE \"$mailbox\"\r\n");
  79       $read_ary = sqimap_read_data($imap_stream, "a001", true, $response, $message);
  80    }
  81
  82
  83
  84
  85    /******************************************************************************
  86     **  Unsubscribes to an existing folder
  87     ******************************************************************************/
  88    function sqimap_unsubscribe ($imap_stream, $mailbox) {
  89                 global $imap_server_type;
  90
  91       fputs ($imap_stream, "a001 UNSUBSCRIBE \"$mailbox\"\r\n");
  92       $read_ary = sqimap_read_data($imap_stream, "a001", true, $response, $message);
  93    }
  94
  95
  96
  97
  98    /******************************************************************************
  99     **  This function simply deletes the given folder
 100     ******************************************************************************/
 101    function sqimap_mailbox_delete ($imap_stream, $mailbox) {
 102       fputs ($imap_stream, "a001 DELETE \"$mailbox\"\r\n");
 103       $read_ary = sqimap_read_data($imap_stream, "a001", true, $response, $message);
 104       sqimap_unsubscribe ($imap_stream, $mailbox);
 105    }
 106
 107    /***********************************************************************
 108     ** Determines if the user is subscribed to the folder or not
 109     **********************************************************************/
 110    function sqimap_mailbox_is_subscribed($imap_stream, $folder) {
 111        $boxes = sqimap_mailbox_list ($imap_stream);
 112        foreach ($boxes as $ref) {
 113           if ($ref['unformatted'] == $folder)
 114              return true;
 115        }
 116        return false;
 117    }
 118
 119
 120
 121    /******************************************************************************
 122     **  Formats a mailbox into 4 parts for the $boxes array
 123     **
 124     **  The four parts are:
 125     **
 126     **    raw            - Raw LIST/LSUB response from the IMAP server
 127     **    formatted      - nicely formatted folder name
 128     **    unformatted    - unformatted, but with delimiter at end removed
 129     **    unformatted-dm - folder name as it appears in raw response
 130     **    unformatted-disp - unformatted without $folder_prefix
 131     **
 132     ******************************************************************************/
 133    function sqimap_mailbox_parse ($line, $line_lsub, $dm) {
 134       global $folder_prefix;
 135
 136       // Process each folder line
 137       for ($g=0; $g < count($line); $g++) {
 138
 139          // Store the raw IMAP reply
 140          if (isset($line[$g]))
 141             $boxes[$g]["raw"] = $line[$g];
 142          else
 143             $boxes[$g]["raw"] = "";
 144
 145
 146          // Count number of delimiters ($dm) in folder name
 147          $mailbox = trim($line_lsub[$g]);
 148          $dm_count = countCharInString($mailbox, $dm);
 149          if (substr($mailbox, -1) == $dm)
 150             $dm_count--;  // If name ends in delimiter - decrement count by one
 151
 152          // Format folder name, but only if it's a INBOX.* or have
 153          // a parent.
 154          $boxesbyname[$mailbox] = $g;
 155          $parentfolder = readMailboxParent($mailbox, $dm);
 156          if((strtolower(substr($mailbox, 0, 5)) == "inbox") ||
 157             (substr($mailbox, 0, strlen($folder_prefix)) == $folder_prefix) ||
 158             (isset($boxesbyname[$parentfolder]) && (strlen($parentfolder) > 0) ) ) {
 159             $indent = $dm_count - (countCharInString($folder_prefix, $dm));
 160             if ($indent > 0)
 161                 $boxes[$g]["formatted"]  = str_repeat("&nbsp;&nbsp;", $indent);
 162             else
 163                 $boxes[$g]["formatted"] = '';
 164             $boxes[$g]["formatted"] .= readShortMailboxName($mailbox, $dm);
 165          } else {
 166             $boxes[$g]["formatted"]  = $mailbox;
 167          }
 168
 169          $boxes[$g]['unformatted-dm'] = $mailbox;
 170          if (substr($mailbox, -1) == $dm)
 171             $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
 172          $boxes[$g]['unformatted'] = $mailbox;
 173          if (substr($mailbox,0,strlen($folder_prefix))==$folder_prefix)
 174             $mailbox = substr($mailbox, strlen($folder_prefix));
 175          $boxes[$g]['unformatted-disp'] = $mailbox;
 176          $boxes[$g]['id'] = $g;
 177
 178          $boxes[$g]['flags'] = array();
 179          if (isset($line[$g])) {
 180             ereg("\(([^)]*)\)",$line[$g],$regs);
 181             $flags = trim(strtolower(str_replace('\\', '',$regs[1])));
 182             if ($flags)
 183                $boxes[$g]['flags'] = explode(' ', $flags);
 184          }
 185       }
 186
 187       return $boxes;
 188    }
 189
 190    /* Apparently you must call a user function with usort instead
 191     * of calling a built-in directly.  Stupid.
 192     * Patch from dave_michmerhuizen@yahoo.com
 193     * Allows case insensitivity when sorting folders
 194     */
 195    function user_strcasecmp($a, $b)
 196    {
 197        return strcasecmp($a, $b);
 198    }
 199
 200
 201    /******************************************************************************
 202     **  Returns sorted mailbox lists in several different ways.
 203     **  See comment on sqimap_mailbox_parse() for info about the returned array.
 204     ******************************************************************************/
 205    function sqimap_mailbox_list ($imap_stream) {
 206       global $data_dir, $username, $list_special_folders_first;
 207       global $trash_folder, $sent_folder;
 208       global $move_to_trash, $move_to_sent, $folder_prefix;
 209
 210       $inbox_in_list = false;
 211       $inbox_subscribed = false;
 212
 213       include "../src/load_prefs.php";
 214       include "../functions/array.php";
 215
 216       $dm = sqimap_get_delimiter ($imap_stream);
 217
 218       /** LSUB array **/
 219       fputs ($imap_stream, "a001 LSUB \"$folder_prefix\" \"*\"\r\n");
 220       $lsub_ary = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
 221
 222       // Section about removing the last element was removed
 223       // We don't return "* OK" anymore from sqimap_read_data
 224
 225       $sorted_lsub_ary = array();
 226       for ($i=0;$i < count($lsub_ary); $i++) {
 227          // Workaround for EIMS
 228          // Doesn't work if the mailbox name is multiple lines
 229          if (isset($lsub_ary[$i + 1]) &&
 230              ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
 231                   $lsub_ary[$i], $regs)) {
 232             $i ++;
 233             $lsub_ary[$i] = $regs[1] . '"' . addslashes(trim($lsub_ary[$i])) .
 234                '"' . $regs[2];
 235          }
 236          $temp_mailbox_name = find_mailbox_name($lsub_ary[$i]);
 237          $sorted_lsub_ary[] = $temp_mailbox_name;
 238          if (strtoupper($temp_mailbox_name) == 'INBOX')
 239             $inbox_subscribed = true;
 240       }
 241       $new_ary = array();
 242       for ($i=0; $i < count($sorted_lsub_ary); $i++) {
 243          if (!in_array($sorted_lsub_ary[$i], $new_ary)) {
 244             $new_ary[] = $sorted_lsub_ary[$i];
 245          }
 246       }
 247       $sorted_lsub_ary = $new_ary;
 248       if (isset($sorted_lsub_ary)) {
 249          usort($sorted_lsub_ary, 'user_strcasecmp');
 250          //sort($sorted_lsub_ary);
 251       }
 252
 253       /** LIST array **/
 254       $sorted_list_ary = array();
 255       for ($i=0; $i < count($sorted_lsub_ary); $i++) {
 256          if (substr($sorted_lsub_ary[$i], -1) == $dm)
 257             $mbx = substr($sorted_lsub_ary[$i], 0, strlen($sorted_lsub_ary[$i])-1);
 258          else
 259             $mbx = $sorted_lsub_ary[$i];
 260
 261          fputs ($imap_stream, "a001 LIST \"\" \"$mbx\"\r\n");
 262          $read = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
 263          // Another workaround for EIMS
 264          if (isset($read[1]) &&
 265              ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
 266                   $read[0], $regs)) {
 267             $read[0] = $regs[1] . '"' . addslashes(trim($read[1])) .
 268                '"' . $regs[2];
 269          }
 270          if (isset($sorted_list_ary[$i]))
 271             $sorted_list_ary[$i] = "";
 272          if (isset($read[0]))
 273             $sorted_list_ary[$i] = $read[0];
 274          else
 275             $sorted_list_ary[$i] = "";
 276          if (isset($sorted_list_ary[$i]) &&
 277              strtoupper(find_mailbox_name($sorted_list_ary[$i])) == "INBOX")
 278             $inbox_in_list = true;
 279       }
 280
 281       /** Just in case they're not subscribed to their inbox, we'll get it
 282           for them anyway **/
 283       if ($inbox_subscribed == false || $inbox_in_list == false) {
 284          fputs ($imap_stream, "a001 LIST \"\" \"INBOX\"\r\n");
 285          $inbox_ary = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
 286          // Another workaround for EIMS
 287          if (isset($inbox_ary[1]) &&
 288              ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
 289                   $inbox_ary[0], $regs)) {
 290             $inbox_ary[0] = $regs[1] . '"' . addslashes(trim($inbox_ary[1])) .
 291                '"' . $regs[2];
 292          }
 293
 294          $sorted_list_ary[] = $inbox_ary[0];
 295          $sorted_lsub_ary[] = find_mailbox_name($inbox_ary[0]);
 296       }
 297
 298       $boxes = sqimap_mailbox_parse ($sorted_list_ary, $sorted_lsub_ary, $dm);
 299
 300
 301       /** Now, lets sort for special folders **/
 302
 303       $boxesnew = Array();
 304
 305       // Find INBOX
 306       for ($i = 0; $i < count($boxes); $i++) {
 307          if (strtolower($boxes[$i]["unformatted"]) == "inbox") {
 308             $boxesnew[] = $boxes[$i];
 309             $used[$i] = true;
 310             $i = count($boxes);
 311          }
 312       }
 313
 314       if ($list_special_folders_first == true) {
 315
 316          // Then list special folders and their subfolders
 317          for ($i = 0 ; $i < count($boxes) ; $i++) {
 318             if ($move_to_trash &&
 319                 eregi('^' . quotemeta($trash_folder) . '(' .
 320                 quotemeta($dm) . '.*)?$', $boxes[$i]["unformatted"])) {
 321                $boxesnew[] = $boxes[$i];
 322                $used[$i] = true;
 323             }
 324             elseif ($move_to_sent &&
 325                 eregi('^' . quotemeta($sent_folder) . '(' .
 326                 quotemeta($dm) . '.*)?$', $boxes[$i]["unformatted"])) {
 327                $boxesnew[] = $boxes[$i];
 328                $used[$i] = true;
 329             }
 330          }
 331
 332          // Put INBOX.* folders ahead of the rest
 333          for ($i = 0; $i < count($boxes); $i++) {
 334             if (eregi('^inbox\\.', $boxes[$i]["unformatted"]) &&
 335                 (!isset($used[$i]) || $used[$i] == false)) {
 336                $boxesnew[] = $boxes[$i];
 337                $used[$i] = true;
 338             }
 339          }
 340
 341       }
 342
 343       // Rest of the folders
 344       for ($i = 0; $i < count($boxes); $i++) {
 345          if ((strtolower($boxes[$i]["unformatted"]) != "inbox") &&
 346              (!isset($used[$i]) || $used[$i] == false))  {
 347             $boxesnew[] = $boxes[$i];
 348             $used[$i] = true;
 349          }
 350       }
 351
 352       return $boxesnew;
 353    }
 354
 355    /******************************************************************************
 356     **  Returns a list of all folders, subscribed or not
 357     ******************************************************************************/
 358    function sqimap_mailbox_list_all ($imap_stream) {
 359       global $list_special_folders_first, $folder_prefix;
 360
 361       if (!function_exists ("ary_sort"))
 362          include ("../functions/array.php");
 363
 364       $dm = sqimap_get_delimiter ($imap_stream);
 365
 366       fputs ($imap_stream, "a001 LIST \"$folder_prefix\" *\r\n");
 367       $read_ary = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
 368       $g = 0;
 369       $phase = "inbox";
 370
 371       for ($i = 0; $i < count($read_ary); $i++) {
 372          // Another workaround for EIMS
 373          if (isset($read_ary[$i + 1]) &&
 374              ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
 375              $read_ary[$i], $regs)) {
 376             $i ++;
 377             $read_ary[$i] = $regs[1] . '"' .
 378                addslashes(trim($read_ary[$i])) .
 379                '"' . $regs[2];
 380          }
 381          if (substr ($read_ary[$i], 0, 4) != "a001") {
 382
 383             // Store the raw IMAP reply
 384             $boxes[$g]["raw"] = $read_ary[$i];
 385
 386             // Count number of delimiters ($dm) in folder name
 387             $mailbox = find_mailbox_name($read_ary[$i]);
 388             $dm_count = countCharInString($mailbox, $dm);
 389             if (substr($mailbox, -1) == $dm)
 390                $dm_count--;  // If name ends in delimiter - decrement count by one
 391
 392             // Format folder name, but only if it's a INBOX.* or have
 393             // a parent.
 394             $boxesbyname[$mailbox] = $g;
 395             $parentfolder = readMailboxParent($mailbox, $dm);
 396             if((eregi('^inbox'.quotemeta($dm), $mailbox)) ||
 397                (ereg('^'.$folder_prefix, $mailbox)) ||
 398                ( isset($boxesbyname[$parentfolder]) && (strlen($parentfolder) > 0) ) ) {
 399                if ($dm_count)
 400                    $boxes[$g]["formatted"]  = str_repeat("&nbsp;&nbsp;", $dm_count);
 401                else
 402                    $boxes[$g]["formatted"] = '';
 403                $boxes[$g]["formatted"] .= readShortMailboxName($mailbox, $dm);
 404             } else {
 405                $boxes[$g]["formatted"]  = $mailbox;
 406             }
 407
 408             $boxes[$g]["unformatted-dm"] = $mailbox;
 409             if (substr($mailbox, -1) == $dm)
 410                $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
 411             $boxes[$g]["unformatted"] = $mailbox;
 412             $boxes[$g]["unformatted-disp"] = ereg_replace('^' . $folder_prefix, '', $mailbox);
 413             $boxes[$g]["id"] = $g;
 414
 415             /** Now lets get the flags for this mailbox **/
 416             fputs ($imap_stream, "a002 LIST \"\" \"$mailbox\"\r\n");
 417             $read_mlbx = sqimap_read_data ($imap_stream, "a002", true, $response, $message);
 418             // Another workaround for EIMS
 419             if (isset($read_mlbx[1]) &&
 420                 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
 421                 $read_mlbx[0], $regs)) {
 422                $read_mlbx[0] = $regs[1] . '"' .
 423                   addslashes(trim($read_mlbx[1])) .
 424                   '"' . $regs[2];
 425             }
 426
 427             $flags = substr($read_mlbx[0], strpos($read_mlbx[0], "(")+1);
 428             $flags = substr($flags, 0, strpos($flags, ")"));
 429             $flags = str_replace('\\', '', $flags);
 430             $flags = trim(strtolower($flags));
 431             if ($flags) {
 432                $boxes[$g]['flags'] = explode(" ", $flags);
 433             }
 434             else
 435             {
 436                $boxes[$g]['flags'] = array();
 437             }
 438          }
 439          $g++;
 440       }
 441       if(is_array($boxes)) {
 442          $boxes = ary_sort ($boxes, "unformatted", 1);
 443       }
 444
 445       return $boxes;
 446    }
 447
 448 ?>