/**
* imap_mailbox.php
*
- * Copyright (c) 1999-2002 The SquirrelMail Project Team
+ * Copyright (c) 1999-2003 The SquirrelMail Project Team
* Licensed under the GNU GPL. For full terms see the file COPYING.
*
* This impliments all functions that manipulate mailboxes
*
* $Id$
*/
-require_once(SM_PATH . 'functions/imap_utf7_encode_local.php');
-require_once(SM_PATH . 'functions/imap_utf7_decode_local.php');
+require_once(SM_PATH . 'functions/imap_utf7_local.php');
+
global $boxesnew;
class mailboxes {
return( $ret );
}
-
-function isBoxBelow( $box2, $box1 ) {
- global $delimiter, $folder_prefix, $imap_server_type;
-
- if ( $imap_server_type == 'uw' ) {
- $boxs = $box2;
- $i = strpos( $box1, $delimiter, strlen( $folder_prefix ) );
- if ( $i === false ) {
- $i = strlen( $box2 );
+/**
+ * Check if $subbox is below the specified $parentbox
+ */
+function isBoxBelow( $subbox, $parentbox ) {
+ global $delimiter;
+ /*
+ * Eliminate the obvious mismatch, where the
+ * subfolder path is shorter than that of the potential parent
+ */
+ if ( strlen($subbox) < strlen($parentbox) ) {
+ return false;
+ }
+ /* check for delimiter */
+ if (!substr($parentbox,-1) == $delimiter) {
+ $parentbox.=$delimiter;
}
- } else {
- $boxs = $box2 . $delimiter;
- /* Skip next second delimiter */
- $i = strpos( $box1, $delimiter );
- $i = strpos( $box1, $delimiter, $i + 1 );
- if ( $i === false ) {
- $i = strlen( $box2 );
+ if (substr($subbox,0,strlen($parentbox)) == $parentbox) {
+ return true;
} else {
- $i++;
+ return false;
}
- }
-
- return ( substr( $box1, 0, $i ) == substr( $boxs, 0, $i ) );
}
/* Defines special mailboxes */
$move_to_trash, $move_to_sent, $save_as_draft;
$ret = ( (strtolower($box) == 'inbox') ||
- ( $move_to_trash && isBoxBelow( $box, $trash_folder ) ) ||
- ( $move_to_sent && isBoxBelow( $box, $sent_folder )) ||
- ($save_as_draft && $box == $draft_folder ) );
+ isTrashMailbox($box) || isSentMailbox($box) || isDraftMailbox($box) );
if ( !$ret ) {
$ret = do_hook_function( 'special_mailbox', $box );
}
-
return $ret;
}
+function isTrashMailbox ($box) {
+ global $trash_folder, $move_to_trash;
+ return $move_to_trash && $trash_folder &&
+ ( $box == $trash_folder || isBoxBelow($box, $trash_folder) );
+}
+
+function isSentMailbox($box) {
+ global $sent_folder, $move_to_sent;
+ return $move_to_sent && $sent_folder &&
+ ( $box == $sent_folder || isBoxBelow($box, $sent_folder) );
+}
+
+function isDraftMailbox($box) {
+ global $draft_folder, $save_as_draft;
+ return $save_as_draft &&
+ ( $box == $draft_folder || isBoxBelow($box, $draft_folder) );
+}
+
/* Expunges a mailbox */
function sqimap_mailbox_expunge ($imap_stream, $mailbox, $handle_errors = true, $id='') {
global $uid_support;
/* Checks whether or not the specified mailbox exists */
function sqimap_mailbox_exists ($imap_stream, $mailbox) {
- if (!isset($mailbox)) {
+ if (!isset($mailbox) || empty($mailbox)) {
return false;
}
$mbx = sqimap_run_command($imap_stream, "LIST \"\" \"$mailbox\"",
if (strtolower($type) == 'noselect') {
$mailbox .= $delimiter;
}
- $mailbox = imap_utf7_encode_local($mailbox);
+
$read_ary = sqimap_run_command($imap_stream, "CREATE \"$mailbox\"",
true, $response, $message);
sqimap_subscribe ($imap_stream, $mailbox);
/* Unsubscribes to an existing folder */
function sqimap_unsubscribe ($imap_stream, $mailbox) {
- global $imap_server_type;
$read_ary = sqimap_run_command($imap_stream, "UNSUBSCRIBE \"$mailbox\"",
true, $response, $message);
}
$read_ary = sqimap_run_command($imap_stream, "DELETE \"$mailbox\"",
true, $response, $message);
sqimap_unsubscribe ($imap_stream, $mailbox);
- do_hook_function("rename_or_delete_folder", $args = array($mailbox, 'delete', ''));
+ do_hook_function('rename_or_delete_folder', $args = array($mailbox, 'delete', ''));
removePref($data_dir, $username, "thread_$mailbox");
}
} else {
$postfix = '';
}
+
$boxesall = sqimap_mailbox_list($imap_stream);
- $cmd = 'RENAME "' . quoteIMAP($old_name) . '" "' . quoteIMAP($new_name) . '"';
+ $cmd = 'RENAME "' . $old_name . '" "' . $new_name . '"';
$data = sqimap_run_command($imap_stream, $cmd, true, $response, $message);
sqimap_unsubscribe($imap_stream, $old_name.$postfix);
- $oldpref = getPref($data_dir, $username, "thread_".$old_name.$postfix);
- removePref($data_dir, $username, "thread_".$old_name.$postfix);
+ $oldpref = getPref($data_dir, $username, 'thread_'.$old_name.$postfix);
+ removePref($data_dir, $username, 'thread_'.$old_name.$postfix);
sqimap_subscribe($imap_stream, $new_name.$postfix);
- setPref($data_dir, $username, "thread_".$new_name.$postfix, $oldpref);
- do_hook_function("rename_or_delete_folder",$args = array($old_name, 'rename', $new_name));
+ setPref($data_dir, $username, 'thread_'.$new_name.$postfix, $oldpref);
+ do_hook_function('rename_or_delete_folder',$args = array($old_name, 'rename', $new_name));
$l = strlen( $old_name ) + 1;
$p = 'unformatted';
+
foreach ($boxesall as $box) {
if (substr($box[$p], 0, $l) == $old_name . $delimiter) {
$new_sub = $new_name . $delimiter . substr($box[$p], $l);
if ($imap_server_type == 'cyrus') {
- $cmd = 'RENAME "' . quoteIMAP($box[$p]) . '" "' . quoteIMAP($new_sub) . '"';
+ $cmd = 'RENAME "' . $box[$p] . '" "' . $new_sub . '"';
$data = sqimap_run_command($imap_stream, $cmd, true,
$response, $message);
}
sqimap_unsubscribe($imap_stream, $box[$p]);
- $oldpref = getPref($data_dir, $username, "thread_".$box[$p]);
- removePref($data_dir, $username, "thread_".$box[$p]);
+ $oldpref = getPref($data_dir, $username, 'thread_'.$box[$p]);
+ removePref($data_dir, $username, 'thread_'.$box[$p]);
sqimap_subscribe($imap_stream, $new_sub);
- setPref($data_dir, $username, "thread_".$new_sub, $oldpref);
- do_hook_function("rename_or_delete_folder",
+ setPref($data_dir, $username, 'thread_'.$new_sub, $oldpref);
+ do_hook_function('rename_or_delete_folder',
$args = array($box[$p], 'rename', $new_sub));
}
}
global $folder_prefix, $delimiter;
/* Process each folder line */
- for ($g = 0, $cnt = count($line); $g < $cnt; $g++) {
+ for ($g = 0, $cnt = count($line); $g < $cnt; ++$g) {
/* Store the raw IMAP reply */
if (isset($line[$g])) {
- $boxesall[$g]["raw"] = $line[$g];
+ $boxesall[$g]['raw'] = $line[$g];
} else {
- $boxesall[$g]["raw"] = '';
+ $boxesall[$g]['raw'] = '';
}
/* Count number of delimiters ($delimiter) in folder name */
* With special sort function: foobar AFTER foo and foo.bar :)
*/
function user_strcasecmp($a, $b) {
- global $delimiter;
-
return strnatcasecmp($a, $b);
-
- /* Calculate the length of some strings. */
- $a_length = strlen($a);
- $b_length = strlen($b);
- $min_length = min($a_length, $b_length);
- $delimiter_length = strlen($delimiter);
-
- /* Set the initial result value. */
- $result = 0;
- /* Check the strings... */
- for ($c = 0; $c < $min_length; ++$c) {
- $a_del = substr($a, $c, $delimiter_length);
- $b_del = substr($b, $c, $delimiter_length);
-
- if (($a_del == $delimiter) && ($b_del == $delimiter)) {
- $result = 0;
- } else if (($a_del == $delimiter) && ($b_del != $delimiter)) {
- $result = -1;
- } else if (($a_del != $delimiter) && ($b_del == $delimiter)) {
- $result = 1;
- } else {
- $result = strcasecmp($a{$c}, $b{$c});
- }
-
- if ($result != 0) {
- break;
- }
- }
-
- /* If one string is a prefix of the other... */
- if ($result == 0) {
- if ($a_length < $b_length) {
- $result = -1;
- } else if ($a_length > $b_length) {
- $result = 1;
- }
- }
-
- return $result;
}
/*
* $folder_skip - array of folders to keep out of option list (compared in lower)
* $boxes - list of already fetched boxes (for places like folder panel, where
* you know these options will be shown 3 times in a row.. (most often unset).
+ * $flag - flag to check for in mailbox flags, used to filter out mailboxes.
+ * 'noselect' by default to remove unselectable mailboxes.
+ * 'noinferiors' used to filter out folders that can not contain subfolders.
+ * NULL to avoid flag check entirely.
+ * $use_long_format - override folder display preference and always show full folder name.
*/
-function sqimap_mailbox_option_list($imap_stream, $show_selected = 0, $folder_skip = 0, $boxes = 0 ) {
+function sqimap_mailbox_option_list($imap_stream, $show_selected = 0, $folder_skip = 0, $boxes = 0,
+ $flag = 'noselect', $use_long_format = false ) {
global $username, $data_dir;
$mbox_options = '';
- $shorten_box_names = getPref($data_dir, $username, 'mailbox_select_style', SMPREF_OFF);
+ if ( $use_long_format ) {
+ $shorten_box_names = 0;
+ } else {
+ $shorten_box_names = getPref($data_dir, $username, 'mailbox_select_style', SMPREF_OFF);
+ }
if ($boxes == 0) {
$boxes = sqimap_mailbox_list($imap_stream);
}
+
foreach ($boxes as $boxes_part) {
- if (!in_array('noselect', $boxes_part['flags'])) {
+ if ($flag == NULL || !in_array($flag, $boxes_part['flags'])) {
$box = $boxes_part['unformatted'];
$lowerbox = strtolower($box);
$inbox_subscribed = false;
require_once(SM_PATH . 'include/load_prefs.php');
- require_once(SM_PATH . 'functions/array.php');
if ($noselect_fix_enable) {
$lsub_args = "LSUB \"$folder_prefix\" \"*%\"";
$lsub_ary = sqimap_run_command ($imap_stream, $lsub_args,
true, $response, $message);
-
- /*
- * Section about removing the last element was removed
- * We don't return "* OK" anymore from sqimap_read_data
- */
-
$sorted_lsub_ary = array();
for ($i = 0, $cnt = count($lsub_ary);$i < $cnt; $i++) {
/*
- * Workaround for EIMS
- * Doesn't work if the mailbox name is multiple lines
+ * Workaround for mailboxes returned as literal
+ * Doesn't work if the mailbox name is multiple lines
+ * (larger then fgets buffer)
*/
- if (isset($lsub_ary[$i + 1]) &&
- ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
+ if (isset($lsub_ary[$i + 1]) && substr($lsub_ary[$i],-3) == "}\r\n") {
+ if (ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
$lsub_ary[$i], $regs)) {
- $i++;
- $lsub_ary[$i] = $regs[1] . '"' . addslashes(trim($lsub_ary[$i])) . '"' . $regs[2];
+ $i++;
+ $lsub_ary[$i] = $regs[1] . '"' . addslashes(trim($lsub_ary[$i])) . '"' . $regs[2];
+ }
}
$temp_mailbox_name = find_mailbox_name($lsub_ary[$i]);
$sorted_lsub_ary[] = $temp_mailbox_name;
- if (strtoupper($temp_mailbox_name) == 'INBOX') {
+ if (!$inbox_subscribed && strtoupper($temp_mailbox_name) == 'INBOX') {
$inbox_subscribed = true;
}
}
- $new_ary = array();
- for ($i = 0, $cnt = count($sorted_lsub_ary); $i < $cnt; $i++) {
- if (!in_array($sorted_lsub_ary[$i], $new_ary)) {
- $new_ary[] = $sorted_lsub_ary[$i];
- }
- }
- $sorted_lsub_ary = $new_ary;
+ /* remove duplicates */
+ $sorted_lsub_ary = array_unique($sorted_lsub_ary);
+
+ /* natural sort mailboxes */
if (isset($sorted_lsub_ary)) {
usort($sorted_lsub_ary, 'user_strcasecmp');
}
- $sorted_list_ary = $sorted_lsub_ary;
- /* LIST array */
-/* $sorted_list_ary = array();
+ /*
+ * The LSUB response doesn't provide us information about \Noselect
+ * mail boxes. The LIST response does, that's why we need to do a LIST
+ * call to retrieve the flags for the mailbox
+ * Note: according RFC2060 an imap server may provide \NoSelect flags in the LSUB response.
+ * in other words, we cannot rely on it.
+ */
+ $sorted_list_ary = array();
for ($i=0; $i < count($sorted_lsub_ary); $i++) {
- if (false) {
if (substr($sorted_lsub_ary[$i], -1) == $delimiter) {
$mbx = substr($sorted_lsub_ary[$i], 0, strlen($sorted_lsub_ary[$i])-1);
}
$read = sqimap_run_command ($imap_stream, "LIST \"\" \"$mbx\"",
true, $response, $message);
-*/
- /* Another workaround for EIMS */
-/*
- if (isset($read[1]) &&
- ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
- $read[0], $regs)) {
- $read[0] = $regs[1] . '"' . addslashes(trim($read[1])) . '"' . $regs[2];
- }
- if (isset($sorted_list_ary[$i])) {
- $sorted_list_ary[$i] = '';
+ /* Another workaround for literals */
+
+ if (isset($read[1]) && substr($read[1],-3) == "}\r\n") {
+ if (ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
+ $read[0], $regs)) {
+ $read[0] = $regs[1] . '"' . addslashes(trim($read[1])) . '"' . $regs[2];
+ }
}
if (isset($read[0])) {
$sorted_list_ary[$i] = $read[0];
- }
- else {
+ } else {
$sorted_list_ary[$i] = '';
}
-
- if (isset($sorted_list_ary[$i]) &&
- strtoupper(find_mailbox_name($sorted_list_ary[$i])) == 'INBOX') {
- $inbox_in_list = true;
- }
}
-*/
-/* $inbox_in_list = true; */
+
/*
* Just in case they're not subscribed to their inbox,
* we'll get it for them anyway
*/
- if (!$inbox_subscribed) {/* || !$inbox_in_list) { */
+ if (!$inbox_subscribed) {
$inbox_ary = sqimap_run_command ($imap_stream, "LIST \"\" \"INBOX\"",
true, $response, $message);
- /* Another workaround for EIMS */
- if (isset($inbox_ary[1]) &&
- ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
+ /* Another workaround for literals */
+ if (isset($inbox_ary[1]) && substr($inbox_ary[0],-3) == "}\r\n") {
+ if (ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
$inbox_ary[0], $regs)) {
- $inbox_ary[0] = $regs[1] . '"' . addslashes(trim($inbox_ary[1])) .
+ $inbox_ary[0] = $regs[1] . '"' . addslashes(trim($inbox_ary[1])) .
'"' . $regs[2];
+ }
}
-
$sorted_list_ary[] = $inbox_ary[0];
$sorted_lsub_ary[] = find_mailbox_name($inbox_ary[0]);
}
/* Find INBOX */
$cnt = count($boxesall);
- for($k = 0; $k < $cnt; $k++) {
+ $used = array_pad($used,$cnt,false);
+ for($k = 0; $k < $cnt; ++$k) {
if (strtolower($boxesall[$k]['unformatted']) == 'inbox') {
$boxesnew[] = $boxesall[$k];
$used[$k] = true;
- } else {
- $used[$k] = false;
+ break;
}
}
/* List special folders and their subfolders, if requested. */
if ($list_special_folders_first) {
- for($k = 0; $k < $cnt; $k++) {
+ for($k = 0; $k < $cnt; ++$k) {
if (!$used[$k] && isSpecialMailbox($boxesall[$k]['unformatted'])) {
$boxesnew[] = $boxesall[$k];
$used[$k] = true;
}
- $spec_sub = str_replace(' ', '', $boxesall[$k]['formatted']);
- $spec_sub = preg_replace("/(\*|\[|\]|\(|\)|\?|\+|\{|\}|\^|\\$)/", '\\\\'.'\\1', $spec_sub);
-
- /* In case of problems with preg
- here is a ereg version
- if (!$used[$k] && ereg("^$default_folder_prefix(Sent|Drafts|Trash).{1}$spec_sub$", $box['unformatted']) ) {
- */
- $match = "?^$default_folder_prefix(Sent|Drafts|Trash).{1}$spec_sub$?";
- if (!$used[$k] && preg_match($match, $boxesall[$k]['unformatted']) ) {
- $boxesnew[] = $boxesall[$k];
- $used[$k] = true;
- }
- }
+ }
+ }
- }
/* Rest of the folders */
for($k = 0; $k < $cnt; $k++) {
if (!$used[$k]) {
function sqimap_mailbox_list_all($imap_stream) {
global $list_special_folders_first, $folder_prefix, $delimiter;
- require_once(SM_PATH . 'functions/array.php');
-
$ssid = sqimap_session_id();
$lsid = strlen( $ssid );
fputs ($imap_stream, $ssid . " LIST \"$folder_prefix\" *\r\n");
$g++;
}
if(is_array($boxes)) {
- $boxes = ary_sort ($boxes, 'unformatted', 1);
+ sort ($boxes);
}
return $boxes;
$inbox_subscribed = false;
require_once(SM_PATH . 'include/load_prefs.php');
- require_once(SM_PATH . 'functions/array.php');
/* LSUB array */
$lsub_ary = sqimap_run_command ($imap_stream, "LSUB \"$folder_prefix\" \"*\"",
return $mailboxes;
}
+
?>