fixed bug in quotemeta() patch (was applied to the wrong variable) :)
[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
6 **/
7
8 /******************************************************************************
9 ** Expunges a mailbox
10 ******************************************************************************/
a7f3c40d 11 function sqimap_mailbox_expunge ($imap_stream, $mailbox,$handle_errors = true) {
8e9e8afa 12 sqimap_mailbox_select ($imap_stream, $mailbox);
13 fputs ($imap_stream, "a001 EXPUNGE\r\n");
8cf653ad 14 $read = sqimap_read_data($imap_stream, "a001", $handle_errors, $response, $message);
a2790a61 15 sqimap_mailbox_close ($imap_stream);
8e9e8afa 16 }
17
18
19 /******************************************************************************
20 ** Checks whether or not the specified mailbox exists
21 ******************************************************************************/
22 function sqimap_mailbox_exists ($imap_stream, $mailbox) {
26511b3e 23 fputs ($imap_stream, "a001 LIST \"\" \"$mailbox\"\r\n");
24 $mbx = sqimap_read_data($imap_stream, "a001", true, $response, $message);
44f642f5 25 if ($mailbox) {
f9b3e5d9 26 return !!(ereg ("$mailbox", $mbx[0])); // To force into true/false
8e9e8afa 27 }
8e9e8afa 28 }
29
a2790a61 30 /******************************************************************************
31 ** Closes an open mailbox
32 ******************************************************************************/
33 function sqimap_mailbox_close ($imap_stream) {
34 fputs ($imap_stream, "a001 CLOSE\r\n");
c95df380 35 $tmp = sqimap_read_data($imap_stream, "a001", false, $response, $message);
a2790a61 36 }
8e9e8afa 37
8e9e8afa 38 /******************************************************************************
39 ** Selects a mailbox
40 ******************************************************************************/
04632dbc 41 function sqimap_mailbox_select ($imap_stream, $mailbox, $hide=true, $recent=false) {
3751dc7f 42 global $auto_expunge;
43
8e9e8afa 44 fputs ($imap_stream, "a001 SELECT \"$mailbox\"\r\n");
c5eb2c03 45 $read = sqimap_read_data($imap_stream, "a001", true, $response, $message);
04632dbc 46 if ($recent) {
47 for ($i=0; $i<count($read); $i++) {
48 if (strpos(strtolower($read[$i]), "recent")) {
49 $r = explode(" ", $read[$i]);
50 }
51 }
52 return $r[1];
53 }
3751dc7f 54 if ($auto_expunge) {
55 fputs ($imap_stream, "a001 EXPUNGE\r\n");
8cf653ad 56 $tmp = sqimap_read_data($imap_stream, "a001", false, $a, $b);
3751dc7f 57 }
8e9e8afa 58 }
59
60
61
62 /******************************************************************************
63 ** Creates a folder
64 ******************************************************************************/
65 function sqimap_mailbox_create ($imap_stream, $mailbox, $type) {
66 if (strtolower($type) == "noselect") {
67 $dm = sqimap_get_delimiter($imap_stream);
68 $mailbox = $mailbox.$dm;
69 }
70 fputs ($imap_stream, "a001 CREATE \"$mailbox\"\r\n");
71 $read_ary = sqimap_read_data($imap_stream, "a001", true, $response, $message);
72
73 sqimap_subscribe ($imap_stream, $mailbox);
74 }
75
76
77
78 /******************************************************************************
79 ** Subscribes to an existing folder
80 ******************************************************************************/
81 function sqimap_subscribe ($imap_stream, $mailbox) {
82 fputs ($imap_stream, "a001 SUBSCRIBE \"$mailbox\"\r\n");
83 $read_ary = sqimap_read_data($imap_stream, "a001", true, $response, $message);
84 }
85
86
87
88
89 /******************************************************************************
90 ** Unsubscribes to an existing folder
91 ******************************************************************************/
92 function sqimap_unsubscribe ($imap_stream, $mailbox) {
cbdc5621 93 global $imap_server_type;
94
8e9e8afa 95 fputs ($imap_stream, "a001 UNSUBSCRIBE \"$mailbox\"\r\n");
96 $read_ary = sqimap_read_data($imap_stream, "a001", true, $response, $message);
97 }
98
99
100
101
102 /******************************************************************************
103 ** This function simply deletes the given folder
104 ******************************************************************************/
105 function sqimap_mailbox_delete ($imap_stream, $mailbox) {
106 fputs ($imap_stream, "a001 DELETE \"$mailbox\"\r\n");
107 $read_ary = sqimap_read_data($imap_stream, "a001", true, $response, $message);
108 sqimap_unsubscribe ($imap_stream, $mailbox);
109 }
110
111
112 /******************************************************************************
113 ** Formats a mailbox into 4 parts for the $boxes array
5bdd7223 114 **
115 ** The four parts are:
116 **
117 ** raw - Raw LIST/LSUB response from the IMAP server
118 ** formatted - nicely formatted folder name
119 ** unformatted - unformatted, but with delimiter at end removed
120 ** unformatted-dm - folder name as it appears in raw response
121 **
8e9e8afa 122 ******************************************************************************/
16530f8b 123 function sqimap_mailbox_parse ($line, $line_lsub, $dm) {
5bdd7223 124 global $folder_prefix;
125
126 // Process each folder line
8e9e8afa 127 for ($g=0; $g < count($line); $g++) {
5bdd7223 128
129 // Store the raw IMAP reply
8e9e8afa 130 $boxes[$g]["raw"] = $line[$g];
5bdd7223 131
132 // Count number of delimiters ($dm) in folder name
6477eb2d 133 $mailbox = trim($line_lsub[$g]);
8e9e8afa 134 $dm_count = countCharInString($mailbox, $dm);
135 if (substr($mailbox, -1) == $dm)
5bdd7223 136 $dm_count--; // If name ends in delimiter - decrement count by one
137
138 // Format folder name, but only if it's a INBOX.* or have
139 // a parent.
140 $boxesbyname[$mailbox] = $g;
141 $parentfolder = readMailboxParent($mailbox, $dm);
142 if((eregi("^inbox".quotemeta($dm), $mailbox)) ||
143 ( isset($boxesbyname[$parentfolder]) && (strlen($parentfolder) > 0) ) ) {
144 $indent = $dm_count - (countCharInString($folder_prefix, $dm));
145 $boxes[$g]["formatted"] = str_repeat("&nbsp;&nbsp;", $indent);
146 $boxes[$g]["formatted"] .= readShortMailboxName($mailbox, $dm);
147 } else {
148 $boxes[$g]["formatted"] = $mailbox;
149 }
8e9e8afa 150
151 $boxes[$g]["unformatted-dm"] = $mailbox;
152 if (substr($mailbox, -1) == $dm)
153 $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
154 $boxes[$g]["unformatted"] = $mailbox;
155 $boxes[$g]["id"] = $g;
156
f9b3e5d9 157 ereg("\(([^)]*)\)",$line[$g],$regs);
158 $flags = trim(strtolower(str_replace("\\", "",$regs[1])));
8e9e8afa 159 if ($flags) {
160 $boxes[$g]["flags"] = explode(" ", $flags);
161 }
8e9e8afa 162 }
5bdd7223 163
8e9e8afa 164 return $boxes;
165 }
10359c65 166
5bdd7223 167 /* patch from dave_michmerhuizen@yahoo.com
168 * allows case insensativity when sorting folders
169 */
170 function _icmp ($a, $b) {
171 return strcasecmp($a, $b);
172 }
8e9e8afa 173
174 /******************************************************************************
175 ** Returns sorted mailbox lists in several different ways.
5bdd7223 176 ** See comment on sqimap_mailbox_parse() for info about the returned array.
8e9e8afa 177 ******************************************************************************/
178 function sqimap_mailbox_list ($imap_stream) {
5bdd7223 179 global $load_prefs_php, $prefs_php, $config_php;
180 global $data_dir, $username, $list_special_folders_first;
6477eb2d 181 global $trash_folder, $sent_folder;
f9b3e5d9 182 global $move_to_trash, $move_to_sent;
8e9e8afa 183
1590a668 184 $inbox_in_list = false;
185 $inbox_subscribed = false;
186
8e9e8afa 187 if (!isset($load_prefs_php)) include "../src/load_prefs.php";
188 else global $folder_prefix;
189 if (!function_exists ("ary_sort")) include "../functions/array.php";
190
191 $dm = sqimap_get_delimiter ($imap_stream);
192
8e9e8afa 193 /** LSUB array **/
194 $inbox_subscribed = false;
6477eb2d 195 fputs ($imap_stream, "a001 LSUB \"\" \"*\"\r\n");
8e9e8afa 196 $lsub_ary = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
6477eb2d 197
8e9e8afa 198 for ($i=0;$i < count($lsub_ary); $i++) {
199 $sorted_lsub_ary[$i] = find_mailbox_name($lsub_ary[$i]);
8e9e8afa 200 if ($sorted_lsub_ary[$i] == "INBOX")
201 $inbox_subscribed = true;
202 }
ee62ce13 203 $new_ary = array();
204 for ($i=0; $i < count($sorted_lsub_ary); $i++) {
205 if (!in_array($sorted_lsub_ary[$i], $new_ary)) {
206 $new_ary[] = $sorted_lsub_ary[$i];
207 }
208 }
209 $sorted_lsub_ary = $new_ary;
8e9e8afa 210 if (isset($sorted_lsub_ary)) {
5bdd7223 211 usort($sorted_lsub_ary, "_icmp");
10359c65 212 //sort($sorted_lsub_ary);
8e9e8afa 213 }
214
3cb866d7 215 /** LIST array **/
f9b3e5d9 216 for ($i=0; $i < count($sorted_lsub_ary); $i++) {
217 if (substr($sorted_lsub_ary[$i], -1) == $dm)
218 $mbx = substr($sorted_lsub_ary[$i], 0, strlen($sorted_lsub_ary[$i])-1);
219 else
220 $mbx = $sorted_lsub_ary[$i];
221
222 fputs ($imap_stream, "a001 LIST \"\" \"$mbx\"\r\n");
223 $read = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
224 $sorted_list_ary[$i] = $read[0];
3cb866d7 225 if (find_mailbox_name($sorted_list_ary[$i]) == "INBOX")
226 $inbox_in_list = true;
f9b3e5d9 227 }
3cb866d7 228
8e9e8afa 229 /** Just in case they're not subscribed to their inbox, we'll get it for them anyway **/
230 if ($inbox_subscribed == false || $inbox_in_list == false) {
231 fputs ($imap_stream, "a001 LIST \"\" \"INBOX\"\r\n");
232 $inbox_ary = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
591000ec 233
234 $pos = count($sorted_list_ary);
235 $sorted_list_ary[$pos] = $inbox_ary[0];
236
237 $pos = count($sorted_lsub_ary);
238 $sorted_lsub_ary[$pos] = find_mailbox_name($inbox_ary[0]);
8e9e8afa 239 }
240
f9b3e5d9 241 $boxes = sqimap_mailbox_parse ($sorted_list_ary, $sorted_lsub_ary, $dm);
242
5bdd7223 243
f9b3e5d9 244 /** Now, lets sort for special folders **/
5bdd7223 245
246 $boxesnew = Array();
247
248 // Find INBOX
8e9e8afa 249 for ($i = 0; $i < count($boxes); $i++) {
1e0628fb 250 if (strtolower($boxes[$i]["unformatted"]) == "inbox") {
5bdd7223 251 $boxesnew[] = $boxes[$i];
8e9e8afa 252 $boxes[$i]["used"] = true;
5bdd7223 253 $i = count($boxes);
8e9e8afa 254 }
255 }
aed206bf 256
8e9e8afa 257 if ($list_special_folders_first == true) {
5bdd7223 258
259 // Then list special folders and their subfolders
260 for ($i = 0 ; $i <= count($boxes) ; $i++) {
261 if((eregi("^".$trash_folder.'$', $boxes[$i]["unformatted"]) ||
262 eregi("^".$trash_folder.quotemeta($dm), $boxes[$i]["unformatted"]) ) &&
263 ($move_to_trash)) {
264 $boxesnew[] = $boxes[$i];
1e0628fb 265 $boxes[$i]["used"] = true;
266 }
5bdd7223 267 else if((eregi("^".$sent_folder.'$', $boxes[$i]["unformatted"]) ||
268 eregi("^".$sent_folder.quotemeta($dm), $boxes[$i]["unformatted"]) ) &&
269 ($move_to_sent)) {
270 $boxesnew[] = $boxes[$i];
1e0628fb 271 $boxes[$i]["used"] = true;
8e9e8afa 272 }
273 }
5bdd7223 274
275 // Put INBOX.* folders ahead of the rest
276 for ($i = 0; $i <= count($boxes); $i++) {
277 if (eregi("^inbox\.", $boxes[$i]["unformatted"]) &&
278 ($boxes[$i]["used"] == false)) {
279 $boxesnew[] = $boxes[$i];
280 $boxes[$i]["used"] = true;
281 }
282 }
283
8e9e8afa 284 }
c5eb2c03 285
5bdd7223 286 // Rest of the folders
8e9e8afa 287 for ($i = 0; $i < count($boxes); $i++) {
1e0628fb 288 if ((strtolower($boxes[$i]["unformatted"]) != "inbox") &&
8e9e8afa 289 ($boxes[$i]["used"] == false)) {
5bdd7223 290 $boxesnew[] = $boxes[$i];
8e9e8afa 291 $boxes[$i]["used"] = true;
292 }
293 }
294
295 return $boxesnew;
296 }
8e9e8afa 297
298 /******************************************************************************
299 ** Returns a list of all folders, subscribed or not
300 ******************************************************************************/
301 function sqimap_mailbox_list_all ($imap_stream) {
1e0628fb 302 global $list_special_folders_first, $folder_prefix;
8e9e8afa 303
304 if (!function_exists ("ary_sort"))
305 include ("../functions/array.php");
306
307 $dm = sqimap_get_delimiter ($imap_stream);
308
309 fputs ($imap_stream, "a001 LIST \"$folder_prefix\" *\r\n");
310 $read_ary = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
311 $g = 0;
312 $phase = "inbox";
5bdd7223 313
8e9e8afa 314 for ($i = 0; $i < count($read_ary); $i++) {
315 if (substr ($read_ary[$i], 0, 4) != "a001") {
5bdd7223 316
317 // Store the raw IMAP reply
8e9e8afa 318 $boxes[$g]["raw"] = $read_ary[$i];
319
5bdd7223 320 // Count number of delimiters ($dm) in folder name
8e9e8afa 321 $mailbox = find_mailbox_name($read_ary[$i]);
322 $dm_count = countCharInString($mailbox, $dm);
323 if (substr($mailbox, -1) == $dm)
5bdd7223 324 $dm_count--; // If name ends in delimiter - decrement count by one
325
326 // Format folder name, but only if it's a INBOX.* or have
327 // a parent.
328 $boxesbyname[$mailbox] = $g;
329 $parentfolder = readMailboxParent($mailbox, $dm);
330 if((eregi("^inbox".quotemeta($dm), $mailbox)) ||
331 ( isset($boxesbyname[$parentfolder]) && (strlen($parentfolder) > 0) ) ) {
332 $boxes[$g]["formatted"] = str_repeat("&nbsp;&nbsp;", $dm_count);
333 $boxes[$g]["formatted"] .= readShortMailboxName($mailbox, $dm);
334 } else {
335 $boxes[$g]["formatted"] = $mailbox;
336 }
8e9e8afa 337
338 $boxes[$g]["unformatted-dm"] = $mailbox;
339 if (substr($mailbox, -1) == $dm)
340 $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
341 $boxes[$g]["unformatted"] = $mailbox;
342 $boxes[$g]["id"] = $g;
343
344 /** Now lets get the flags for this mailbox **/
345 fputs ($imap_stream, "a002 LIST \"\" \"$mailbox\"\r\n");
346 $read_mlbx = sqimap_read_data ($imap_stream, "a002", true, $response, $message);
347
348 $flags = substr($read_mlbx[0], strpos($read_mlbx[0], "(")+1);
349 $flags = substr($flags, 0, strpos($flags, ")"));
350 $flags = str_replace("\\", "", $flags);
351 $flags = trim(strtolower($flags));
352 if ($flags) {
353 $boxes[$g]["flags"] = explode(" ", $flags);
354 }
355 }
356 $g++;
357 }
5bdd7223 358 if(is_array($boxes)) {
591000ec 359 $boxes = ary_sort ($boxes, "unformatted", 1);
360 }
5bdd7223 361
8e9e8afa 362 return $boxes;
363 }
364
052e0c26 365?>