** -> *
[squirrelmail.git] / functions / imap_mailbox.php
CommitLineData
59177427 1<?php
bccadd02 2
8e9e8afa 3 /**
7350889b 4 * imap_mailbox.php
5 *
6 * Copyright (c) 1999-2001 The Squirrelmail Development Team
7 * Licensed under the GNU GPL. For full terms see the file COPYING.
8 *
9 * This impliments all functions that manipulate mailboxes
10 *
11 * $Id$
12 */
f435778e 13
8e9e8afa 14 /******************************************************************************
15 ** Expunges a mailbox
16 ******************************************************************************/
a7f3c40d 17 function sqimap_mailbox_expunge ($imap_stream, $mailbox,$handle_errors = true) {
180aa6d7 18 fputs ($imap_stream, sqimap_session_id() . " EXPUNGE\r\n");
19 $read = sqimap_read_data($imap_stream, sqimap_session_id(), $handle_errors, $response, $message);
8e9e8afa 20 }
21
22
23 /******************************************************************************
24 ** Checks whether or not the specified mailbox exists
25 ******************************************************************************/
26 function sqimap_mailbox_exists ($imap_stream, $mailbox) {
146e0c45 27 if (! isset($mailbox))
28 return false;
180aa6d7 29 fputs ($imap_stream, sqimap_session_id() . " LIST \"\" \"$mailbox\"\r\n");
30 $mbx = sqimap_read_data($imap_stream, sqimap_session_id(), true, $response, $message);
146e0c45 31 return isset($mbx[0]);
8e9e8afa 32 }
33
a2790a61 34 /******************************************************************************
8e9e8afa 35 ** Selects a mailbox
36 ******************************************************************************/
04632dbc 37 function sqimap_mailbox_select ($imap_stream, $mailbox, $hide=true, $recent=false) {
3751dc7f 38 global $auto_expunge;
dce206ab 39
2d367c68 40 if( $mailbox == 'None' )
dce206ab 41 return;
2d367c68 42
180aa6d7 43 fputs ($imap_stream, sqimap_session_id() . " SELECT \"$mailbox\"\r\n");
44 $read = sqimap_read_data($imap_stream, sqimap_session_id(), true, $response, $message);
04632dbc 45 if ($recent) {
46 for ($i=0; $i<count($read); $i++) {
bccadd02 47 if (strpos(strtolower($read[$i]), 'recent')) {
48 $r = explode(' ', $read[$i]);
04632dbc 49 }
50 }
51 return $r[1];
52 }
3751dc7f 53 if ($auto_expunge) {
180aa6d7 54 fputs ($imap_stream, sqimap_session_id() . " EXPUNGE\r\n");
55 $tmp = sqimap_read_data($imap_stream, sqimap_session_id(), false, $a, $b);
3751dc7f 56 }
8e9e8afa 57 }
58
59
60
61 /******************************************************************************
62 ** Creates a folder
63 ******************************************************************************/
64 function sqimap_mailbox_create ($imap_stream, $mailbox, $type) {
525b7ae6 65 global $delimiter;
2d367c68 66 if (strtolower($type) == 'noselect') {
525b7ae6 67 $mailbox = $mailbox.$delimiter;
8e9e8afa 68 }
180aa6d7 69 fputs ($imap_stream, sqimap_session_id() . " CREATE \"$mailbox\"\r\n");
70 $read_ary = sqimap_read_data($imap_stream, sqimap_session_id(), true, $response, $message);
8e9e8afa 71
72 sqimap_subscribe ($imap_stream, $mailbox);
73 }
74
75
76
77 /******************************************************************************
78 ** Subscribes to an existing folder
79 ******************************************************************************/
80 function sqimap_subscribe ($imap_stream, $mailbox) {
180aa6d7 81 fputs ($imap_stream, sqimap_session_id() . " SUBSCRIBE \"$mailbox\"\r\n");
82 $read_ary = sqimap_read_data($imap_stream, sqimap_session_id(), true, $response, $message);
8e9e8afa 83 }
84
85
86
87
88 /******************************************************************************
89 ** Unsubscribes to an existing folder
90 ******************************************************************************/
91 function sqimap_unsubscribe ($imap_stream, $mailbox) {
2752bb16 92 global $imap_server_type;
cbdc5621 93
180aa6d7 94 fputs ($imap_stream, sqimap_session_id() . " UNSUBSCRIBE \"$mailbox\"\r\n");
95 $read_ary = sqimap_read_data($imap_stream, sqimap_session_id(), true, $response, $message);
8e9e8afa 96 }
97
98
99
100
101 /******************************************************************************
102 ** This function simply deletes the given folder
103 ******************************************************************************/
104 function sqimap_mailbox_delete ($imap_stream, $mailbox) {
180aa6d7 105 fputs ($imap_stream, sqimap_session_id() . " DELETE \"$mailbox\"\r\n");
106 $read_ary = sqimap_read_data($imap_stream, sqimap_session_id(), true, $response, $message);
8e9e8afa 107 sqimap_unsubscribe ($imap_stream, $mailbox);
108 }
8d636967 109
110 /***********************************************************************
111 ** Determines if the user is subscribed to the folder or not
112 **********************************************************************/
113 function sqimap_mailbox_is_subscribed($imap_stream, $folder) {
114 $boxes = sqimap_mailbox_list ($imap_stream);
115 foreach ($boxes as $ref) {
116 if ($ref['unformatted'] == $folder)
117 return true;
118 }
119 return false;
120 }
121
8e9e8afa 122
123
124 /******************************************************************************
125 ** Formats a mailbox into 4 parts for the $boxes array
5bdd7223 126 **
127 ** The four parts are:
128 **
129 ** raw - Raw LIST/LSUB response from the IMAP server
130 ** formatted - nicely formatted folder name
131 ** unformatted - unformatted, but with delimiter at end removed
132 ** unformatted-dm - folder name as it appears in raw response
18a148f0 133 ** unformatted-disp - unformatted without $folder_prefix
5bdd7223 134 **
8e9e8afa 135 ******************************************************************************/
525b7ae6 136 function sqimap_mailbox_parse ($line, $line_lsub) {
137 global $folder_prefix, $delimiter;
5bdd7223 138
139 // Process each folder line
8e9e8afa 140 for ($g=0; $g < count($line); $g++) {
5bdd7223 141
2752bb16 142 // Store the raw IMAP reply
a7ea7540 143 if (isset($line[$g]))
144 $boxes[$g]["raw"] = $line[$g];
145 else
146 $boxes[$g]["raw"] = "";
147
5bdd7223 148
525b7ae6 149 // Count number of delimiters ($delimiter) in folder name
6477eb2d 150 $mailbox = trim($line_lsub[$g]);
525b7ae6 151 $dm_count = countCharInString($mailbox, $delimiter);
152 if (substr($mailbox, -1) == $delimiter)
5bdd7223 153 $dm_count--; // If name ends in delimiter - decrement count by one
154
2752bb16 155 // Format folder name, but only if it's a INBOX.* or have
156 // a parent.
157 $boxesbyname[$mailbox] = $g;
525b7ae6 158 $parentfolder = readMailboxParent($mailbox, $delimiter);
36dfb0c9 159 if((strtolower(substr($mailbox, 0, 5)) == "inbox") ||
160 (substr($mailbox, 0, strlen($folder_prefix)) == $folder_prefix) ||
161 (isset($boxesbyname[$parentfolder]) && (strlen($parentfolder) > 0) ) ) {
525b7ae6 162 $indent = $dm_count - (countCharInString($folder_prefix, $delimiter));
b1275991 163 if ($indent > 0)
0debfed6 164 $boxes[$g]["formatted"] = str_repeat("&nbsp;&nbsp;", $indent);
165 else
166 $boxes[$g]["formatted"] = '';
525b7ae6 167 $boxes[$g]["formatted"] .= readShortMailboxName($mailbox, $delimiter);
2752bb16 168 } else {
169 $boxes[$g]["formatted"] = $mailbox;
170 }
8e9e8afa 171
146e0c45 172 $boxes[$g]['unformatted-dm'] = $mailbox;
525b7ae6 173 if (substr($mailbox, -1) == $delimiter)
8e9e8afa 174 $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
146e0c45 175 $boxes[$g]['unformatted'] = $mailbox;
20eb2621 176 if (substr($mailbox,0,strlen($folder_prefix))==$folder_prefix)
631b9da3 177 $mailbox = substr($mailbox, strlen($folder_prefix));
178 $boxes[$g]['unformatted-disp'] = $mailbox;
146e0c45 179 $boxes[$g]['id'] = $g;
8e9e8afa 180
1a7e1e97 181 $boxes[$g]['flags'] = array();
182 if (isset($line[$g])) {
36dfb0c9 183 ereg("\(([^)]*)\)",$line[$g],$regs);
1a7e1e97 184 $flags = trim(strtolower(str_replace('\\', '',$regs[1])));
185 if ($flags)
186 $boxes[$g]['flags'] = explode(' ', $flags);
187 }
8e9e8afa 188 }
5bdd7223 189
8e9e8afa 190 return $boxes;
191 }
1071ae95 192
193 /* Apparently you must call a user function with usort instead
194 * of calling a built-in directly. Stupid.
195 * Patch from dave_michmerhuizen@yahoo.com
196 * Allows case insensitivity when sorting folders
197 */
198 function user_strcasecmp($a, $b)
199 {
200 return strcasecmp($a, $b);
201 }
10359c65 202
6b8a49c9 203
8e9e8afa 204 /******************************************************************************
205 ** Returns sorted mailbox lists in several different ways.
5bdd7223 206 ** See comment on sqimap_mailbox_parse() for info about the returned array.
8e9e8afa 207 ******************************************************************************/
208 function sqimap_mailbox_list ($imap_stream) {
5bdd7223 209 global $data_dir, $username, $list_special_folders_first;
f7b1b3b1 210 global $folder_prefix, $trash_folder, $sent_folder, $draft_folder;
211 global $move_to_trash, $move_to_sent, $save_as_draft;
525b7ae6 212 global $delimiter;
8e9e8afa 213
1590a668 214 $inbox_in_list = false;
215 $inbox_subscribed = false;
216
38dc768c 217 require_once('../src/load_prefs.php');
218 require_once('../functions/array.php');
8e9e8afa 219
8e9e8afa 220 /** LSUB array **/
180aa6d7 221 fputs ($imap_stream, sqimap_session_id() . " LSUB \"$folder_prefix\" \"*\"\r\n");
222 $lsub_ary = sqimap_read_data ($imap_stream, sqimap_session_id(), true, $response, $message);
44a3ca20 223
224 // Section about removing the last element was removed
225 // We don't return "* OK" anymore from sqimap_read_data
6477eb2d 226
44a3ca20 227 $sorted_lsub_ary = array();
8e9e8afa 228 for ($i=0;$i < count($lsub_ary); $i++) {
44a3ca20 229 // Workaround for EIMS
230 // Doesn't work if the mailbox name is multiple lines
231 if (isset($lsub_ary[$i + 1]) &&
232 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
233 $lsub_ary[$i], $regs)) {
234 $i ++;
235 $lsub_ary[$i] = $regs[1] . '"' . addslashes(trim($lsub_ary[$i])) .
236 '"' . $regs[2];
237 }
238 $temp_mailbox_name = find_mailbox_name($lsub_ary[$i]);
239 $sorted_lsub_ary[] = $temp_mailbox_name;
240 if (strtoupper($temp_mailbox_name) == 'INBOX')
8e9e8afa 241 $inbox_subscribed = true;
242 }
ee62ce13 243 $new_ary = array();
244 for ($i=0; $i < count($sorted_lsub_ary); $i++) {
245 if (!in_array($sorted_lsub_ary[$i], $new_ary)) {
246 $new_ary[] = $sorted_lsub_ary[$i];
247 }
248 }
249 $sorted_lsub_ary = $new_ary;
8e9e8afa 250 if (isset($sorted_lsub_ary)) {
44a3ca20 251 usort($sorted_lsub_ary, 'user_strcasecmp');
10359c65 252 //sort($sorted_lsub_ary);
8e9e8afa 253 }
254
3cb866d7 255 /** LIST array **/
44a3ca20 256 $sorted_list_ary = array();
f9b3e5d9 257 for ($i=0; $i < count($sorted_lsub_ary); $i++) {
525b7ae6 258 if (substr($sorted_lsub_ary[$i], -1) == $delimiter)
f9b3e5d9 259 $mbx = substr($sorted_lsub_ary[$i], 0, strlen($sorted_lsub_ary[$i])-1);
260 else
261 $mbx = $sorted_lsub_ary[$i];
262
180aa6d7 263 fputs ($imap_stream, sqimap_session_id() . " LIST \"\" \"$mbx\"\r\n");
264 $read = sqimap_read_data ($imap_stream, sqimap_session_id(), true, $response, $message);
44a3ca20 265 // Another workaround for EIMS
266 if (isset($read[1]) &&
267 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
268 $read[0], $regs)) {
269 $read[0] = $regs[1] . '"' . addslashes(trim($read[1])) .
270 '"' . $regs[2];
271 }
a7ea7540 272 if (isset($sorted_list_ary[$i]))
273 $sorted_list_ary[$i] = "";
274 if (isset($read[0]))
44a3ca20 275 $sorted_list_ary[$i] = $read[0];
a7ea7540 276 else
44a3ca20 277 $sorted_list_ary[$i] = "";
278 if (isset($sorted_list_ary[$i]) &&
279 strtoupper(find_mailbox_name($sorted_list_ary[$i])) == "INBOX")
3cb866d7 280 $inbox_in_list = true;
f9b3e5d9 281 }
2752bb16 282
f7b1b3b1 283 /**
284 * Just in case they're not subscribed to their inbox,
285 * we'll get it for them anyway
286 */
8e9e8afa 287 if ($inbox_subscribed == false || $inbox_in_list == false) {
180aa6d7 288 fputs ($imap_stream, sqimap_session_id() . " LIST \"\" \"INBOX\"\r\n");
289 $inbox_ary = sqimap_read_data ($imap_stream, sqimap_session_id(), true, $response, $message);
44a3ca20 290 // Another workaround for EIMS
291 if (isset($inbox_ary[1]) &&
292 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
293 $inbox_ary[0], $regs)) {
294 $inbox_ary[0] = $regs[1] . '"' . addslashes(trim($inbox_ary[1])) .
295 '"' . $regs[2];
296 }
297
298 $sorted_list_ary[] = $inbox_ary[0];
299 $sorted_lsub_ary[] = find_mailbox_name($inbox_ary[0]);
8e9e8afa 300 }
301
525b7ae6 302 $boxes = sqimap_mailbox_parse ($sorted_list_ary, $sorted_lsub_ary);
f9b3e5d9 303
304 /** Now, lets sort for special folders **/
5bdd7223 305 $boxesnew = Array();
306
f7b1b3b1 307 /* Find INBOX */
8e9e8afa 308 for ($i = 0; $i < count($boxes); $i++) {
1e0628fb 309 if (strtolower($boxes[$i]["unformatted"]) == "inbox") {
5bdd7223 310 $boxesnew[] = $boxes[$i];
283db905 311 $used[$i] = true;
2752bb16 312 $i = count($boxes);
8e9e8afa 313 }
314 }
aed206bf 315
f7b1b3b1 316 /* List special folders and their subfolders, if requested. */
8e9e8afa 317 if ($list_special_folders_first == true) {
f7b1b3b1 318 /* First list the trash folder. */
245a6892 319 for ($i = 0 ; $i < count($boxes) ; $i++) {
23ed73eb 320 if ($move_to_trash &&
f7b1b3b1 321 eregi('^' . quotemeta($trash_folder) . '(' .
525b7ae6 322 quotemeta($delimiter) . '.*)?$', $boxes[$i]['unformatted'])) {
5bdd7223 323 $boxesnew[] = $boxes[$i];
283db905 324 $used[$i] = true;
1e0628fb 325 }
f7b1b3b1 326 }
327
328 /* Then list the sent folder. */
329 for ($i = 0 ; $i < count($boxes) ; $i++) {
330 if ($move_to_sent &&
331 eregi('^' . quotemeta($sent_folder) . '(' .
525b7ae6 332 quotemeta($delimiter) . '.*)?$', $boxes[$i]['unformatted'])) {
5bdd7223 333 $boxesnew[] = $boxes[$i];
283db905 334 $used[$i] = true;
8e9e8afa 335 }
336 }
5bdd7223 337
f7b1b3b1 338 /* Lastly, list the list the draft folder. */
339 for ($i = 0 ; $i < count($boxes) ; $i++) {
340 if ($save_as_draft &&
341 eregi('^' . quotemeta($draft_folder) . '(' .
525b7ae6 342 quotemeta($delimiter) . '.*)?$', $boxes[$i]['unformatted'])) {
f7b1b3b1 343 $boxesnew[] = $boxes[$i];
344 $used[$i] = true;
345 }
346 }
347
348 /* Put INBOX.* folders ahead of the rest. */
245a6892 349 for ($i = 0; $i < count($boxes); $i++) {
146e0c45 350 if (eregi('^inbox\\.', $boxes[$i]["unformatted"]) &&
283db905 351 (!isset($used[$i]) || $used[$i] == false)) {
2752bb16 352 $boxesnew[] = $boxes[$i];
283db905 353 $used[$i] = true;
2752bb16 354 }
355 }
8e9e8afa 356 }
c5eb2c03 357
5bdd7223 358 // Rest of the folders
8e9e8afa 359 for ($i = 0; $i < count($boxes); $i++) {
1e0628fb 360 if ((strtolower($boxes[$i]["unformatted"]) != "inbox") &&
283db905 361 (!isset($used[$i]) || $used[$i] == false)) {
5bdd7223 362 $boxesnew[] = $boxes[$i];
283db905 363 $used[$i] = true;
8e9e8afa 364 }
365 }
366
367 return $boxesnew;
368 }
8e9e8afa 369
370 /******************************************************************************
371 ** Returns a list of all folders, subscribed or not
372 ******************************************************************************/
373 function sqimap_mailbox_list_all ($imap_stream) {
1e0628fb 374 global $list_special_folders_first, $folder_prefix;
525b7ae6 375 global $delimiter;
376
38dc768c 377 if (!function_exists ("ary_sort"))
378 include_once('../functions/array.php');
8e9e8afa 379
180aa6d7 380 $ssid = sqimap_session_id();
381 $lsid = strlen( $ssid );
382 fputs ($imap_stream, $ssid . " LIST \"$folder_prefix\" *\r\n");
383 $read_ary = sqimap_read_data ($imap_stream, $ssid, true, $response, $message);
8e9e8afa 384 $g = 0;
180aa6d7 385 $phase = "inbox";
5bdd7223 386
8e9e8afa 387 for ($i = 0; $i < count($read_ary); $i++) {
44a3ca20 388 // Another workaround for EIMS
180aa6d7 389 if (isset($read_ary[$i + 1]) &&
390 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
391 $read_ary[$i], $regs)) {
392 $i ++;
393 $read_ary[$i] = $regs[1] . '"' .
394 addslashes(trim($read_ary[$i])) .
395 '"' . $regs[2];
396 }
397 if (substr ($read_ary[$i], 0, $lsid) != $ssid ) {
5bdd7223 398
2752bb16 399 // Store the raw IMAP reply
8e9e8afa 400 $boxes[$g]["raw"] = $read_ary[$i];
401
525b7ae6 402 // Count number of delimiters ($delimiter) in folder name
8e9e8afa 403 $mailbox = find_mailbox_name($read_ary[$i]);
525b7ae6 404 $dm_count = countCharInString($mailbox, $delimiter);
405 if (substr($mailbox, -1) == $delimiter)
5bdd7223 406 $dm_count--; // If name ends in delimiter - decrement count by one
2752bb16 407
408 // Format folder name, but only if it's a INBOX.* or have
409 // a parent.
410 $boxesbyname[$mailbox] = $g;
525b7ae6 411 $parentfolder = readMailboxParent($mailbox, $delimiter);
412 if((eregi('^inbox'.quotemeta($delimiter), $mailbox)) ||
146e0c45 413 (ereg('^'.$folder_prefix, $mailbox)) ||
2752bb16 414 ( isset($boxesbyname[$parentfolder]) && (strlen($parentfolder) > 0) ) ) {
0debfed6 415 if ($dm_count)
416 $boxes[$g]["formatted"] = str_repeat("&nbsp;&nbsp;", $dm_count);
417 else
418 $boxes[$g]["formatted"] = '';
525b7ae6 419 $boxes[$g]["formatted"] .= readShortMailboxName($mailbox, $delimiter);
2752bb16 420 } else {
421 $boxes[$g]["formatted"] = $mailbox;
422 }
8e9e8afa 423
424 $boxes[$g]["unformatted-dm"] = $mailbox;
525b7ae6 425 if (substr($mailbox, -1) == $delimiter)
8e9e8afa 426 $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
427 $boxes[$g]["unformatted"] = $mailbox;
146e0c45 428 $boxes[$g]["unformatted-disp"] = ereg_replace('^' . $folder_prefix, '', $mailbox);
8e9e8afa 429 $boxes[$g]["id"] = $g;
430
431 /** Now lets get the flags for this mailbox **/
180aa6d7 432 fputs ($imap_stream, sqimap_session_id() . " LIST \"\" \"$mailbox\"\r\n");
433 $read_mlbx = sqimap_read_data ($imap_stream, sqimap_session_id(), true, $response, $message);
434
435 // Another workaround for EIMS
436 if (isset($read_mlbx[1]) &&
437 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
438 $read_mlbx[0], $regs)) {
439 $read_mlbx[0] = $regs[1] . '"' .
440 addslashes(trim($read_mlbx[1])) .
441 '"' . $regs[2];
442 }
8e9e8afa 443
444 $flags = substr($read_mlbx[0], strpos($read_mlbx[0], "(")+1);
445 $flags = substr($flags, 0, strpos($flags, ")"));
146e0c45 446 $flags = str_replace('\\', '', $flags);
8e9e8afa 447 $flags = trim(strtolower($flags));
448 if ($flags) {
4afa7206 449 $boxes[$g]['flags'] = explode(" ", $flags);
8e9e8afa 450 }
12d61439 451 else
452 {
453 $boxes[$g]['flags'] = array();
454 }
8e9e8afa 455 }
456 $g++;
457 }
5bdd7223 458 if(is_array($boxes)) {
591000ec 459 $boxes = ary_sort ($boxes, "unformatted", 1);
460 }
5bdd7223 461
8e9e8afa 462 return $boxes;
463 }
464
f7b1b3b1 465?>