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 global $data_dir, $username;
178 $read_ary = sqimap_run_command($imap_stream, "DELETE \"$mailbox\"",
179 true, $response, $message);
180 sqimap_unsubscribe ($imap_stream, $mailbox);
181 do_hook_function("rename_or_delete_folder", $args = array($mailbox, 'delete', ''));
182 removePref($data_dir, $username, "thread_$mailbox");
185 /* Determines if the user is subscribed to the folder or not */
186 function sqimap_mailbox_is_subscribed($imap_stream, $folder) {
187 $boxesall = sqimap_mailbox_list ($imap_stream);
188 foreach ($boxesall as $ref) {
189 if ($ref['unformatted'] == $folder) {
196 /* Renames a mailbox */
197 function sqimap_mailbox_rename( $imap_stream, $old_name, $new_name ) {
198 if ( $old_name != $new_name ) {
199 global $delimiter, $imap_server_type, $data_dir, $username;
200 if ( substr( $old_name, -1 ) == $delimiter ) {
201 $old_name = substr( $old_name, 0, strlen( $old_name ) - 1 );
202 $new_name = substr( $new_name, 0, strlen( $new_name ) - 1 );
203 $postfix = $delimiter;
207 $boxesall = sqimap_mailbox_list($imap_stream);
208 $cmd = 'RENAME "' . quoteIMAP($old_name) . '" "' . quoteIMAP($new_name) . '"';
209 $data = sqimap_run_command($imap_stream, $cmd, true, $response, $message);
210 sqimap_unsubscribe($imap_stream, $old_name.$postfix);
211 $oldpref = getPref($data_dir, $username, "thread_".$old_name.$postfix);
212 removePref($data_dir, $username, "thread_".$old_name.$postfix);
213 sqimap_subscribe($imap_stream, $new_name.$postfix);
214 setPref($data_dir, $username, "thread_".$new_name.$postfix, $oldpref);
215 do_hook_function("rename_or_delete_folder",$args = array($old_name, 'rename', $new_name));
216 $l = strlen( $old_name ) +
1;
218 foreach ( $boxesall as $box ) {
219 if ( substr( $box[$p], 0, $l ) == $old_name . $delimiter ) {
220 $new_sub = $new_name . $delimiter . substr($box[$p], $l);
221 if ($imap_server_type == 'cyrus') {
222 $cmd = 'RENAME "' . quoteIMAP($box[$p]) . '" "' . quoteIMAP($new_sub) . '"';
223 $data = sqimap_run_command($imap_stream, $cmd, true,
224 $response, $message);
226 sqimap_unsubscribe($imap_stream, $box[$p]);
227 $oldpref = getPref($data_dir, $username, "thread_".$box[$p]);
228 removePref($data_dir, $username, "thread_".$box[$p]);
229 sqimap_subscribe($imap_stream, $new_sub);
230 setPref($data_dir, $username, "thread_".$new_sub, $oldpref);
231 do_hook_function("rename_or_delete_folder",
232 $args = array($box[$p], 'rename', $new_sub));
239 * Formats a mailbox into 4 parts for the $boxesall array
241 * The four parts are:
243 * raw - Raw LIST/LSUB response from the IMAP server
244 * formatted - nicely formatted folder name
245 * unformatted - unformatted, but with delimiter at end removed
246 * unformatted-dm - folder name as it appears in raw response
247 * unformatted-disp - unformatted without $folder_prefix
249 function sqimap_mailbox_parse ($line, $line_lsub) {
250 global $folder_prefix, $delimiter;
252 /* Process each folder line */
253 for ($g=0; $g < count($line); $g++
) {
255 /* Store the raw IMAP reply */
256 if (isset($line[$g])) {
257 $boxesall[$g]["raw"] = $line[$g];
260 $boxesall[$g]["raw"] = '';
264 /* Count number of delimiters ($delimiter) in folder name */
265 $mailbox = trim($line_lsub[$g]);
266 $dm_count = substr_count($mailbox, $delimiter);
267 if (substr($mailbox, -1) == $delimiter) {
268 /* If name ends in delimiter, decrement count by one */
272 /* Format folder name, but only if it's a INBOX.* or has a parent. */
273 $boxesallbyname[$mailbox] = $g;
274 $parentfolder = readMailboxParent($mailbox, $delimiter);
275 if ( (strtolower(substr($mailbox, 0, 5)) == "inbox") ||
276 (substr($mailbox, 0, strlen($folder_prefix)) == $folder_prefix) ||
277 ( isset($boxesallbyname[$parentfolder]) &&
278 (strlen($parentfolder) > 0) ) ) {
279 $indent = $dm_count - ( substr_count($folder_prefix, $delimiter));
281 $boxesall[$g]['formatted'] = str_repeat(' ', $indent);
284 $boxesall[$g]['formatted'] = '';
286 $boxesall[$g]['formatted'] .= readShortMailboxName($mailbox, $delimiter);
289 $boxesall[$g]['formatted'] = $mailbox;
292 $boxesall[$g]['unformatted-dm'] = $mailbox;
293 if (substr($mailbox, -1) == $delimiter) {
294 $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
296 $boxesall[$g]['unformatted'] = $mailbox;
297 if (substr($mailbox,0,strlen($folder_prefix))==$folder_prefix) {
298 $mailbox = substr($mailbox, strlen($folder_prefix));
300 $boxesall[$g]['unformatted-disp'] = $mailbox;
301 $boxesall[$g]['id'] = $g;
303 $boxesall[$g]['flags'] = array();
304 if (isset($line[$g])) {
305 ereg("\(([^)]*)\)",$line[$g],$regs);
306 $flags = trim(strtolower(str_replace('\\', '',$regs[1])));
308 $boxesall[$g]['flags'] = explode(' ', $flags);
317 * Sorting function used to sort mailbox names.
318 * + Original patch from dave_michmerhuizen@yahoo.com
319 * + Allows case insensitivity when sorting folders
320 * + Takes care of the delimiter being sorted to the end, causing
321 * subfolders to be listed in below folders that are prefixed
322 * with their parent folders name.
324 * For example: INBOX.foo, INBOX.foobar, and INBOX.foo.bar
325 * Without special sort function: foobar between foo and foo.bar
326 * With special sort function: foobar AFTER foo and foo.bar :)
328 function user_strcasecmp($a, $b) {
331 /* Calculate the length of some strings. */
332 $a_length = strlen($a);
333 $b_length = strlen($b);
334 $min_length = min($a_length, $b_length);
335 $delimiter_length = strlen($delimiter);
337 /* Set the initial result value. */
340 /* Check the strings... */
341 for ($c = 0; $c < $min_length; ++
$c) {
342 $a_del = substr($a, $c, $delimiter_length);
343 $b_del = substr($b, $c, $delimiter_length);
345 if (($a_del == $delimiter) && ($b_del == $delimiter)) {
347 } else if (($a_del == $delimiter) && ($b_del != $delimiter)) {
349 } else if (($a_del != $delimiter) && ($b_del == $delimiter)) {
352 $result = strcasecmp($a{$c}, $b{$c});
360 /* If one string is a prefix of the other... */
362 if ($a_length < $b_length) {
364 } else if ($a_length > $b_length) {
374 * Returns sorted mailbox lists in several different ways.
375 * See comment on sqimap_mailbox_parse() for info about the returned array.
377 function sqimap_mailbox_list($imap_stream) {
378 global $boxesnew, $default_folder_prefix;
380 if ( !isset( $boxesnew ) ) {
382 global $data_dir, $username, $list_special_folders_first,
383 $folder_prefix, $trash_folder, $sent_folder, $draft_folder,
384 $move_to_trash, $move_to_sent, $save_as_draft,
387 $inbox_in_list = false;
388 $inbox_subscribed = false;
390 require_once('../src/load_prefs.php');
391 require_once('../functions/array.php');
394 $lsub_ary = sqimap_run_command ($imap_stream, "LSUB \"$folder_prefix\" \"*%\"",
395 true, $response, $message);
398 * Section about removing the last element was removed
399 * We don't return "* OK" anymore from sqimap_read_data
402 $sorted_lsub_ary = array();
403 for ($i=0;$i < count($lsub_ary); $i++
) {
405 * Workaround for EIMS
406 * Doesn't work if the mailbox name is multiple lines
408 if (isset($lsub_ary[$i +
1]) &&
409 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
410 $lsub_ary[$i], $regs)) {
412 $lsub_ary[$i] = $regs[1] . '"' . addslashes(trim($lsub_ary[$i])) . '"' . $regs[2];
414 $temp_mailbox_name = find_mailbox_name($lsub_ary[$i]);
415 $sorted_lsub_ary[] = $temp_mailbox_name;
416 if (strtoupper($temp_mailbox_name) == 'INBOX') {
417 $inbox_subscribed = true;
421 for ($i=0; $i < count($sorted_lsub_ary); $i++
) {
422 if (!in_array($sorted_lsub_ary[$i], $new_ary)) {
423 $new_ary[] = $sorted_lsub_ary[$i];
426 $sorted_lsub_ary = $new_ary;
427 if (isset($sorted_lsub_ary)) {
428 usort($sorted_lsub_ary, 'user_strcasecmp');
432 $sorted_list_ary = array();
433 for ($i=0; $i < count($sorted_lsub_ary); $i++
) {
434 if (substr($sorted_lsub_ary[$i], -1) == $delimiter) {
435 $mbx = substr($sorted_lsub_ary[$i], 0, strlen($sorted_lsub_ary[$i])-1);
438 $mbx = $sorted_lsub_ary[$i];
441 $read = sqimap_run_command ($imap_stream, "LIST \"\" \"$mbx\"",
442 true, $response, $message);
443 /* Another workaround for EIMS */
444 if (isset($read[1]) &&
445 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
447 $read[0] = $regs[1] . '"' . addslashes(trim($read[1])) . '"' . $regs[2];
450 if (isset($sorted_list_ary[$i])) {
451 $sorted_list_ary[$i] = '';
454 if (isset($read[0])) {
455 $sorted_list_ary[$i] = $read[0];
458 $sorted_list_ary[$i] = '';
461 if (isset($sorted_list_ary[$i]) &&
462 strtoupper(find_mailbox_name($sorted_list_ary[$i])) == 'INBOX') {
463 $inbox_in_list = true;
468 * Just in case they're not subscribed to their inbox,
469 * we'll get it for them anyway
471 if (!$inbox_subscribed ||
!$inbox_in_list) {
472 $inbox_ary = sqimap_run_command ($imap_stream, "LIST \"\" \"INBOX\"",
473 true, $response, $message);
474 /* Another workaround for EIMS */
475 if (isset($inbox_ary[1]) &&
476 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
477 $inbox_ary[0], $regs)) {
478 $inbox_ary[0] = $regs[1] . '"' . addslashes(trim($inbox_ary[1])) .
482 $sorted_list_ary[] = $inbox_ary[0];
483 $sorted_lsub_ary[] = find_mailbox_name($inbox_ary[0]);
486 $boxesall = sqimap_mailbox_parse ($sorted_list_ary, $sorted_lsub_ary);
488 /* Now, lets sort for special folders */
489 $boxesnew = $used = array();
492 foreach ( $boxesall as $k => $box ) {
493 if ( strtolower($box['unformatted']) == 'inbox') {
500 /* List special folders and their subfolders, if requested. */
501 if ($list_special_folders_first) {
502 foreach ( $boxesall as $k => $box ) {
503 if ( !$used[$k] && isSpecialMailbox( $box['unformatted'] ) ) {
507 $spec_sub = str_replace(' ', '', $box['formatted']);
509 /* In case of problems with preg
510 here is a ereg version
511 if (!$used[$k] && ereg("^$default_folder_prefix(Sent|Drafts|Trash).{1}$spec_sub$", $box['unformatted']) ) { */
513 if (!$used[$k] && preg_match("?^$default_folder_prefix(Sent|Drafts|Trash).{1}$spec_sub$?", $box['unformatted']) ) {
520 /* Rest of the folders */
521 foreach ( $boxesall as $k => $box ) {
531 * Returns a list of all folders, subscribed or not
533 function sqimap_mailbox_list_all($imap_stream) {
534 global $list_special_folders_first, $folder_prefix, $delimiter;
536 require_once('../functions/array.php');
538 $ssid = sqimap_session_id();
539 $lsid = strlen( $ssid );
540 fputs ($imap_stream, $ssid . " LIST \"$folder_prefix\" *\r\n");
541 $read_ary = sqimap_read_data ($imap_stream, $ssid, true, $response, $message);
545 for ($i = 0; $i < count($read_ary); $i++
) {
546 /* Another workaround for EIMS */
547 if (isset($read_ary[$i +
1]) &&
548 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
549 $read_ary[$i], $regs)) {
551 $read_ary[$i] = $regs[1] . '"' . addslashes(trim($read_ary[$i])) . '"' . $regs[2];
553 if (substr($read_ary[$i], 0, $lsid) != $ssid ) {
555 /* Store the raw IMAP reply */
556 $boxes[$g]['raw'] = $read_ary[$i];
558 /* Count number of delimiters ($delimiter) in folder name */
559 $mailbox = find_mailbox_name($read_ary[$i]);
560 $dm_count = substr_count($mailbox, $delimiter);
561 if (substr($mailbox, -1) == $delimiter) {
562 /* If name ends in delimiter - decrement count by one */
566 /* Format folder name, but only if it's a INBOX.* or has a parent. */
567 $boxesallbyname[$mailbox] = $g;
568 $parentfolder = readMailboxParent($mailbox, $delimiter);
569 if((eregi('^inbox'.quotemeta($delimiter), $mailbox)) ||
570 (ereg('^'.$folder_prefix, $mailbox)) ||
571 ( isset($boxesallbyname[$parentfolder]) && (strlen($parentfolder) > 0) ) ) {
573 $boxes[$g]['formatted'] = str_repeat(' ', $dm_count);
576 $boxes[$g]['formatted'] = '';
578 $boxes[$g]['formatted'] .= readShortMailboxName($mailbox, $delimiter);
581 $boxes[$g]['formatted'] = $mailbox;
584 $boxes[$g]['unformatted-dm'] = $mailbox;
585 if (substr($mailbox, -1) == $delimiter) {
586 $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
588 $boxes[$g]['unformatted'] = $mailbox;
589 $boxes[$g]['unformatted-disp'] = ereg_replace('^' . $folder_prefix, '', $mailbox);
590 $boxes[$g]['id'] = $g;
592 /* Now lets get the flags for this mailbox */
593 $read_mlbx = sqimap_run_command ($imap_stream, "LIST \"\" \"$mailbox\"",
594 true, $response, $message);
596 /* Another workaround for EIMS */
597 if (isset($read_mlbx[1]) &&
598 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$", $read_mlbx[0], $regs)) {
599 $read_mlbx[0] = $regs[1] . '"' . addslashes(trim($read_mlbx[1])) . '"' . $regs[2];
602 $flags = substr($read_mlbx[0], strpos($read_mlbx[0], '(')+
1);
603 $flags = substr($flags, 0, strpos($flags, ')'));
604 $flags = str_replace('\\', '', $flags);
605 $flags = trim(strtolower($flags));
607 $boxes[$g]['flags'] = explode(' ', $flags);
609 $boxes[$g]['flags'] = array();
614 if(is_array($boxes)) {
615 $boxes = ary_sort ($boxes, 'unformatted', 1);