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