/**
* imap_mailbox.php
*
- * Copyright (c) 1999-2003 The SquirrelMail Project Team
+ * Copyright (c) 1999-2005 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
+ * @subpackage imap
+ * @since 1.3.0
+ */
class mailboxes {
- var $mailboxname_full = '', $mailboxname_sub= '', $is_noselect = false,
+ var $mailboxname_full = '', $mailboxname_sub= '', $is_noselect = false, $is_noinferiors = false,
$is_special = false, $is_root = false, $is_inbox = false, $is_sent = false,
- $is_trash = false, $is_draft = false, $mbxs = array(),
+ $is_trash = false, $is_draft = false, $mbxs = array(),
$unseen = false, $total = false;
function addMbx($mbx, $delimiter, $start, $specialfirst) {
}
}
+/**
+ * array callback used for sorting in mailboxes class
+ * @param object $a
+ * @param object $b
+ * @return integer see php strnatcasecmp()
+ * @since 1.3.0
+ */
function sortSpecialMbx($a, $b) {
if ($a->is_inbox) {
$acmp = '0'. $a->mailboxname_full;
} else {
$bcmp = '2' . $b->mailboxname_full;
}
- if ($acmp == $bcmp) return 0;
- return ($acmp > $bcmp) ? 1: -1;
-}
-
-/*
-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];
+ return strnatcasecmp($acmp, $bcmp);
}
-*/
-// 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)) {
- if (substr($regs[1], 0, 1) == '"')
- return stripslashes(substr($regs[1], 1, -1));
- return $regs[1];
- }
- return '';
-}
-
-function encode_mailbox_name($what)
-{
- if (ereg("[\"\\\r\n]", $what))
- return '{' . strlen($what) . "}\r\n" . $what; /* 4.3 literal form */
- return '"' . $what . '"'; /* 4.3 quoted string form */
-}
-
-function compact_mailboxes_response($ary)
-{
+/**
+ * @param array $ary
+ * @return array
+ * @since 1.5.0
+ */
+function compact_mailboxes_response($ary) {
/*
* Workaround for mailboxes returned as literal
- * FIXME : Doesn't work if the mailbox name is multiple lines
+ * FIXME : Doesn't work if the mailbox name is multiple lines
* (larger then fgets buffer)
*/
- for ($i = 0; $i < count($ary); $i++) {
+ for ($i = 0, $iCnt=count($ary); $i < $iCnt; $i++) {
if (isset($ary[$i + 1]) && substr($ary[$i], -3) == "}\r\n") {
if (ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
$ary[$i], $regs)) {
return array_values(array_unique($ary));
}
+/**
+ * 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)
+ *
+ * Originally stored in functions/strings.php. Since 1.2.6 stored in
+ * functions/imap_mailbox.php
+ * @param string $line imap LIST/LSUB response line
+ * @return string mailbox name
+ */
+function find_mailbox_name($line) {
+ if (preg_match('/^\* (?:LIST|LSUB) \([^\)]*\) (?:NIL|\"[^\"]*\") ([^\r\n]*)[\r\n]*$/i', $line, $regs)) {
+ if (substr($regs[1], 0, 1) == '"')
+ return stripslashes(substr($regs[1], 1, -1));
+ return $regs[1];
+ }
+ return '';
+}
+
+/**
+ * Detects if mailbox has noselect flag (can't store messages)
+ * In versions older than 1.4.5 function checks only LSUB responses
+ * and can produce pcre warnings.
+ * @param string $lsub_line mailbox line from untagged LIST or LSUB response
+ * @return bool whether this is a Noselect mailbox.
+ * @since 1.3.2
+ */
function check_is_noselect ($lsub_line) {
return preg_match("/^\* (LSUB|LIST) \([^\)]*\\\\Noselect[^\)]*\)/i", $lsub_line);
}
/**
+ * Detects if mailbox has noinferiors flag (can't store subfolders)
+ * @param string $lsub_line mailbox line from untagged LIST or LSUB response
+ * @return bool whether this is a Noinferiors mailbox.
+ * @since 1.5.0
+ */
+function check_is_noinferiors ($lsub_line) {
+ return preg_match("/^\* (LSUB|LIST) \([^\)]*\\\\Noinferiors[^\)]*\)/i", $lsub_line);
+}
+
+/**
+ * Detects mailbox's parent folder
+ *
* If $haystack is a full mailbox name, and $needle is the mailbox
* separator character, returns the second last part of the full
* mailbox name (i.e. the mailbox's parent mailbox)
+ *
+ * Originally stored in functions/strings.php. Since 1.2.6 stored in
+ * functions/imap_mailbox.php
+ * @param string $haystack full mailbox name
+ * @param string $needle delimiter
+ * @return string parent mailbox
*/
function readMailboxParent($haystack, $needle) {
if ($needle == '') {
return( $ret );
}
-/**
+/**
* Check if $subbox is below the specified $parentbox
+ * @param string $subbox potential sub folder
+ * @param string $parentbox potential parent
+ * @return boolean
+ * @since 1.2.3
*/
function isBoxBelow( $subbox, $parentbox ) {
global $delimiter;
- /*
- * Eliminate the obvious mismatch, where the
+ /*
+ * 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;
- }
- if (substr($subbox,0,strlen($parentbox)) == $parentbox) {
- return true;
- } else {
- return false;
- }
+ if (substr($parentbox,-1) != $delimiter) {
+ $parentbox .= $delimiter;
+ }
+
+ return (substr($subbox,0,strlen($parentbox)) == $parentbox);
}
-/* Defines special mailboxes */
+/**
+ * Defines special mailboxes: given a mailbox name, it checks if this is a
+ * "special" one: INBOX, Trash, Sent or Draft.
+ *
+ * Since 1.2.5 function includes special_mailbox hook.<br>
+ * Since 1.4.3 hook supports more than one plugin.
+ * @param string $box mailbox name
+ * @return boolean
+ * @since 1.2.3
+ */
function isSpecialMailbox( $box ) {
- global $trash_folder, $sent_folder, $draft_folder,
- $move_to_trash, $move_to_sent, $save_as_draft;
-
$ret = ( (strtolower($box) == 'inbox') ||
isTrashMailbox($box) || isSentMailbox($box) || isDraftMailbox($box) );
if ( !$ret ) {
- $ret = do_hook_function( 'special_mailbox', $box );
+ $ret = boolean_hook_function('special_mailbox',$box,1);
}
return $ret;
}
+/**
+ * Detects if mailbox is a Trash folder or subfolder of Trash
+ * @param string $box mailbox name
+ * @return bool whether this is a Trash folder
+ * @since 1.4.0
+ */
function isTrashMailbox ($box) {
global $trash_folder, $move_to_trash;
return $move_to_trash && $trash_folder &&
( $box == $trash_folder || isBoxBelow($box, $trash_folder) );
}
+/**
+ * Detects if mailbox is a Sent folder or subfolder of Sent
+ * @param string $box mailbox name
+ * @return bool whether this is a Sent folder
+ * @since 1.4.0
+ */
function isSentMailbox($box) {
global $sent_folder, $move_to_sent;
return $move_to_sent && $sent_folder &&
( $box == $sent_folder || isBoxBelow($box, $sent_folder) );
}
+/**
+ * Detects if mailbox is a Drafts folder or subfolder of Drafts
+ * @param string $box mailbox name
+ * @return bool whether this is a Draft folder
+ * @since 1.4.0
+ */
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
+ *
+ * WARNING: Select mailbox before calling this function.
+ *
+ * permanently removes all messages that have the \Deleted flag
+ * set from the selected mailbox. See EXPUNGE command chapter in
+ * IMAP RFC.
+ * @param stream $imap_stream imap connection resource
+ * @param string $mailbox mailbox name (unused since 1.1.3).
+ * @param boolean $handle_errors error handling control (displays error_box on error).
+ * @param mixed $id (since 1.3.0) integer message id or array with integer ids
+ * @return integer number of expunged messages
+ * @since 1.0 or older
+ */
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 */
+/**
+ * Checks whether or not the specified mailbox exists
+ * @param stream $imap_stream imap connection resource
+ * @param string $mailbox mailbox name
+ * @return boolean
+ * @since 1.0 or older
+ */
function sqimap_mailbox_exists ($imap_stream, $mailbox) {
if (!isset($mailbox) || empty($mailbox)) {
return false;
}
- $mbx = sqimap_run_command($imap_stream, 'LIST "" ' . encode_mailbox_name($mailbox),
+ $mbx = sqimap_run_command($imap_stream, 'LIST "" ' . sqimap_encode_mailbox_name($mailbox),
true, $response, $message);
return isset($mbx[0]);
}
-/* Selects a mailbox */
+/**
+ * Selects a mailbox
+ * Before 1.3.0 used more arguments and returned data depended on those argumements.
+ * @param stream $imap_stream imap connection resource
+ * @param string $mailbox mailbox name
+ * @return array results of select command (on success - permanentflags, flags and rights)
+ * @since 1.0 or older
+ */
function sqimap_mailbox_select ($imap_stream, $mailbox) {
- global $auto_expunge;
-
if ($mailbox == 'None') {
return;
}
- $read = sqimap_run_command($imap_stream, 'SELECT ' . encode_mailbox_name($mailbox),
+ $read = sqimap_run_command($imap_stream, 'SELECT ' . sqimap_encode_mailbox_name($mailbox),
true, $response, $message);
$result = array();
for ($i = 0, $cnt = count($read); $i < $cnt; $i++) {
} else {
if (preg_match("/PERMANENTFLAGS(.*)/i",$read[$i], $regs)) {
$regs[1]=trim(preg_replace ( array ("/\(/","/\)/","/\]/") ,'', $regs[1])) ;
- $result['PERMANENTFLAGS'] = $regs[1];
+ $result['PERMANENTFLAGS'] = explode(' ',strtolower($regs[1]));
} else if (preg_match("/FLAGS(.*)/i",$read[$i], $regs)) {
$regs[1]=trim(preg_replace ( array ("/\(/","/\)/") ,'', $regs[1])) ;
- $result['FLAGS'] = $regs[1];
+ $result['FLAGS'] = explode(' ',strtolower($regs[1]));
}
}
}
+ if (!isset($result['PERMANENTFLAGS'])) {
+ $result['PERMANENTFLAGS'] = $result['FLAGS'];
+ }
if (preg_match('/^\[(.+)\]/',$message, $regs)) {
- $result['RIGHTS']=$regs[1];
+ $result['RIGHTS']=strtoupper($regs[1]);
}
- if ($auto_expunge) {
- $tmp = sqimap_run_command($imap_stream, 'EXPUNGE', false, $a, $b);
- }
return $result;
}
-/* Creates a folder */
+/**
+ * Creates a folder.
+ *
+ * Mailbox is automatically subscribed.
+ *
+ * Set $type to string that does not match 'noselect' (case insensitive),
+ * if you don't want to prepend delimiter to mailbox name. Please note
+ * that 'noinferiors' might be used someday as keyword for folders
+ * that store only messages.
+ * @param stream $imap_steam imap connection resource
+ * @param string $mailbox mailbox name
+ * @param string $type folder type.
+ * @since 1.0 or older
+ */
function sqimap_mailbox_create ($imap_stream, $mailbox, $type) {
global $delimiter;
if (strtolower($type) == 'noselect') {
$mailbox .= $delimiter;
}
- $read_ary = sqimap_run_command($imap_stream, 'CREATE ' . 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 ' . encode_mailbox_name($mailbox),
- true, $response, $message);
+/**
+ * Subscribes to an existing folder.
+ * @param stream $imap_stream imap connection resource
+ * @param string $mailbox mailbox name
+ * @param boolean $debug (since 1.5.1)
+ * @since 1.0 or older
+ */
+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
+ * @param stream $imap_stream imap connection resource
+ * @param string $mailbox mailbox name
+ * @since 1.0 or older
+ */
function sqimap_unsubscribe ($imap_stream, $mailbox) {
- $read_ary = sqimap_run_command($imap_stream, 'UNSUBSCRIBE ' . 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
+ * Since 1.2.6 and 1.3.0 contains rename_or_delete_folder hook
+ * @param stream $imap_stream imap connection resource
+ * @param string $mailbox mailbox name
+ * @since 1.0 or older
+ */
function sqimap_mailbox_delete ($imap_stream, $mailbox) {
global $data_dir, $username;
- $read_ary = sqimap_run_command($imap_stream, 'DELETE ' . 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");
+ removePref($data_dir, $username, "collapse_folder_$mailbox");
+ }
}
-/* Determines if the user is subscribed to the folder or not */
+/**
+ * Determines if the user is subscribed to the folder or not
+ * @param stream $imap_stream imap connection resource
+ * @param string $mailbox mailbox name
+ * @return boolean
+ * @since 1.2.0
+ */
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.
+ * Since 1.2.6 and 1.3.0 contains rename_or_delete_folder hook
+ * @param stream $imap_stream imap connection resource
+ * @param string $old_name mailbox name
+ * @param string $new_name new mailbox name
+ * @since 1.2.3
+ */
function sqimap_mailbox_rename( $imap_stream, $old_name, $new_name ) {
if ( $old_name != $new_name ) {
global $delimiter, $imap_server_type, $data_dir, $username;
$postfix = '';
}
- $boxesall = sqimap_mailbox_list($imap_stream);
- $cmd = 'RENAME ' . encode_mailbox_name($old_name) . ' ' . encode_mailbox_name($new_name);
+ $boxesall = sqimap_mailbox_list_all($imap_stream);
+ $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);
+ $oldpref_thread = getPref($data_dir, $username, 'thread_'.$old_name.$postfix);
+ $oldpref_collapse = getPref($data_dir, $username, 'collapse_folder_'.$old_name.$postfix);
removePref($data_dir, $username, 'thread_'.$old_name.$postfix);
+ removePref($data_dir, $username, 'collapse_folder_'.$old_name.$postfix);
sqimap_subscribe($imap_stream, $new_name.$postfix);
- setPref($data_dir, $username, 'thread_'.$new_name.$postfix, $oldpref);
+ setPref($data_dir, $username, 'thread_'.$new_name.$postfix, $oldpref_thread);
+ setPref($data_dir, $username, 'collapse_folder_'.$new_name.$postfix, $oldpref_collapse);
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);
+ /* With Cyrus IMAPd >= 2.0 rename is recursive, so don't check for errors here */
if ($imap_server_type == 'cyrus') {
$cmd = 'RENAME "' . $box[$p] . '" "' . $new_sub . '"';
- $data = sqimap_run_command($imap_stream, $cmd, true,
+ $data = sqimap_run_command($imap_stream, $cmd, false,
$response, $message);
}
- sqimap_unsubscribe($imap_stream, $box[$p]);
- $oldpref = getPref($data_dir, $username, 'thread_'.$box[$p]);
+ $was_subscribed = sqimap_mailbox_is_subscribed($imap_stream, $box[$p]);
+ if ( $was_subscribed ) {
+ sqimap_unsubscribe($imap_stream, $box[$p]);
+ }
+ $oldpref_thread = getPref($data_dir, $username, 'thread_'.$box[$p]);
+ $oldpref_collapse = getPref($data_dir, $username, 'collapse_folder_'.$box[$p]);
removePref($data_dir, $username, 'thread_'.$box[$p]);
- sqimap_subscribe($imap_stream, $new_sub);
- setPref($data_dir, $username, 'thread_'.$new_sub, $oldpref);
+ removePref($data_dir, $username, 'collapse_folder_'.$box[$p]);
+ if ( $was_subscribed ) {
+ sqimap_subscribe($imap_stream, $new_sub);
+ }
+ setPref($data_dir, $username, 'thread_'.$new_sub, $oldpref_thread);
+ setPref($data_dir, $username, 'collapse_folder_'.$new_sub, $oldpref_collapse);
do_hook_function('rename_or_delete_folder',
$args = array($box[$p], 'rename', $new_sub));
}
}
}
-/*
- * Formats a mailbox into 4 parts for the $boxesall array
- *
- * The four parts are:
+/**
+ * Formats a mailbox into parts for the $boxesall array
*
- * raw - Raw LIST/LSUB response from the IMAP server
- * formatted - nicely formatted folder name
- * unformatted - unformatted, but with delimiter at end removed
- * unformatted-dm - folder name as it appears in raw response
- * unformatted-disp - unformatted without $folder_prefix
+ * The parts are:
+ * <ul>
+ * <li>raw - Raw LIST/LSUB response from the IMAP server
+ * <li>formatted - nicely formatted folder name
+ * <li>unformatted - unformatted, but with delimiter at end removed
+ * <li>unformatted-dm - folder name as it appears in raw response
+ * <li>unformatted-disp - unformatted without $folder_prefix
+ * <li>id - TODO: document me
+ * <li>flags - TODO: document me
+ * </ul>
+ * Before 1.2.0 used third argument for delimiter.
+ * @param $line
+ * @param $line_lsub
+ * @return array
+ * @since 1.0 or older
+ * @todo document id and flags keys in boxes array and function arguments.
*/
function sqimap_mailbox_parse ($line, $line_lsub) {
global $folder_prefix, $delimiter;
}
/* Count number of delimiters ($delimiter) in folder name */
- $mailbox = trim($line_lsub[$g]);
+ $mailbox = /*trim(*/$line_lsub[$g]/*)*/;
$dm_count = substr_count($mailbox, $delimiter);
if (substr($mailbox, -1) == $delimiter) {
/* If name ends in delimiter, decrement count by one */
$boxesall[$g]['flags'] = array();
if (isset($line[$g])) {
ereg("\(([^)]*)\)",$line[$g],$regs);
- // FIXME Flags do contain the \ character. \NoSelect \NoInferiors
+ // FIXME Flags do contain the \ character. \NoSelect \NoInferiors
// and $MDNSent <= last one doesn't have the \
// It's better to follow RFC3501 instead of using our own naming.
$flags = trim(strtolower(str_replace('\\', '',$regs[1])));
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
+ * Caller should surround options with <select ...> </select> and
* any formatting.
- * $imap_stream - $imapConnection to query for mailboxes
- * $show_selected - array containing list of mailboxes to pre-select (0 if none)
- * $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
+ * @param stream $imap_stream imap connection resource to query for mailboxes
+ * @param array $show_selected array containing list of mailboxes to pre-select (0 if none)
+ * @param array $folder_skip array of folders to keep out of option list (compared in lower)
+ * @param $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.
+ * @param string $flag (since 1.4.1) 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.
* NOTE: noselect and noiferiors are used internally. The IMAP representation is
* \NoSelect and \NoInferiors
- * $use_long_format - override folder display preference and always show full folder name.
+ * @param boolean $use_long_format (since 1.4.1) override folder display preference and always show full folder name.
+ * @return string html formated mailbox selection options
+ * @since 1.3.2
*/
-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 = '';
}
foreach ($boxes as $boxes_part) {
- if ($flag == NULL || !in_array($flag, $boxes_part['flags'])) {
+ if ($flag == NULL || (is_array($boxes_part['flags'])
+ && !in_array($flag, $boxes_part['flags']))) {
$box = $boxes_part['unformatted'];
if ($folder_skip != 0 && in_array($box, $folder_skip) ) {
continue;
}
- $lowerbox = strtolower($box);
+ $lowerbox = strtolower($box);
// mailboxes are casesensitive => inbox.sent != inbox.Sent
// nevermind, to many dependencies this should be fixed!
-
+
if (strtolower($box) == 'inbox') { // inbox is special and not casesensitive
$box2 = _("INBOX");
- } else {
+ } else {
switch ($shorten_box_names)
{
case 2: /* delimited, style = 2 */
- $box2 = str_replace(' ', '. ', $boxes_part['formatted']);
+ $box2 = str_replace('&nbsp;&nbsp;', '. ', htmlspecialchars($boxes_part['formatted']));
break;
case 1: /* indent, style = 1 */
- $box2 = $boxes_part['formatted'];
+ $box2 = str_replace('&nbsp;&nbsp;', ' ', htmlspecialchars($boxes_part['formatted']));
break;
default: /* default, long names, style = 0 */
- $box2 = str_replace(' ', ' ', imap_utf7_decode_local($boxes_part['unformatted-disp']));
+ $box2 = str_replace(' ', ' ', htmlspecialchars(imap_utf7_decode_local($boxes_part['unformatted-disp'])));
break;
}
}
if ($show_selected != 0 && in_array($lowerbox, $show_selected) ) {
- $mbox_options .= '<OPTION VALUE="'.$box.'" SELECTED>'.$box2.'</OPTION>' . "\n";
+ $mbox_options .= '<option value="' . htmlspecialchars($box) .'" selected="selected">'.$box2.'</option>' . "\n";
} else {
- $mbox_options .= '<OPTION VALUE="'.$box.'">'.$box2.'</OPTION>' . "\n";
+ $mbox_options .= '<option value="' . htmlspecialchars($box) .'">'.$box2.'</option>' . "\n";
}
}
}
return $mbox_options;
}
-/*
- * Returns sorted mailbox lists in several different ways.
+/**
+ * Returns sorted mailbox lists in several different ways.
* See comment on sqimap_mailbox_parse() for info about the returned array.
+ * @param resource $imap_stream imap connection resource
+ * @param boolean $force force update of mailbox listing. available since 1.4.2 and 1.5.0
+ * @return array list of mailboxes
+ * @since 1.0 or older
*/
-function sqimap_mailbox_list($imap_stream) {
- global $default_folder_prefix;
-
- if (!isset($boxesnew)) {
+function sqimap_mailbox_list($imap_stream, $force=false) {
+ 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;
-
- $inbox_in_list = false;
+ $delimiter, $noselect_fix_enable, $imap_server_type,
+ $show_only_subscribed_folders;
$inbox_subscribed = false;
+ $listsubscribed = sqimap_capability($imap_stream,'LIST-SUBSCRIBED');
require_once(SM_PATH . 'include/load_prefs.php');
+ if (!$show_only_subscribed_folders) {
+ $lsub = 'LIST';
+ } elseif ($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,
$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 "" ' . encode_mailbox_name($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 "" ' . encode_mailbox_name('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]);
}
}
}
+ /* Find INBOX's children */
+ for($k = 0; $k < $cnt; ++$k) {
+ if (!$used[$k] && isBoxBelow(strtolower($boxesall[$k]['unformatted']), 'inbox') &&
+ strtolower($boxesall[$k]['unformatted']) != 'inbox') {
+ $boxesnew[] = $boxesall[$k];
+ $used[$k] = true;
+ }
+ }
+
/* 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
+/**
+ * Returns a list of all folders, subscribed or not
+ * @param stream $imap_stream imap connection resource
+ * @return array see sqimap_mailbox_parse()
+ * @since 1.0 or older
*/
function sqimap_mailbox_list_all($imap_stream) {
global $list_special_folders_first, $folder_prefix, $delimiter;
$read_ary = compact_mailboxes_response($read_ary);
$g = 0;
- $phase = 'inbox';
$fld_pre_length = strlen($folder_prefix);
for ($i = 0, $cnt = count($read_ary); $i < $cnt; $i++) {
/* Store the raw IMAP reply */
return $boxes;
}
+/**
+ * @param stream $imap_stream imap connection resource
+ * @return object see mailboxes class.
+ * @since 1.3.0
+ */
function sqimap_mailbox_tree($imap_stream) {
- global $boxesnew, $default_folder_prefix, $unseen_notify, $unseen_type;
- if (!isset($boxesnew)) {
-
+ global $default_folder_prefix;
+ if (true) {
global $data_dir, $username, $list_special_folders_first,
$folder_prefix, $delimiter, $trash_folder, $move_to_trash,
- $imap_server_type;
+ $imap_server_type, $show_only_subscribed_folders;
-
- $inbox_in_list = false;
- $inbox_subscribed = false;
$noselect = false;
+ $noinferiors = false;
require_once(SM_PATH . 'include/load_prefs.php');
+ if ($show_only_subscribed_folders) {
+ $lsub_cmd = 'LSUB';
+ } else {
+ $lsub_cmd = 'LIST';
+ }
+
/* LSUB array */
- $lsub_ary = sqimap_run_command ($imap_stream, "LSUB \"$folder_prefix\" \"*\"",
+ $lsub_ary = sqimap_run_command ($imap_stream, "$lsub_cmd \"$folder_prefix\" \"*\"",
true, $response, $message);
$lsub_ary = compact_mailboxes_response($lsub_ary);
$has_inbox = false;
for ($i = 0, $cnt = count($lsub_ary); $i < $cnt; $i++) {
- if (preg_match("/^\*\s+LSUB\s+(.*)\"?INBOX\"?[^(\/\.)].*$/",$lsub_ary[$i])) {
- $has_inbox = true;
+ if (preg_match("/^\*\s+$lsub_cmd.*\s\"?INBOX\"?[^(\/\.)].*$/i",$lsub_ary[$i])) {
+ $lsub_ary[$i] = strtoupper($lsub_ary[$i]);
+ // 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_cmd\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 () "' . $folder_prefix . '" 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];
+ }
}
/*
- * Section about removing the last element was removed
+ * Section about removing the last element was removed
* We don't return "* OK" anymore from sqimap_read_data
*/
$mbx = find_mailbox_name($lsub_ary[$i]);
// only do the noselect test if !uw, is checked later. FIX ME see conf.pl setting
- if ($imap_server_type != "uw") {
+ if ($imap_server_type != "uw") {
$noselect = check_is_noselect($lsub_ary[$i]);
+ $noinferiors = check_is_noinferiors($lsub_ary[$i]);
}
if (substr($mbx, -1) == $delimiter) {
$mbx = substr($mbx, 0, strlen($mbx) - 1);
}
- $sorted_lsub_ary[] = array ('mbx' => $mbx, 'noselect' => $noselect);
+ $sorted_lsub_ary[] = array ('mbx' => $mbx, 'noselect' => $noselect, 'noinferiors' => $noinferiors);
}
// FIX ME this requires a config setting inside conf.pl instead of checking on server type
if ($imap_server_type == "uw") {
// prepare an array with queries
foreach ($sorted_lsub_ary as $aMbx) {
$mbx = stripslashes($aMbx['mbx']);
- sqimap_prepare_pipelined_query('LIST "" ' . encode_mailbox_name($mbx), $tag, $aQuery, false);
+ sqimap_prepare_pipelined_query('LIST "" ' . sqimap_encode_mailbox_name($mbx), $tag, $aQuery, false);
$aTag[$tag] = $mbx;
- }
+ }
$sorted_lsub_ary = array();
// execute all the queries at once
$aResponse = sqimap_run_pipelined_command ($imap_stream, $aQuery, false, $aServerResponse, $aServerMessage);
if ($aServerResponse[$tag] == 'OK') {
$sResponse = implode('', $aResponse[$tag]);
$noselect = check_is_noselect($sResponse);
- $sorted_lsub_ary[] = array ('mbx' => $mbx, 'noselect' => $noselect);
+ $noinferiors = check_is_noinferiors($sResponse);
+ $sorted_lsub_ary[] = array ('mbx' => $mbx, 'noselect' => $noselect, 'noinferiors' => $noinferiors);
}
}
$cnt = count($sorted_lsub_ary);
}
$sorted_lsub_ary = array_values($sorted_lsub_ary);
- array_multisort($sorted_lsub_ary, SORT_ASC, SORT_REGULAR);
- $boxesnew = sqimap_fill_mailbox_tree($sorted_lsub_ary,false,$imap_stream);
- return $boxesnew;
+ usort($sorted_lsub_ary, 'mbxSort');
+ $boxestree = sqimap_fill_mailbox_tree($sorted_lsub_ary,false,$imap_stream);
+ return $boxestree;
}
}
+/**
+ * Callback function used for sorting mailboxes in sqimap_mailbox_tree
+ * @param string $a
+ * @param string $b
+ * @return integer see php strnatcasecmp()
+ * @since 1.5.1
+ */
+function mbxSort($a, $b) {
+ return strnatcasecmp($a['mbx'], $b['mbx']);
+}
+
+/**
+ * @param array $mbx_ary
+ * @param $mbxs
+ * @param stream $imap_stream (since 1.5.0) imap connection resource
+ * @return object see mailboxes class
+ * @since 1.3.0
+ */
function sqimap_fill_mailbox_tree($mbx_ary, $mbxs=false,$imap_stream) {
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, $imap_server_type;
- $special_folders = array ('INBOX', $sent_folder, $draft_folder, $trash_folder);
+ // $special_folders = array ('INBOX', $sent_folder, $draft_folder, $trash_folder);
/* create virtual root node */
$mailboxes= new mailboxes();
if (isset($folder_prefix) && ($folder_prefix != '')) {
$start = substr_count($folder_prefix,$delimiter);
if (strrpos($folder_prefix, $delimiter) == (strlen($folder_prefix)-1)) {
- $trail_del = true;
$mailboxes->mailboxname_full = substr($folder_prefix,0, (strlen($folder_prefix)-1));
} else {
$mailboxes->mailboxname_full = $folder_prefix;
$start = 0;
}
- $cnt = count($mbx_ary);
+ $cnt = count($mbx_ary);
for ($i=0; $i < $cnt; $i++) {
if ($mbx_ary[$i]['mbx'] !='' ) {
$mbx = new mailboxes();
$mailbox = $mbx_ary[$i]['mbx'];
+
+ /*
+ sent subfolders messes up using existing code as subfolders
+ were marked, but the parents were ordered somewhere else in
+ the list, despite having "special folders at top" option set.
+ Need a better method than this.
+ */
+/*
+ if ($mailbox == 'INBOX') {
+ $mbx->is_special = true;
+ } elseif (stristr($trash_folder , $mailbox)) {
+ $mbx->is_special = true;
+ } elseif (stristr($sent_folder , $mailbox)) {
+ $mbx->is_special = true;
+ } elseif (stristr($draft_folder , $mailbox)) {
+ $mbx->is_special = true;
+ }
+
switch ($mailbox) {
case 'INBOX':
$mbx->is_inbox = true;
$mbx->is_special = true;
+ $mbx_ary[$i]['noselect'] = false;
break;
case $trash_folder:
$mbx->is_trash = true;
$mbx->is_special = true;
break;
}
+*/
+ $mbx->is_special |= ($mbx->is_inbox = (strtoupper($mailbox) == 'INBOX'));
+ $mbx->is_special |= ($mbx->is_trash = isTrashMailbox($mailbox));
+ $mbx->is_special |= ($mbx->is_sent = isSentMailbox($mailbox));
+ $mbx->is_special |= ($mbx->is_draft = isDraftMailbox($mailbox));
+ if (!$mbx->is_special)
+ $mbx->is_special = boolean_hook_function('special_mailbox', $mailbox, 1);
if (isset($mbx_ary[$i]['unseen'])) {
$mbx->unseen = $mbx_ary[$i]['unseen'];
}
$mbx->is_noselect = $mbx_ary[$i]['noselect'];
+ $mbx->is_noinferiors = $mbx_ary[$i]['noinferiors'];
$r_del_pos = strrpos($mbx_ary[$i]['mbx'], $delimiter);
if ($r_del_pos) {
return $mailboxes;
}
+/**
+ * @param object $mbx_tree
+ * @since 1.5.0
+ */
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);
}
}
-
+/**
+ * @param object $mbx_tree
+ * @param array $aMbxs
+ * @since 1.5.0
+ */
function sqimap_tree_to_ref_array(&$mbx_tree,&$aMbxs) {
if ($mbx_tree)
$aMbxs[] =& $mbx_tree;
sqimap_tree_to_ref_array($mbx_tree->mbxs[$i],$aMbxs);
}
}
-}
-
-
-/* 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);
-*/
+}
+/**
+ * @param stream $imap_stream imap connection resource
+ * @param object $mbx_tree
+ * @since since 1.5.0
+ */
function sqimap_get_status_mbx_tree($imap_stream,&$mbx_tree) {
global $unseen_notify, $unseen_type, $trash_folder,$move_to_trash;
- $aMbxs = $aQuery = $aTag = array();
+ $aMbxs = $aQuery = array();
sqimap_tree_to_ref_array($mbx_tree,$aMbxs);
// remove the root node
array_shift($aMbxs);
$mbx = $oMbx->mailboxname_full;
if ($unseen_type == 2 ||
($move_to_trash && $oMbx->mailboxname_full == $trash_folder)) {
- $query = 'STATUS ' . encode_mailbox_name($mbx) . ' (MESSAGES UNSEEN)';
+ $query = 'STATUS ' . sqimap_encode_mailbox_name($mbx) . ' (MESSAGES UNSEEN)';
} else {
- $query = 'STATUS ' . encode_mailbox_name($mbx) . ' (UNSEEN)';
+ $query = 'STATUS ' . sqimap_encode_mailbox_name($mbx) . ' (UNSEEN)';
}
sqimap_prepare_pipelined_query($query,$tag,$aQuery,false);
} else {
$oMbx =& $aMbxs[$i];
if (strtoupper($oMbx->mailboxname_full) == 'INBOX' ||
($move_to_trash && $oMbx->mailboxname_full == $trash_folder)) {
- if ($unseen_type == 2 ||
+ if ($unseen_type == 2 ||
($oMbx->mailboxname_full == $trash_folder && $move_to_trash)) {
$aStatus = sqimap_status_messages($imap_stream,$oMbx->mailboxname_full);
$oMbx->unseen = $aStatus['UNSEEN'];
}
}
}
- }
-}
+ }
+}
-?>
+?>
\ No newline at end of file
projects / squirrelmail.git / blobdiff