- /**
- ** imap_mailbox.php
- ** Copyright (c) 1999-2001 The Squirrelmail Development Team
- ** Licensed under the GNU GPL. For full terms see the file COPYING.
- **
- ** This impliments all functions that manipulate mailboxes
- **
- ** $Id$
- **/
-
- if (defined ('imap_mailbox_php'))
- return;
- define ('imap_mailbox_php', true);
-
- /******************************************************************************
- ** Expunges a mailbox
- ******************************************************************************/
- function sqimap_mailbox_expunge ($imap_stream, $mailbox,$handle_errors = true) {
- fputs ($imap_stream, sqimap_session_id() . " EXPUNGE\r\n");
- $read = sqimap_read_data($imap_stream, sqimap_session_id(), $handle_errors, $response, $message);
- }
-
-
- /******************************************************************************
- ** Checks whether or not the specified mailbox exists
- ******************************************************************************/
- function sqimap_mailbox_exists ($imap_stream, $mailbox) {
- if (! isset($mailbox))
- return false;
- fputs ($imap_stream, sqimap_session_id() . " LIST \"\" \"$mailbox\"\r\n");
- $mbx = sqimap_read_data($imap_stream, sqimap_session_id(), true, $response, $message);
- return isset($mbx[0]);
- }
-
- /******************************************************************************
- ** Selects a mailbox
- ******************************************************************************/
- function sqimap_mailbox_select ($imap_stream, $mailbox, $hide=true, $recent=false) {
- global $auto_expunge;
-
- if( $mailbox == _("None") )
- return;
-
- fputs ($imap_stream, sqimap_session_id() . " SELECT \"$mailbox\"\r\n");
- $read = sqimap_read_data($imap_stream, sqimap_session_id(), true, $response, $message);
- if ($recent) {
- for ($i=0; $i<count($read); $i++) {
- if (strpos(strtolower($read[$i]), 'recent')) {
- $r = explode(' ', $read[$i]);
- }
- }
- return $r[1];
- }
- if ($auto_expunge) {
- fputs ($imap_stream, sqimap_session_id() . " EXPUNGE\r\n");
- $tmp = sqimap_read_data($imap_stream, sqimap_session_id(), false, $a, $b);
- }
- }
-
-
-
- /******************************************************************************
- ** Creates a folder
- ******************************************************************************/
- function sqimap_mailbox_create ($imap_stream, $mailbox, $type) {
- global $delimiter;
- if (strtolower($type) == "noselect") {
- $mailbox = $mailbox.$delimiter;
- }
- fputs ($imap_stream, sqimap_session_id() . " CREATE \"$mailbox\"\r\n");
- $read_ary = sqimap_read_data($imap_stream, sqimap_session_id(), true, $response, $message);
-
- sqimap_subscribe ($imap_stream, $mailbox);
- }
-
-
-
- /******************************************************************************
- ** Subscribes to an existing folder
- ******************************************************************************/
- function sqimap_subscribe ($imap_stream, $mailbox) {
- fputs ($imap_stream, sqimap_session_id() . " SUBSCRIBE \"$mailbox\"\r\n");
- $read_ary = sqimap_read_data($imap_stream, sqimap_session_id(), true, $response, $message);
- }
-
-
-
-
- /******************************************************************************
- ** Unsubscribes to an existing folder
- ******************************************************************************/
- function sqimap_unsubscribe ($imap_stream, $mailbox) {
- global $imap_server_type;
-
- fputs ($imap_stream, sqimap_session_id() . " UNSUBSCRIBE \"$mailbox\"\r\n");
- $read_ary = sqimap_read_data($imap_stream, sqimap_session_id(), true, $response, $message);
- }
-
-
-
-
- /******************************************************************************
- ** This function simply deletes the given folder
- ******************************************************************************/
- function sqimap_mailbox_delete ($imap_stream, $mailbox) {
- fputs ($imap_stream, sqimap_session_id() . " DELETE \"$mailbox\"\r\n");
- $read_ary = sqimap_read_data($imap_stream, sqimap_session_id(), true, $response, $message);
- sqimap_unsubscribe ($imap_stream, $mailbox);
- }
-
- /***********************************************************************
- ** Determines if the user is subscribed to the folder or not
- **********************************************************************/
- function sqimap_mailbox_is_subscribed($imap_stream, $folder) {
- $boxes = sqimap_mailbox_list ($imap_stream);
- foreach ($boxes as $ref) {
- if ($ref['unformatted'] == $folder)
- return true;
- }
- return false;
- }
-
-
-
- /******************************************************************************
- ** Formats a mailbox into 4 parts for the $boxes array
- **
- ** The four parts are:
- **
- ** 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
- **
- ******************************************************************************/
- function sqimap_mailbox_parse ($line, $line_lsub) {
- global $folder_prefix, $delimiter;
-
- // Process each folder line
- for ($g=0; $g < count($line); $g++) {
-
- // Store the raw IMAP reply
- if (isset($line[$g]))
- $boxes[$g]["raw"] = $line[$g];
- else
- $boxes[$g]["raw"] = "";
-
-
- // Count number of delimiters ($delimiter) in folder name
- $mailbox = trim($line_lsub[$g]);
- $dm_count = countCharInString($mailbox, $delimiter);
- if (substr($mailbox, -1) == $delimiter)
- $dm_count--; // If name ends in delimiter - decrement count by one
-
- // Format folder name, but only if it's a INBOX.* or have
- // a parent.
- $boxesbyname[$mailbox] = $g;
- $parentfolder = readMailboxParent($mailbox, $delimiter);
- if((strtolower(substr($mailbox, 0, 5)) == "inbox") ||
- (substr($mailbox, 0, strlen($folder_prefix)) == $folder_prefix) ||
- (isset($boxesbyname[$parentfolder]) && (strlen($parentfolder) > 0) ) ) {
- $indent = $dm_count - (countCharInString($folder_prefix, $delimiter));
- if ($indent > 0)
- $boxes[$g]["formatted"] = str_repeat(" ", $indent);
- else
- $boxes[$g]["formatted"] = '';
- $boxes[$g]["formatted"] .= readShortMailboxName($mailbox, $delimiter);
- } else {
- $boxes[$g]["formatted"] = $mailbox;
- }
-
- $boxes[$g]['unformatted-dm'] = $mailbox;
- if (substr($mailbox, -1) == $delimiter)
+/**
+ * imap_mailbox.php
+ *
+ * Copyright (c) 1999-2002 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_local.php');
+
+global $boxesnew;
+
+class mailboxes {
+ var $mailboxname_full = '', $mailboxname_sub= '', $is_noselect = false,
+ $is_special = false, $is_root = false, $is_inbox = false, $is_sent = false,
+ $is_trash = false, $is_draft = false, $mbxs = array(),
+ $unseen = false, $total = false;
+
+ function addMbx($mbx, $delimiter, $start, $specialfirst) {
+ $ary = explode($delimiter, $mbx->mailboxname_full);
+ $mbx_parent = &$this;
+ for ($i = $start, $c = count($ary)-1; $i < $c; $i++) {
+ $mbx_childs = &$mbx_parent->mbxs;
+ $found = false;
+ if ($mbx_childs) {
+ foreach ($mbx_childs as $key => $parent) {
+ if ($parent->mailboxname_sub == $ary[$i]) {
+ $mbx_parent = &$mbx_parent->mbxs[$key];
+ $found = true;
+ }
+ }
+ }
+ if (!$found) {
+ $no_select_mbx = new mailboxes();
+ if (isset($mbx_parent->mailboxname_full) && $mbx_parent->mailboxname_full != '') {
+ $no_select_mbx->mailboxname_full = $mbx_parent->mailboxname_full.$delimiter.$ary[$i];
+ } else {
+ $no_select_mbx->mailboxname_full = $ary[$i];
+ }
+ $no_select_mbx->mailboxname_sub = $ary[$i];
+ $no_select_mbx->is_noselect = true;
+ $mbx_parent->mbxs[] = $no_select_mbx;
+ $i--;
+ }
+ }
+ $mbx_parent->mbxs[] = $mbx;
+ if ($mbx->is_special && $specialfirst) {
+ usort($mbx_parent->mbxs, 'sortSpecialMbx');
+ }
+ }
+}
+
+function sortSpecialMbx($a, $b) {
+ if ($a->is_inbox) {
+ $acmp = '0'. $a->mailboxname_full;
+ } else if ($a->is_special) {
+ $acmp = '1'. $a->mailboxname_full;
+ } else {
+ $acmp = '2' . $a->mailboxname_full;
+ }
+ if ($b->is_inbox) {
+ $bcmp = '0'. $b->mailboxname_full;
+ }else if ($b->is_special) {
+ $bcmp = '1' . $b->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];
+}
+
+function check_is_noselect ($lsub_line) {
+ return preg_match("/^\* LSUB \([^\)]*\\Noselect[^\)]*\)/i", $lsub_line);
+}
+
+/**
+ * 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)
+ */
+function readMailboxParent($haystack, $needle) {
+ if ($needle == '') {
+ $ret = '';
+ } else {
+ $parts = explode($needle, $haystack);
+ $elem = array_pop($parts);
+ while ($elem == '' && count($parts)) {
+ $elem = array_pop($parts);
+ }
+ $ret = join($needle, $parts);
+ }
+ 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 );
+ }
+ } else {
+ $boxs = $box2 . $delimiter;
+ /* Skip next second delimiter */
+ $i = strpos( $box1, $delimiter );
+ $i = strpos( $box1, $delimiter, $i + 1 );
+ if ( $i === false ) {
+ $i = strlen( $box2 );
+ } else {
+ $i++;
+ }
+ }
+
+ return ( substr( $box1, 0, $i ) == substr( $boxs, 0, $i ) );
+}
+
+/* Defines special mailboxes */
+function isSpecialMailbox( $box ) {
+ global $trash_folder, $sent_folder, $draft_folder,
+ $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 ) );
+
+ if ( !$ret ) {
+ $ret = do_hook_function( 'special_mailbox', $box );
+ }
+
+ return $ret;
+}
+
+/* Expunges a mailbox */
+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;
+ } else {
+ $uid = false;
+ }
+ $read = sqimap_run_command($imap_stream, 'EXPUNGE'.$id, $handle_errors,
+ $response, $message, $uid);
+ $cnt = 0;
+
+ if (is_array($read)) {
+ foreach ($read as $r) {
+ if (preg_match('/^\*\s[0-9]+\sEXPUNGE/AUi',$r,$regs)) {
+ $cnt++;
+ }
+ }
+ }
+ return $cnt;
+}
+
+/* Checks whether or not the specified mailbox exists */
+function sqimap_mailbox_exists ($imap_stream, $mailbox) {
+ if (!isset($mailbox)) {
+ return false;
+ }
+ $mbx = sqimap_run_command($imap_stream, "LIST \"\" \"$mailbox\"",
+ true, $response, $message);
+ return isset($mbx[0]);
+}
+
+/* Selects a mailbox */
+function sqimap_mailbox_select ($imap_stream, $mailbox) {
+ global $auto_expunge;
+
+ if ($mailbox == 'None') {
+ return;
+ }
+
+ $read = sqimap_run_command($imap_stream, "SELECT \"$mailbox\"",
+ true, $response, $message);
+ $result = array();
+ for ($i = 0, $cnt = count($read); $i < $cnt; $i++) {
+ if (preg_match('/^\*\s+OK\s\[(\w+)\s(\w+)\]/',$read[$i], $regs)) {
+ $result[strtoupper($regs[1])] = $regs[2];
+ } else if (preg_match('/^\*\s([0-9]+)\s(\w+)/',$read[$i], $regs)) {
+ $result[strtoupper($regs[2])] = $regs[1];
+ } else {
+ if (preg_match("/PERMANENTFLAGS(.*)/i",$read[$i], $regs)) {
+ $regs[1]=trim(preg_replace ( array ("/\(/","/\)/","/\]/") ,'', $regs[1])) ;
+ $result['PERMANENTFLAGS'] = $regs[1];
+ } else if (preg_match("/FLAGS(.*)/i",$read[$i], $regs)) {
+ $regs[1]=trim(preg_replace ( array ("/\(/","/\)/") ,'', $regs[1])) ;
+ $result['FLAGS'] = $regs[1];
+ }
+ }
+ }
+ if (preg_match('/^\[(.+)\]/',$message, $regs)) {
+ $result['RIGHTS']=$regs[1];
+ }
+
+ if ($auto_expunge) {
+ $tmp = sqimap_run_command($imap_stream, 'EXPUNGE', false, $a, $b);
+ }
+ return $result;
+}
+
+/* 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 \"$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 \"$mailbox\"",
+ true, $response, $message);
+}
+
+/* Unsubscribes to an existing folder */
+function sqimap_unsubscribe ($imap_stream, $mailbox) {
+ $read_ary = sqimap_run_command($imap_stream, "UNSUBSCRIBE \"$mailbox\"",
+ true, $response, $message);
+}
+
+/* Deletes the given folder */
+function sqimap_mailbox_delete ($imap_stream, $mailbox) {
+ global $data_dir, $username;
+ $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', ''));
+ removePref($data_dir, $username, "thread_$mailbox");
+}
+
+/* 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) {
+ if ($ref['unformatted'] == $folder) {
+ return true;
+ }
+ }
+ return false;
+}
+
+/* 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;
+ if ( substr( $old_name, -1 ) == $delimiter ) {
+ $old_name = substr( $old_name, 0, strlen( $old_name ) - 1 );
+ $new_name = substr( $new_name, 0, strlen( $new_name ) - 1 );
+ $postfix = $delimiter;
+ } else {
+ $postfix = '';
+ }
+
+ $boxesall = sqimap_mailbox_list($imap_stream);
+ $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);
+ 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));
+ $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 "' . $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]);
+ sqimap_subscribe($imap_stream, $new_sub);
+ setPref($data_dir, $username, 'thread_'.$new_sub, $oldpref);
+ 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:
+ *
+ * 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
+ */
+function sqimap_mailbox_parse ($line, $line_lsub) {
+ global $folder_prefix, $delimiter;
+
+ /* Process each folder line */
+ for ($g = 0, $cnt = count($line); $g < $cnt; $g++) {
+ /* Store the raw IMAP reply */
+ if (isset($line[$g])) {
+ $boxesall[$g]['raw'] = $line[$g];
+ } else {
+ $boxesall[$g]['raw'] = '';
+ }
+
+ /* Count number of delimiters ($delimiter) in folder name */
+ $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 */
+ $dm_count--;
+ }
+
+ /* Format folder name, but only if it's a INBOX.* or has a parent. */
+ $boxesallbyname[$mailbox] = $g;
+ $parentfolder = readMailboxParent($mailbox, $delimiter);
+ if ( (strtolower(substr($mailbox, 0, 5)) == "inbox") ||
+ (substr($mailbox, 0, strlen($folder_prefix)) == $folder_prefix) ||
+ (isset($boxesallbyname[$parentfolder]) &&
+ (strlen($parentfolder) > 0) ) ) {
+ $indent = $dm_count - (substr_count($folder_prefix, $delimiter));
+ if ($indent > 0) {
+ $boxesall[$g]['formatted'] = str_repeat(' ', $indent);
+ } else {
+ $boxesall[$g]['formatted'] = '';
+ }
+ $boxesall[$g]['formatted'] .= imap_utf7_decode_local(readShortMailboxName($mailbox, $delimiter));
+ } else {
+ $boxesall[$g]['formatted'] = imap_utf7_decode_local($mailbox);
+ }
+
+ $boxesall[$g]['unformatted-dm'] = $mailbox;
+ if (substr($mailbox, -1) == $delimiter) {