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