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
16 function find_mailbox_name ($mailbox) {
17 if (ereg(" *\"([^\r\n\"]*)\"[ \r\n]*$", $mailbox, $regs))
19 ereg(" *([^ \r\n\"]*)[ \r\n]*$",$mailbox,$regs);
25 * If $haystack is a full mailbox name, and $needle is the mailbox
26 * separator character, returns the second last part of the full
27 * mailbox name (i.e. the mailbox's parent mailbox)
29 function readMailboxParent($haystack, $needle) {
34 $parts = explode($needle, $haystack);
35 $elem = array_pop($parts);
36 while ($elem == '' && count($parts)) {
37 $elem = array_pop($parts);
39 $ret = join($needle, $parts);
45 function isBoxBelow( $box2, $box1 ) {
46 global $delimiter, $folder_prefix, $imap_server_type;
48 if ( $imap_server_type == 'uw' ) {
50 $i = strpos( $box1, $delimiter, strlen( $folder_prefix ) );
55 $boxs = $box2 . $delimiter;
56 /* Skip next second delimiter */
57 $i = strpos( $box1, $delimiter );
58 $i = strpos( $box1, $delimiter, $i +
1 );
66 return ( substr( $box1, 0, $i ) == substr( $boxs, 0, $i ) );
69 /* Defines special mailboxes */
70 function isSpecialMailbox( $box ) {
71 global $trash_folder, $sent_folder, $draft_folder,
72 $move_to_trash, $move_to_sent, $save_as_draft;
74 $ret = ( (strtolower($box) == 'inbox') ||
75 ( $move_to_trash && isBoxBelow( $box, $trash_folder ) ) ||
76 ( $move_to_sent && isBoxBelow( $box, $sent_folder )) ||
77 ($save_as_draft && $box == $draft_folder ) );
80 $ret = do_hook_function( 'special_mailbox', $box );
86 /* Expunges a mailbox */
87 function sqimap_mailbox_expunge ($imap_stream, $mailbox, $handle_errors = true) {
88 $read = sqimap_run_command($imap_stream, 'EXPUNGE', $handle_errors,
92 /* Checks whether or not the specified mailbox exists */
93 function sqimap_mailbox_exists ($imap_stream, $mailbox) {
94 if (! isset($mailbox)) {
97 $mbx = sqimap_run_command($imap_stream, "LIST \"\" \"$mailbox\"",
98 true, $response, $message);
99 return isset($mbx[0]);
102 /* Selects a mailbox */
103 function sqimap_mailbox_select ($imap_stream, $mailbox,
104 $hide = true, $recent = false, $extrainfo = false) {
105 global $auto_expunge;
107 if ( $mailbox == 'None' ) {
111 $read = sqimap_run_command($imap_stream, "SELECT \"$mailbox\"",
112 true, $response, $message);
114 for ($i=0; $i<count($read); $i++
) {
115 if (strpos(strtolower($read[$i]), 'recent')) {
116 $r = explode(' ', $read[$i]);
122 $tmp = sqimap_run_command($imap_stream, 'EXPUNGE', false, $a, $b);
124 if (isset( $extrainfo ) && $extrainfo) {
126 for ($i=0; $i<count($read); $i++
) {
127 if (preg_match("/PERMANENTFLAGS(.*)/i",$read[$i], $regs)) {
128 $regs[1]=trim(preg_replace ( array ("/\(/","/\)/","/\]/") ,'', $regs[1])) ;
129 $result['PERMANENTFLAGS'] = $regs[1];
131 else if (preg_match("/FLAGS(.*)/i",$read[$i], $regs)) {
132 $regs[1]=trim(preg_replace ( array ("/\(/","/\)/") ,'', $regs[1])) ;
133 $result['FLAGS'] = $regs[1];
135 else if (preg_match("/(.*)EXISTS/i",$read[$i], $regs)) {
136 $result['EXISTS']=trim($regs[1]);
138 else if (preg_match("/(.*)RECENT/i",$read[$i], $regs)) {
139 $result['RECENT']=trim($regs[1]);
141 else if (preg_match("/\[UNSEEN(.*)\]/i",$read[$i], $regs)) {
142 $result['UNSEEN']=trim($regs[1]);
151 /* Creates a folder */
152 function sqimap_mailbox_create ($imap_stream, $mailbox, $type) {
154 if (strtolower($type) == 'noselect') {
155 $mailbox .= $delimiter;
157 $read_ary = sqimap_run_command($imap_stream, "CREATE \"$mailbox\"",
158 true, $response, $message);
159 sqimap_subscribe ($imap_stream, $mailbox);
162 /* Subscribes to an existing folder */
163 function sqimap_subscribe ($imap_stream, $mailbox) {
164 $read_ary = sqimap_run_command($imap_stream, "SUBSCRIBE \"$mailbox\"",
165 true, $response, $message);
168 /* Unsubscribes to an existing folder */
169 function sqimap_unsubscribe ($imap_stream, $mailbox) {
170 global $imap_server_type;
171 $read_ary = sqimap_run_command($imap_stream, "UNSUBSCRIBE \"$mailbox\"",
172 true, $response, $message);
175 /* Deletes the given folder */
176 function sqimap_mailbox_delete ($imap_stream, $mailbox) {
177 $read_ary = sqimap_run_command($imap_stream, "DELETE \"$mailbox\"",
178 true, $response, $message);
179 sqimap_unsubscribe ($imap_stream, $mailbox);
180 do_hook_function("rename_or_delete_folder", $args = array($mailbox, 'delete', ''));
183 /* Determines if the user is subscribed to the folder or not */
184 function sqimap_mailbox_is_subscribed($imap_stream, $folder) {
185 $boxesall = sqimap_mailbox_list ($imap_stream);
186 foreach ($boxesall as $ref) {
187 if ($ref['unformatted'] == $folder) {
194 /* Renames a mailbox */
195 function sqimap_mailbox_rename( $imap_stream, $old_name, $new_name ) {
196 if ( $old_name != $new_name ) {
197 global $delimiter, $imap_server_type;
198 if ( substr( $old_name, -1 ) == $delimiter ) {
199 $old_name = substr( $old_name, 0, strlen( $old_name ) - 1 );
200 $new_name = substr( $new_name, 0, strlen( $new_name ) - 1 );
201 $postfix = $delimiter;
205 $boxesall = sqimap_mailbox_list($imap_stream);
206 $cmd = 'RENAME "' . quoteIMAP($old_name) . '" "' . quoteIMAP($new_name) . '"';
207 $data = sqimap_run_command($imap_stream, $cmd, true, $response, $message);
208 sqimap_unsubscribe($imap_stream, $old_name.$postfix);
209 sqimap_subscribe($imap_stream, $new_name.$postfix);
210 do_hook_function("rename_or_delete_folder",$args = array($old_name, 'rename', $new_name));
211 $l = strlen( $old_name ) +
1;
213 foreach ( $boxesall as $box ) {
214 if ( substr( $box[$p], 0, $l ) == $old_name . $delimiter ) {
215 $new_sub = $new_name . $delimiter . substr($box[$p], $l);
216 if ($imap_server_type == 'cyrus') {
217 $cmd = 'RENAME "' . quoteIMAP($box[$p]) . '" "' . quoteIMAP($new_sub) . '"';
218 $data = sqimap_run_command($imap_stream, $cmd, true,
219 $response, $message);
221 sqimap_unsubscribe($imap_stream, $box[$p]);
222 sqimap_subscribe($imap_stream, $new_sub);
223 do_hook_function("rename_or_delete_folder",
224 $args = array($box[$p], 'rename', $new_sub));
231 * Formats a mailbox into 4 parts for the $boxesall array
233 * The four parts are:
235 * raw - Raw LIST/LSUB response from the IMAP server
236 * formatted - nicely formatted folder name
237 * unformatted - unformatted, but with delimiter at end removed
238 * unformatted-dm - folder name as it appears in raw response
239 * unformatted-disp - unformatted without $folder_prefix
241 function sqimap_mailbox_parse ($line, $line_lsub) {
242 global $folder_prefix, $delimiter;
244 /* Process each folder line */
245 for ($g=0; $g < count($line); $g++
) {
247 /* Store the raw IMAP reply */
248 if (isset($line[$g])) {
249 $boxesall[$g]["raw"] = $line[$g];
252 $boxesall[$g]["raw"] = '';
256 /* Count number of delimiters ($delimiter) in folder name */
257 $mailbox = trim($line_lsub[$g]);
258 $dm_count = substr_count($mailbox, $delimiter);
259 if (substr($mailbox, -1) == $delimiter) {
260 /* If name ends in delimiter, decrement count by one */
264 /* Format folder name, but only if it's a INBOX.* or has a parent. */
265 $boxesallbyname[$mailbox] = $g;
266 $parentfolder = readMailboxParent($mailbox, $delimiter);
267 if ( (strtolower(substr($mailbox, 0, 5)) == "inbox") ||
268 (substr($mailbox, 0, strlen($folder_prefix)) == $folder_prefix) ||
269 ( isset($boxesallbyname[$parentfolder]) &&
270 (strlen($parentfolder) > 0) ) ) {
271 $indent = $dm_count - ( substr_count($folder_prefix, $delimiter));
273 $boxesall[$g]['formatted'] = str_repeat(' ', $indent);
276 $boxesall[$g]['formatted'] = '';
278 $boxesall[$g]['formatted'] .= readShortMailboxName($mailbox, $delimiter);
281 $boxesall[$g]['formatted'] = $mailbox;
284 $boxesall[$g]['unformatted-dm'] = $mailbox;
285 if (substr($mailbox, -1) == $delimiter) {
286 $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
288 $boxesall[$g]['unformatted'] = $mailbox;
289 if (substr($mailbox,0,strlen($folder_prefix))==$folder_prefix) {
290 $mailbox = substr($mailbox, strlen($folder_prefix));
292 $boxesall[$g]['unformatted-disp'] = $mailbox;
293 $boxesall[$g]['id'] = $g;
295 $boxesall[$g]['flags'] = array();
296 if (isset($line[$g])) {
297 ereg("\(([^)]*)\)",$line[$g],$regs);
298 $flags = trim(strtolower(str_replace('\\', '',$regs[1])));
300 $boxesall[$g]['flags'] = explode(' ', $flags);
309 * Sorting function used to sort mailbox names.
310 * + Original patch from dave_michmerhuizen@yahoo.com
311 * + Allows case insensitivity when sorting folders
312 * + Takes care of the delimiter being sorted to the end, causing
313 * subfolders to be listed in below folders that are prefixed
314 * with their parent folders name.
316 * For example: INBOX.foo, INBOX.foobar, and INBOX.foo.bar
317 * Without special sort function: foobar between foo and foo.bar
318 * With special sort function: foobar AFTER foo and foo.bar :)
320 function user_strcasecmp($a, $b) {
323 /* Calculate the length of some strings. */
324 $a_length = strlen($a);
325 $b_length = strlen($b);
326 $min_length = min($a_length, $b_length);
327 $delimiter_length = strlen($delimiter);
329 /* Set the initial result value. */
332 /* Check the strings... */
333 for ($c = 0; $c < $min_length; ++
$c) {
334 $a_del = substr($a, $c, $delimiter_length);
335 $b_del = substr($b, $c, $delimiter_length);
337 if (($a_del == $delimiter) && ($b_del == $delimiter)) {
339 } else if (($a_del == $delimiter) && ($b_del != $delimiter)) {
341 } else if (($a_del != $delimiter) && ($b_del == $delimiter)) {
344 $result = strcasecmp($a{$c}, $b{$c});
352 /* If one string is a prefix of the other... */
354 if ($a_length < $b_length) {
356 } else if ($a_length > $b_length) {
366 * Returns sorted mailbox lists in several different ways.
367 * See comment on sqimap_mailbox_parse() for info about the returned array.
369 function sqimap_mailbox_list($imap_stream) {
370 global $boxesnew, $default_folder_prefix;
372 if ( !isset( $boxesnew ) ) {
374 global $data_dir, $username, $list_special_folders_first,
375 $folder_prefix, $trash_folder, $sent_folder, $draft_folder,
376 $move_to_trash, $move_to_sent, $save_as_draft,
379 $inbox_in_list = false;
380 $inbox_subscribed = false;
382 require_once('../src/load_prefs.php');
383 require_once('../functions/array.php');
386 $lsub_ary = sqimap_run_command ($imap_stream, "LSUB \"$folder_prefix\" \"*%\"",
387 true, $response, $message);
390 * Section about removing the last element was removed
391 * We don't return "* OK" anymore from sqimap_read_data
394 $sorted_lsub_ary = array();
395 for ($i=0;$i < count($lsub_ary); $i++
) {
397 * Workaround for EIMS
398 * Doesn't work if the mailbox name is multiple lines
400 if (isset($lsub_ary[$i +
1]) &&
401 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
402 $lsub_ary[$i], $regs)) {
404 $lsub_ary[$i] = $regs[1] . '"' . addslashes(trim($lsub_ary[$i])) . '"' . $regs[2];
406 $temp_mailbox_name = find_mailbox_name($lsub_ary[$i]);
407 $sorted_lsub_ary[] = $temp_mailbox_name;
408 if (strtoupper($temp_mailbox_name) == 'INBOX') {
409 $inbox_subscribed = true;
413 for ($i=0; $i < count($sorted_lsub_ary); $i++
) {
414 if (!in_array($sorted_lsub_ary[$i], $new_ary)) {
415 $new_ary[] = $sorted_lsub_ary[$i];
418 $sorted_lsub_ary = $new_ary;
419 if (isset($sorted_lsub_ary)) {
420 usort($sorted_lsub_ary, 'user_strcasecmp');
424 $sorted_list_ary = array();
425 for ($i=0; $i < count($sorted_lsub_ary); $i++
) {
426 if (substr($sorted_lsub_ary[$i], -1) == $delimiter) {
427 $mbx = substr($sorted_lsub_ary[$i], 0, strlen($sorted_lsub_ary[$i])-1);
430 $mbx = $sorted_lsub_ary[$i];
433 $read = sqimap_run_command ($imap_stream, "LIST \"\" \"$mbx\"",
434 true, $response, $message);
435 /* Another workaround for EIMS */
436 if (isset($read[1]) &&
437 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
439 $read[0] = $regs[1] . '"' . addslashes(trim($read[1])) . '"' . $regs[2];
442 if (isset($sorted_list_ary[$i])) {
443 $sorted_list_ary[$i] = '';
446 if (isset($read[0])) {
447 $sorted_list_ary[$i] = $read[0];
450 $sorted_list_ary[$i] = '';
453 if (isset($sorted_list_ary[$i]) &&
454 strtoupper(find_mailbox_name($sorted_list_ary[$i])) == 'INBOX') {
455 $inbox_in_list = true;
460 * Just in case they're not subscribed to their inbox,
461 * we'll get it for them anyway
463 if (!$inbox_subscribed ||
!$inbox_in_list) {
464 $inbox_ary = sqimap_run_command ($imap_stream, "LIST \"\" \"INBOX\"",
465 true, $response, $message);
466 /* Another workaround for EIMS */
467 if (isset($inbox_ary[1]) &&
468 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
469 $inbox_ary[0], $regs)) {
470 $inbox_ary[0] = $regs[1] . '"' . addslashes(trim($inbox_ary[1])) .
474 $sorted_list_ary[] = $inbox_ary[0];
475 $sorted_lsub_ary[] = find_mailbox_name($inbox_ary[0]);
478 $boxesall = sqimap_mailbox_parse ($sorted_list_ary, $sorted_lsub_ary);
480 /* Now, lets sort for special folders */
481 $boxesnew = $used = array();
484 foreach ( $boxesall as $k => $box ) {
485 if ( strtolower($box['unformatted']) == 'inbox') {
492 /* List special folders and their subfolders, if requested. */
493 if ($list_special_folders_first) {
494 foreach ( $boxesall as $k => $box ) {
495 if ( !$used[$k] && isSpecialMailbox( $box['unformatted'] ) ) {
499 $spec_sub = str_replace(' ', '', $box['formatted']);
501 /* In case of problems with preg
502 here is a ereg version
503 if (!$used[$k] && ereg("^$default_folder_prefix(Sent|Drafts|Trash).{1}$spec_sub$", $box['unformatted']) ) { */
505 if (!$used[$k] && preg_match("?^$default_folder_prefix(Sent|Drafts|Trash).{1}$spec_sub$?", $box['unformatted']) ) {
512 /* Rest of the folders */
513 foreach ( $boxesall as $k => $box ) {
523 * Returns a list of all folders, subscribed or not
525 function sqimap_mailbox_list_all($imap_stream) {
526 global $list_special_folders_first, $folder_prefix, $delimiter;
528 require_once('../functions/array.php');
530 $ssid = sqimap_session_id();
531 $lsid = strlen( $ssid );
532 fputs ($imap_stream, $ssid . " LIST \"$folder_prefix\" *\r\n");
533 $read_ary = sqimap_read_data ($imap_stream, $ssid, true, $response, $message);
537 for ($i = 0; $i < count($read_ary); $i++
) {
538 /* Another workaround for EIMS */
539 if (isset($read_ary[$i +
1]) &&
540 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
541 $read_ary[$i], $regs)) {
543 $read_ary[$i] = $regs[1] . '"' . addslashes(trim($read_ary[$i])) . '"' . $regs[2];
545 if (substr($read_ary[$i], 0, $lsid) != $ssid ) {
547 /* Store the raw IMAP reply */
548 $boxes[$g]['raw'] = $read_ary[$i];
550 /* Count number of delimiters ($delimiter) in folder name */
551 $mailbox = find_mailbox_name($read_ary[$i]);
552 $dm_count = substr_count($mailbox, $delimiter);
553 if (substr($mailbox, -1) == $delimiter) {
554 /* If name ends in delimiter - decrement count by one */
558 /* Format folder name, but only if it's a INBOX.* or has a parent. */
559 $boxesallbyname[$mailbox] = $g;
560 $parentfolder = readMailboxParent($mailbox, $delimiter);
561 if((eregi('^inbox'.quotemeta($delimiter), $mailbox)) ||
562 (ereg('^'.$folder_prefix, $mailbox)) ||
563 ( isset($boxesallbyname[$parentfolder]) && (strlen($parentfolder) > 0) ) ) {
565 $boxes[$g]['formatted'] = str_repeat(' ', $dm_count);
568 $boxes[$g]['formatted'] = '';
570 $boxes[$g]['formatted'] .= readShortMailboxName($mailbox, $delimiter);
573 $boxes[$g]['formatted'] = $mailbox;
576 $boxes[$g]['unformatted-dm'] = $mailbox;
577 if (substr($mailbox, -1) == $delimiter) {
578 $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
580 $boxes[$g]['unformatted'] = $mailbox;
581 $boxes[$g]['unformatted-disp'] = ereg_replace('^' . $folder_prefix, '', $mailbox);
582 $boxes[$g]['id'] = $g;
584 /* Now lets get the flags for this mailbox */
585 $read_mlbx = sqimap_run_command ($imap_stream, "LIST \"\" \"$mailbox\"",
586 true, $response, $message);
588 /* Another workaround for EIMS */
589 if (isset($read_mlbx[1]) &&
590 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$", $read_mlbx[0], $regs)) {
591 $read_mlbx[0] = $regs[1] . '"' . addslashes(trim($read_mlbx[1])) . '"' . $regs[2];
594 $flags = substr($read_mlbx[0], strpos($read_mlbx[0], '(')+
1);
595 $flags = substr($flags, 0, strpos($flags, ')'));
596 $flags = str_replace('\\', '', $flags);
597 $flags = trim(strtolower($flags));
599 $boxes[$g]['flags'] = explode(' ', $flags);
601 $boxes[$g]['flags'] = array();
606 if(is_array($boxes)) {
607 $boxes = ary_sort ($boxes, 'unformatted', 1);