/**
* imap_mailbox.php
*
- * Copyright (c) 1999-2003 The SquirrelMail Project Team
+ * Copyright (c) 1999-2004 The SquirrelMail Project Team
* Licensed under the GNU GPL. For full terms see the file COPYING.
*
* This impliments all functions that manipulate mailboxes
*
- * $Id$
+ * @version $Id$
+ * @package squirrelmail
+ * @subpackage imap
*/
+
+/** UTF7 support */
require_once(SM_PATH . 'functions/imap_utf7_local.php');
global $boxesnew;
-/*
- FIXME. This class should be extracted and placed in a separate file that
- can be included before we start the session. That makes caching of the tree
- possible. On a refresh mailboxes from left_main.php the only function that
- should be called is the sqimap_get_status_mbx_tree. In case of subscribe
- / rename / delete / new we have to create methods for adding/changing the
- mailbox in the mbx_tree without the need for a refresh.
+/**
+ * Mailboxes class
+ *
+ * FIXME. This class should be extracted and placed in a separate file that
+ * can be included before we start the session. That makes caching of the tree
+ * possible. On a refresh mailboxes from left_main.php the only function that
+ * should be called is the sqimap_get_status_mbx_tree. In case of subscribe
+ * / rename / delete / new we have to create methods for adding/changing the
+ * mailbox in the mbx_tree without the need for a refresh.
+ * @package squirrelmail
*/
class mailboxes {
} else {
$bcmp = '2' . $b->mailboxname_full;
}
- return user_strcasecmp($acmp, $bcmp);
+ return strnatcasecmp($acmp, $bcmp);
}
function compact_mailboxes_response($ary)
return array_values(array_unique($ary));
}
-/*
-function find_mailbox_name ($mailbox) {
- if (preg_match('/\*.+\"([^\r\n\"]*)\"[\s\r\n]*$/', $mailbox, $regs))
- return $regs[1];
- if (ereg(" *\"([^\r\n\"]*)\"[ \r\n]*$", $mailbox, $regs))
- return $regs[1];
- ereg(" *([^ \r\n\"]*)[ \r\n]*$",$mailbox,$regs);
- return $regs[1];
-}
-*/
-
-// Extract the mailbox name from an untagged LIST (7.2.2) or LSUB (7.2.3) answer
-// * (LIST|LSUB) (<Flags list>) (NIL|"<separator atom>") <mailbox name string>\r\n
-// mailbox name in quoted string MUST be unquoted and stripslashed (sm API)
+/**
+ * Extract the mailbox name from an untagged LIST (7.2.2) or LSUB (7.2.3) answer
+ * (LIST|LSUB) (<Flags list>) (NIL|"<separator atom>") <mailbox name string>\r\n
+ * mailbox name in quoted string MUST be unquoted and stripslashed (sm API)
+ */
function find_mailbox_name($line)
{
if (preg_match('/^\* (?:LIST|LSUB) \([^\)]*\) (?:NIL|\"[^\"]*\") ([^\r\n]*)[\r\n]*$/i', $line, $regs)) {
return '';
}
+/**
+ * @return bool whether this is a Noselect mailbox.
+ */
function check_is_noselect ($lsub_line) {
return preg_match("/^\* (LSUB|LIST) \([^\)]*\\\\Noselect[^\)]*\)/i", $lsub_line);
}
+/**
+ * @return bool whether this is a Noinferiors mailbox.
+ */
function check_is_noinferiors ($lsub_line) {
return preg_match("/^\* (LSUB|LIST) \([^\)]*\\\\Noinferiors[^\)]*\)/i", $lsub_line);
}
}
}
-/* Defines special mailboxes */
+/**
+ * Defines special mailboxes: given a mailbox name, it checks if this is a
+ * "special" one: INBOX, Trash, Sent or Draft.
+ */
function isSpecialMailbox( $box ) {
$ret = ( (strtolower($box) == 'inbox') ||
isTrashMailbox($box) || isSentMailbox($box) || isDraftMailbox($box) );
return $ret;
}
+/**
+ * @return bool whether this is a Trash folder
+ */
function isTrashMailbox ($box) {
global $trash_folder, $move_to_trash;
return $move_to_trash && $trash_folder &&
( $box == $trash_folder || isBoxBelow($box, $trash_folder) );
}
+/**
+ * @return bool whether this is a Sent folder
+ */
function isSentMailbox($box) {
global $sent_folder, $move_to_sent;
return $move_to_sent && $sent_folder &&
( $box == $sent_folder || isBoxBelow($box, $sent_folder) );
}
+/**
+ * @return bool whether this is a Draft folder
+ */
function isDraftMailbox($box) {
global $draft_folder, $save_as_draft;
return $save_as_draft &&
( $box == $draft_folder || isBoxBelow($box, $draft_folder) );
}
-/* Expunges a mailbox */
+/**
+ * Expunges a mailbox, ie. delete all contents.
+ */
function sqimap_mailbox_expunge ($imap_stream, $mailbox, $handle_errors = true, $id='') {
- global $uid_support;
if ($id) {
if (is_array($id)) {
$id = sqimap_message_list_squisher($id);
}
$id = ' '.$id;
- $uid = $uid_support;
+ $uid = TRUE;
} else {
$uid = false;
}
return $cnt;
}
-/* Checks whether or not the specified mailbox exists */
+/**
+ * Expunge specified message, updated $msgs and $msort
+ *
+ * Until Marc and I come up with a better way to maintain
+ * these stupid arrays, we'll use this wrapper function to
+ * remove the message with the matching UID .. the order
+ * won't be changed - the array element for the message
+ * will just be removed.
+ */
+function sqimap_mailbox_expunge_dmn($message_id, $aMbxResponse, &$server_sort_array)
+{
+ global $msgs, $msort, $sort, $imapConnection,
+ $mailbox, $auto_expunge,
+ $sort, $allow_server_sort, $thread_sort_messages, $allow_thread_sort,
+ $username, $data_dir;
+ $cnt = 0;
+
+ if (!isset($sort) || $sort === false) {
+ sqgetGlobalVar('sort',$sort,SQ_GET);
+ }
+ // Got to grab this out of prefs, since it isn't saved from mailbox_view.php
+ if ($allow_thread_sort) {
+ $thread_sort_messages = getPref($data_dir, $username, "thread_$mailbox",0);
+ }
+
+ for ($i = 0; $i < count($msort); $i++) {
+ if ($msgs[$i]['ID'] == $message_id) {
+ break;
+ }
+ }
+
+ if ( isset($msgs) ) {
+ unset($msgs[$i]);
+ $msgs = array_values($msgs);
+ sqsession_register($msgs, 'msgs');
+ }
+
+ if ( isset($msort) ) {
+ unset($msort[$i]);
+ $msort = array_values($msort);
+ sqsession_register($msort, 'msort');
+ }
+
+ if ($auto_expunge) {
+ $cnt = sqimap_mailbox_expunge($imapConnection, $mailbox, true);
+ } else {
+ return $cnt;
+ }
+
+ // And after all that mucking around, update the sort list!
+ // Remind me why the hell we need those two arrays again?!
+
+ if ( $allow_thread_sort && $thread_sort_messages ) {
+ $server_sort_array = get_thread_sort($imapConnection);
+ } elseif ( $allow_server_sort ) {
+ if (is_array($server_sort_array)) {
+ $key = array_search($message_id,$server_sort_array,true);
+ if ($key !== false) {
+ unset($server_sort_array[$key]);
+ $server_sort_array = array_values($server_sort_array);
+ } else {
+ $server_sort_array = sqimap_get_sort_order($imapConnection,$sort,$aMbxResponse);
+ }
+ } else {
+ $server_sort_array = sqimap_get_sort_order($imapConnection,$sort,$aMbxResponse);
+ }
+ } else {
+ $server_sort_array = sqimap_get_php_sort_order($imapConnection,
+ $sort,$aMbxResponse);
+ }
+ sqsession_register($server_sort_array,'server_sort_array');
+ return $cnt;
+}
+
+/**
+ * Checks whether or not the specified mailbox exists
+ */
function sqimap_mailbox_exists ($imap_stream, $mailbox) {
if (!isset($mailbox) || empty($mailbox)) {
return false;
return isset($mbx[0]);
}
-/* Selects a mailbox */
+/**
+ * Selects a mailbox
+ */
function sqimap_mailbox_select ($imap_stream, $mailbox) {
- global $auto_expunge;
-
if ($mailbox == 'None') {
return;
}
$result['RIGHTS']=$regs[1];
}
- if ($auto_expunge) {
- $tmp = sqimap_run_command($imap_stream, 'EXPUNGE', false, $a, $b);
- }
return $result;
}
-/* Creates a folder */
+/**
+ * Creates a folder.
+ */
function sqimap_mailbox_create ($imap_stream, $mailbox, $type) {
global $delimiter;
if (strtolower($type) == 'noselect') {
$mailbox .= $delimiter;
}
- $read_ary = sqimap_run_command($imap_stream, 'CREATE ' . sqimap_encode_mailbox_name($mailbox),
+ $read_ary = sqimap_run_command($imap_stream, 'CREATE ' .
+ sqimap_encode_mailbox_name($mailbox),
true, $response, $message);
sqimap_subscribe ($imap_stream, $mailbox);
}
-/* Subscribes to an existing folder */
-function sqimap_subscribe ($imap_stream, $mailbox) {
- $read_ary = sqimap_run_command($imap_stream, 'SUBSCRIBE ' . sqimap_encode_mailbox_name($mailbox),
- true, $response, $message);
+/**
+ * Subscribes to an existing folder.
+ */
+function sqimap_subscribe ($imap_stream, $mailbox,$debug=true) {
+ $read_ary = sqimap_run_command($imap_stream, 'SUBSCRIBE ' .
+ sqimap_encode_mailbox_name($mailbox),
+ $debug, $response, $message);
}
-/* Unsubscribes to an existing folder */
+/**
+ * Unsubscribes from an existing folder
+ */
function sqimap_unsubscribe ($imap_stream, $mailbox) {
- $read_ary = sqimap_run_command($imap_stream, 'UNSUBSCRIBE ' . sqimap_encode_mailbox_name($mailbox),
- true, $response, $message);
+ $read_ary = sqimap_run_command($imap_stream, 'UNSUBSCRIBE ' .
+ sqimap_encode_mailbox_name($mailbox),
+ false, $response, $message);
}
-/* Deletes the given folder */
+/**
+ * Deletes the given folder
+ */
function sqimap_mailbox_delete ($imap_stream, $mailbox) {
global $data_dir, $username;
- $read_ary = sqimap_run_command($imap_stream, 'DELETE ' . sqimap_encode_mailbox_name($mailbox),
- true, $response, $message);
sqimap_unsubscribe ($imap_stream, $mailbox);
- do_hook_function('rename_or_delete_folder', $args = array($mailbox, 'delete', ''));
- removePref($data_dir, $username, "thread_$mailbox");
+ $read_ary = sqimap_run_command($imap_stream, 'DELETE ' .
+ sqimap_encode_mailbox_name($mailbox),
+ true, $response, $message);
+ if ($response !== 'OK') {
+ // subscribe again
+ sqimap_subscribe ($imap_stream, $mailbox);
+ } else {
+ do_hook_function('rename_or_delete_folder', $args = array($mailbox, 'delete', ''));
+ removePref($data_dir, $username, "thread_$mailbox");
+ }
}
-/* Determines if the user is subscribed to the folder or not */
+/**
+ * Determines if the user is subscribed to the folder or not
+ */
function sqimap_mailbox_is_subscribed($imap_stream, $folder) {
$boxesall = sqimap_mailbox_list ($imap_stream);
foreach ($boxesall as $ref) {
return false;
}
-/* Renames a mailbox */
+/**
+ * Renames a mailbox.
+ */
function sqimap_mailbox_rename( $imap_stream, $old_name, $new_name ) {
if ( $old_name != $new_name ) {
global $delimiter, $imap_server_type, $data_dir, $username;
}
$boxesall = sqimap_mailbox_list($imap_stream);
- $cmd = 'RENAME ' . sqimap_encode_mailbox_name($old_name) . ' ' . sqimap_encode_mailbox_name($new_name);
+ $cmd = 'RENAME ' . sqimap_encode_mailbox_name($old_name) .
+ ' ' . sqimap_encode_mailbox_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);
}
}
-/*
+/**
* Formats a mailbox into parts for the $boxesall array
*
* The parts are:
return $boxesall;
}
-/*
- * Sorting function used to sort mailbox names.
- * + Original patch from dave_michmerhuizen@yahoo.com
- * + Allows case insensitivity when sorting folders
- * + Takes care of the delimiter being sorted to the end, causing
- * subfolders to be listed in below folders that are prefixed
- * with their parent folders name.
- *
- * For example: INBOX.foo, INBOX.foobar, and INBOX.foo.bar
- * Without special sort function: foobar between foo and foo.bar
- * With special sort function: foobar AFTER foo and foo.bar :)
- */
-function user_strcasecmp($a, $b) {
- return strnatcasecmp($a, $b);
-}
-
-/*
+/**
* Returns list of options (to be echoed into select statement
* based on available mailboxes and separators
* Caller should surround options with <SELECT..> </SELECT> and
return $mbox_options;
}
-/*
+/**
* Returns sorted mailbox lists in several different ways.
* See comment on sqimap_mailbox_parse() for info about the returned array.
*/
-function sqimap_mailbox_list($imap_stream) {
+
+
+function sqimap_mailbox_list($imap_stream, $force=false) {
global $default_folder_prefix;
- if (!isset($boxesnew)) {
+ if (!sqgetGlobalVar('boxesnew',$boxesnew,SQ_SESSION) || $force) {
global $data_dir, $username, $list_special_folders_first,
$folder_prefix, $trash_folder, $sent_folder, $draft_folder,
$move_to_trash, $move_to_sent, $save_as_draft,
- $delimiter, $noselect_fix_enable;
-
+ $delimiter, $noselect_fix_enable, $imap_server_type;
$inbox_in_list = false;
$inbox_subscribed = false;
+ $listsubscribed = sqimap_capability($imap_stream,'LIST-SUBSCRIBED');
require_once(SM_PATH . 'include/load_prefs.php');
+
+ if ($listsubscribed) {
+ $lsub = 'LIST (SUBSCRIBED)';
+ } else {
+ $lsub = 'LSUB';
+ }
+
if ($noselect_fix_enable) {
- $lsub_args = "LSUB \"$folder_prefix\" \"*%\"";
+
+ $lsub_args = "$lsub \"$folder_prefix\" \"*%\"";
} else {
- $lsub_args = "LSUB \"$folder_prefix\" \"*\"";
+ $lsub_args = "$lsub \"$folder_prefix\" \"*\"";
}
/* LSUB array */
$lsub_ary = sqimap_run_command ($imap_stream, $lsub_args,
true, $response, $message);
- $lsub_ary = compact_mailboxes_response($lsub_ary);
+ $lsub_ary = compact_mailboxes_response($lsub_ary);
$sorted_lsub_ary = array();
for ($i = 0, $cnt = count($lsub_ary);$i < $cnt; $i++) {
+
$temp_mailbox_name = find_mailbox_name($lsub_ary[$i]);
$sorted_lsub_ary[] = $temp_mailbox_name;
if (!$inbox_subscribed && strtoupper($temp_mailbox_name) == 'INBOX') {
/* natural sort mailboxes */
if (isset($sorted_lsub_ary)) {
- usort($sorted_lsub_ary, 'user_strcasecmp');
+ usort($sorted_lsub_ary, 'strnatcasecmp');
}
/*
* The LSUB response doesn't provide us information about \Noselect
* 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 (!$listsubscribed) {
+ for ($i=0; $i < count($sorted_lsub_ary); $i++) {
if (substr($sorted_lsub_ary[$i], -1) == $delimiter) {
$mbx = substr($sorted_lsub_ary[$i], 0, strlen($sorted_lsub_ary[$i])-1);
}
else {
$mbx = $sorted_lsub_ary[$i];
}
- $mbx = stripslashes($mbx);
+
$read = sqimap_run_command ($imap_stream, 'LIST "" ' . sqimap_encode_mailbox_name($mbx),
true, $response, $message);
+
$read = compact_mailboxes_response($read);
+
if (isset($read[0])) {
$sorted_list_ary[$i] = $read[0];
} else {
$sorted_list_ary[$i] = '';
}
- }
+ }
+ // }
/*
* Just in case they're not subscribed to their inbox,
* we'll get it for them anyway
*/
if (!$inbox_subscribed) {
- $inbox_ary = sqimap_run_command ($imap_stream, 'LIST "" INBOX',
+ $inbox_ary = sqimap_run_command ($imap_stream, 'LIST "" "INBOX"',
true, $response, $message);
- $sorted_list_ary[] = implode('', compact_mailboxes_response($inbox_ary));
+ $sorted_list_ary[] = implode('',compact_mailboxes_response($inbox_ary));
$sorted_lsub_ary[] = find_mailbox_name($inbox_ary[0]);
}
}
}
}
-
- /* Rest of the folders */
+ /* Rest of the folders */
for($k = 0; $k < $cnt; $k++) {
if (!$used[$k]) {
$boxesnew[] = $boxesall[$k];
}
}
+ sqsession_register($boxesnew,'boxesnew');
}
-
return $boxesnew;
}
-/*
+/**
* Returns a list of all folders, subscribed or not
*/
function sqimap_mailbox_list_all($imap_stream) {
function sqimap_mailbox_tree($imap_stream) {
global $boxesnew, $default_folder_prefix, $unseen_notify, $unseen_type;
- if (!isset($boxesnew)) {
+ if (true) {
global $data_dir, $username, $list_special_folders_first,
$folder_prefix, $delimiter, $trash_folder, $move_to_trash,
$has_inbox = false;
for ($i = 0, $cnt = count($lsub_ary); $i < $cnt; $i++) {
- if (preg_match("/^\*\s+LSUB\s+(.*)\"?INBOX\"?[^(\/\.)].*$/i",$lsub_ary[$i])) {
+ if (preg_match("/^\*\s+LSUB.*\s\"?INBOX\"?[^(\/\.)].*$/i",$lsub_ary[$i])) {
$lsub_ary[$i] = strtoupper($lsub_ary[$i]);
- $has_inbox = true;
+ // in case of an unsubscribed inbox an imap server can
+ // return the inbox in the lsub results with a \NoSelect
+ // flag.
+ if (!preg_match("/\*\s+LSUB\s+\(.*\\\\NoSelect.*\).*/i",$lsub_ary[$i])) {
+ $has_inbox = true;
+ } else {
+ // remove the result and request it again with a list
+ // response at a later stage.
+ unset($lsub_ary[$i]);
+ // re-index the array otherwise the addition of the LIST
+ // response will fail in PHP 4.1.2 and probably other older versions
+ $lsub_ary = array_values($lsub_ary);
+ }
break;
}
}
if ($has_inbox == false) {
- $lsub_ary[] = '* LSUB () NIL INBOX';
+ // do a list request for inbox because we should always show
+ // inbox even if the user isn't subscribed to it.
+ $inbox_ary = sqimap_run_command ($imap_stream, 'LIST "" INBOX',
+ true, $response, $message);
+ $inbox_ary = compact_mailboxes_response($inbox_ary);
+ if (count($inbox_ary)) {
+ $lsub_ary[] = $inbox_ary[0];
+ }
}
/*
$mbx->is_special |= ($mbx->is_sent = isSentMailbox($mailbox));
$mbx->is_special |= ($mbx->is_draft = isDraftMailbox($mailbox));
if (!$mbx->is_special)
- $mbx->is_special = do_hook_function('special_mailbox', $mailbox);
+ $mbx->is_special = boolean_hook_function('special_mailbox', $mailbox, 1);
if (isset($mbx_ary[$i]['unseen'])) {
$mbx->unseen = $mbx_ary[$i]['unseen'];
}
function sqimap_utf7_decode_mbx_tree(&$mbx_tree) {
- if (strtoupper($mbx_tree->mailboxname_sub) == 'INBOX')
+ if (strtoupper($mbx_tree->mailboxname_full) == 'INBOX')
$mbx_tree->mailboxname_sub = _("INBOX");
else
$mbx_tree->mailboxname_sub = imap_utf7_decode_local($mbx_tree->mailboxname_sub);
}
}
-
-/* Define preferences for folder settings. */
-/* FIXME, we should load constants.php
-unseen_notify
-define('SMPREF_UNSEEN_NONE', 1);
-define('SMPREF_UNSEEN_INBOX', 2);
-define('SMPREF_UNSEEN_ALL', 3);
-
-define('SMPREF_UNSEEN_SPECIAL', 4); // Only special folders
-define('SMPREF_UNSEEN_NORMAL', 5); // Only normal folders
-
-unseen_type
-define('SMPREF_UNSEEN_ONLY', 1);
-define('SMPREF_UNSEEN_TOTAL', 2);
-*/
-
function sqimap_get_status_mbx_tree($imap_stream,&$mbx_tree) {
global $unseen_notify, $unseen_type, $trash_folder,$move_to_trash;
$aMbxs = $aQuery = $aTag = array();