6 * Copyright (c) 1999-2002 The SquirrelMail Project Team
7 * Licensed under the GNU GPL. For full terms see the file COPYING.
9 * This impliments all functions that manipulate mailboxes
14 /*************************
15 ** Expunges a mailbox **
16 *************************/
17 function sqimap_mailbox_expunge ($imap_stream, $mailbox,$handle_errors = true)
19 fputs ($imap_stream, sqimap_session_id() . " EXPUNGE\r\n");
20 $read = sqimap_read_data($imap_stream, sqimap_session_id(),
21 $handle_errors, $response, $message);
25 /******************************************************************************
26 ** Checks whether or not the specified mailbox exists
27 ******************************************************************************/
28 function sqimap_mailbox_exists ($imap_stream, $mailbox)
30 if (! isset($mailbox)) {
33 fputs ($imap_stream, sqimap_session_id() . " LIST \"\" \"$mailbox\"\r\n");
34 $mbx = sqimap_read_data($imap_stream, sqimap_session_id(),
35 true, $response, $message);
36 return isset($mbx[0]);
39 /******************************************************************************
41 ******************************************************************************/
42 function sqimap_mailbox_select ($imap_stream, $mailbox,
43 $hide=true, $recent=false)
47 if ( $mailbox == 'None' ) {
51 fputs ($imap_stream, sqimap_session_id() . " SELECT \"$mailbox\"\r\n");
52 $read = sqimap_read_data($imap_stream, sqimap_session_id(),
53 true, $response, $message);
55 for ($i=0; $i<count($read); $i++
) {
56 if (strpos(strtolower($read[$i]), 'recent')) {
57 $r = explode(' ', $read[$i]);
63 fputs ($imap_stream, sqimap_session_id() . " EXPUNGE\r\n");
64 $tmp = sqimap_read_data($imap_stream, sqimap_session_id(),
71 /******************************************************************************
73 ******************************************************************************/
74 function sqimap_mailbox_create ($imap_stream, $mailbox, $type)
77 if (strtolower($type) == 'noselect') {
78 $mailbox = $mailbox.$delimiter;
80 fputs ($imap_stream, sqimap_session_id() . " CREATE \"$mailbox\"\r\n");
81 $read_ary = sqimap_read_data($imap_stream, sqimap_session_id(),
82 true, $response, $message);
84 sqimap_subscribe ($imap_stream, $mailbox);
89 /******************************************************************************
90 ** Subscribes to an existing folder
91 ******************************************************************************/
92 function sqimap_subscribe ($imap_stream, $mailbox)
94 fputs ($imap_stream, sqimap_session_id() . " SUBSCRIBE \"$mailbox\"\r\n");
95 $read_ary = sqimap_read_data($imap_stream, sqimap_session_id(),
96 true, $response, $message);
101 /******************************************************************************
102 ** Unsubscribes to an existing folder
103 ******************************************************************************/
104 function sqimap_unsubscribe ($imap_stream, $mailbox)
106 global $imap_server_type;
108 fputs ($imap_stream, sqimap_session_id() . " UNSUBSCRIBE \"$mailbox\"\r\n");
109 $read_ary = sqimap_read_data($imap_stream, sqimap_session_id(),
110 true, $response, $message);
115 /******************************************************************************
116 ** This function simply deletes the given folder
117 ******************************************************************************/
118 function sqimap_mailbox_delete ($imap_stream, $mailbox)
120 fputs ($imap_stream, sqimap_session_id() . " DELETE \"$mailbox\"\r\n");
121 $read_ary = sqimap_read_data($imap_stream, sqimap_session_id(),
122 true, $response, $message);
123 sqimap_unsubscribe ($imap_stream, $mailbox);
126 /***********************************************************************
127 ** Determines if the user is subscribed to the folder or not
128 **********************************************************************/
129 function sqimap_mailbox_is_subscribed($imap_stream, $folder)
131 $boxes = sqimap_mailbox_list ($imap_stream);
132 foreach ($boxes as $ref) {
133 if ($ref['unformatted'] == $folder) {
142 /******************************************************************************
143 ** Formats a mailbox into 4 parts for the $boxes array
145 ** The four parts are:
147 ** raw - Raw LIST/LSUB response from the IMAP server
148 ** formatted - nicely formatted folder name
149 ** unformatted - unformatted, but with delimiter at end removed
150 ** unformatted-dm - folder name as it appears in raw response
151 ** unformatted-disp - unformatted without $folder_prefix
153 ******************************************************************************/
154 function sqimap_mailbox_parse ($line, $line_lsub)
156 global $folder_prefix, $delimiter;
158 /* Process each folder line */
159 for ($g=0; $g < count($line); $g++
) {
161 /* Store the raw IMAP reply */
162 if (isset($line[$g])) {
163 $boxes[$g]["raw"] = $line[$g];
166 $boxes[$g]["raw"] = "";
170 /* Count number of delimiters ($delimiter) in folder name */
171 $mailbox = trim($line_lsub[$g]);
172 $dm_count = substr_count($mailbox, $delimiter);
173 if (substr($mailbox, -1) == $delimiter) {
174 /* If name ends in delimiter - decrement count by one */
178 /* Format folder name, but only if it's a INBOX.* or have */
180 $boxesbyname[$mailbox] = $g;
181 $parentfolder = readMailboxParent($mailbox, $delimiter);
182 if ( (strtolower(substr($mailbox, 0, 5)) == "inbox") ||
183 (substr($mailbox, 0, strlen($folder_prefix)) == $folder_prefix) ||
184 ( isset($boxesbyname[$parentfolder]) &&
185 (strlen($parentfolder) > 0) ) ) {
186 $indent = $dm_count - ( substr_count($folder_prefix, $delimiter));
188 $boxes[$g]["formatted"] = str_repeat(" ", $indent);
191 $boxes[$g]["formatted"] = '';
193 $boxes[$g]["formatted"] .= readShortMailboxName($mailbox, $delimiter);
196 $boxes[$g]["formatted"] = $mailbox;
199 $boxes[$g]['unformatted-dm'] = $mailbox;
200 if (substr($mailbox, -1) == $delimiter) {
201 $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
203 $boxes[$g]['unformatted'] = $mailbox;
204 if (substr($mailbox,0,strlen($folder_prefix))==$folder_prefix) {
205 $mailbox = substr($mailbox, strlen($folder_prefix));
207 $boxes[$g]['unformatted-disp'] = $mailbox;
208 $boxes[$g]['id'] = $g;
210 $boxes[$g]['flags'] = array();
211 if (isset($line[$g])) {
212 ereg("\(([^)]*)\)",$line[$g],$regs);
213 $flags = trim(strtolower(str_replace('\\', '',$regs[1])));
215 $boxes[$g]['flags'] = explode(' ', $flags);
224 * Sorting function used to sort mailbox names.
225 * + Original patch from dave_michmerhuizen@yahoo.com
226 * + Allows case insensitivity when sorting folders
227 * + Takes care of the delimiter being sorted to the end, causing
228 * subfolders to be listed in below folders that are prefixed
229 * with their parent folders name.
230 * For example: INBOX.foo, INBOX.foobar, and INBOX.foo.bar
231 * Without special sort function: foobar between foo and foo.bar
232 * With special sort function: foobar AFTER foo and foo.bar :)
234 function user_strcasecmp($a, $b) {
237 /* Calculate the length of some strings. */
238 $a_length = strlen($a);
239 $b_length = strlen($b);
240 $min_length = min($a_length, $b_length);
241 $delimiter_length = strlen($delimiter);
243 /* Set the initial result value. */
246 /* Check the strings... */
247 for ($c = 0; $c < $min_length; ++
$c) {
248 $a_del = substr($a, $c, $delimiter_length);
249 $b_del = substr($b, $c, $delimiter_length);
251 if (($a_del == $delimiter) && ($b_del == $delimiter)) {
253 } else if (($a_del == $delimiter) && ($b_del != $delimiter)) {
255 } else if (($a_del != $delimiter) && ($b_del == $delimiter)) {
258 $result = strcasecmp($a{$c}, $b{$c});
266 /* If one string is a prefix of the other... */
268 if ($a_length < $b_length) {
270 } else if ($a_length > $b_length) {
279 /******************************************************************************
280 ** Returns sorted mailbox lists in several different ways.
281 ** See comment on sqimap_mailbox_parse() for info about the returned array.
282 ******************************************************************************/
283 function sqimap_mailbox_list ($imap_stream) {
284 global $data_dir, $username, $list_special_folders_first;
285 global $folder_prefix, $trash_folder, $sent_folder, $draft_folder;
286 global $move_to_trash, $move_to_sent, $save_as_draft;
289 $inbox_in_list = false;
290 $inbox_subscribed = false;
292 require_once('../src/load_prefs.php');
293 require_once('../functions/array.php');
296 fputs ($imap_stream, sqimap_session_id() .
297 " LSUB \"$folder_prefix\" \"*\"\r\n");
298 $lsub_ary = sqimap_read_data ($imap_stream, sqimap_session_id(),
299 true, $response, $message);
301 /* Section about removing the last element was removed */
302 /* We don't return "* OK" anymore from sqimap_read_data */
304 $sorted_lsub_ary = array();
305 for ($i=0;$i < count($lsub_ary); $i++
) {
306 /* Workaround for EIMS */
307 /* Doesn't work if the mailbox name is multiple lines */
308 if (isset($lsub_ary[$i +
1]) &&
309 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
310 $lsub_ary[$i], $regs)) {
312 $lsub_ary[$i] = $regs[1] . '"' . addslashes(trim($lsub_ary[$i])) .
315 $temp_mailbox_name = find_mailbox_name($lsub_ary[$i]);
316 $sorted_lsub_ary[] = $temp_mailbox_name;
317 if (strtoupper($temp_mailbox_name) == 'INBOX') {
318 $inbox_subscribed = true;
322 for ($i=0; $i < count($sorted_lsub_ary); $i++
) {
323 if (!in_array($sorted_lsub_ary[$i], $new_ary)) {
324 $new_ary[] = $sorted_lsub_ary[$i];
327 $sorted_lsub_ary = $new_ary;
328 if (isset($sorted_lsub_ary)) {
329 usort($sorted_lsub_ary, 'user_strcasecmp');
333 $sorted_list_ary = array();
334 for ($i=0; $i < count($sorted_lsub_ary); $i++
) {
335 if (substr($sorted_lsub_ary[$i], -1) == $delimiter) {
336 $mbx = substr($sorted_lsub_ary[$i], 0, strlen($sorted_lsub_ary[$i])-1);
339 $mbx = $sorted_lsub_ary[$i];
342 fputs ($imap_stream, sqimap_session_id() . " LIST \"\" \"$mbx\"\r\n");
343 $read = sqimap_read_data ($imap_stream, sqimap_session_id(),
344 true, $response, $message);
345 /* Another workaround for EIMS */
346 if (isset($read[1]) &&
347 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
349 $read[0] = $regs[1] . '"' . addslashes(trim($read[1])) .
353 if (isset($sorted_list_ary[$i])) {
354 $sorted_list_ary[$i] = "";
357 if (isset($read[0])) {
358 $sorted_list_ary[$i] = $read[0];
361 $sorted_list_ary[$i] = "";
364 if (isset($sorted_list_ary[$i]) &&
365 strtoupper(find_mailbox_name($sorted_list_ary[$i])) == "INBOX") {
366 $inbox_in_list = true;
371 * Just in case they're not subscribed to their inbox,
372 * we'll get it for them anyway
374 if ($inbox_subscribed == false ||
$inbox_in_list == false) {
375 fputs ($imap_stream, sqimap_session_id() . " LIST \"\" \"INBOX\"\r\n");
376 $inbox_ary = sqimap_read_data ($imap_stream, sqimap_session_id(),
377 true, $response, $message);
378 /* Another workaround for EIMS */
379 if (isset($inbox_ary[1]) &&
380 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
381 $inbox_ary[0], $regs)) {
382 $inbox_ary[0] = $regs[1] . '"' . addslashes(trim($inbox_ary[1])) .
386 $sorted_list_ary[] = $inbox_ary[0];
387 $sorted_lsub_ary[] = find_mailbox_name($inbox_ary[0]);
390 $boxes = sqimap_mailbox_parse ($sorted_list_ary, $sorted_lsub_ary);
392 /** Now, lets sort for special folders **/
396 for ($i = 0; $i < count($boxes); $i++
) {
397 if (strtolower($boxes[$i]["unformatted"]) == "inbox") {
398 $boxesnew[] = $boxes[$i];
404 /* List special folders and their subfolders, if requested. */
405 if ($list_special_folders_first == true) {
406 /* First list the trash folder. */
407 for ($i = 0 ; $i < count($boxes) ; $i++
) {
408 if ($move_to_trash &&
409 eregi('^' . quotemeta($trash_folder) . '(' .
410 quotemeta($delimiter) . '.*)?$', $boxes[$i]['unformatted'])) {
411 $boxesnew[] = $boxes[$i];
416 /* Then list the sent folder. */
417 for ($i = 0 ; $i < count($boxes) ; $i++
) {
419 eregi('^' . quotemeta($sent_folder) . '(' .
420 quotemeta($delimiter) . '.*)?$', $boxes[$i]['unformatted'])) {
421 $boxesnew[] = $boxes[$i];
426 /* Lastly, list the list the draft folder. */
427 for ($i = 0 ; $i < count($boxes) ; $i++
) {
428 if ($save_as_draft &&
429 eregi('^' . quotemeta($draft_folder) . '(' .
430 quotemeta($delimiter) . '.*)?$', $boxes[$i]['unformatted'])) {
431 $boxesnew[] = $boxes[$i];
436 /* Put INBOX.* folders ahead of the rest. */
437 for ($i = 0; $i < count($boxes); $i++
) {
438 if (eregi('^inbox\\.', $boxes[$i]["unformatted"]) &&
439 (!isset($used[$i]) ||
$used[$i] == false)) {
440 $boxesnew[] = $boxes[$i];
446 /* Rest of the folders */
447 for ($i = 0; $i < count($boxes); $i++
) {
448 if ((strtolower($boxes[$i]["unformatted"]) != "inbox") &&
449 (!isset($used[$i]) ||
$used[$i] == false)) {
450 $boxesnew[] = $boxes[$i];
458 /******************************************************************************
459 ** Returns a list of all folders, subscribed or not
460 ******************************************************************************/
461 function sqimap_mailbox_list_all ($imap_stream)
463 global $list_special_folders_first, $folder_prefix;
466 if (!function_exists ("ary_sort")) {
467 include_once('../functions/array.php');
470 $ssid = sqimap_session_id();
471 $lsid = strlen( $ssid );
472 fputs ($imap_stream, $ssid . " LIST \"$folder_prefix\" *\r\n");
473 $read_ary = sqimap_read_data ($imap_stream, $ssid, true, $response, $message);
477 for ($i = 0; $i < count($read_ary); $i++
) {
478 /* Another workaround for EIMS */
479 if (isset($read_ary[$i +
1]) &&
480 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
481 $read_ary[$i], $regs)) {
483 $read_ary[$i] = $regs[1] . '"' .
484 addslashes(trim($read_ary[$i])) .
487 if (substr ($read_ary[$i], 0, $lsid) != $ssid ) {
489 /* Store the raw IMAP reply */
490 $boxes[$g]["raw"] = $read_ary[$i];
492 /* Count number of delimiters ($delimiter) in folder name */
493 $mailbox = find_mailbox_name($read_ary[$i]);
494 $dm_count = substr_count($mailbox, $delimiter);
495 if (substr($mailbox, -1) == $delimiter) {
496 /* If name ends in delimiter - decrement count by one */
500 /* Format folder name, but only if it's a INBOX.* or have */
502 $boxesbyname[$mailbox] = $g;
503 $parentfolder = readMailboxParent($mailbox, $delimiter);
504 if((eregi('^inbox'.quotemeta($delimiter), $mailbox)) ||
505 (ereg('^'.$folder_prefix, $mailbox)) ||
506 ( isset($boxesbyname[$parentfolder]) && (strlen($parentfolder) > 0) ) ) {
508 $boxes[$g]["formatted"] = str_repeat(" ", $dm_count);
511 $boxes[$g]["formatted"] = '';
513 $boxes[$g]["formatted"] .= readShortMailboxName($mailbox, $delimiter);
516 $boxes[$g]["formatted"] = $mailbox;
519 $boxes[$g]["unformatted-dm"] = $mailbox;
520 if (substr($mailbox, -1) == $delimiter) {
521 $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
523 $boxes[$g]["unformatted"] = $mailbox;
524 $boxes[$g]["unformatted-disp"] =
525 ereg_replace('^' . $folder_prefix, '', $mailbox);
526 $boxes[$g]["id"] = $g;
528 /** Now lets get the flags for this mailbox **/
529 fputs ($imap_stream, sqimap_session_id() . " LIST \"\" \"$mailbox\"\r\n");
530 $read_mlbx = sqimap_read_data ($imap_stream, sqimap_session_id(),
531 true, $response, $message);
533 /* Another workaround for EIMS */
534 if (isset($read_mlbx[1]) &&
535 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
536 $read_mlbx[0], $regs)) {
537 $read_mlbx[0] = $regs[1] . '"' .
538 addslashes(trim($read_mlbx[1])) .
542 $flags = substr($read_mlbx[0], strpos($read_mlbx[0], "(")+
1);
543 $flags = substr($flags, 0, strpos($flags, ")"));
544 $flags = str_replace('\\', '', $flags);
545 $flags = trim(strtolower($flags));
547 $boxes[$g]['flags'] = explode(" ", $flags);
550 $boxes[$g]['flags'] = array();
555 if(is_array($boxes)) {
556 $boxes = ary_sort ($boxes, "unformatted", 1);