[squirrelmail.git] / functions / imap_mailbox.php

<?php
   /**
    **  imap_mailbox.php
    **
    **  This impliments all functions that manipulate mailboxes
    **/

   /******************************************************************************
    **  Expunges a mailbox 
    ******************************************************************************/
   function sqimap_mailbox_expunge ($imap_stream, $mailbox) {
      sqimap_mailbox_select ($imap_stream, $mailbox);
      fputs ($imap_stream, "a001 EXPUNGE\r\n");
      $read = sqimap_read_data($imap_stream, "a001", true, $response, $message);
   }


   /******************************************************************************
    **  Checks whether or not the specified mailbox exists 
    ******************************************************************************/
   function sqimap_mailbox_exists ($imap_stream, $mailbox) {
      $boxes = sqimap_mailbox_list ($imap_stream);
      $found = false;
      for ($i = 0; $i < count ($boxes); $i++) {
         if ($boxes[$i]["unformatted"] == $mailbox)
            $found = true;
      }
      return $found;
   }


   /******************************************************************************
    **  Selects a mailbox
    ******************************************************************************/
   function sqimap_mailbox_select ($imap_stream, $mailbox) {
      fputs ($imap_stream, "a001 SELECT \"$mailbox\"\r\n");
      $read = sqimap_read_data($imap_stream, "a001", true, $response, $message);
   }

   
   /******************************************************************************
    **  Creates a folder 
    ******************************************************************************/
   function sqimap_mailbox_create ($imap_stream, $mailbox, $type) {
      if (strtolower($type) == "noselect") {
         $dm = sqimap_get_delimiter($imap_stream);
         $mailbox = $mailbox.$dm;
      }
      fputs ($imap_stream, "a001 CREATE \"$mailbox\"\r\n");
      $read_ary = sqimap_read_data($imap_stream, "a001", true, $response, $message);

      sqimap_subscribe ($imap_stream, $mailbox);
   }


   /******************************************************************************
    **  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);
   }


   /******************************************************************************
    **  Unsubscribes to an existing folder 
    ******************************************************************************/
   function sqimap_unsubscribe ($imap_stream, $mailbox) {
      fputs ($imap_stream, "a001 UNSUBSCRIBE \"$mailbox\"\r\n");
      $read_ary = sqimap_read_data($imap_stream, "a001", 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);
      sqimap_unsubscribe ($imap_stream, $mailbox);
   }


   /******************************************************************************
    **  Formats a mailbox into 4 parts for the $boxes array
    ******************************************************************************/
   function sqimap_mailbox_parse ($line, $dm) {
		global $folder_prefix;
      for ($g=0; $g < count($line); $g++) {
         $boxes[$g]["raw"] = $line[$g];
            
         $mailbox = find_mailbox_name($line[$g]);
         $dm_count = countCharInString($mailbox, $dm);
         if (substr($mailbox, -1) == $dm)
            $dm_count--;
            
         for ($j = 0; $j < $dm_count - (countCharInString($folder_prefix, $dm)); $j++)
            $boxes[$g]["formatted"] = $boxes[$g]["formatted"] . "  ";
         $boxes[$g]["formatted"] .= readShortMailboxName($mailbox, $dm);
            
         $boxes[$g]["unformatted-dm"] = $mailbox;
         if (substr($mailbox, -1) == $dm)
            $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
         $boxes[$g]["unformatted"] = $mailbox;
         $boxes[$g]["id"] = $g;

         $flags = substr($line[$g], strpos($line[$g], "(")+1);
         $flags = substr($flags, 0, strpos($flags, ")"));
         $flags = str_replace("\\", "", $flags);
         $flags = trim(strtolower($flags));
         if ($flags) {
            $boxes[$g]["flags"] = explode(" ", $flags);
         }
			for ($i=0; $i < count($boxes[$g]["flags"]); $i++) {
				if ($boxes[$g]["flags"][$i] == "noselect") {
					$boxes[$g]["unformatted-dm"] = $boxes[$g]["unformatted-dm"].$dm;
					echo $boxes[$g]["unformatted-dm"]." - debug<br>";
				}
			}
      }
      return $boxes;
   }
   
   /******************************************************************************
    **  Returns sorted mailbox lists in several different ways.
    **  The array returned looks like this:
    ******************************************************************************/
   function sqimap_mailbox_list ($imap_stream) {
      global $load_prefs_php, $prefs_php, $config_php, $data_dir, $username, $list_special_folders_first;
		global $special_folders;

      $inbox_in_list = false;
      $inbox_subscribed = false;

      if (!isset($load_prefs_php)) include "../src/load_prefs.php";
      else global $folder_prefix;
      if (!function_exists ("ary_sort")) include "../functions/array.php";

      $dm = sqimap_get_delimiter ($imap_stream);

      /** LIST array **/
      fputs ($imap_stream, "a001 LIST \"\" \"$folder_prefix*\"\r\n");
      $list_ary = sqimap_read_data ($imap_stream, "a001", true, $response, $message);

      for ($i=0;$i < count($list_ary); $i++) {
         $sorted_list_ary[$i]["name"] = find_mailbox_name($list_ary[$i]);
         $sorted_list_ary[$i]["raw"]  = $list_ary[$i];
         if ($sorted_list_ary[$i]["name"] == "INBOX")
            $inbox_in_list = true;
      }
      if (isset($sorted_list_ary)) {
         $list_sorted = array_cleave ($sorted_list_ary, "name");
         asort($list_sorted);
      }   


      /** LSUB array **/
      $inbox_subscribed = false;
      fputs ($imap_stream, "a001 LSUB \"\" \"*\"\r\n");
      $lsub_ary = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
      for ($i=0;$i < count($lsub_ary); $i++) {
         $sorted_lsub_ary[$i] = find_mailbox_name($lsub_ary[$i]);
         if (substr($sorted_lsub_ary[$i], -1) == $dm)
            $sorted_lsub_ary[$i] = substr($sorted_lsub_ary[$i], 0, strlen($sorted_lsub_ary[$i])-1);
         if ($sorted_lsub_ary[$i] == "INBOX")
            $inbox_subscribed = true;
      }
      if (isset($sorted_lsub_ary)) {
         sort($sorted_lsub_ary);
      }   

      
      /** 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);
         $merged[0] = $inbox_ary[0];
         $k = 1;
      } else {
         $k = 0;
      }

      $i = $j = 0;
      
      if (isset($list_sorted) && isset($sorted_lsub_ary)) {
	      reset ($list_sorted);
	      for (reset($list_sorted); $key = key($list_sorted), isset($key);) {
	         if ($sorted_lsub_ary[$i] == $list_sorted[$key]) {
	            $merged[$k] = $sorted_list_ary[$key]["raw"];
	            $k++;
	            $i++;
	            next($list_sorted);
	         } else if ($sorted_lsub_ary[$i] < $list_sorted[$key]) {
	            $i++;
	         } else {
	            next($list_sorted);
	         }
	      }
      }

		$boxes = sqimap_mailbox_parse ($merged, $dm);
		
		/** Now, lets sort for special folders **/
      for ($i = 0; $i < count($boxes); $i++) {
         if ($boxes[$i]["unformatted"] == $special_folders[0]) {
            $boxesnew[0] = $boxes[$i];
            $boxes[$i]["used"] = true;
         }
      }

      if ($list_special_folders_first == true) {
         for ($i = 0; $i < count($boxes); $i++) {
            for ($j = 1; $j < count($special_folders); $j++) {
               if (substr($boxes[$i]["unformatted"], strlen($folder_prefix), strlen($special_folders[$j])) == $special_folders[$j]) {
                  $pos = count($boxesnew);
                  $boxesnew[$pos] = $boxes[$i];
                  $boxes[$i]["used"] = true;
               }
            }
         }
      }
		
      for ($i = 0; $i < count($boxes); $i++) {
         if (($boxes[$i]["unformatted"] != $special_folders[0]) &&
             ($boxes[$i]["used"] == false))  {
            $pos = count($boxesnew);
            $boxesnew[$pos] = $boxes[$i];
            $boxes[$i]["used"] = true;
         }
      }

      return $boxesnew;
   }
   
   /******************************************************************************
    **  Returns a list of all folders, subscribed or not
    ******************************************************************************/
   function sqimap_mailbox_list_all ($imap_stream) {
      global $special_folders, $list_special_folders_first, $folder_prefix;
      
      if (!function_exists ("ary_sort"))
         include ("../functions/array.php");
      
      $dm = sqimap_get_delimiter ($imap_stream);

      fputs ($imap_stream, "a001 LIST \"$folder_prefix\" *\r\n");
      $read_ary = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
      $g = 0;
      $phase = "inbox"; 
      for ($i = 0; $i < count($read_ary); $i++) {
         if (substr ($read_ary[$i], 0, 4) != "a001") {
            $boxes[$g]["raw"] = $read_ary[$i];

            $mailbox = find_mailbox_name($read_ary[$i]);
            $dm_count = countCharInString($mailbox, $dm);
            if (substr($mailbox, -1) == $dm)
               $dm_count--;
               
            for ($j = 0; $j < $dm_count; $j++)
               $boxes[$g]["formatted"] = $boxes[$g]["formatted"] . "  ";
            $boxes[$g]["formatted"] .= readShortMailboxName($mailbox, $dm);
               
            $boxes[$g]["unformatted-dm"] = $mailbox;
            if (substr($mailbox, -1) == $dm)
               $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
            $boxes[$g]["unformatted"] = $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);

            $flags = substr($read_mlbx[0], strpos($read_mlbx[0], "(")+1);
            $flags = substr($flags, 0, strpos($flags, ")"));
            $flags = str_replace("\\", "", $flags);
            $flags = trim(strtolower($flags));
            if ($flags) {
               $boxes[$g]["flags"] = explode(" ", $flags);
            }
         }
         $g++;
      }
      $boxes = ary_sort ($boxes, "unformatted", 1);
      return $boxes;
   }
   
?>
Commit	Line	Data
59177427	1	<?php
8e9e8afa	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) {
aed206bf	95	global $folder_prefix;
8e9e8afa	96	for ($g=0; $g < count($line); $g++) {
	97	$boxes[$g]["raw"] = $line[$g];
	98
	99	$mailbox = find_mailbox_name($line[$g]);
	100	$dm_count = countCharInString($mailbox, $dm);
	101	if (substr($mailbox, -1) == $dm)
	102	$dm_count--;
	103
aed206bf	104	for ($j = 0; $j < $dm_count - (countCharInString($folder_prefix, $dm)); $j++)
8e9e8afa	105	$boxes[$g]["formatted"] = $boxes[$g]["formatted"] . " ";
	106	$boxes[$g]["formatted"] .= readShortMailboxName($mailbox, $dm);
	107
	108	$boxes[$g]["unformatted-dm"] = $mailbox;
	109	if (substr($mailbox, -1) == $dm)
	110	$mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
	111	$boxes[$g]["unformatted"] = $mailbox;
	112	$boxes[$g]["id"] = $g;
	113
	114	$flags = substr($line[$g], strpos($line[$g], "(")+1);
	115	$flags = substr($flags, 0, strpos($flags, ")"));
	116	$flags = str_replace("\\", "", $flags);
	117	$flags = trim(strtolower($flags));
	118	if ($flags) {
	119	$boxes[$g]["flags"] = explode(" ", $flags);
	120	}
cbd55894	121	for ($i=0; $i < count($boxes[$g]["flags"]); $i++) {
	122	if ($boxes[$g]["flags"][$i] == "noselect") {
	123	$boxes[$g]["unformatted-dm"] = $boxes[$g]["unformatted-dm"].$dm;
	124	echo $boxes[$g]["unformatted-dm"]." - debug<br>";
	125	}
	126	}
8e9e8afa	127	}
	128	return $boxes;
	129	}
	130
	131	/******************************************************************************
	132	** Returns sorted mailbox lists in several different ways.
	133	** The array returned looks like this:
	134	******************************************************************************/
	135	function sqimap_mailbox_list ($imap_stream) {
aed206bf	136	global $load_prefs_php, $prefs_php, $config_php, $data_dir, $username, $list_special_folders_first;
aed206bf	137	global $special_folders;
8e9e8afa	138
1590a668	139	$inbox_in_list = false;
	140	$inbox_subscribed = false;
	141
8e9e8afa	142	if (!isset($load_prefs_php)) include "../src/load_prefs.php";
	143	else global $folder_prefix;
	144	if (!function_exists ("ary_sort")) include "../functions/array.php";
	145
	146	$dm = sqimap_get_delimiter ($imap_stream);
	147
	148	/ LIST array /
	149	fputs ($imap_stream, "a001 LIST \"\" \"$folder_prefix*\"\r\n");
	150	$list_ary = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
aed206bf	151
8e9e8afa	152	for ($i=0;$i < count($list_ary); $i++) {
	153	$sorted_list_ary[$i]["name"] = find_mailbox_name($list_ary[$i]);
	154	$sorted_list_ary[$i]["raw"] = $list_ary[$i];
1590a668	155	if ($sorted_list_ary[$i]["name"] == "INBOX")
8e9e8afa	156	$inbox_in_list = true;
	157	}
	158	if (isset($sorted_list_ary)) {
	159	$list_sorted = array_cleave ($sorted_list_ary, "name");
	160	asort($list_sorted);
	161	}
	162
8e9e8afa	163
	164	/ LSUB array /
	165	$inbox_subscribed = false;
	166	fputs ($imap_stream, "a001 LSUB \"\" \"*\"\r\n");
	167	$lsub_ary = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
	168	for ($i=0;$i < count($lsub_ary); $i++) {
	169	$sorted_lsub_ary[$i] = find_mailbox_name($lsub_ary[$i]);
	170	if (substr($sorted_lsub_ary[$i], -1) == $dm)
	171	$sorted_lsub_ary[$i] = substr($sorted_lsub_ary[$i], 0, strlen($sorted_lsub_ary[$i])-1);
	172	if ($sorted_lsub_ary[$i] == "INBOX")
	173	$inbox_subscribed = true;
	174	}
	175	if (isset($sorted_lsub_ary)) {
	176	sort($sorted_lsub_ary);
	177	}
	178
	179
	180	/ Just in case they're not subscribed to their inbox, we'll get it for them anyway /
	181	if ($inbox_subscribed == false \|\| $inbox_in_list == false) {
	182	fputs ($imap_stream, "a001 LIST \"\" \"INBOX\"\r\n");
	183	$inbox_ary = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
	184	$merged[0] = $inbox_ary[0];
	185	$k = 1;
	186	} else {
	187	$k = 0;
	188	}
	189
	190	$i = $j = 0;
	191
	192	if (isset($list_sorted) && isset($sorted_lsub_ary)) {
	193	reset ($list_sorted);
	194	for (reset($list_sorted); $key = key($list_sorted), isset($key);) {
	195	if ($sorted_lsub_ary[$i] == $list_sorted[$key]) {
	196	$merged[$k] = $sorted_list_ary[$key]["raw"];
	197	$k++;
	198	$i++;
	199	next($list_sorted);
	200	} else if ($sorted_lsub_ary[$i] < $list_sorted[$key]) {
	201	$i++;
	202	} else {
	203	next($list_sorted);
	204	}
	205	}
	206	}
	207
aed206bf	208	$boxes = sqimap_mailbox_parse ($merged, $dm);
	209
	210	/ Now, lets sort for special folders /
8e9e8afa	211	for ($i = 0; $i < count($boxes); $i++) {
	212	if ($boxes[$i]["unformatted"] == $special_folders[0]) {
	213	$boxesnew[0] = $boxes[$i];
	214	$boxes[$i]["used"] = true;
	215	}
	216	}
aed206bf	217
8e9e8afa	218	if ($list_special_folders_first == true) {
	219	for ($i = 0; $i < count($boxes); $i++) {
	220	for ($j = 1; $j < count($special_folders); $j++) {
aed206bf	221	if (substr($boxes[$i]["unformatted"], strlen($folder_prefix), strlen($special_folders[$j])) == $special_folders[$j]) {
8e9e8afa	222	$pos = count($boxesnew);
	223	$boxesnew[$pos] = $boxes[$i];
	224	$boxes[$i]["used"] = true;
	225	}
	226	}
	227	}
	228	}
aed206bf	229
8e9e8afa	230	for ($i = 0; $i < count($boxes); $i++) {
	231	if (($boxes[$i]["unformatted"] != $special_folders[0]) &&
	232	($boxes[$i]["used"] == false)) {
	233	$pos = count($boxesnew);
	234	$boxesnew[$pos] = $boxes[$i];
	235	$boxes[$i]["used"] = true;
	236	}
	237	}
	238
	239	return $boxesnew;
	240	}
8e9e8afa	241
	242	/******************************************************************************
	243	** Returns a list of all folders, subscribed or not
	244	******************************************************************************/
	245	function sqimap_mailbox_list_all ($imap_stream) {
	246	global $special_folders, $list_special_folders_first, $folder_prefix;
	247
	248	if (!function_exists ("ary_sort"))
	249	include ("../functions/array.php");
	250
	251	$dm = sqimap_get_delimiter ($imap_stream);
	252
	253	fputs ($imap_stream, "a001 LIST \"$folder_prefix\" *\r\n");
	254	$read_ary = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
	255	$g = 0;
	256	$phase = "inbox";
	257	for ($i = 0; $i < count($read_ary); $i++) {
	258	if (substr ($read_ary[$i], 0, 4) != "a001") {
	259	$boxes[$g]["raw"] = $read_ary[$i];
	260
	261	$mailbox = find_mailbox_name($read_ary[$i]);
	262	$dm_count = countCharInString($mailbox, $dm);
	263	if (substr($mailbox, -1) == $dm)
	264	$dm_count--;
	265
	266	for ($j = 0; $j < $dm_count; $j++)
	267	$boxes[$g]["formatted"] = $boxes[$g]["formatted"] . " ";
	268	$boxes[$g]["formatted"] .= readShortMailboxName($mailbox, $dm);
	269
	270	$boxes[$g]["unformatted-dm"] = $mailbox;
	271	if (substr($mailbox, -1) == $dm)
	272	$mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
	273	$boxes[$g]["unformatted"] = $mailbox;
	274	$boxes[$g]["id"] = $g;
	275
	276	/ Now lets get the flags for this mailbox /
	277	fputs ($imap_stream, "a002 LIST \"\" \"$mailbox\"\r\n");
	278	$read_mlbx = sqimap_read_data ($imap_stream, "a002", true, $response, $message);
	279
	280	$flags = substr($read_mlbx[0], strpos($read_mlbx[0], "(")+1);
	281	$flags = substr($flags, 0, strpos($flags, ")"));
	282	$flags = str_replace("\\", "", $flags);
	283	$flags = trim(strtolower($flags));
	284	if ($flags) {
	285	$boxes[$g]["flags"] = explode(" ", $flags);
	286	}
	287	}
	288	$g++;
	289	}
	290	$boxes = ary_sort ($boxes, "unformatted", 1);
	291	return $boxes;
	292	}
	293
052e0c26	294	?>