** -> *
[squirrelmail.git] / functions / imap_mailbox.php
index 0ed33a1c277d251144190660a5e0fc39c90729c1..031ccc43f498d9bf689dd688c4a4e5c9fc581047 100755 (executable)
@@ -1,22 +1,22 @@
 <?php
-   /**
-    **  imap_mailbox.php
-    **
-    **  This impliments all functions that manipulate mailboxes
-    **
-    **  $Id$
-    **/
 
-   if (defined ('imap_mailbox_php'))
-      return;
-   define ('imap_mailbox_php', true);
+   /**
+    *   imap_mailbox.php
+    *
+    *   Copyright (c) 1999-2001 The Squirrelmail Development Team
+    *   Licensed under the GNU GPL. For full terms see the file COPYING.
+    *
+    *   This impliments all functions that manipulate mailboxes
+    *
+    *   $Id$
+    */
 
    /******************************************************************************
     **  Expunges a mailbox 
     ******************************************************************************/
    function sqimap_mailbox_expunge ($imap_stream, $mailbox,$handle_errors = true) {
-      fputs ($imap_stream, "a001 EXPUNGE\r\n");
-      $read = sqimap_read_data($imap_stream, "a001", $handle_errors, $response, $message);
+      fputs ($imap_stream, sqimap_session_id() . " EXPUNGE\r\n");
+      $read = sqimap_read_data($imap_stream, sqimap_session_id(), $handle_errors, $response, $message);
    }
 
 
@@ -26,8 +26,8 @@
    function sqimap_mailbox_exists ($imap_stream, $mailbox) {
       if (! isset($mailbox))
           return false;
-      fputs ($imap_stream, "a001 LIST \"\" \"$mailbox\"\r\n");
-      $mbx = sqimap_read_data($imap_stream, "a001", true, $response, $message);
+      fputs ($imap_stream, sqimap_session_id() . " LIST \"\" \"$mailbox\"\r\n");
+      $mbx = sqimap_read_data($imap_stream, sqimap_session_id(), true, $response, $message);
       return isset($mbx[0]);
    }
 
     ******************************************************************************/
    function sqimap_mailbox_select ($imap_stream, $mailbox, $hide=true, $recent=false) {
       global $auto_expunge;
-      
-      fputs ($imap_stream, "a001 SELECT \"$mailbox\"\r\n");
-             $read = sqimap_read_data($imap_stream, "a001", true, $response, $message);
+
+      if( $mailbox == 'None' )
+          return;
+
+      fputs ($imap_stream, sqimap_session_id() . " SELECT \"$mailbox\"\r\n");
+             $read = sqimap_read_data($imap_stream, sqimap_session_id(), true, $response, $message);
       if ($recent) {
          for ($i=0; $i<count($read); $i++) {
-            if (strpos(strtolower($read[$i]), "recent")) {
-               $r = explode(" ", $read[$i]);
+            if (strpos(strtolower($read[$i]), 'recent')) {
+               $r = explode(' ', $read[$i]);
             }
          }
          return $r[1];
       }
       if ($auto_expunge) {
-         fputs ($imap_stream, "a001 EXPUNGE\r\n");
-         $tmp = sqimap_read_data($imap_stream, "a001", false, $a, $b);
+         fputs ($imap_stream, sqimap_session_id() . " EXPUNGE\r\n");
+         $tmp = sqimap_read_data($imap_stream, sqimap_session_id(), false, $a, $b);
       }   
    }
 
     **  Creates a folder 
     ******************************************************************************/
    function sqimap_mailbox_create ($imap_stream, $mailbox, $type) {
-      if (strtolower($type) == "noselect") {
-         $dm = sqimap_get_delimiter($imap_stream);
-         $mailbox = $mailbox.$dm;
+      global $delimiter;
+      if (strtolower($type) == 'noselect') {
+         $mailbox = $mailbox.$delimiter;
       }
-      fputs ($imap_stream, "a001 CREATE \"$mailbox\"\r\n");
-      $read_ary = sqimap_read_data($imap_stream, "a001", true, $response, $message);
+      fputs ($imap_stream, sqimap_session_id() . " CREATE \"$mailbox\"\r\n");
+      $read_ary = sqimap_read_data($imap_stream, sqimap_session_id(), true, $response, $message);
 
       sqimap_subscribe ($imap_stream, $mailbox);
    }
@@ -75,8 +78,8 @@
     **  Subscribes to an existing folder 
     ******************************************************************************/
    function sqimap_subscribe ($imap_stream, $mailbox) {
-      fputs ($imap_stream, "a001 SUBSCRIBE \"$mailbox\"\r\n");
-      $read_ary = sqimap_read_data($imap_stream, "a001", true, $response, $message);
+      fputs ($imap_stream, sqimap_session_id() . " SUBSCRIBE \"$mailbox\"\r\n");
+      $read_ary = sqimap_read_data($imap_stream, sqimap_session_id(), true, $response, $message);
    }
 
 
@@ -88,8 +91,8 @@
    function sqimap_unsubscribe ($imap_stream, $mailbox) {
                 global $imap_server_type;
 
-      fputs ($imap_stream, "a001 UNSUBSCRIBE \"$mailbox\"\r\n");
-      $read_ary = sqimap_read_data($imap_stream, "a001", true, $response, $message);
+      fputs ($imap_stream, sqimap_session_id() . " UNSUBSCRIBE \"$mailbox\"\r\n");
+      $read_ary = sqimap_read_data($imap_stream, sqimap_session_id(), true, $response, $message);
    }
 
 
     **  This function simply deletes the given folder
     ******************************************************************************/
    function sqimap_mailbox_delete ($imap_stream, $mailbox) {
-      fputs ($imap_stream, "a001 DELETE \"$mailbox\"\r\n");
-      $read_ary = sqimap_read_data($imap_stream, "a001", true, $response, $message);
+      fputs ($imap_stream, sqimap_session_id() . " DELETE \"$mailbox\"\r\n");
+      $read_ary = sqimap_read_data($imap_stream, sqimap_session_id(), true, $response, $message);
       sqimap_unsubscribe ($imap_stream, $mailbox);
    }
+   
+   /***********************************************************************
+    ** Determines if the user is subscribed to the folder or not
+    **********************************************************************/
+   function sqimap_mailbox_is_subscribed($imap_stream, $folder) {
+       $boxes = sqimap_mailbox_list ($imap_stream);
+       foreach ($boxes as $ref) {
+          if ($ref['unformatted'] == $folder)
+            return true;
+       }
+       return false;
+   }
+      
 
 
    /******************************************************************************
     **    unformatted-disp - unformatted without $folder_prefix
     **
     ******************************************************************************/
-   function sqimap_mailbox_parse ($line, $line_lsub, $dm) {
-      global $folder_prefix;
+   function sqimap_mailbox_parse ($line, $line_lsub) {
+      global $folder_prefix, $delimiter;
      
       // Process each folder line
       for ($g=0; $g < count($line); $g++) {
             $boxes[$g]["raw"] = "";
 
 
-         // Count number of delimiters ($dm) in folder name
+         // Count number of delimiters ($delimiter) in folder name
          $mailbox = trim($line_lsub[$g]);
-         $dm_count = countCharInString($mailbox, $dm);
-         if (substr($mailbox, -1) == $dm)
+         $dm_count = countCharInString($mailbox, $delimiter);
+         if (substr($mailbox, -1) == $delimiter)
             $dm_count--;  // If name ends in delimiter - decrement count by one
 
          // Format folder name, but only if it's a INBOX.* or have
          // a parent.
          $boxesbyname[$mailbox] = $g;
-         $parentfolder = readMailboxParent($mailbox, $dm);
+         $parentfolder = readMailboxParent($mailbox, $delimiter);
          if((strtolower(substr($mailbox, 0, 5)) == "inbox") ||
             (substr($mailbox, 0, strlen($folder_prefix)) == $folder_prefix) ||
             (isset($boxesbyname[$parentfolder]) && (strlen($parentfolder) > 0) ) ) {
-            $indent = $dm_count - (countCharInString($folder_prefix, $dm));
+            $indent = $dm_count - (countCharInString($folder_prefix, $delimiter));
             if ($indent > 0)
                 $boxes[$g]["formatted"]  = str_repeat("&nbsp;&nbsp;", $indent);
             else
                 $boxes[$g]["formatted"] = '';
-            $boxes[$g]["formatted"] .= readShortMailboxName($mailbox, $dm);
+            $boxes[$g]["formatted"] .= readShortMailboxName($mailbox, $delimiter);
          } else {
             $boxes[$g]["formatted"]  = $mailbox;
          }
             
          $boxes[$g]['unformatted-dm'] = $mailbox;
-         if (substr($mailbox, -1) == $dm)
+         if (substr($mailbox, -1) == $delimiter)
             $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
          $boxes[$g]['unformatted'] = $mailbox;
          if (substr($mailbox,0,strlen($folder_prefix))==$folder_prefix)
          $boxes[$g]['unformatted-disp'] = $mailbox;
          $boxes[$g]['id'] = $g;
 
-         if (isset($line[$g]))
+         $boxes[$g]['flags'] = array();
+         if (isset($line[$g])) {
             ereg("\(([^)]*)\)",$line[$g],$regs);
-         $flags = trim(strtolower(str_replace('\\', '',$regs[1])));
-         if ($flags) {
-            $boxes[$g]['flags'] = explode(' ', $flags);
-         } else
-            $boxes[$g]['flags'] = array();
+            $flags = trim(strtolower(str_replace('\\', '',$regs[1])));
+            if ($flags)
+               $boxes[$g]['flags'] = explode(' ', $flags);
+        }
       }
 
       return $boxes;
     ******************************************************************************/
    function sqimap_mailbox_list ($imap_stream) {
       global $data_dir, $username, $list_special_folders_first;
-      global $trash_folder, $sent_folder;
-      global $move_to_trash, $move_to_sent, $folder_prefix;
+      global $folder_prefix, $trash_folder, $sent_folder, $draft_folder;
+      global $move_to_trash, $move_to_sent, $save_as_draft;
+      global $delimiter;
 
       $inbox_in_list = false;
       $inbox_subscribed = false;
 
-      include "../src/load_prefs.php";
-      include "../functions/array.php";
-
-      $dm = sqimap_get_delimiter ($imap_stream);
+      require_once('../src/load_prefs.php');
+      require_once('../functions/array.php');
 
       /** LSUB array **/
-      fputs ($imap_stream, "a001 LSUB \"$folder_prefix\" \"*\"\r\n");
-      $lsub_ary = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
+      fputs ($imap_stream, sqimap_session_id() . " LSUB \"$folder_prefix\" \"*\"\r\n");
+      $lsub_ary = sqimap_read_data ($imap_stream, sqimap_session_id(), true, $response, $message);
       
       // Section about removing the last element was removed
       // We don't return "* OK" anymore from sqimap_read_data
       /** LIST array **/
       $sorted_list_ary = array();
       for ($i=0; $i < count($sorted_lsub_ary); $i++) {
-         if (substr($sorted_lsub_ary[$i], -1) == $dm)
+         if (substr($sorted_lsub_ary[$i], -1) == $delimiter)
             $mbx = substr($sorted_lsub_ary[$i], 0, strlen($sorted_lsub_ary[$i])-1);
          else
             $mbx = $sorted_lsub_ary[$i];
 
-         fputs ($imap_stream, "a001 LIST \"\" \"$mbx\"\r\n");
-         $read = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
+         fputs ($imap_stream, sqimap_session_id() . " LIST \"\" \"$mbx\"\r\n");
+         $read = sqimap_read_data ($imap_stream, sqimap_session_id(), true, $response, $message);
         // Another workaround for EIMS
          if (isset($read[1]) && 
             ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$", 
             $inbox_in_list = true;
       }
                 
-      /** Just in case they're not subscribed to their inbox, we'll get it 
-          for them anyway **/
+      /**
+       * Just in case they're not subscribed to their inbox,
+       * we'll get it for them anyway
+       */
       if ($inbox_subscribed == false || $inbox_in_list == false) {
-         fputs ($imap_stream, "a001 LIST \"\" \"INBOX\"\r\n");
-         $inbox_ary = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
+         fputs ($imap_stream, sqimap_session_id() . " LIST \"\" \"INBOX\"\r\n");
+         $inbox_ary = sqimap_read_data ($imap_stream, sqimap_session_id(), true, $response, $message);
         // Another workaround for EIMS
          if (isset($inbox_ary[1]) &&
             ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$", 
          $sorted_lsub_ary[] = find_mailbox_name($inbox_ary[0]);
       }
 
-      $boxes = sqimap_mailbox_parse ($sorted_list_ary, $sorted_lsub_ary, $dm);
-
+      $boxes = sqimap_mailbox_parse ($sorted_list_ary, $sorted_lsub_ary);
 
       /** Now, lets sort for special folders **/
-
       $boxesnew = Array();
 
-      // Find INBOX
+      /* Find INBOX */
       for ($i = 0; $i < count($boxes); $i++) {
          if (strtolower($boxes[$i]["unformatted"]) == "inbox") {
             $boxesnew[] = $boxes[$i];
          }
       }
 
+      /* List special folders and their subfolders, if requested. */
       if ($list_special_folders_first == true) {
-
-         // Then list special folders and their subfolders
+         /* First list the trash folder. */
          for ($i = 0 ; $i < count($boxes) ; $i++) {
             if ($move_to_trash &&
-                eregi('^' . quotemeta($trash_folder) . '(' .
-                quotemeta($dm) . '.*)?$', $boxes[$i]["unformatted"])) {
+                   eregi('^' . quotemeta($trash_folder) . '(' .
+                     quotemeta($delimiter) . '.*)?$', $boxes[$i]['unformatted'])) {
                $boxesnew[] = $boxes[$i];
                $used[$i] = true;
             }
-            elseif ($move_to_sent &&
-                eregi('^' . quotemeta($sent_folder) . '(' .
-                quotemeta($dm) . '.*)?$', $boxes[$i]["unformatted"])) {
+         }
+
+         /* Then list the sent folder. */
+         for ($i = 0 ; $i < count($boxes) ; $i++) {
+            if ($move_to_sent &&
+                  eregi('^' . quotemeta($sent_folder) . '(' .
+                    quotemeta($delimiter) . '.*)?$', $boxes[$i]['unformatted'])) {
                $boxesnew[] = $boxes[$i];
                $used[$i] = true;
             }
          }
 
-         // Put INBOX.* folders ahead of the rest
+         /* Lastly, list the list the draft folder. */
+         for ($i = 0 ; $i < count($boxes) ; $i++) {
+            if ($save_as_draft &&
+                  eregi('^' . quotemeta($draft_folder) . '(' .
+                    quotemeta($delimiter) . '.*)?$', $boxes[$i]['unformatted'])) {
+               $boxesnew[] = $boxes[$i];
+               $used[$i] = true;
+            }
+         }
+
+         /* Put INBOX.* folders ahead of the rest. */
          for ($i = 0; $i < count($boxes); $i++) {
             if (eregi('^inbox\\.', $boxes[$i]["unformatted"]) &&
                 (!isset($used[$i]) || $used[$i] == false)) {
                $used[$i] = true;
             }
          }
-
       }
 
       // Rest of the folders
     ******************************************************************************/
    function sqimap_mailbox_list_all ($imap_stream) {
       global $list_special_folders_first, $folder_prefix;
-      
+      global $delimiter;
+
       if (!function_exists ("ary_sort"))
-         include ("../functions/array.php");
-      
-      $dm = sqimap_get_delimiter ($imap_stream);
+         include_once('../functions/array.php');
 
-      fputs ($imap_stream, "a001 LIST \"$folder_prefix\" *\r\n");
-      $read_ary = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
+      $ssid = sqimap_session_id();
+      $lsid = strlen( $ssid ); 
+      fputs ($imap_stream, $ssid . " LIST \"$folder_prefix\" *\r\n");
+      $read_ary = sqimap_read_data ($imap_stream, $ssid, true, $response, $message);
       $g = 0;
-      $phase = "inbox"; 
+      $phase = "inbox";
 
       for ($i = 0; $i < count($read_ary); $i++) {
          // Another workaround for EIMS
-        if (isset($read_ary[$i + 1]) &&
-            ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$", 
-            $read_ary[$i], $regs)) {
-           $i ++;
-           $read_ary[$i] = $regs[1] . '"' . 
-              addslashes(trim($read_ary[$i])) .
-              '"' . $regs[2];
-        }
-         if (substr ($read_ary[$i], 0, 4) != "a001") {
+                       if (isset($read_ary[$i + 1]) &&
+                         ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$", 
+                         $read_ary[$i], $regs)) {
+                        $i ++;
+                        $read_ary[$i] = $regs[1] . '"' . 
+                           addslashes(trim($read_ary[$i])) .
+                           '"' . $regs[2];
+                       }
+         if (substr ($read_ary[$i], 0, $lsid) != $ssid ) {
 
             // Store the raw IMAP reply
             $boxes[$g]["raw"] = $read_ary[$i];
 
-            // Count number of delimiters ($dm) in folder name
+            // Count number of delimiters ($delimiter) in folder name
             $mailbox = find_mailbox_name($read_ary[$i]);
-            $dm_count = countCharInString($mailbox, $dm);
-            if (substr($mailbox, -1) == $dm)
+            $dm_count = countCharInString($mailbox, $delimiter);
+            if (substr($mailbox, -1) == $delimiter)
                $dm_count--;  // If name ends in delimiter - decrement count by one
             
             // Format folder name, but only if it's a INBOX.* or have
             // a parent.
             $boxesbyname[$mailbox] = $g;
-            $parentfolder = readMailboxParent($mailbox, $dm);
-            if((eregi('^inbox'.quotemeta($dm), $mailbox)) || 
+            $parentfolder = readMailboxParent($mailbox, $delimiter);
+            if((eregi('^inbox'.quotemeta($delimiter), $mailbox)) || 
                (ereg('^'.$folder_prefix, $mailbox)) ||
                ( isset($boxesbyname[$parentfolder]) && (strlen($parentfolder) > 0) ) ) {
                if ($dm_count)
                    $boxes[$g]["formatted"]  = str_repeat("&nbsp;&nbsp;", $dm_count);
                else
                    $boxes[$g]["formatted"] = '';
-               $boxes[$g]["formatted"] .= readShortMailboxName($mailbox, $dm);
+               $boxes[$g]["formatted"] .= readShortMailboxName($mailbox, $delimiter);
             } else {
                $boxes[$g]["formatted"]  = $mailbox;
             }
                
             $boxes[$g]["unformatted-dm"] = $mailbox;
-            if (substr($mailbox, -1) == $dm)
+            if (substr($mailbox, -1) == $delimiter)
                $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
             $boxes[$g]["unformatted"] = $mailbox;
             $boxes[$g]["unformatted-disp"] = ereg_replace('^' . $folder_prefix, '', $mailbox);
             $boxes[$g]["id"] = $g;
 
             /** Now lets get the flags for this mailbox **/
-            fputs ($imap_stream, "a002 LIST \"\" \"$mailbox\"\r\n"); 
-            $read_mlbx = sqimap_read_data ($imap_stream, "a002", true, $response, $message);
-           // Another workaround for EIMS
-           if (isset($read_mlbx[1]) &&
-               ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$", 
-               $read_mlbx[0], $regs)) {
-              $read_mlbx[0] = $regs[1] . '"' . 
-                 addslashes(trim($read_mlbx[1])) .
-                 '"' . $regs[2];
-           }
+            fputs ($imap_stream, sqimap_session_id() . " LIST \"\" \"$mailbox\"\r\n"); 
+            $read_mlbx = sqimap_read_data ($imap_stream, sqimap_session_id(), true, $response, $message);
+            
+                               // Another workaround for EIMS
+                               if (isset($read_mlbx[1]) &&
+                                 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$", 
+                                 $read_mlbx[0], $regs)) {
+                                $read_mlbx[0] = $regs[1] . '"' . 
+                                   addslashes(trim($read_mlbx[1])) .
+                                   '"' . $regs[2];
+                               }
 
             $flags = substr($read_mlbx[0], strpos($read_mlbx[0], "(")+1);
             $flags = substr($flags, 0, strpos($flags, ")"));