- /**
- ** imap_mailbox.php
- **
- ** This impliments all functions that manipulate mailboxes
- **
- ** $Id$
- **/
-
- /******************************************************************************
- ** Expunges a mailbox
- ******************************************************************************/
- function sqimap_mailbox_expunge ($imap_stream, $mailbox,$handle_errors = true) {
- sqimap_mailbox_select ($imap_stream, $mailbox);
- fputs ($imap_stream, "a001 EXPUNGE\r\n");
- $read = sqimap_read_data($imap_stream, "a001", $handle_errors, $response, $message);
- }
-
-
- /******************************************************************************
- ** Checks whether or not the specified mailbox exists
- ******************************************************************************/
- function sqimap_mailbox_exists ($imap_stream, $mailbox) {
- fputs ($imap_stream, "a001 LIST \"\" \"$mailbox\"\r\n");
- $mbx = sqimap_read_data($imap_stream, "a001", true, $response, $message);
- if ($mailbox) {
- return !!(ereg ("$mailbox", $mbx[0])); // To force into true/false
- }
- }
-
- /******************************************************************************
- ** Selects a mailbox
- ******************************************************************************/
- function sqimap_mailbox_select ($imap_stream, $mailbox, $hide=true, $recent=false) {
- global $auto_expunge;
-
- fputs ($imap_stream, "a001 SELECT \"$mailbox\"\r\n");
- $read = sqimap_read_data($imap_stream, "a001", true, $response, $message);
- if ($recent) {
- for ($i=0; $i<count($read); $i++) {
- if (strpos(strtolower($read[$i]), "recent")) {
- $r = explode(" ", $read[$i]);
+
+/**
+ * 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$
+ */
+
+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 Mail Boxes
+*/
+function isSpecialMailbox( $box ) {
+
+ global $trash_folder, $sent_folder, $draft_folder,
+ $move_to_trash, $move_to_sent, $save_as_draft,
+ $delimiter, $folder_prefix, $imap_server_type;
+
+ $ret = ( (strtolower($box) == 'inbox') ||
+ ( $move_to_trash && isBoxBelow( $box, $trash_folder ) ) ||
+ ( $move_to_sent && isBoxBelow( $box, $sent_folder )) ||
+ ($save_as_draft && $box == $draft_folder ) );
+
+ return( $ret );
+
+}
+
+/*************************
+ ** Expunges a mailbox **
+ *************************/
+function sqimap_mailbox_expunge ($imap_stream, $mailbox,$handle_errors = TRUE)
+{
+ $read = sqimap_run_command($imap_stream, 'EXPUNGE',
+ $handle_errors, $response, $message);
+}
+
+
+/******************************************************************************
+ ** 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,
+ $hide=TRUE, $recent=false)
+{
+ global $auto_expunge;
+
+ if ( $mailbox == 'None' ) {
+ return;
+ }
+
+ $read = sqimap_run_command($imap_stream, "SELECT \"$mailbox\"",
+ 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) {
+ $tmp = sqimap_run_command($imap_stream, 'EXPUNGE',
+ false, $a, $b);
+ }
+}
+
+
+
+/******************************************************************************
+ ** Creates a folder
+ ******************************************************************************/
+function sqimap_mailbox_create ($imap_stream, $mailbox, $type)
+{
+ global $delimiter;
+ if (strtolower($type) == 'noselect') {
+ $mailbox = $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)
+{
+ global $imap_server_type;
+
+ $read_ary = sqimap_run_command($imap_stream, "UNSUBSCRIBE \"$mailbox\"",
+ TRUE, $response, $message);
+}
+
+
+
+/******************************************************************************
+ ** This function simply deletes the given folder
+ ******************************************************************************/
+function sqimap_mailbox_delete ($imap_stream, $mailbox)
+{
+ $read_ary = sqimap_run_command($imap_stream, "DELETE \"$mailbox\"",
+ 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;
+}
+
+/*
+ Renames a mailbox
+*/
+function sqimap_mailbox_rename( $imap_stream, $old_name, $new_name ) {
+
+ if ( $old_name <> $new_name ) {
+
+ global $delimiter;
+
+ 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;
+ $boxes = sqimap_mailbox_list($imap_stream);
+ } else {
+ $postfix = '';
+ $boxes = FALSE;
+ }
+
+ $cmd = 'RENAME "' . quoteIMAP($old_name) . '" "' . quoteIMAP($new_name) . '"';
+ $data = sqimap_run_command($imap_stream, $cmd,
+ TRUE, $response, $message);
+ sqimap_unsubscribe($imap_stream, $old_name.$postfix);
+ sqimap_subscribe($imap_stream, $new_name.$postfix);
+
+ if ( $boxes ) {
+ // Sub-unsub subfolders
+ $l = strlen( $old_name ) + 1;
+ $p = 'unformatted';
+ foreach ( $boxes as $box ) {
+ if ( substr( $box[$p], 0, $l ) == $old_name . $delimiter ) {
+ sqimap_unsubscribe($imap_stream, $box[$p]);
+ sqimap_subscribe($imap_stream,
+ $new_name . $delimiter . substr( $box[$p], $l ) );
+ }
+ }
+ }
+
+ }
+
+}
+
+/******************************************************************************
+ ** 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 = 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 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 - ( substr_count($folder_prefix, $delimiter));
+ if ($indent > 0) {
+ $boxes[$g]['formatted'] = str_repeat(" ", $indent);