Fix copyerror, this eliminates some warnings of undefined index in the msg list.
[squirrelmail.git] / functions / imap_mailbox.php
CommitLineData
59177427 1<?php
bccadd02 2
35586184 3/**
4 * imap_mailbox.php
5 *
76911253 6 * Copyright (c) 1999-2003 The SquirrelMail Project Team
35586184 7 * Licensed under the GNU GPL. For full terms see the file COPYING.
8 *
9 * This impliments all functions that manipulate mailboxes
10 *
11 * $Id$
12 */
334a77f8 13require_once(SM_PATH . 'functions/imap_utf7_local.php');
14
3411d4ec 15global $boxesnew;
1da22cda 16
60b5724d 17class mailboxes {
ff245fbd 18 var $mailboxname_full = '', $mailboxname_sub= '', $is_noselect = false,
19 $is_special = false, $is_root = false, $is_inbox = false, $is_sent = false,
20 $is_trash = false, $is_draft = false, $mbxs = array(),
21 $unseen = false, $total = false;
22
23 function addMbx($mbx, $delimiter, $start, $specialfirst) {
24 $ary = explode($delimiter, $mbx->mailboxname_full);
25 $mbx_parent = &$this;
26 for ($i = $start, $c = count($ary)-1; $i < $c; $i++) {
27 $mbx_childs = &$mbx_parent->mbxs;
28 $found = false;
29 if ($mbx_childs) {
30 foreach ($mbx_childs as $key => $parent) {
31 if ($parent->mailboxname_sub == $ary[$i]) {
32 $mbx_parent = &$mbx_parent->mbxs[$key];
33 $found = true;
34 }
35 }
36 }
37 if (!$found) {
38 $no_select_mbx = new mailboxes();
39 if (isset($mbx_parent->mailboxname_full) && $mbx_parent->mailboxname_full != '') {
40 $no_select_mbx->mailboxname_full = $mbx_parent->mailboxname_full.$delimiter.$ary[$i];
41 } else {
42 $no_select_mbx->mailboxname_full = $ary[$i];
43 }
44 $no_select_mbx->mailboxname_sub = $ary[$i];
45 $no_select_mbx->is_noselect = true;
46 $mbx_parent->mbxs[] = $no_select_mbx;
47 $i--;
48 }
49 }
50 $mbx_parent->mbxs[] = $mbx;
51 if ($mbx->is_special && $specialfirst) {
52 usort($mbx_parent->mbxs, 'sortSpecialMbx');
53 }
54 }
60b5724d 55}
56
57function sortSpecialMbx($a, $b) {
58 if ($a->is_inbox) {
ff245fbd 59 $acmp = '0'. $a->mailboxname_full;
60b5724d 60 } else if ($a->is_special) {
ff245fbd 61 $acmp = '1'. $a->mailboxname_full;
60b5724d 62 } else {
ff245fbd 63 $acmp = '2' . $a->mailboxname_full;
64 }
60b5724d 65 if ($b->is_inbox) {
ff245fbd 66 $bcmp = '0'. $b->mailboxname_full;
60b5724d 67 }else if ($b->is_special) {
ff245fbd 68 $bcmp = '1' . $b->mailboxname_full;
60b5724d 69 } else {
ff245fbd 70 $bcmp = '2' . $b->mailboxname_full;
60b5724d 71 }
72 if ($acmp == $bcmp) return 0;
ff245fbd 73 return ($acmp > $bcmp) ? 1: -1;
74}
60b5724d 75
79e07c7e 76function find_mailbox_name ($mailbox) {
d42310bd 77 if (preg_match('/\*.+\"([^\r\n\"]*)\"[\s\r\n]*$/', $mailbox, $regs))
78 return $regs[1];
79e07c7e 79 if (ereg(" *\"([^\r\n\"]*)\"[ \r\n]*$", $mailbox, $regs))
80 return $regs[1];
81 ereg(" *([^ \r\n\"]*)[ \r\n]*$",$mailbox,$regs);
82 return $regs[1];
f73348a3 83}
84
85function check_is_noselect ($lsub_line) {
86 return preg_match("/^\* LSUB \([^\)]*\\Noselect[^\)]*\)/i", $lsub_line);
79e07c7e 87}
88
97b1248c 89/**
90 * If $haystack is a full mailbox name, and $needle is the mailbox
91 * separator character, returns the second last part of the full
92 * mailbox name (i.e. the mailbox's parent mailbox)
93 */
94function readMailboxParent($haystack, $needle) {
97b1248c 95 if ($needle == '') {
96 $ret = '';
97 } else {
98 $parts = explode($needle, $haystack);
99 $elem = array_pop($parts);
100 while ($elem == '' && count($parts)) {
101 $elem = array_pop($parts);
102 }
103 $ret = join($needle, $parts);
104 }
105 return( $ret );
106}
107
6a8e7cae 108/**
109 * Check if $subbox is below the specified $parentbox
110 */
111function isBoxBelow( $subbox, $parentbox ) {
cef054e4 112 global $delimiter;
6a8e7cae 113 /*
114 * Eliminate the obvious mismatch, where the
115 * subfolder path is shorter than that of the potential parent
116 */
117 if ( strlen($subbox) < strlen($parentbox) ) {
118 return false;
119 }
cef054e4 120 /* check for delimiter */
121 if (!substr($parentbox,-1) == $delimiter) {
122 $parentbox.=$delimiter;
123 }
124 if (substr($subbox,0,strlen($parentbox)) == $parentbox) {
125 return true;
126 } else {
127 return false;
128 }
1e18bf95 129}
130
3411d4ec 131/* Defines special mailboxes */
1e18bf95 132function isSpecialMailbox( $box ) {
1e18bf95 133 global $trash_folder, $sent_folder, $draft_folder,
65c3ec94 134 $move_to_trash, $move_to_sent, $save_as_draft;
1e18bf95 135
90de1755 136 $ret = ( (strtolower($box) == 'inbox') ||
6a8e7cae 137 isTrashMailbox($box) || isSentMailbox($box) || isDraftMailbox($box) );
90de1755 138
2586d588 139 if ( !$ret ) {
31524bcd 140 $ret = do_hook_function( 'special_mailbox', $box );
2586d588 141 }
3411d4ec 142 return $ret;
90de1755 143}
144
6a8e7cae 145function isTrashMailbox ($box) {
146 global $trash_folder, $move_to_trash;
147 return $move_to_trash && $trash_folder &&
148 ( $box == $trash_folder || isBoxBelow($box, $trash_folder) );
149}
150
151function isSentMailbox($box) {
152 global $sent_folder, $move_to_sent;
153 return $move_to_sent && $sent_folder &&
154 ( $box == $sent_folder || isBoxBelow($box, $sent_folder) );
155}
156
157function isDraftMailbox($box) {
158 global $draft_folder, $save_as_draft;
159 return $save_as_draft &&
160 ( $box == $draft_folder || isBoxBelow($box, $draft_folder) );
161}
162
3411d4ec 163/* Expunges a mailbox */
8f6505f6 164function sqimap_mailbox_expunge ($imap_stream, $mailbox, $handle_errors = true, $id='') {
63240b90 165 global $uid_support;
06b5c3ff 166 if ($id) {
ff245fbd 167 if (is_array($id)) {
168 $id = sqimap_message_list_squisher($id);
169 }
170 $id = ' '.$id;
171 $uid = $uid_support;
06b5c3ff 172 } else {
ff245fbd 173 $uid = false;
8f6505f6 174 }
06b5c3ff 175 $read = sqimap_run_command($imap_stream, 'EXPUNGE'.$id, $handle_errors,
176 $response, $message, $uid);
63240b90 177 $cnt = 0;
ff245fbd 178
179 if (is_array($read)) {
63240b90 180 foreach ($read as $r) {
ff245fbd 181 if (preg_match('/^\*\s[0-9]+\sEXPUNGE/AUi',$r,$regs)) {
182 $cnt++;
183 }
63240b90 184 }
8f6505f6 185 }
ff245fbd 186 return $cnt;
43b698c7 187}
188
3411d4ec 189/* Checks whether or not the specified mailbox exists */
1da22cda 190function sqimap_mailbox_exists ($imap_stream, $mailbox) {
ff245fbd 191 if (!isset($mailbox)) {
43b698c7 192 return false;
193 }
1c72b151 194 $mbx = sqimap_run_command($imap_stream, "LIST \"\" \"$mailbox\"",
3411d4ec 195 true, $response, $message);
43b698c7 196 return isset($mbx[0]);
197}
198
3411d4ec 199/* Selects a mailbox */
e4c6fe41 200function sqimap_mailbox_select ($imap_stream, $mailbox) {
43b698c7 201 global $auto_expunge;
f69feefe 202
ff245fbd 203 if ($mailbox == 'None') {
43b698c7 204 return;
205 }
f69feefe 206
1c72b151 207 $read = sqimap_run_command($imap_stream, "SELECT \"$mailbox\"",
3411d4ec 208 true, $response, $message);
e4c6fe41 209 $result = array();
ff245fbd 210 for ($i = 0, $cnt = count($read); $i < $cnt; $i++) {
e4c6fe41 211 if (preg_match('/^\*\s+OK\s\[(\w+)\s(\w+)\]/',$read[$i], $regs)) {
ff245fbd 212 $result[strtoupper($regs[1])] = $regs[2];
213 } else if (preg_match('/^\*\s([0-9]+)\s(\w+)/',$read[$i], $regs)) {
214 $result[strtoupper($regs[2])] = $regs[1];
215 } else {
216 if (preg_match("/PERMANENTFLAGS(.*)/i",$read[$i], $regs)) {
217 $regs[1]=trim(preg_replace ( array ("/\(/","/\)/","/\]/") ,'', $regs[1])) ;
218 $result['PERMANENTFLAGS'] = $regs[1];
219 } else if (preg_match("/FLAGS(.*)/i",$read[$i], $regs)) {
220 $regs[1]=trim(preg_replace ( array ("/\(/","/\)/") ,'', $regs[1])) ;
221 $result['FLAGS'] = $regs[1];
222 }
223 }
e4c6fe41 224 }
225 if (preg_match('/^\[(.+)\]/',$message, $regs)) {
ff245fbd 226 $result['RIGHTS']=$regs[1];
e4c6fe41 227 }
f69feefe 228
e4c6fe41 229 if ($auto_expunge) {
ff245fbd 230 $tmp = sqimap_run_command($imap_stream, 'EXPUNGE', false, $a, $b);
43b698c7 231 }
e4c6fe41 232 return $result;
43b698c7 233}
234
3411d4ec 235/* Creates a folder */
236function sqimap_mailbox_create ($imap_stream, $mailbox, $type) {
43b698c7 237 global $delimiter;
238 if (strtolower($type) == 'noselect') {
3411d4ec 239 $mailbox .= $delimiter;
43b698c7 240 }
e429f014 241
1c72b151 242 $read_ary = sqimap_run_command($imap_stream, "CREATE \"$mailbox\"",
3411d4ec 243 true, $response, $message);
43b698c7 244 sqimap_subscribe ($imap_stream, $mailbox);
245}
246
3411d4ec 247/* Subscribes to an existing folder */
248function sqimap_subscribe ($imap_stream, $mailbox) {
1a16af11 249 $read_ary = sqimap_run_command($imap_stream, "SUBSCRIBE \"$mailbox\"",
3411d4ec 250 true, $response, $message);
43b698c7 251}
252
3411d4ec 253/* Unsubscribes to an existing folder */
254function sqimap_unsubscribe ($imap_stream, $mailbox) {
1a16af11 255 $read_ary = sqimap_run_command($imap_stream, "UNSUBSCRIBE \"$mailbox\"",
3411d4ec 256 true, $response, $message);
43b698c7 257}
258
3411d4ec 259/* Deletes the given folder */
260function sqimap_mailbox_delete ($imap_stream, $mailbox) {
78cc4b12 261 global $data_dir, $username;
1c72b151 262 $read_ary = sqimap_run_command($imap_stream, "DELETE \"$mailbox\"",
3411d4ec 263 true, $response, $message);
43b698c7 264 sqimap_unsubscribe ($imap_stream, $mailbox);
e429f014 265 do_hook_function('rename_or_delete_folder', $args = array($mailbox, 'delete', ''));
78cc4b12 266 removePref($data_dir, $username, "thread_$mailbox");
43b698c7 267}
268
3411d4ec 269/* Determines if the user is subscribed to the folder or not */
1da22cda 270function sqimap_mailbox_is_subscribed($imap_stream, $folder) {
1da22cda 271 $boxesall = sqimap_mailbox_list ($imap_stream);
272 foreach ($boxesall as $ref) {
43b698c7 273 if ($ref['unformatted'] == $folder) {
3411d4ec 274 return true;
43b698c7 275 }
276 }
277 return false;
278}
279
3411d4ec 280/* Renames a mailbox */
1c52ba77 281function sqimap_mailbox_rename( $imap_stream, $old_name, $new_name ) {
3411d4ec 282 if ( $old_name != $new_name ) {
78cc4b12 283 global $delimiter, $imap_server_type, $data_dir, $username;
1c52ba77 284 if ( substr( $old_name, -1 ) == $delimiter ) {
285 $old_name = substr( $old_name, 0, strlen( $old_name ) - 1 );
286 $new_name = substr( $new_name, 0, strlen( $new_name ) - 1 );
287 $postfix = $delimiter;
1c52ba77 288 } else {
289 $postfix = '';
1c52ba77 290 }
68f2ce7a 291
648713af 292 $boxesall = sqimap_mailbox_list($imap_stream);
68f2ce7a 293 $cmd = 'RENAME "' . $old_name . '" "' . $new_name . '"';
3411d4ec 294 $data = sqimap_run_command($imap_stream, $cmd, true, $response, $message);
1c52ba77 295 sqimap_unsubscribe($imap_stream, $old_name.$postfix);
68f2ce7a 296 $oldpref = getPref($data_dir, $username, 'thread_'.$old_name.$postfix);
297 removePref($data_dir, $username, 'thread_'.$old_name.$postfix);
1c52ba77 298 sqimap_subscribe($imap_stream, $new_name.$postfix);
68f2ce7a 299 setPref($data_dir, $username, 'thread_'.$new_name.$postfix, $oldpref);
e429f014 300 do_hook_function('rename_or_delete_folder',$args = array($old_name, 'rename', $new_name));
648713af 301 $l = strlen( $old_name ) + 1;
302 $p = 'unformatted';
68f2ce7a 303
ff245fbd 304 foreach ($boxesall as $box) {
305 if (substr($box[$p], 0, $l) == $old_name . $delimiter) {
648713af 306 $new_sub = $new_name . $delimiter . substr($box[$p], $l);
307 if ($imap_server_type == 'cyrus') {
68f2ce7a 308 $cmd = 'RENAME "' . $box[$p] . '" "' . $new_sub . '"';
3411d4ec 309 $data = sqimap_run_command($imap_stream, $cmd, true,
648713af 310 $response, $message);
1c52ba77 311 }
648713af 312 sqimap_unsubscribe($imap_stream, $box[$p]);
68f2ce7a 313 $oldpref = getPref($data_dir, $username, 'thread_'.$box[$p]);
314 removePref($data_dir, $username, 'thread_'.$box[$p]);
648713af 315 sqimap_subscribe($imap_stream, $new_sub);
68f2ce7a 316 setPref($data_dir, $username, 'thread_'.$new_sub, $oldpref);
317 do_hook_function('rename_or_delete_folder',
3411d4ec 318 $args = array($box[$p], 'rename', $new_sub));
1c52ba77 319 }
320 }
1c52ba77 321 }
1c52ba77 322}
43b698c7 323
3411d4ec 324/*
325 * Formats a mailbox into 4 parts for the $boxesall array
326 *
327 * The four parts are:
328 *
329 * raw - Raw LIST/LSUB response from the IMAP server
330 * formatted - nicely formatted folder name
331 * unformatted - unformatted, but with delimiter at end removed
332 * unformatted-dm - folder name as it appears in raw response
333 * unformatted-disp - unformatted without $folder_prefix
334 */
335function sqimap_mailbox_parse ($line, $line_lsub) {
43b698c7 336 global $folder_prefix, $delimiter;
3411d4ec 337
43b698c7 338 /* Process each folder line */
cef054e4 339 for ($g = 0, $cnt = count($line); $g < $cnt; ++$g) {
43b698c7 340 /* Store the raw IMAP reply */
341 if (isset($line[$g])) {
e429f014 342 $boxesall[$g]['raw'] = $line[$g];
ff245fbd 343 } else {
e429f014 344 $boxesall[$g]['raw'] = '';
43b698c7 345 }
3411d4ec 346
43b698c7 347 /* Count number of delimiters ($delimiter) in folder name */
ff245fbd 348 $mailbox = trim($line_lsub[$g]);
349 $dm_count = substr_count($mailbox, $delimiter);
43b698c7 350 if (substr($mailbox, -1) == $delimiter) {
3411d4ec 351 /* If name ends in delimiter, decrement count by one */
352 $dm_count--;
43b698c7 353 }
3411d4ec 354
355 /* Format folder name, but only if it's a INBOX.* or has a parent. */
1da22cda 356 $boxesallbyname[$mailbox] = $g;
43b698c7 357 $parentfolder = readMailboxParent($mailbox, $delimiter);
358 if ( (strtolower(substr($mailbox, 0, 5)) == "inbox") ||
359 (substr($mailbox, 0, strlen($folder_prefix)) == $folder_prefix) ||
ff245fbd 360 (isset($boxesallbyname[$parentfolder]) &&
361 (strlen($parentfolder) > 0) ) ) {
362 $indent = $dm_count - (substr_count($folder_prefix, $delimiter));
43b698c7 363 if ($indent > 0) {
ff245fbd 364 $boxesall[$g]['formatted'] = str_repeat('&nbsp;&nbsp;', $indent);
365 } else {
1da22cda 366 $boxesall[$g]['formatted'] = '';
43b698c7 367 }
447b2166 368 $boxesall[$g]['formatted'] .= imap_utf7_decode_local(readShortMailboxName($mailbox, $delimiter));
ff245fbd 369 } else {
447b2166 370 $boxesall[$g]['formatted'] = imap_utf7_decode_local($mailbox);
43b698c7 371 }
90de1755 372
1da22cda 373 $boxesall[$g]['unformatted-dm'] = $mailbox;
43b698c7 374 if (substr($mailbox, -1) == $delimiter) {
8e9e8afa 375 $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
43b698c7 376 }
1da22cda 377 $boxesall[$g]['unformatted'] = $mailbox;
43b698c7 378 if (substr($mailbox,0,strlen($folder_prefix))==$folder_prefix) {
631b9da3 379 $mailbox = substr($mailbox, strlen($folder_prefix));
43b698c7 380 }
1da22cda 381 $boxesall[$g]['unformatted-disp'] = $mailbox;
382 $boxesall[$g]['id'] = $g;
90de1755 383
1da22cda 384 $boxesall[$g]['flags'] = array();
43b698c7 385 if (isset($line[$g])) {
36dfb0c9 386 ereg("\(([^)]*)\)",$line[$g],$regs);
1a7e1e97 387 $flags = trim(strtolower(str_replace('\\', '',$regs[1])));
43b698c7 388 if ($flags) {
1da22cda 389 $boxesall[$g]['flags'] = explode(' ', $flags);
43b698c7 390 }
391 }
392 }
1da22cda 393 return $boxesall;
43b698c7 394}
395
3411d4ec 396/*
a3439b27 397 * Sorting function used to sort mailbox names.
3411d4ec 398 * + Original patch from dave_michmerhuizen@yahoo.com
399 * + Allows case insensitivity when sorting folders
400 * + Takes care of the delimiter being sorted to the end, causing
401 * subfolders to be listed in below folders that are prefixed
402 * with their parent folders name.
403 *
404 * For example: INBOX.foo, INBOX.foobar, and INBOX.foo.bar
405 * Without special sort function: foobar between foo and foo.bar
406 * With special sort function: foobar AFTER foo and foo.bar :)
43b698c7 407 */
a3439b27 408function user_strcasecmp($a, $b) {
d42310bd 409 return strnatcasecmp($a, $b);
43b698c7 410}
411
be2d5495 412/*
413 * Returns list of options (to be echoed into select statement
414 * based on available mailboxes and separators
415 * Caller should surround options with <SELECT..> </SELECT> and
416 * any formatting.
417 * $imap_stream - $imapConnection to query for mailboxes
418 * $show_selected - array containing list of mailboxes to pre-select (0 if none)
419 * $folder_skip - array of folders to keep out of option list (compared in lower)
420 * $boxes - list of already fetched boxes (for places like folder panel, where
421 * you know these options will be shown 3 times in a row.. (most often unset).
422 */
423function sqimap_mailbox_option_list($imap_stream, $show_selected = 0, $folder_skip = 0, $boxes = 0 ) {
424 global $username, $data_dir;
425 $mbox_options = '';
426
427 $shorten_box_names = getPref($data_dir, $username, 'mailbox_select_style', SMPREF_OFF);
ff245fbd 428
429 if ($boxes == 0) {
be2d5495 430 $boxes = sqimap_mailbox_list($imap_stream);
ff245fbd 431 }
be2d5495 432 foreach ($boxes as $boxes_part) {
433 if (!in_array('noselect', $boxes_part['flags'])) {
434 $box = $boxes_part['unformatted'];
435 $lowerbox = strtolower($box);
436
ff245fbd 437 if ($folder_skip != 0 && in_array($lowerbox, $folder_skip) ) {
be2d5495 438 continue;
439 }
440 if ($lowerbox == 'inbox'){
441 $box2 = _("INBOX");
442 } else if ( $shorten_box_names == 2 ) { /* delimited, style = 2 */
443 $box2 = str_replace('&nbsp;&nbsp;', '.&nbsp;', $boxes_part['formatted']);
444 } else if ( $shorten_box_names == 1 ) { /* indent, style = 1 */
445 $box2 = $boxes_part['formatted'];
446 } else { /* default, long names, style = 0 */
447 $box2 = str_replace(' ', '&nbsp;', imap_utf7_decode_local($boxes_part['unformatted-disp']));
448 }
449 if ($show_selected != 0 && in_array($lowerbox, $show_selected) ) {
450 $mbox_options .= '<OPTION VALUE="'.$box.'" SELECTED>'.$box2.'</OPTION>' . "\n";
451 } else {
452 $mbox_options .= '<OPTION VALUE="'.$box.'">'.$box2.'</OPTION>' . "\n";
453 }
454 }
455 }
456 return $mbox_options;
457}
43b698c7 458
3411d4ec 459/*
460 * Returns sorted mailbox lists in several different ways.
461 * See comment on sqimap_mailbox_parse() for info about the returned array.
462 */
1da22cda 463function sqimap_mailbox_list($imap_stream) {
4b2fe13a 464 global $default_folder_prefix;
7e235a1a 465
ff245fbd 466 if (!isset($boxesnew)) {
3411d4ec 467 global $data_dir, $username, $list_special_folders_first,
7e235a1a 468 $folder_prefix, $trash_folder, $sent_folder, $draft_folder,
469 $move_to_trash, $move_to_sent, $save_as_draft,
ca85aabe 470 $delimiter, $noselect_fix_enable;
7e235a1a 471
3411d4ec 472 $inbox_in_list = false;
473 $inbox_subscribed = false;
7e235a1a 474
08185f2a 475 require_once(SM_PATH . 'include/load_prefs.php');
7e235a1a 476
ff245fbd 477 if ($noselect_fix_enable) {
478 $lsub_args = "LSUB \"$folder_prefix\" \"*%\"";
479 } else {
480 $lsub_args = "LSUB \"$folder_prefix\" \"*\"";
481 }
3411d4ec 482 /* LSUB array */
ca85aabe 483 $lsub_ary = sqimap_run_command ($imap_stream, $lsub_args,
3411d4ec 484 true, $response, $message);
7e235a1a 485
7e235a1a 486 $sorted_lsub_ary = array();
ff245fbd 487 for ($i = 0, $cnt = count($lsub_ary);$i < $cnt; $i++) {
3411d4ec 488 /*
cef054e4 489 * Workaround for mailboxes returned as literal
490 * Doesn't work if the mailbox name is multiple lines
491 * (larger then fgets buffer)
3411d4ec 492 */
cef054e4 493 if (isset($lsub_ary[$i + 1]) && substr($lsub_ary[$i],-3) == "}\r\n") {
494 if (ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
7e235a1a 495 $lsub_ary[$i], $regs)) {
cef054e4 496 $i++;
497 $lsub_ary[$i] = $regs[1] . '"' . addslashes(trim($lsub_ary[$i])) . '"' . $regs[2];
498 }
7e235a1a 499 }
500 $temp_mailbox_name = find_mailbox_name($lsub_ary[$i]);
501 $sorted_lsub_ary[] = $temp_mailbox_name;
cef054e4 502 if (!$inbox_subscribed && strtoupper($temp_mailbox_name) == 'INBOX') {
3411d4ec 503 $inbox_subscribed = true;
7e235a1a 504 }
505 }
cef054e4 506 /* remove duplicates */
507 $sorted_lsub_ary = array_unique($sorted_lsub_ary);
508
509 /* natural sort mailboxes */
7e235a1a 510 if (isset($sorted_lsub_ary)) {
511 usort($sorted_lsub_ary, 'user_strcasecmp');
512 }
cef054e4 513 /*
514 * The LSUB response doesn't provide us information about \Noselect
515 * mail boxes. The LIST response does, that's why we need to do a LIST
516 * call to retrieve the flags for the mailbox
517 * Note: according RFC2060 an imap server may provide \NoSelect flags in the LSUB response.
518 * in other words, we cannot rely on it.
519 */
520 $sorted_list_ary = array();
ff245fbd 521 for ($i=0; $i < count($sorted_lsub_ary); $i++) {
7e235a1a 522 if (substr($sorted_lsub_ary[$i], -1) == $delimiter) {
523 $mbx = substr($sorted_lsub_ary[$i], 0, strlen($sorted_lsub_ary[$i])-1);
524 }
525 else {
526 $mbx = $sorted_lsub_ary[$i];
527 }
528
529 $read = sqimap_run_command ($imap_stream, "LIST \"\" \"$mbx\"",
3411d4ec 530 true, $response, $message);
7e235a1a 531
cef054e4 532 /* Another workaround for literals */
533
534 if (isset($read[1]) && substr($read[1],-3) == "}\r\n") {
535 if (ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
536 $read[0], $regs)) {
537 $read[0] = $regs[1] . '"' . addslashes(trim($read[1])) . '"' . $regs[2];
538 }
7e235a1a 539 }
540
541 if (isset($read[0])) {
542 $sorted_list_ary[$i] = $read[0];
cef054e4 543 } else {
7e235a1a 544 $sorted_list_ary[$i] = '';
545 }
7e235a1a 546 }
cef054e4 547
3411d4ec 548 /*
7e235a1a 549 * Just in case they're not subscribed to their inbox,
550 * we'll get it for them anyway
551 */
cef054e4 552 if (!$inbox_subscribed) {
7e235a1a 553 $inbox_ary = sqimap_run_command ($imap_stream, "LIST \"\" \"INBOX\"",
3411d4ec 554 true, $response, $message);
cef054e4 555 /* Another workaround for literals */
322f4e37 556 if (isset($inbox_ary[1]) && substr($inbox_ary[0],-3) == "}\r\n") {
cef054e4 557 if (ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
7e235a1a 558 $inbox_ary[0], $regs)) {
cef054e4 559 $inbox_ary[0] = $regs[1] . '"' . addslashes(trim($inbox_ary[1])) .
ff245fbd 560 '"' . $regs[2];
cef054e4 561 }
7e235a1a 562 }
7e235a1a 563 $sorted_list_ary[] = $inbox_ary[0];
564 $sorted_lsub_ary[] = find_mailbox_name($inbox_ary[0]);
565 }
566
567 $boxesall = sqimap_mailbox_parse ($sorted_list_ary, $sorted_lsub_ary);
568
3411d4ec 569 /* Now, lets sort for special folders */
7e235a1a 570 $boxesnew = $used = array();
571
572 /* Find INBOX */
ff245fbd 573 $cnt = count($boxesall);
cef054e4 574 $used = array_pad($used,$cnt,false);
575 for($k = 0; $k < $cnt; ++$k) {
ff245fbd 576 if (strtolower($boxesall[$k]['unformatted']) == 'inbox') {
577 $boxesnew[] = $boxesall[$k];
3411d4ec 578 $used[$k] = true;
cef054e4 579 break;
7e235a1a 580 }
581 }
7e235a1a 582 /* List special folders and their subfolders, if requested. */
3411d4ec 583 if ($list_special_folders_first) {
cef054e4 584 for($k = 0; $k < $cnt; ++$k) {
ff245fbd 585 if (!$used[$k] && isSpecialMailbox($boxesall[$k]['unformatted'])) {
586 $boxesnew[] = $boxesall[$k];
587 $used[$k] = true;
7e235a1a 588 }
cef054e4 589 }
590 }
7e235a1a 591
7e235a1a 592 /* Rest of the folders */
ff245fbd 593 for($k = 0; $k < $cnt; $k++) {
594 if (!$used[$k]) {
595 $boxesnew[] = $boxesall[$k];
7e235a1a 596 }
597 }
43b698c7 598 }
3411d4ec 599 return $boxesnew;
43b698c7 600}
601
90de1755 602/*
603 * Returns a list of all folders, subscribed or not
604 */
1da22cda 605function sqimap_mailbox_list_all($imap_stream) {
3411d4ec 606 global $list_special_folders_first, $folder_prefix, $delimiter;
90de1755 607
43b698c7 608 $ssid = sqimap_session_id();
90de1755 609 $lsid = strlen( $ssid );
43b698c7 610 fputs ($imap_stream, $ssid . " LIST \"$folder_prefix\" *\r\n");
3411d4ec 611 $read_ary = sqimap_read_data ($imap_stream, $ssid, true, $response, $message);
43b698c7 612 $g = 0;
90de1755 613 $phase = 'inbox';
7d82bceb 614 $fld_pre_length = strlen($folder_prefix);
90de1755 615
ff245fbd 616 for ($i = 0, $cnt = count($read_ary); $i < $cnt; $i++) {
43b698c7 617 /* Another workaround for EIMS */
618 if (isset($read_ary[$i + 1]) &&
90de1755 619 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
43b698c7 620 $read_ary[$i], $regs)) {
621 $i ++;
3411d4ec 622 $read_ary[$i] = $regs[1] . '"' . addslashes(trim($read_ary[$i])) . '"' . $regs[2];
43b698c7 623 }
90de1755 624 if (substr($read_ary[$i], 0, $lsid) != $ssid ) {
43b698c7 625 /* Store the raw IMAP reply */
65c3ec94 626 $boxes[$g]['raw'] = $read_ary[$i];
1c52ba77 627
43b698c7 628 /* Count number of delimiters ($delimiter) in folder name */
8e9e8afa 629 $mailbox = find_mailbox_name($read_ary[$i]);
602e1431 630 $dm_count = substr_count($mailbox, $delimiter);
43b698c7 631 if (substr($mailbox, -1) == $delimiter) {
0cfd745a 632 /* If name ends in delimiter - decrement count by one */
90de1755 633 $dm_count--;
43b698c7 634 }
90de1755 635
3411d4ec 636 /* Format folder name, but only if it's a INBOX.* or has a parent. */
1da22cda 637 $boxesallbyname[$mailbox] = $g;
525b7ae6 638 $parentfolder = readMailboxParent($mailbox, $delimiter);
90de1755 639 if((eregi('^inbox'.quotemeta($delimiter), $mailbox)) ||
146e0c45 640 (ereg('^'.$folder_prefix, $mailbox)) ||
1da22cda 641 ( isset($boxesallbyname[$parentfolder]) && (strlen($parentfolder) > 0) ) ) {
43b698c7 642 if ($dm_count) {
90de1755 643 $boxes[$g]['formatted'] = str_repeat('&nbsp;&nbsp;', $dm_count);
ff245fbd 644 } else {
90de1755 645 $boxes[$g]['formatted'] = '';
43b698c7 646 }
447b2166 647 $boxes[$g]['formatted'] .= imap_utf7_decode_local(readShortMailboxName($mailbox, $delimiter));
ff245fbd 648 } else {
447b2166 649 $boxes[$g]['formatted'] = imap_utf7_decode_local($mailbox);
43b698c7 650 }
90de1755 651
1da22cda 652 $boxes[$g]['unformatted-dm'] = $mailbox;
43b698c7 653 if (substr($mailbox, -1) == $delimiter) {
654 $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
655 }
90de1755 656 $boxes[$g]['unformatted'] = $mailbox;
7d82bceb 657 $boxes[$g]['unformatted-disp'] = substr($mailbox,$fld_pre_length);
658
90de1755 659 $boxes[$g]['id'] = $g;
660
3411d4ec 661 /* Now lets get the flags for this mailbox */
ff245fbd 662 $read_mlbx = $read_ary[$i];
7d82bceb 663
664// $read_mlbx = sqimap_run_command ($imap_stream, "LIST \"\" \"$mailbox\"",
665// true, $response, $message);
90de1755 666
43b698c7 667 /* Another workaround for EIMS */
7d82bceb 668// if (isset($read_mlbx[1]) &&
669// ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$", $read_mlbx[0], $regs)) {
670// $read_mlbx[0] = $regs[1] . '"' . addslashes(trim($read_mlbx[1])) . '"' . $regs[2];
671// }
ff245fbd 672// echo $read_mlbx[0] .' raw 2 <br>';
90de1755 673
7d82bceb 674 $flags = substr($read_mlbx, strpos($read_mlbx, '(')+1);
90de1755 675 $flags = substr($flags, 0, strpos($flags, ')'));
146e0c45 676 $flags = str_replace('\\', '', $flags);
8e9e8afa 677 $flags = trim(strtolower($flags));
678 if ($flags) {
1c52ba77 679 $boxes[$g]['flags'] = explode(' ', $flags);
90de1755 680 } else {
43b698c7 681 $boxes[$g]['flags'] = array();
12d61439 682 }
43b698c7 683 }
684 $g++;
685 }
686 if(is_array($boxes)) {
e429f014 687 sort ($boxes);
43b698c7 688 }
90de1755 689
43b698c7 690 return $boxes;
691}
5bdd7223 692
60b5724d 693function sqimap_mailbox_tree($imap_stream) {
694 global $boxesnew, $default_folder_prefix, $unseen_notify, $unseen_type;
ff245fbd 695 if (!isset($boxesnew)) {
60b5724d 696
697 global $data_dir, $username, $list_special_folders_first,
e4c6fe41 698 $folder_prefix, $delimiter, $trash_folder, $move_to_trash;
60b5724d 699
700
701 $inbox_in_list = false;
702 $inbox_subscribed = false;
703
08185f2a 704 require_once(SM_PATH . 'include/load_prefs.php');
60b5724d 705
706 /* LSUB array */
2c617aa5 707 $lsub_ary = sqimap_run_command ($imap_stream, "LSUB \"$folder_prefix\" \"*\"",
60b5724d 708 true, $response, $message);
709
710 /*
711 * Section about removing the last element was removed
712 * We don't return "* OK" anymore from sqimap_read_data
713 */
714 $sorted_lsub_ary = array();
e4c6fe41 715 $cnt = count($lsub_ary);
ff245fbd 716 for ($i = 0; $i < $cnt; $i++) {
60b5724d 717 /*
718 * Workaround for EIMS
719 * Doesn't work if the mailbox name is multiple lines
720 */
721 if (isset($lsub_ary[$i + 1]) &&
722 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
723 $lsub_ary[$i], $regs)) {
ff245fbd 724 $i++;
60b5724d 725 $lsub_ary[$i] = $regs[1] . '"' . addslashes(trim($lsub_ary[$i])) . '"' . $regs[2];
726 }
727
ff245fbd 728 /*
729 if (preg_match("/^\*\s+LSUB\s+\((.*)\)\s+\"(.*)\"\s+\"?(.+(?=\")|.+).*$/",$lsub_ary[$i],$regs)) {
730 $flag = $regs[1];
731 $mbx = trim($regs[3]);
732 $sorted_lsub_ary[] = array ('mbx' => $mbx, 'flag' => $flag);
733 }
734 */
735 $mbx = find_mailbox_name($lsub_ary[$i]);
736 $noselect = check_is_noselect($lsub_ary[$i]);
737 if (substr($mbx, -1) == $delimiter) {
738 $mbx = substr($mbx, 0, strlen($mbx) - 1);
739 }
740 $sorted_lsub_ary[] = array ('mbx' => $mbx, 'noselect' => $noselect);
60b5724d 741 }
ff245fbd 742 array_multisort($sorted_lsub_ary, SORT_ASC, SORT_REGULAR);
60b5724d 743
ff245fbd 744 for($i = 0; $i < $cnt; $i++) {
745 if ($sorted_lsub_ary[$i]['mbx'] == 'INBOX') {
60b5724d 746 $inbox_in_list = true;
ff245fbd 747 break;
60b5724d 748 }
ff245fbd 749 }
60b5724d 750
751 /*
752 * Just in case they're not subscribed to their inbox,
753 * we'll get it for them anyway
754 */
755 if (!$inbox_in_list) {
756 $inbox_ary = sqimap_run_command ($imap_stream, "LIST \"\" \"INBOX\"",
757 true, $response, $message);
758 /* Another workaround for EIMS */
759 if (isset($inbox_ary[1]) &&
760 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
761 $inbox_ary[0], $regs)) {
762 $inbox_ary[0] = $regs[1] . '"' . addslashes(trim($inbox_ary[1])) .
ff245fbd 763 '"' . $regs[2];
764 }
765 $mbx = find_mailbox_name($inbox_ary[0]);
766 if (substr($mbx, -1) == $delimiter) {
767 $mbx = substr($mbx, 0, strlen($mbx) - 1);
768 }
769 if ($mbx == 'INBOX') {
770 $sorted_lsub_ary[] = array ('mbx' => $mbx, 'flag' => '');
771 sqimap_subscribe($imap_stream, 'INBOX');
772 $cnt++;
773 }
774
775 /*
776 if (preg_match("/^\*\s+LIST\s+\((.*)\)\s+\"(.*)\"\s+\"?(.+(?=\")|.+).*$/",$inbox_ary[0],$regs)) {
777 $flag = $regs[1];
778 $mbx = trim($regs[3]);
779 if (substr($mbx, -1) == $delimiter) {
780 $mbx = substr($mbx, 0, strlen($mbx) - 1);
781 }
782 $sorted_lsub_ary[] = array ('mbx' => $mbx, 'flag' => $flag);
783 }
784 */
785 }
786 for ($i = 0 ; $i < $cnt; $i++) {
787 $mbx = $sorted_lsub_ary[$i]['mbx'];
788 if (($unseen_notify == 2 && $mbx == 'INBOX') ||
789 ($unseen_notify == 3) ||
790 ($move_to_trash && ($mbx == $trash_folder))) {
791 if($sorted_lsub_ary[$i]['noselect']) {
792 $sorted_lsub_ary[$i]['unseen'] = 0;
793 } else {
794 $sorted_lsub_ary[$i]['unseen'] =
795 sqimap_unseen_messages($imap_stream, $mbx);
796 }
797 if (($unseen_type == 2) ||
798 ($move_to_trash && ($mbx == $trash_folder)) ||
799 ($mbx == $trash_folder)) {
800 if($sorted_lsub_ary[$i]['noselect']) {
801 $sorted_lsub_ary[$i]['nummessages'] = 0;
802 } else {
803 $sorted_lsub_ary[$i]['nummessages'] =
804 sqimap_get_num_messages($imap_stream, $mbx);
805 }
806 }
807 }
808 }
809 $boxesnew = sqimap_fill_mailbox_tree($sorted_lsub_ary);
810 return $boxesnew;
60b5724d 811 }
812}
813
814
815function sqimap_fill_mailbox_tree($mbx_ary, $mbxs=false) {
816 global $data_dir, $username, $list_special_folders_first,
817 $folder_prefix, $trash_folder, $sent_folder, $draft_folder,
818 $move_to_trash, $move_to_sent, $save_as_draft,
819 $delimiter;
820
821 $special_folders = array ('INBOX', $sent_folder, $draft_folder, $trash_folder);
ff245fbd 822
60b5724d 823 /* create virtual root node */
824 $mailboxes= new mailboxes();
825 $mailboxes->is_root = true;
ff245fbd 826 $trail_del = false;
60b5724d 827 if (isset($folder_prefix) && $folder_prefix != '') {
ff245fbd 828 $start = substr_count($folder_prefix,$delimiter);
829 if (strrpos($folder_prefix, $delimiter) == (strlen($folder_prefix)-1)) {
830 $trail_del = true;
831 $mailboxes->mailboxname_full = substr($folder_prefix,0, (strlen($folder_prefix)-1));
832 } else {
833 $mailboxes->mailboxname_full = $folder_prefix;
834 $start++;
835 }
836 $mailboxes->mailboxname_sub = $mailboxes->mailboxname_full;
837 } else {
838 $start = 0;
839 }
e4c6fe41 840 $cnt = count($mbx_ary);
841 for ($i=0; $i < $cnt; $i++) {
ff245fbd 842 if ($mbx_ary[$i]['mbx'] !='' ) {
843 $mbx = new mailboxes();
844 $mailbox = $mbx_ary[$i]['mbx'];
845 switch ($mailbox) {
846 case 'INBOX':
847 $mbx->is_inbox = true;
848 $mbx->is_special = true;
849 break;
850 case $trash_folder:
851 $mbx->is_trash = true;
852 $mbx->is_special = true;
853 break;
854 case $sent_folder:
855 $mbx->is_sent = true;
856 $mbx->is_special = true;
857 break;
858 case $draft_folder:
859 $mbx->is_draft = true;
860 $mbx->is_special = true;
861 break;
862 }
863
864 if (isset($mbx_ary[$i]['unseen'])) {
865 $mbx->unseen = $mbx_ary[$i]['unseen'];
866 }
867 if (isset($mbx_ary[$i]['nummessages'])) {
868 $mbx->total = $mbx_ary[$i]['nummessages'];
869 }
870
871 $mbx->is_noselect = $mbx_ary[$i]['noselect'];
872
60b5724d 873 $r_del_pos = strrpos($mbx_ary[$i]['mbx'], $delimiter);
ff245fbd 874 if ($r_del_pos) {
875 $mbx->mailboxname_sub = substr($mbx_ary[$i]['mbx'],$r_del_pos+1);
876 } else { /* mailbox is root folder */
877 $mbx->mailboxname_sub = $mbx_ary[$i]['mbx'];
878 }
879 $mbx->mailboxname_full = $mbx_ary[$i]['mbx'];
880 $mailboxes->addMbx($mbx, $delimiter, $start, $list_special_folders_first);
881 }
60b5724d 882 }
883
884 return $mailboxes;
885}
259faa39 886
648713af 887?>