While getting data from a stream it is possible to reach the end, so we should check...
[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;
dce206ab 39
40 if( $mailbox == _("None") )
41 return;
3751dc7f 42
8e9e8afa 43 fputs ($imap_stream, "a001 SELECT \"$mailbox\"\r\n");
2752bb16 44 $read = sqimap_read_data($imap_stream, "a001", true, $response, $message);
04632dbc 45 if ($recent) {
46 for ($i=0; $i<count($read); $i++) {
47 if (strpos(strtolower($read[$i]), "recent")) {
48 $r = explode(" ", $read[$i]);
49 }
50 }
51 return $r[1];
52 }
3751dc7f 53 if ($auto_expunge) {
54 fputs ($imap_stream, "a001 EXPUNGE\r\n");
8cf653ad 55 $tmp = sqimap_read_data($imap_stream, "a001", 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) {
65 if (strtolower($type) == "noselect") {
66 $dm = sqimap_get_delimiter($imap_stream);
67 $mailbox = $mailbox.$dm;
68 }
69 fputs ($imap_stream, "a001 CREATE \"$mailbox\"\r\n");
70 $read_ary = sqimap_read_data($imap_stream, "a001", true, $response, $message);
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) {
81 fputs ($imap_stream, "a001 SUBSCRIBE \"$mailbox\"\r\n");
82 $read_ary = sqimap_read_data($imap_stream, "a001", true, $response, $message);
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
8e9e8afa 94 fputs ($imap_stream, "a001 UNSUBSCRIBE \"$mailbox\"\r\n");
95 $read_ary = sqimap_read_data($imap_stream, "a001", true, $response, $message);
96 }
97
98
99
100
101 /******************************************************************************
102 ** This function simply deletes the given folder
103 ******************************************************************************/
104 function sqimap_mailbox_delete ($imap_stream, $mailbox) {
105 fputs ($imap_stream, "a001 DELETE \"$mailbox\"\r\n");
106 $read_ary = sqimap_read_data($imap_stream, "a001", true, $response, $message);
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 ******************************************************************************/
16530f8b 136 function sqimap_mailbox_parse ($line, $line_lsub, $dm) {
5bdd7223 137 global $folder_prefix;
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
2752bb16 149 // Count number of delimiters ($dm) in folder name
6477eb2d 150 $mailbox = trim($line_lsub[$g]);
8e9e8afa 151 $dm_count = countCharInString($mailbox, $dm);
152 if (substr($mailbox, -1) == $dm)
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;
158 $parentfolder = readMailboxParent($mailbox, $dm);
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) ) ) {
2752bb16 162 $indent = $dm_count - (countCharInString($folder_prefix, $dm));
b1275991 163 if ($indent > 0)
0debfed6 164 $boxes[$g]["formatted"] = str_repeat("&nbsp;&nbsp;", $indent);
165 else
166 $boxes[$g]["formatted"] = '';
2752bb16 167 $boxes[$g]["formatted"] .= readShortMailboxName($mailbox, $dm);
168 } else {
169 $boxes[$g]["formatted"] = $mailbox;
170 }
8e9e8afa 171
146e0c45 172 $boxes[$g]['unformatted-dm'] = $mailbox;
8e9e8afa 173 if (substr($mailbox, -1) == $dm)
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;
6477eb2d 210 global $trash_folder, $sent_folder;
f435778e 211 global $move_to_trash, $move_to_sent, $folder_prefix;
8e9e8afa 212
1590a668 213 $inbox_in_list = false;
214 $inbox_subscribed = false;
215
38dc768c 216 require_once('../src/load_prefs.php');
217 require_once('../functions/array.php');
8e9e8afa 218
219 $dm = sqimap_get_delimiter ($imap_stream);
220
8e9e8afa 221 /** LSUB array **/
44a3ca20 222 fputs ($imap_stream, "a001 LSUB \"$folder_prefix\" \"*\"\r\n");
8e9e8afa 223 $lsub_ary = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
44a3ca20 224
225 // Section about removing the last element was removed
226 // We don't return "* OK" anymore from sqimap_read_data
6477eb2d 227
44a3ca20 228 $sorted_lsub_ary = array();
8e9e8afa 229 for ($i=0;$i < count($lsub_ary); $i++) {
44a3ca20 230 // Workaround for EIMS
231 // Doesn't work if the mailbox name is multiple lines
232 if (isset($lsub_ary[$i + 1]) &&
233 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
234 $lsub_ary[$i], $regs)) {
235 $i ++;
236 $lsub_ary[$i] = $regs[1] . '"' . addslashes(trim($lsub_ary[$i])) .
237 '"' . $regs[2];
238 }
239 $temp_mailbox_name = find_mailbox_name($lsub_ary[$i]);
240 $sorted_lsub_ary[] = $temp_mailbox_name;
241 if (strtoupper($temp_mailbox_name) == 'INBOX')
8e9e8afa 242 $inbox_subscribed = true;
243 }
ee62ce13 244 $new_ary = array();
245 for ($i=0; $i < count($sorted_lsub_ary); $i++) {
246 if (!in_array($sorted_lsub_ary[$i], $new_ary)) {
247 $new_ary[] = $sorted_lsub_ary[$i];
248 }
249 }
250 $sorted_lsub_ary = $new_ary;
8e9e8afa 251 if (isset($sorted_lsub_ary)) {
44a3ca20 252 usort($sorted_lsub_ary, 'user_strcasecmp');
10359c65 253 //sort($sorted_lsub_ary);
8e9e8afa 254 }
255
3cb866d7 256 /** LIST array **/
44a3ca20 257 $sorted_list_ary = array();
f9b3e5d9 258 for ($i=0; $i < count($sorted_lsub_ary); $i++) {
259 if (substr($sorted_lsub_ary[$i], -1) == $dm)
260 $mbx = substr($sorted_lsub_ary[$i], 0, strlen($sorted_lsub_ary[$i])-1);
261 else
262 $mbx = $sorted_lsub_ary[$i];
263
264 fputs ($imap_stream, "a001 LIST \"\" \"$mbx\"\r\n");
265 $read = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
44a3ca20 266 // Another workaround for EIMS
267 if (isset($read[1]) &&
268 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
269 $read[0], $regs)) {
270 $read[0] = $regs[1] . '"' . addslashes(trim($read[1])) .
271 '"' . $regs[2];
272 }
a7ea7540 273 if (isset($sorted_list_ary[$i]))
274 $sorted_list_ary[$i] = "";
275 if (isset($read[0]))
44a3ca20 276 $sorted_list_ary[$i] = $read[0];
a7ea7540 277 else
44a3ca20 278 $sorted_list_ary[$i] = "";
279 if (isset($sorted_list_ary[$i]) &&
280 strtoupper(find_mailbox_name($sorted_list_ary[$i])) == "INBOX")
3cb866d7 281 $inbox_in_list = true;
f9b3e5d9 282 }
2752bb16 283
44a3ca20 284 /** Just in case they're not subscribed to their inbox, we'll get it
285 for them anyway **/
8e9e8afa 286 if ($inbox_subscribed == false || $inbox_in_list == false) {
287 fputs ($imap_stream, "a001 LIST \"\" \"INBOX\"\r\n");
288 $inbox_ary = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
44a3ca20 289 // Another workaround for EIMS
290 if (isset($inbox_ary[1]) &&
291 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
292 $inbox_ary[0], $regs)) {
293 $inbox_ary[0] = $regs[1] . '"' . addslashes(trim($inbox_ary[1])) .
294 '"' . $regs[2];
295 }
296
297 $sorted_list_ary[] = $inbox_ary[0];
298 $sorted_lsub_ary[] = find_mailbox_name($inbox_ary[0]);
8e9e8afa 299 }
300
f9b3e5d9 301 $boxes = sqimap_mailbox_parse ($sorted_list_ary, $sorted_lsub_ary, $dm);
302
5bdd7223 303
f9b3e5d9 304 /** Now, lets sort for special folders **/
5bdd7223 305
306 $boxesnew = Array();
307
308 // Find INBOX
8e9e8afa 309 for ($i = 0; $i < count($boxes); $i++) {
1e0628fb 310 if (strtolower($boxes[$i]["unformatted"]) == "inbox") {
5bdd7223 311 $boxesnew[] = $boxes[$i];
283db905 312 $used[$i] = true;
2752bb16 313 $i = count($boxes);
8e9e8afa 314 }
315 }
aed206bf 316
8e9e8afa 317 if ($list_special_folders_first == true) {
5bdd7223 318
2752bb16 319 // Then list special folders and their subfolders
245a6892 320 for ($i = 0 ; $i < count($boxes) ; $i++) {
23ed73eb 321 if ($move_to_trash &&
146e0c45 322 eregi('^' . quotemeta($trash_folder) . '(' .
323 quotemeta($dm) . '.*)?$', $boxes[$i]["unformatted"])) {
5bdd7223 324 $boxesnew[] = $boxes[$i];
283db905 325 $used[$i] = true;
1e0628fb 326 }
23ed73eb 327 elseif ($move_to_sent &&
146e0c45 328 eregi('^' . quotemeta($sent_folder) . '(' .
329 quotemeta($dm) . '.*)?$', $boxes[$i]["unformatted"])) {
5bdd7223 330 $boxesnew[] = $boxes[$i];
283db905 331 $used[$i] = true;
8e9e8afa 332 }
333 }
5bdd7223 334
2752bb16 335 // Put INBOX.* folders ahead of the rest
245a6892 336 for ($i = 0; $i < count($boxes); $i++) {
146e0c45 337 if (eregi('^inbox\\.', $boxes[$i]["unformatted"]) &&
283db905 338 (!isset($used[$i]) || $used[$i] == false)) {
2752bb16 339 $boxesnew[] = $boxes[$i];
283db905 340 $used[$i] = true;
2752bb16 341 }
342 }
5bdd7223 343
8e9e8afa 344 }
c5eb2c03 345
5bdd7223 346 // Rest of the folders
8e9e8afa 347 for ($i = 0; $i < count($boxes); $i++) {
1e0628fb 348 if ((strtolower($boxes[$i]["unformatted"]) != "inbox") &&
283db905 349 (!isset($used[$i]) || $used[$i] == false)) {
5bdd7223 350 $boxesnew[] = $boxes[$i];
283db905 351 $used[$i] = true;
8e9e8afa 352 }
353 }
354
355 return $boxesnew;
356 }
8e9e8afa 357
358 /******************************************************************************
359 ** Returns a list of all folders, subscribed or not
360 ******************************************************************************/
361 function sqimap_mailbox_list_all ($imap_stream) {
1e0628fb 362 global $list_special_folders_first, $folder_prefix;
8e9e8afa 363
38dc768c 364 if (!function_exists ("ary_sort"))
365 include_once('../functions/array.php');
366
8e9e8afa 367 $dm = sqimap_get_delimiter ($imap_stream);
368
369 fputs ($imap_stream, "a001 LIST \"$folder_prefix\" *\r\n");
370 $read_ary = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
371 $g = 0;
372 $phase = "inbox";
5bdd7223 373
8e9e8afa 374 for ($i = 0; $i < count($read_ary); $i++) {
44a3ca20 375 // Another workaround for EIMS
376 if (isset($read_ary[$i + 1]) &&
377 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
378 $read_ary[$i], $regs)) {
379 $i ++;
380 $read_ary[$i] = $regs[1] . '"' .
381 addslashes(trim($read_ary[$i])) .
382 '"' . $regs[2];
383 }
8e9e8afa 384 if (substr ($read_ary[$i], 0, 4) != "a001") {
5bdd7223 385
2752bb16 386 // Store the raw IMAP reply
8e9e8afa 387 $boxes[$g]["raw"] = $read_ary[$i];
388
2752bb16 389 // Count number of delimiters ($dm) in folder name
8e9e8afa 390 $mailbox = find_mailbox_name($read_ary[$i]);
391 $dm_count = countCharInString($mailbox, $dm);
392 if (substr($mailbox, -1) == $dm)
5bdd7223 393 $dm_count--; // If name ends in delimiter - decrement count by one
2752bb16 394
395 // Format folder name, but only if it's a INBOX.* or have
396 // a parent.
397 $boxesbyname[$mailbox] = $g;
398 $parentfolder = readMailboxParent($mailbox, $dm);
146e0c45 399 if((eregi('^inbox'.quotemeta($dm), $mailbox)) ||
400 (ereg('^'.$folder_prefix, $mailbox)) ||
2752bb16 401 ( isset($boxesbyname[$parentfolder]) && (strlen($parentfolder) > 0) ) ) {
0debfed6 402 if ($dm_count)
403 $boxes[$g]["formatted"] = str_repeat("&nbsp;&nbsp;", $dm_count);
404 else
405 $boxes[$g]["formatted"] = '';
2752bb16 406 $boxes[$g]["formatted"] .= readShortMailboxName($mailbox, $dm);
407 } else {
408 $boxes[$g]["formatted"] = $mailbox;
409 }
8e9e8afa 410
411 $boxes[$g]["unformatted-dm"] = $mailbox;
412 if (substr($mailbox, -1) == $dm)
413 $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
414 $boxes[$g]["unformatted"] = $mailbox;
146e0c45 415 $boxes[$g]["unformatted-disp"] = ereg_replace('^' . $folder_prefix, '', $mailbox);
8e9e8afa 416 $boxes[$g]["id"] = $g;
417
418 /** Now lets get the flags for this mailbox **/
419 fputs ($imap_stream, "a002 LIST \"\" \"$mailbox\"\r\n");
420 $read_mlbx = sqimap_read_data ($imap_stream, "a002", true, $response, $message);
44a3ca20 421 // Another workaround for EIMS
422 if (isset($read_mlbx[1]) &&
423 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
424 $read_mlbx[0], $regs)) {
425 $read_mlbx[0] = $regs[1] . '"' .
426 addslashes(trim($read_mlbx[1])) .
427 '"' . $regs[2];
428 }
8e9e8afa 429
430 $flags = substr($read_mlbx[0], strpos($read_mlbx[0], "(")+1);
431 $flags = substr($flags, 0, strpos($flags, ")"));
146e0c45 432 $flags = str_replace('\\', '', $flags);
8e9e8afa 433 $flags = trim(strtolower($flags));
434 if ($flags) {
4afa7206 435 $boxes[$g]['flags'] = explode(" ", $flags);
8e9e8afa 436 }
12d61439 437 else
438 {
439 $boxes[$g]['flags'] = array();
440 }
8e9e8afa 441 }
442 $g++;
443 }
5bdd7223 444 if(is_array($boxes)) {
591000ec 445 $boxes = ary_sort ($boxes, "unformatted", 1);
446 }
5bdd7223 447
8e9e8afa 448 return $boxes;
449 }
450
0fc2aca0 451?>