59177427 |
1 | <?php |
62f7daa5 |
2 | |
35586184 |
3 | /** |
4 | * imap_mailbox.php |
5 | * |
6c84ba1e |
6 | * Copyright (c) 1999-2005 The SquirrelMail Project Team |
35586184 |
7 | * Licensed under the GNU GPL. For full terms see the file COPYING. |
8 | * |
4b2720f5 |
9 | * This implements all functions that manipulate mailboxes |
35586184 |
10 | * |
eb19bc67 |
11 | * @version $Id$ |
d6c32258 |
12 | * @package squirrelmail |
eb19bc67 |
13 | * @subpackage imap |
35586184 |
14 | */ |
d6c32258 |
15 | |
4b2720f5 |
16 | /** @ignore */ |
17 | if (! defined('SM_PATH')) define('SM_PATH','../'); |
18 | |
d6c32258 |
19 | /** UTF7 support */ |
334a77f8 |
20 | require_once(SM_PATH . 'functions/imap_utf7_local.php'); |
21 | |
3411d4ec |
22 | global $boxesnew; |
1da22cda |
23 | |
d6c32258 |
24 | /** |
25 | * Mailboxes class |
4669e892 |
26 | * |
27 | * FIXME. This class should be extracted and placed in a separate file that |
d6c32258 |
28 | * can be included before we start the session. That makes caching of the tree |
4669e892 |
29 | * possible. On a refresh mailboxes from left_main.php the only function that |
30 | * should be called is the sqimap_get_status_mbx_tree. In case of subscribe |
31 | * / rename / delete / new we have to create methods for adding/changing the |
d6c32258 |
32 | * mailbox in the mbx_tree without the need for a refresh. |
4b2720f5 |
33 | * |
34 | * Some code fragments are present in 1.3.0 - 1.4.4. |
d6c32258 |
35 | * @package squirrelmail |
dc027257 |
36 | * @subpackage imap |
4b2720f5 |
37 | * @since 1.5.0 |
dc027257 |
38 | */ |
60b5724d |
39 | class mailboxes { |
86c2763d |
40 | var $mailboxname_full = '', $mailboxname_sub= '', $is_noselect = false, $is_noinferiors = false, |
ff245fbd |
41 | $is_special = false, $is_root = false, $is_inbox = false, $is_sent = false, |
4669e892 |
42 | $is_trash = false, $is_draft = false, $mbxs = array(), |
ff245fbd |
43 | $unseen = false, $total = false; |
44 | |
45 | function addMbx($mbx, $delimiter, $start, $specialfirst) { |
46 | $ary = explode($delimiter, $mbx->mailboxname_full); |
ae7df16e |
47 | $mbx_parent =& $this; |
ff245fbd |
48 | for ($i = $start, $c = count($ary)-1; $i < $c; $i++) { |
ae7df16e |
49 | $mbx_childs =& $mbx_parent->mbxs; |
ff245fbd |
50 | $found = false; |
51 | if ($mbx_childs) { |
52 | foreach ($mbx_childs as $key => $parent) { |
53 | if ($parent->mailboxname_sub == $ary[$i]) { |
ae7df16e |
54 | $mbx_parent =& $mbx_parent->mbxs[$key]; |
ff245fbd |
55 | $found = true; |
ae7df16e |
56 | break; |
ff245fbd |
57 | } |
58 | } |
59 | } |
60 | if (!$found) { |
61 | $no_select_mbx = new mailboxes(); |
62 | if (isset($mbx_parent->mailboxname_full) && $mbx_parent->mailboxname_full != '') { |
63 | $no_select_mbx->mailboxname_full = $mbx_parent->mailboxname_full.$delimiter.$ary[$i]; |
64 | } else { |
65 | $no_select_mbx->mailboxname_full = $ary[$i]; |
66 | } |
587ec647 |
67 | $no_select_mbx->mailboxname_sub = $ary[$i]; |
ff245fbd |
68 | $no_select_mbx->is_noselect = true; |
69 | $mbx_parent->mbxs[] = $no_select_mbx; |
70 | $i--; |
71 | } |
72 | } |
73 | $mbx_parent->mbxs[] = $mbx; |
74 | if ($mbx->is_special && $specialfirst) { |
75 | usort($mbx_parent->mbxs, 'sortSpecialMbx'); |
76 | } |
77 | } |
60b5724d |
78 | } |
79 | |
dc027257 |
80 | /** |
81 | * array callback used for sorting in mailboxes class |
82 | * @param object $a |
83 | * @param object $b |
3131bc8d |
84 | * @return integer see php strnatcasecmp() |
dc027257 |
85 | * @since 1.3.0 |
86 | */ |
60b5724d |
87 | function sortSpecialMbx($a, $b) { |
88 | if ($a->is_inbox) { |
ff245fbd |
89 | $acmp = '0'. $a->mailboxname_full; |
60b5724d |
90 | } else if ($a->is_special) { |
ff245fbd |
91 | $acmp = '1'. $a->mailboxname_full; |
60b5724d |
92 | } else { |
ff245fbd |
93 | $acmp = '2' . $a->mailboxname_full; |
94 | } |
60b5724d |
95 | if ($b->is_inbox) { |
ff245fbd |
96 | $bcmp = '0'. $b->mailboxname_full; |
60b5724d |
97 | }else if ($b->is_special) { |
ff245fbd |
98 | $bcmp = '1' . $b->mailboxname_full; |
60b5724d |
99 | } else { |
ff245fbd |
100 | $bcmp = '2' . $b->mailboxname_full; |
60b5724d |
101 | } |
4669e892 |
102 | return strnatcasecmp($acmp, $bcmp); |
ff245fbd |
103 | } |
60b5724d |
104 | |
dc027257 |
105 | /** |
106 | * @param array $ary |
107 | * @return array |
108 | * @since 1.5.0 |
109 | */ |
110 | function compact_mailboxes_response($ary) { |
86c2763d |
111 | /* |
112 | * Workaround for mailboxes returned as literal |
4669e892 |
113 | * FIXME : Doesn't work if the mailbox name is multiple lines |
86c2763d |
114 | * (larger then fgets buffer) |
115 | */ |
116 | for ($i = 0, $iCnt=count($ary); $i < $iCnt; $i++) { |
117 | if (isset($ary[$i + 1]) && substr($ary[$i], -3) == "}\r\n") { |
118 | if (ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$", |
119 | $ary[$i], $regs)) { |
120 | $ary[$i] = $regs[1] . '"' . addslashes(trim($ary[$i+1])) . '"' . $regs[2]; |
121 | array_splice($ary, $i+1, 2); |
122 | } |
123 | } |
124 | } |
125 | /* remove duplicates and ensure array is contiguous */ |
126 | return array_values(array_unique($ary)); |
127 | } |
128 | |
48af4b64 |
129 | /** |
130 | * Extract the mailbox name from an untagged LIST (7.2.2) or LSUB (7.2.3) answer |
131 | * (LIST|LSUB) (<Flags list>) (NIL|"<separator atom>") <mailbox name string>\r\n |
132 | * mailbox name in quoted string MUST be unquoted and stripslashed (sm API) |
dc027257 |
133 | * |
f8a1ed5a |
134 | * Originally stored in functions/strings.php. Since 1.2.6 stored in |
dc027257 |
135 | * functions/imap_mailbox.php |
136 | * @param string $line imap LIST/LSUB response line |
137 | * @return string mailbox name |
48af4b64 |
138 | */ |
dc027257 |
139 | function find_mailbox_name($line) { |
bac13dd7 |
140 | if (preg_match('/^\* (?:LIST|LSUB) \([^\)]*\) (?:NIL|\"[^\"]*\") ([^\r\n]*)[\r\n]*$/i', $line, $regs)) { |
141 | if (substr($regs[1], 0, 1) == '"') |
142 | return stripslashes(substr($regs[1], 1, -1)); |
143 | return $regs[1]; |
144 | } |
145 | return ''; |
146 | } |
147 | |
48af4b64 |
148 | /** |
dc027257 |
149 | * Detects if mailbox has noselect flag (can't store messages) |
ae9e2adc |
150 | * In versions older than 1.4.5 function checks only LSUB responses |
151 | * and can produce pcre warnings. |
dc027257 |
152 | * @param string $lsub_line mailbox line from untagged LIST or LSUB response |
48af4b64 |
153 | * @return bool whether this is a Noselect mailbox. |
dc027257 |
154 | * @since 1.3.2 |
48af4b64 |
155 | */ |
f73348a3 |
156 | function check_is_noselect ($lsub_line) { |
3698bd49 |
157 | return preg_match("/^\* (LSUB|LIST) \([^\)]*\\\\Noselect[^\)]*\)/i", $lsub_line); |
79e07c7e |
158 | } |
159 | |
48af4b64 |
160 | /** |
dc027257 |
161 | * Detects if mailbox has noinferiors flag (can't store subfolders) |
162 | * @param string $lsub_line mailbox line from untagged LIST or LSUB response |
48af4b64 |
163 | * @return bool whether this is a Noinferiors mailbox. |
dc027257 |
164 | * @since 1.5.0 |
48af4b64 |
165 | */ |
86c2763d |
166 | function check_is_noinferiors ($lsub_line) { |
167 | return preg_match("/^\* (LSUB|LIST) \([^\)]*\\\\Noinferiors[^\)]*\)/i", $lsub_line); |
168 | } |
169 | |
97b1248c |
170 | /** |
d43853c7 |
171 | * Detects mailbox's parent folder |
172 | * |
97b1248c |
173 | * If $haystack is a full mailbox name, and $needle is the mailbox |
174 | * separator character, returns the second last part of the full |
175 | * mailbox name (i.e. the mailbox's parent mailbox) |
d43853c7 |
176 | * |
f8a1ed5a |
177 | * Originally stored in functions/strings.php. Since 1.2.6 stored in |
d43853c7 |
178 | * functions/imap_mailbox.php |
179 | * @param string $haystack full mailbox name |
180 | * @param string $needle delimiter |
f8a1ed5a |
181 | * @return string parent mailbox |
97b1248c |
182 | */ |
183 | function readMailboxParent($haystack, $needle) { |
97b1248c |
184 | if ($needle == '') { |
185 | $ret = ''; |
186 | } else { |
187 | $parts = explode($needle, $haystack); |
188 | $elem = array_pop($parts); |
189 | while ($elem == '' && count($parts)) { |
190 | $elem = array_pop($parts); |
191 | } |
192 | $ret = join($needle, $parts); |
193 | } |
194 | return( $ret ); |
195 | } |
196 | |
4669e892 |
197 | /** |
6a8e7cae |
198 | * Check if $subbox is below the specified $parentbox |
d43853c7 |
199 | * @param string $subbox potential sub folder |
200 | * @param string $parentbox potential parent |
201 | * @return boolean |
202 | * @since 1.2.3 |
6a8e7cae |
203 | */ |
204 | function isBoxBelow( $subbox, $parentbox ) { |
cef054e4 |
205 | global $delimiter; |
4669e892 |
206 | /* |
207 | * Eliminate the obvious mismatch, where the |
6a8e7cae |
208 | * subfolder path is shorter than that of the potential parent |
209 | */ |
210 | if ( strlen($subbox) < strlen($parentbox) ) { |
211 | return false; |
212 | } |
cef054e4 |
213 | /* check for delimiter */ |
c3ce607e |
214 | if (substr($parentbox,-1) != $delimiter) { |
215 | $parentbox .= $delimiter; |
216 | } |
217 | |
218 | return (substr($subbox,0,strlen($parentbox)) == $parentbox); |
1e18bf95 |
219 | } |
220 | |
48af4b64 |
221 | /** |
222 | * Defines special mailboxes: given a mailbox name, it checks if this is a |
223 | * "special" one: INBOX, Trash, Sent or Draft. |
f8a1ed5a |
224 | * |
d43853c7 |
225 | * Since 1.2.5 function includes special_mailbox hook.<br> |
226 | * Since 1.4.3 hook supports more than one plugin. |
227 | * @param string $box mailbox name |
228 | * @return boolean |
229 | * @since 1.2.3 |
48af4b64 |
230 | */ |
1e18bf95 |
231 | function isSpecialMailbox( $box ) { |
90de1755 |
232 | $ret = ( (strtolower($box) == 'inbox') || |
6a8e7cae |
233 | isTrashMailbox($box) || isSentMailbox($box) || isDraftMailbox($box) ); |
90de1755 |
234 | |
2586d588 |
235 | if ( !$ret ) { |
5576644b |
236 | $ret = boolean_hook_function('special_mailbox',$box,1); |
2586d588 |
237 | } |
3411d4ec |
238 | return $ret; |
90de1755 |
239 | } |
240 | |
48af4b64 |
241 | /** |
d43853c7 |
242 | * Detects if mailbox is a Trash folder or subfolder of Trash |
243 | * @param string $box mailbox name |
48af4b64 |
244 | * @return bool whether this is a Trash folder |
d43853c7 |
245 | * @since 1.4.0 |
48af4b64 |
246 | */ |
6a8e7cae |
247 | function isTrashMailbox ($box) { |
248 | global $trash_folder, $move_to_trash; |
249 | return $move_to_trash && $trash_folder && |
250 | ( $box == $trash_folder || isBoxBelow($box, $trash_folder) ); |
251 | } |
252 | |
48af4b64 |
253 | /** |
d43853c7 |
254 | * Detects if mailbox is a Sent folder or subfolder of Sent |
255 | * @param string $box mailbox name |
48af4b64 |
256 | * @return bool whether this is a Sent folder |
d43853c7 |
257 | * @since 1.4.0 |
48af4b64 |
258 | */ |
6a8e7cae |
259 | function isSentMailbox($box) { |
260 | global $sent_folder, $move_to_sent; |
261 | return $move_to_sent && $sent_folder && |
262 | ( $box == $sent_folder || isBoxBelow($box, $sent_folder) ); |
263 | } |
264 | |
48af4b64 |
265 | /** |
d43853c7 |
266 | * Detects if mailbox is a Drafts folder or subfolder of Drafts |
267 | * @param string $box mailbox name |
48af4b64 |
268 | * @return bool whether this is a Draft folder |
d43853c7 |
269 | * @since 1.4.0 |
48af4b64 |
270 | */ |
6a8e7cae |
271 | function isDraftMailbox($box) { |
272 | global $draft_folder, $save_as_draft; |
273 | return $save_as_draft && |
274 | ( $box == $draft_folder || isBoxBelow($box, $draft_folder) ); |
275 | } |
276 | |
48af4b64 |
277 | /** |
d43853c7 |
278 | * Expunges a mailbox |
f8a1ed5a |
279 | * |
d43853c7 |
280 | * WARNING: Select mailbox before calling this function. |
f8a1ed5a |
281 | * |
282 | * permanently removes all messages that have the \Deleted flag |
283 | * set from the selected mailbox. See EXPUNGE command chapter in |
d43853c7 |
284 | * IMAP RFC. |
285 | * @param stream $imap_stream imap connection resource |
286 | * @param string $mailbox mailbox name (unused since 1.1.3). |
287 | * @param boolean $handle_errors error handling control (displays error_box on error). |
288 | * @param mixed $id (since 1.3.0) integer message id or array with integer ids |
289 | * @return integer number of expunged messages |
3131bc8d |
290 | * @since 1.0 or older |
48af4b64 |
291 | */ |
8f6505f6 |
292 | function sqimap_mailbox_expunge ($imap_stream, $mailbox, $handle_errors = true, $id='') { |
06b5c3ff |
293 | if ($id) { |
ff245fbd |
294 | if (is_array($id)) { |
295 | $id = sqimap_message_list_squisher($id); |
296 | } |
297 | $id = ' '.$id; |
9d8d1ebd |
298 | $uid = TRUE; |
06b5c3ff |
299 | } else { |
ff245fbd |
300 | $uid = false; |
8f6505f6 |
301 | } |
06b5c3ff |
302 | $read = sqimap_run_command($imap_stream, 'EXPUNGE'.$id, $handle_errors, |
303 | $response, $message, $uid); |
63240b90 |
304 | $cnt = 0; |
ff245fbd |
305 | |
306 | if (is_array($read)) { |
63240b90 |
307 | foreach ($read as $r) { |
ff245fbd |
308 | if (preg_match('/^\*\s[0-9]+\sEXPUNGE/AUi',$r,$regs)) { |
309 | $cnt++; |
310 | } |
63240b90 |
311 | } |
8f6505f6 |
312 | } |
ff245fbd |
313 | return $cnt; |
43b698c7 |
314 | } |
315 | |
48af4b64 |
316 | /** |
317 | * Checks whether or not the specified mailbox exists |
d43853c7 |
318 | * @param stream $imap_stream imap connection resource |
319 | * @param string $mailbox mailbox name |
320 | * @return boolean |
321 | * @since 1.0 or older |
48af4b64 |
322 | */ |
1da22cda |
323 | function sqimap_mailbox_exists ($imap_stream, $mailbox) { |
247f700e |
324 | if (!isset($mailbox) || empty($mailbox)) { |
43b698c7 |
325 | return false; |
326 | } |
568cb884 |
327 | $mbx = sqimap_run_command($imap_stream, 'LIST "" ' . sqimap_encode_mailbox_name($mailbox), |
3411d4ec |
328 | true, $response, $message); |
43b698c7 |
329 | return isset($mbx[0]); |
330 | } |
331 | |
48af4b64 |
332 | /** |
333 | * Selects a mailbox |
d43853c7 |
334 | * Before 1.3.0 used more arguments and returned data depended on those argumements. |
335 | * @param stream $imap_stream imap connection resource |
336 | * @param string $mailbox mailbox name |
f8a1ed5a |
337 | * @return array results of select command (on success - permanentflags, flags and rights) |
d43853c7 |
338 | * @since 1.0 or older |
48af4b64 |
339 | */ |
e4c6fe41 |
340 | function sqimap_mailbox_select ($imap_stream, $mailbox) { |
ff245fbd |
341 | if ($mailbox == 'None') { |
43b698c7 |
342 | return; |
343 | } |
f69feefe |
344 | |
568cb884 |
345 | $read = sqimap_run_command($imap_stream, 'SELECT ' . sqimap_encode_mailbox_name($mailbox), |
3411d4ec |
346 | true, $response, $message); |
e4c6fe41 |
347 | $result = array(); |
ff245fbd |
348 | for ($i = 0, $cnt = count($read); $i < $cnt; $i++) { |
e4c6fe41 |
349 | if (preg_match('/^\*\s+OK\s\[(\w+)\s(\w+)\]/',$read[$i], $regs)) { |
ff245fbd |
350 | $result[strtoupper($regs[1])] = $regs[2]; |
351 | } else if (preg_match('/^\*\s([0-9]+)\s(\w+)/',$read[$i], $regs)) { |
352 | $result[strtoupper($regs[2])] = $regs[1]; |
353 | } else { |
354 | if (preg_match("/PERMANENTFLAGS(.*)/i",$read[$i], $regs)) { |
355 | $regs[1]=trim(preg_replace ( array ("/\(/","/\)/","/\]/") ,'', $regs[1])) ; |
4669e892 |
356 | $result['PERMANENTFLAGS'] = explode(' ',strtolower($regs[1])); |
ff245fbd |
357 | } else if (preg_match("/FLAGS(.*)/i",$read[$i], $regs)) { |
358 | $regs[1]=trim(preg_replace ( array ("/\(/","/\)/") ,'', $regs[1])) ; |
4669e892 |
359 | $result['FLAGS'] = explode(' ',strtolower($regs[1])); |
ff245fbd |
360 | } |
361 | } |
e4c6fe41 |
362 | } |
4669e892 |
363 | if (!isset($result['PERMANENTFLAGS'])) { |
364 | $result['PERMANENTFLAGS'] = $result['FLAGS']; |
365 | } |
e4c6fe41 |
366 | if (preg_match('/^\[(.+)\]/',$message, $regs)) { |
4669e892 |
367 | $result['RIGHTS']=strtoupper($regs[1]); |
e4c6fe41 |
368 | } |
f69feefe |
369 | |
e4c6fe41 |
370 | return $result; |
43b698c7 |
371 | } |
372 | |
48af4b64 |
373 | /** |
374 | * Creates a folder. |
d43853c7 |
375 | * |
376 | * Mailbox is automatically subscribed. |
f8a1ed5a |
377 | * |
378 | * Set $type to string that does not match 'noselect' (case insensitive), |
379 | * if you don't want to prepend delimiter to mailbox name. Please note |
380 | * that 'noinferiors' might be used someday as keyword for folders |
d43853c7 |
381 | * that store only messages. |
382 | * @param stream $imap_steam imap connection resource |
383 | * @param string $mailbox mailbox name |
384 | * @param string $type folder type. |
385 | * @since 1.0 or older |
48af4b64 |
386 | */ |
3411d4ec |
387 | function sqimap_mailbox_create ($imap_stream, $mailbox, $type) { |
43b698c7 |
388 | global $delimiter; |
389 | if (strtolower($type) == 'noselect') { |
3411d4ec |
390 | $mailbox .= $delimiter; |
43b698c7 |
391 | } |
e429f014 |
392 | |
48af4b64 |
393 | $read_ary = sqimap_run_command($imap_stream, 'CREATE ' . |
394 | sqimap_encode_mailbox_name($mailbox), |
3411d4ec |
395 | true, $response, $message); |
43b698c7 |
396 | sqimap_subscribe ($imap_stream, $mailbox); |
397 | } |
398 | |
48af4b64 |
399 | /** |
400 | * Subscribes to an existing folder. |
d43853c7 |
401 | * @param stream $imap_stream imap connection resource |
402 | * @param string $mailbox mailbox name |
403 | * @param boolean $debug (since 1.5.1) |
404 | * @since 1.0 or older |
48af4b64 |
405 | */ |
852abae7 |
406 | function sqimap_subscribe ($imap_stream, $mailbox,$debug=true) { |
48af4b64 |
407 | $read_ary = sqimap_run_command($imap_stream, 'SUBSCRIBE ' . |
408 | sqimap_encode_mailbox_name($mailbox), |
852abae7 |
409 | $debug, $response, $message); |
43b698c7 |
410 | } |
411 | |
48af4b64 |
412 | /** |
413 | * Unsubscribes from an existing folder |
d43853c7 |
414 | * @param stream $imap_stream imap connection resource |
415 | * @param string $mailbox mailbox name |
416 | * @since 1.0 or older |
48af4b64 |
417 | */ |
3411d4ec |
418 | function sqimap_unsubscribe ($imap_stream, $mailbox) { |
48af4b64 |
419 | $read_ary = sqimap_run_command($imap_stream, 'UNSUBSCRIBE ' . |
420 | sqimap_encode_mailbox_name($mailbox), |
e2e8b92b |
421 | false, $response, $message); |
43b698c7 |
422 | } |
423 | |
48af4b64 |
424 | /** |
425 | * Deletes the given folder |
3131bc8d |
426 | * Since 1.2.6 and 1.3.0 contains rename_or_delete_folder hook |
427 | * @param stream $imap_stream imap connection resource |
428 | * @param string $mailbox mailbox name |
429 | * @since 1.0 or older |
48af4b64 |
430 | */ |
3411d4ec |
431 | function sqimap_mailbox_delete ($imap_stream, $mailbox) { |
78cc4b12 |
432 | global $data_dir, $username; |
e2e8b92b |
433 | sqimap_unsubscribe ($imap_stream, $mailbox); |
c957afd1 |
434 | |
435 | if (sqimap_mailbox_exists($imap_stream, $mailbox)) { |
436 | |
437 | $read_ary = sqimap_run_command($imap_stream, 'DELETE ' . |
438 | sqimap_encode_mailbox_name($mailbox), |
439 | true, $response, $message); |
440 | if ($response !== 'OK') { |
441 | // subscribe again |
442 | sqimap_subscribe ($imap_stream, $mailbox); |
443 | } else { |
444 | do_hook_function('rename_or_delete_folder', $args = array($mailbox, 'delete', '')); |
445 | removePref($data_dir, $username, "thread_$mailbox"); |
446 | removePref($data_dir, $username, "collapse_folder_$mailbox"); |
447 | } |
e2e8b92b |
448 | } |
43b698c7 |
449 | } |
450 | |
48af4b64 |
451 | /** |
452 | * Determines if the user is subscribed to the folder or not |
3131bc8d |
453 | * @param stream $imap_stream imap connection resource |
454 | * @param string $mailbox mailbox name |
455 | * @return boolean |
456 | * @since 1.2.0 |
48af4b64 |
457 | */ |
1da22cda |
458 | function sqimap_mailbox_is_subscribed($imap_stream, $folder) { |
1da22cda |
459 | $boxesall = sqimap_mailbox_list ($imap_stream); |
460 | foreach ($boxesall as $ref) { |
43b698c7 |
461 | if ($ref['unformatted'] == $folder) { |
3411d4ec |
462 | return true; |
43b698c7 |
463 | } |
464 | } |
465 | return false; |
466 | } |
467 | |
48af4b64 |
468 | /** |
469 | * Renames a mailbox. |
3131bc8d |
470 | * Since 1.2.6 and 1.3.0 contains rename_or_delete_folder hook |
471 | * @param stream $imap_stream imap connection resource |
472 | * @param string $old_name mailbox name |
473 | * @param string $new_name new mailbox name |
474 | * @since 1.2.3 |
48af4b64 |
475 | */ |
1c52ba77 |
476 | function sqimap_mailbox_rename( $imap_stream, $old_name, $new_name ) { |
3411d4ec |
477 | if ( $old_name != $new_name ) { |
78cc4b12 |
478 | global $delimiter, $imap_server_type, $data_dir, $username; |
1c52ba77 |
479 | if ( substr( $old_name, -1 ) == $delimiter ) { |
480 | $old_name = substr( $old_name, 0, strlen( $old_name ) - 1 ); |
481 | $new_name = substr( $new_name, 0, strlen( $new_name ) - 1 ); |
482 | $postfix = $delimiter; |
1c52ba77 |
483 | } else { |
484 | $postfix = ''; |
1c52ba77 |
485 | } |
68f2ce7a |
486 | |
5659ad2e |
487 | $boxesall = sqimap_mailbox_list_all($imap_stream); |
48af4b64 |
488 | $cmd = 'RENAME ' . sqimap_encode_mailbox_name($old_name) . |
91e0dccc |
489 | ' ' . sqimap_encode_mailbox_name($new_name); |
3411d4ec |
490 | $data = sqimap_run_command($imap_stream, $cmd, true, $response, $message); |
1c52ba77 |
491 | sqimap_unsubscribe($imap_stream, $old_name.$postfix); |
5659ad2e |
492 | $oldpref_thread = getPref($data_dir, $username, 'thread_'.$old_name.$postfix); |
493 | $oldpref_collapse = getPref($data_dir, $username, 'collapse_folder_'.$old_name.$postfix); |
68f2ce7a |
494 | removePref($data_dir, $username, 'thread_'.$old_name.$postfix); |
5659ad2e |
495 | removePref($data_dir, $username, 'collapse_folder_'.$old_name.$postfix); |
1c52ba77 |
496 | sqimap_subscribe($imap_stream, $new_name.$postfix); |
5659ad2e |
497 | setPref($data_dir, $username, 'thread_'.$new_name.$postfix, $oldpref_thread); |
498 | setPref($data_dir, $username, 'collapse_folder_'.$new_name.$postfix, $oldpref_collapse); |
e429f014 |
499 | do_hook_function('rename_or_delete_folder',$args = array($old_name, 'rename', $new_name)); |
648713af |
500 | $l = strlen( $old_name ) + 1; |
501 | $p = 'unformatted'; |
68f2ce7a |
502 | |
ff245fbd |
503 | foreach ($boxesall as $box) { |
504 | if (substr($box[$p], 0, $l) == $old_name . $delimiter) { |
648713af |
505 | $new_sub = $new_name . $delimiter . substr($box[$p], $l); |
5659ad2e |
506 | /* With Cyrus IMAPd >= 2.0 rename is recursive, so don't check for errors here */ |
648713af |
507 | if ($imap_server_type == 'cyrus') { |
68f2ce7a |
508 | $cmd = 'RENAME "' . $box[$p] . '" "' . $new_sub . '"'; |
5659ad2e |
509 | $data = sqimap_run_command($imap_stream, $cmd, false, |
648713af |
510 | $response, $message); |
1c52ba77 |
511 | } |
5659ad2e |
512 | $was_subscribed = sqimap_mailbox_is_subscribed($imap_stream, $box[$p]); |
513 | if ( $was_subscribed ) { |
514 | sqimap_unsubscribe($imap_stream, $box[$p]); |
515 | } |
516 | $oldpref_thread = getPref($data_dir, $username, 'thread_'.$box[$p]); |
517 | $oldpref_collapse = getPref($data_dir, $username, 'collapse_folder_'.$box[$p]); |
68f2ce7a |
518 | removePref($data_dir, $username, 'thread_'.$box[$p]); |
5659ad2e |
519 | removePref($data_dir, $username, 'collapse_folder_'.$box[$p]); |
520 | if ( $was_subscribed ) { |
521 | sqimap_subscribe($imap_stream, $new_sub); |
522 | } |
523 | setPref($data_dir, $username, 'thread_'.$new_sub, $oldpref_thread); |
524 | setPref($data_dir, $username, 'collapse_folder_'.$new_sub, $oldpref_collapse); |
68f2ce7a |
525 | do_hook_function('rename_or_delete_folder', |
3411d4ec |
526 | $args = array($box[$p], 'rename', $new_sub)); |
1c52ba77 |
527 | } |
528 | } |
1c52ba77 |
529 | } |
1c52ba77 |
530 | } |
43b698c7 |
531 | |
48af4b64 |
532 | /** |
86c2763d |
533 | * Formats a mailbox into parts for the $boxesall array |
3411d4ec |
534 | * |
86c2763d |
535 | * The parts are: |
3131bc8d |
536 | * <ul> |
537 | * <li>raw - Raw LIST/LSUB response from the IMAP server |
538 | * <li>formatted - nicely formatted folder name |
539 | * <li>unformatted - unformatted, but with delimiter at end removed |
540 | * <li>unformatted-dm - folder name as it appears in raw response |
541 | * <li>unformatted-disp - unformatted without $folder_prefix |
542 | * <li>id - TODO: document me |
543 | * <li>flags - TODO: document me |
544 | * </ul> |
545 | * Before 1.2.0 used third argument for delimiter. |
546 | * @param $line |
547 | * @param $line_lsub |
548 | * @return array |
549 | * @since 1.0 or older |
550 | * @todo document id and flags keys in boxes array and function arguments. |
3411d4ec |
551 | */ |
552 | function sqimap_mailbox_parse ($line, $line_lsub) { |
43b698c7 |
553 | global $folder_prefix, $delimiter; |
3411d4ec |
554 | |
43b698c7 |
555 | /* Process each folder line */ |
cef054e4 |
556 | for ($g = 0, $cnt = count($line); $g < $cnt; ++$g) { |
43b698c7 |
557 | /* Store the raw IMAP reply */ |
558 | if (isset($line[$g])) { |
e429f014 |
559 | $boxesall[$g]['raw'] = $line[$g]; |
ff245fbd |
560 | } else { |
e429f014 |
561 | $boxesall[$g]['raw'] = ''; |
43b698c7 |
562 | } |
3411d4ec |
563 | |
43b698c7 |
564 | /* Count number of delimiters ($delimiter) in folder name */ |
86c2763d |
565 | $mailbox = /*trim(*/$line_lsub[$g]/*)*/; |
ff245fbd |
566 | $dm_count = substr_count($mailbox, $delimiter); |
43b698c7 |
567 | if (substr($mailbox, -1) == $delimiter) { |
3411d4ec |
568 | /* If name ends in delimiter, decrement count by one */ |
569 | $dm_count--; |
43b698c7 |
570 | } |
3411d4ec |
571 | |
572 | /* Format folder name, but only if it's a INBOX.* or has a parent. */ |
1da22cda |
573 | $boxesallbyname[$mailbox] = $g; |
43b698c7 |
574 | $parentfolder = readMailboxParent($mailbox, $delimiter); |
575 | if ( (strtolower(substr($mailbox, 0, 5)) == "inbox") || |
576 | (substr($mailbox, 0, strlen($folder_prefix)) == $folder_prefix) || |
ff245fbd |
577 | (isset($boxesallbyname[$parentfolder]) && |
578 | (strlen($parentfolder) > 0) ) ) { |
579 | $indent = $dm_count - (substr_count($folder_prefix, $delimiter)); |
43b698c7 |
580 | if ($indent > 0) { |
ff245fbd |
581 | $boxesall[$g]['formatted'] = str_repeat(' ', $indent); |
582 | } else { |
1da22cda |
583 | $boxesall[$g]['formatted'] = ''; |
43b698c7 |
584 | } |
447b2166 |
585 | $boxesall[$g]['formatted'] .= imap_utf7_decode_local(readShortMailboxName($mailbox, $delimiter)); |
ff245fbd |
586 | } else { |
447b2166 |
587 | $boxesall[$g]['formatted'] = imap_utf7_decode_local($mailbox); |
43b698c7 |
588 | } |
90de1755 |
589 | |
1da22cda |
590 | $boxesall[$g]['unformatted-dm'] = $mailbox; |
43b698c7 |
591 | if (substr($mailbox, -1) == $delimiter) { |
8e9e8afa |
592 | $mailbox = substr($mailbox, 0, strlen($mailbox) - 1); |
43b698c7 |
593 | } |
1da22cda |
594 | $boxesall[$g]['unformatted'] = $mailbox; |
43b698c7 |
595 | if (substr($mailbox,0,strlen($folder_prefix))==$folder_prefix) { |
631b9da3 |
596 | $mailbox = substr($mailbox, strlen($folder_prefix)); |
43b698c7 |
597 | } |
1da22cda |
598 | $boxesall[$g]['unformatted-disp'] = $mailbox; |
599 | $boxesall[$g]['id'] = $g; |
90de1755 |
600 | |
1da22cda |
601 | $boxesall[$g]['flags'] = array(); |
43b698c7 |
602 | if (isset($line[$g])) { |
36dfb0c9 |
603 | ereg("\(([^)]*)\)",$line[$g],$regs); |
4669e892 |
604 | // FIXME Flags do contain the \ character. \NoSelect \NoInferiors |
5c300c60 |
605 | // and $MDNSent <= last one doesn't have the \ |
606 | // It's better to follow RFC3501 instead of using our own naming. |
1a7e1e97 |
607 | $flags = trim(strtolower(str_replace('\\', '',$regs[1]))); |
43b698c7 |
608 | if ($flags) { |
1da22cda |
609 | $boxesall[$g]['flags'] = explode(' ', $flags); |
43b698c7 |
610 | } |
611 | } |
612 | } |
1da22cda |
613 | return $boxesall; |
43b698c7 |
614 | } |
615 | |
48af4b64 |
616 | /** |
be2d5495 |
617 | * Returns list of options (to be echoed into select statement |
618 | * based on available mailboxes and separators |
6fd95361 |
619 | * Caller should surround options with <select ...> </select> and |
be2d5495 |
620 | * any formatting. |
3131bc8d |
621 | * @param stream $imap_stream imap connection resource to query for mailboxes |
622 | * @param array $show_selected array containing list of mailboxes to pre-select (0 if none) |
623 | * @param array $folder_skip array of folders to keep out of option list (compared in lower) |
624 | * @param $boxes list of already fetched boxes (for places like folder panel, where |
be2d5495 |
625 | * you know these options will be shown 3 times in a row.. (most often unset). |
3131bc8d |
626 | * @param string $flag (since 1.4.1) flag to check for in mailbox flags, used to filter out mailboxes. |
59a8e3e8 |
627 | * 'noselect' by default to remove unselectable mailboxes. |
628 | * 'noinferiors' used to filter out folders that can not contain subfolders. |
629 | * NULL to avoid flag check entirely. |
d0928dd5 |
630 | * NOTE: noselect and noiferiors are used internally. The IMAP representation is |
631 | * \NoSelect and \NoInferiors |
3131bc8d |
632 | * @param boolean $use_long_format (since 1.4.1) override folder display preference and always show full folder name. |
633 | * @return string html formated mailbox selection options |
634 | * @since 1.3.2 |
be2d5495 |
635 | */ |
4669e892 |
636 | function sqimap_mailbox_option_list($imap_stream, $show_selected = 0, $folder_skip = 0, $boxes = 0, |
59a8e3e8 |
637 | $flag = 'noselect', $use_long_format = false ) { |
be2d5495 |
638 | global $username, $data_dir; |
639 | $mbox_options = ''; |
45f836eb |
640 | if ( $use_long_format ) { |
641 | $shorten_box_names = 0; |
642 | } else { |
643 | $shorten_box_names = getPref($data_dir, $username, 'mailbox_select_style', SMPREF_OFF); |
644 | } |
ff245fbd |
645 | |
646 | if ($boxes == 0) { |
be2d5495 |
647 | $boxes = sqimap_mailbox_list($imap_stream); |
ff245fbd |
648 | } |
59a8e3e8 |
649 | |
be2d5495 |
650 | foreach ($boxes as $boxes_part) { |
4df5d823 |
651 | if ($flag == NULL || (is_array($boxes_part['flags']) |
652 | && !in_array($flag, $boxes_part['flags']))) { |
be2d5495 |
653 | $box = $boxes_part['unformatted']; |
be2d5495 |
654 | |
d0928dd5 |
655 | if ($folder_skip != 0 && in_array($box, $folder_skip) ) { |
be2d5495 |
656 | continue; |
657 | } |
4669e892 |
658 | $lowerbox = strtolower($box); |
5c300c60 |
659 | // mailboxes are casesensitive => inbox.sent != inbox.Sent |
660 | // nevermind, to many dependencies this should be fixed! |
4669e892 |
661 | |
d0928dd5 |
662 | if (strtolower($box) == 'inbox') { // inbox is special and not casesensitive |
be2d5495 |
663 | $box2 = _("INBOX"); |
4669e892 |
664 | } else { |
5c300c60 |
665 | switch ($shorten_box_names) |
666 | { |
667 | case 2: /* delimited, style = 2 */ |
c77a0487 |
668 | $box2 = str_replace('&nbsp;&nbsp;', '. ', htmlspecialchars($boxes_part['formatted'])); |
5c300c60 |
669 | break; |
d0928dd5 |
670 | case 1: /* indent, style = 1 */ |
c77a0487 |
671 | $box2 = str_replace('&nbsp;&nbsp;', ' ', htmlspecialchars($boxes_part['formatted'])); |
5c300c60 |
672 | break; |
d0928dd5 |
673 | default: /* default, long names, style = 0 */ |
6c4f0fa1 |
674 | $box2 = str_replace(' ', ' ', htmlspecialchars(imap_utf7_decode_local($boxes_part['unformatted-disp']))); |
5c300c60 |
675 | break; |
676 | } |
be2d5495 |
677 | } |
678 | if ($show_selected != 0 && in_array($lowerbox, $show_selected) ) { |
ff0969a0 |
679 | $mbox_options .= '<option value="' . htmlspecialchars($box) .'" selected="selected">'.$box2.'</option>' . "\n"; |
be2d5495 |
680 | } else { |
ff0969a0 |
681 | $mbox_options .= '<option value="' . htmlspecialchars($box) .'">'.$box2.'</option>' . "\n"; |
be2d5495 |
682 | } |
683 | } |
684 | } |
685 | return $mbox_options; |
686 | } |
43b698c7 |
687 | |
48af4b64 |
688 | /** |
4669e892 |
689 | * Returns sorted mailbox lists in several different ways. |
3411d4ec |
690 | * See comment on sqimap_mailbox_parse() for info about the returned array. |
3e9441a2 |
691 | * @param resource $imap_stream imap connection resource |
692 | * @param boolean $force force update of mailbox listing. available since 1.4.2 and 1.5.0 |
693 | * @return array list of mailboxes |
3131bc8d |
694 | * @since 1.0 or older |
3411d4ec |
695 | */ |
fe6efa94 |
696 | function sqimap_mailbox_list($imap_stream, $force=false) { |
fe6efa94 |
697 | if (!sqgetGlobalVar('boxesnew',$boxesnew,SQ_SESSION) || $force) { |
3411d4ec |
698 | global $data_dir, $username, $list_special_folders_first, |
7e235a1a |
699 | $folder_prefix, $trash_folder, $sent_folder, $draft_folder, |
700 | $move_to_trash, $move_to_sent, $save_as_draft, |
4d5f2b31 |
701 | $delimiter, $noselect_fix_enable, $imap_server_type, |
702 | $show_only_subscribed_folders; |
3411d4ec |
703 | $inbox_subscribed = false; |
60a132f8 |
704 | $listsubscribed = sqimap_capability($imap_stream,'LIST-SUBSCRIBED'); |
7e235a1a |
705 | |
08185f2a |
706 | require_once(SM_PATH . 'include/load_prefs.php'); |
7e235a1a |
707 | |
4d5f2b31 |
708 | if (!$show_only_subscribed_folders) { |
709 | $lsub = 'LIST'; |
710 | } elseif ($listsubscribed) { |
60a132f8 |
711 | $lsub = 'LIST (SUBSCRIBED)'; |
712 | } else { |
713 | $lsub = 'LSUB'; |
4669e892 |
714 | } |
715 | |
ff245fbd |
716 | if ($noselect_fix_enable) { |
60a132f8 |
717 | $lsub_args = "$lsub \"$folder_prefix\" \"*%\""; |
ff245fbd |
718 | } else { |
60a132f8 |
719 | $lsub_args = "$lsub \"$folder_prefix\" \"*\""; |
ff245fbd |
720 | } |
3411d4ec |
721 | /* LSUB array */ |
ca85aabe |
722 | $lsub_ary = sqimap_run_command ($imap_stream, $lsub_args, |
3411d4ec |
723 | true, $response, $message); |
4669e892 |
724 | $lsub_ary = compact_mailboxes_response($lsub_ary); |
7e235a1a |
725 | |
7e235a1a |
726 | $sorted_lsub_ary = array(); |
ff245fbd |
727 | for ($i = 0, $cnt = count($lsub_ary);$i < $cnt; $i++) { |
159d2af7 |
728 | |
7e235a1a |
729 | $temp_mailbox_name = find_mailbox_name($lsub_ary[$i]); |
730 | $sorted_lsub_ary[] = $temp_mailbox_name; |
cef054e4 |
731 | if (!$inbox_subscribed && strtoupper($temp_mailbox_name) == 'INBOX') { |
3411d4ec |
732 | $inbox_subscribed = true; |
7e235a1a |
733 | } |
734 | } |
cef054e4 |
735 | |
5c300c60 |
736 | /* natural sort mailboxes */ |
7e235a1a |
737 | if (isset($sorted_lsub_ary)) { |
159d2af7 |
738 | usort($sorted_lsub_ary, 'strnatcasecmp'); |
7e235a1a |
739 | } |
5c300c60 |
740 | /* |
741 | * The LSUB response doesn't provide us information about \Noselect |
742 | * mail boxes. The LIST response does, that's why we need to do a LIST |
743 | * call to retrieve the flags for the mailbox |
cef054e4 |
744 | * Note: according RFC2060 an imap server may provide \NoSelect flags in the LSUB response. |
745 | * in other words, we cannot rely on it. |
fe6efa94 |
746 | */ |
cef054e4 |
747 | $sorted_list_ary = array(); |
60a132f8 |
748 | // if (!$listsubscribed) { |
749 | for ($i=0; $i < count($sorted_lsub_ary); $i++) { |
7e235a1a |
750 | if (substr($sorted_lsub_ary[$i], -1) == $delimiter) { |
751 | $mbx = substr($sorted_lsub_ary[$i], 0, strlen($sorted_lsub_ary[$i])-1); |
752 | } |
753 | else { |
754 | $mbx = $sorted_lsub_ary[$i]; |
755 | } |
fe6efa94 |
756 | |
159d2af7 |
757 | $read = sqimap_run_command ($imap_stream, 'LIST "" ' . sqimap_encode_mailbox_name($mbx), |
3411d4ec |
758 | true, $response, $message); |
4669e892 |
759 | |
159d2af7 |
760 | $read = compact_mailboxes_response($read); |
4669e892 |
761 | |
7e235a1a |
762 | if (isset($read[0])) { |
763 | $sorted_list_ary[$i] = $read[0]; |
cef054e4 |
764 | } else { |
7e235a1a |
765 | $sorted_list_ary[$i] = ''; |
766 | } |
60a132f8 |
767 | } |
768 | // } |
3411d4ec |
769 | /* |
7e235a1a |
770 | * Just in case they're not subscribed to their inbox, |
771 | * we'll get it for them anyway |
772 | */ |
cef054e4 |
773 | if (!$inbox_subscribed) { |
159d2af7 |
774 | $inbox_ary = sqimap_run_command ($imap_stream, 'LIST "" "INBOX"', |
3411d4ec |
775 | true, $response, $message); |
159d2af7 |
776 | $sorted_list_ary[] = implode('',compact_mailboxes_response($inbox_ary)); |
7e235a1a |
777 | $sorted_lsub_ary[] = find_mailbox_name($inbox_ary[0]); |
778 | } |
779 | |
780 | $boxesall = sqimap_mailbox_parse ($sorted_list_ary, $sorted_lsub_ary); |
781 | |
3411d4ec |
782 | /* Now, lets sort for special folders */ |
7e235a1a |
783 | $boxesnew = $used = array(); |
784 | |
785 | /* Find INBOX */ |
ff245fbd |
786 | $cnt = count($boxesall); |
5c300c60 |
787 | $used = array_pad($used,$cnt,false); |
cef054e4 |
788 | for($k = 0; $k < $cnt; ++$k) { |
ff245fbd |
789 | if (strtolower($boxesall[$k]['unformatted']) == 'inbox') { |
790 | $boxesnew[] = $boxesall[$k]; |
3411d4ec |
791 | $used[$k] = true; |
5c300c60 |
792 | break; |
7e235a1a |
793 | } |
794 | } |
7e235a1a |
795 | /* List special folders and their subfolders, if requested. */ |
3411d4ec |
796 | if ($list_special_folders_first) { |
cef054e4 |
797 | for($k = 0; $k < $cnt; ++$k) { |
ff245fbd |
798 | if (!$used[$k] && isSpecialMailbox($boxesall[$k]['unformatted'])) { |
799 | $boxesnew[] = $boxesall[$k]; |
800 | $used[$k] = true; |
7e235a1a |
801 | } |
5c300c60 |
802 | } |
803 | } |
c3ce607e |
804 | |
805 | /* Find INBOX's children */ |
806 | for($k = 0; $k < $cnt; ++$k) { |
f8a1ed5a |
807 | if (!$used[$k] && isBoxBelow(strtolower($boxesall[$k]['unformatted']), 'inbox') && |
66c1aad9 |
808 | strtolower($boxesall[$k]['unformatted']) != 'inbox') { |
c3ce607e |
809 | $boxesnew[] = $boxesall[$k]; |
810 | $used[$k] = true; |
f8a1ed5a |
811 | } |
c3ce607e |
812 | } |
f8a1ed5a |
813 | |
c3ce607e |
814 | /* Rest of the folders */ |
ff245fbd |
815 | for($k = 0; $k < $cnt; $k++) { |
816 | if (!$used[$k]) { |
817 | $boxesnew[] = $boxesall[$k]; |
7e235a1a |
818 | } |
819 | } |
fe6efa94 |
820 | sqsession_register($boxesnew,'boxesnew'); |
43b698c7 |
821 | } |
3411d4ec |
822 | return $boxesnew; |
43b698c7 |
823 | } |
824 | |
48af4b64 |
825 | /** |
3131bc8d |
826 | * Returns a list of all folders, subscribed or not |
827 | * @param stream $imap_stream imap connection resource |
828 | * @return array see sqimap_mailbox_parse() |
829 | * @since 1.0 or older |
90de1755 |
830 | */ |
1da22cda |
831 | function sqimap_mailbox_list_all($imap_stream) { |
3411d4ec |
832 | global $list_special_folders_first, $folder_prefix, $delimiter; |
bac13dd7 |
833 | |
834 | $read_ary = sqimap_run_command($imap_stream,"LIST \"$folder_prefix\" *",true,$response, $message,false); |
835 | $read_ary = compact_mailboxes_response($read_ary); |
836 | |
43b698c7 |
837 | $g = 0; |
7d82bceb |
838 | $fld_pre_length = strlen($folder_prefix); |
ff245fbd |
839 | for ($i = 0, $cnt = count($read_ary); $i < $cnt; $i++) { |
780dd344 |
840 | /* Store the raw IMAP reply */ |
841 | $boxes[$g]['raw'] = $read_ary[$i]; |
90de1755 |
842 | |
780dd344 |
843 | /* Count number of delimiters ($delimiter) in folder name */ |
844 | $mailbox = find_mailbox_name($read_ary[$i]); |
845 | $dm_count = substr_count($mailbox, $delimiter); |
846 | if (substr($mailbox, -1) == $delimiter) { |
847 | /* If name ends in delimiter - decrement count by one */ |
848 | $dm_count--; |
849 | } |
90de1755 |
850 | |
780dd344 |
851 | /* Format folder name, but only if it's a INBOX.* or has a parent. */ |
852 | $boxesallbyname[$mailbox] = $g; |
853 | $parentfolder = readMailboxParent($mailbox, $delimiter); |
854 | if((eregi('^inbox'.quotemeta($delimiter), $mailbox)) || |
855 | (ereg('^'.$folder_prefix, $mailbox)) || |
856 | ( isset($boxesallbyname[$parentfolder]) && (strlen($parentfolder) > 0) ) ) { |
857 | if ($dm_count) { |
858 | $boxes[$g]['formatted'] = str_repeat(' ', $dm_count); |
90de1755 |
859 | } else { |
780dd344 |
860 | $boxes[$g]['formatted'] = ''; |
12d61439 |
861 | } |
780dd344 |
862 | $boxes[$g]['formatted'] .= imap_utf7_decode_local(readShortMailboxName($mailbox, $delimiter)); |
863 | } else { |
864 | $boxes[$g]['formatted'] = imap_utf7_decode_local($mailbox); |
865 | } |
866 | |
867 | $boxes[$g]['unformatted-dm'] = $mailbox; |
868 | if (substr($mailbox, -1) == $delimiter) { |
869 | $mailbox = substr($mailbox, 0, strlen($mailbox) - 1); |
870 | } |
871 | $boxes[$g]['unformatted'] = $mailbox; |
872 | $boxes[$g]['unformatted-disp'] = substr($mailbox,$fld_pre_length); |
873 | |
874 | $boxes[$g]['id'] = $g; |
875 | |
876 | /* Now lets get the flags for this mailbox */ |
877 | $read_mlbx = $read_ary[$i]; |
878 | $flags = substr($read_mlbx, strpos($read_mlbx, '(')+1); |
879 | $flags = substr($flags, 0, strpos($flags, ')')); |
880 | $flags = str_replace('\\', '', $flags); |
881 | $flags = trim(strtolower($flags)); |
882 | if ($flags) { |
883 | $boxes[$g]['flags'] = explode(' ', $flags); |
884 | } else { |
885 | $boxes[$g]['flags'] = array(); |
43b698c7 |
886 | } |
887 | $g++; |
888 | } |
889 | if(is_array($boxes)) { |
e429f014 |
890 | sort ($boxes); |
43b698c7 |
891 | } |
90de1755 |
892 | |
43b698c7 |
893 | return $boxes; |
894 | } |
5bdd7223 |
895 | |
3131bc8d |
896 | /** |
4b2720f5 |
897 | * Fills mailbox object |
898 | * |
899 | * Some code fragments are present in 1.3.0 - 1.4.4. |
3131bc8d |
900 | * @param stream $imap_stream imap connection resource |
901 | * @return object see mailboxes class. |
4b2720f5 |
902 | * @since 1.5.0 |
3131bc8d |
903 | */ |
60b5724d |
904 | function sqimap_mailbox_tree($imap_stream) { |
4b2720f5 |
905 | global $default_folder_prefix, $data_dir, $username, $list_special_folders_first, |
906 | $folder_prefix, $delimiter, $trash_folder, $move_to_trash, |
907 | $imap_server_type, $show_only_subscribed_folders; |
60b5724d |
908 | |
18ef8f2b |
909 | // TODO: implement mailbox tree caching. maybe store object in session? |
910 | |
4b2720f5 |
911 | $noselect = false; |
912 | $noinferiors = false; |
60b5724d |
913 | |
4b2720f5 |
914 | require_once(SM_PATH . 'include/load_prefs.php'); |
4d5f2b31 |
915 | |
4b2720f5 |
916 | if ($show_only_subscribed_folders) { |
917 | $lsub_cmd = 'LSUB'; |
918 | } else { |
919 | $lsub_cmd = 'LIST'; |
920 | } |
60b5724d |
921 | |
4b2720f5 |
922 | /* LSUB array */ |
923 | $lsub_ary = sqimap_run_command ($imap_stream, "$lsub_cmd \"$folder_prefix\" \"*\"", |
924 | true, $response, $message); |
925 | $lsub_ary = compact_mailboxes_response($lsub_ary); |
926 | |
927 | /* Check to see if we have an INBOX */ |
928 | $has_inbox = false; |
929 | |
930 | for ($i = 0, $cnt = count($lsub_ary); $i < $cnt; $i++) { |
87aa4014 |
931 | if (preg_match("/^\*\s+$lsub_cmd.*\s\"?INBOX\"?\s*$/i",$lsub_ary[$i])) { |
4b2720f5 |
932 | $lsub_ary[$i] = strtoupper($lsub_ary[$i]); |
933 | // in case of an unsubscribed inbox an imap server can |
934 | // return the inbox in the lsub results with a \NoSelect |
935 | // flag. |
936 | if (!preg_match("/\*\s+$lsub_cmd\s+\(.*\\\\NoSelect.*\).*/i",$lsub_ary[$i])) { |
937 | $has_inbox = true; |
938 | } else { |
939 | // remove the result and request it again with a list |
940 | // response at a later stage. |
941 | unset($lsub_ary[$i]); |
942 | // re-index the array otherwise the addition of the LIST |
943 | // response will fail in PHP 4.1.2 and probably other older versions |
944 | $lsub_ary = array_values($lsub_ary); |
78bc908d |
945 | } |
4b2720f5 |
946 | break; |
78bc908d |
947 | } |
4b2720f5 |
948 | } |
78bc908d |
949 | |
4b2720f5 |
950 | if ($has_inbox == false) { |
951 | // do a list request for inbox because we should always show |
952 | // inbox even if the user isn't subscribed to it. |
953 | $inbox_ary = sqimap_run_command ($imap_stream, 'LIST "" "INBOX"', |
954 | true, $response, $message); |
955 | $inbox_ary = compact_mailboxes_response($inbox_ary); |
956 | if (count($inbox_ary)) { |
957 | $lsub_ary[] = $inbox_ary[0]; |
78bc908d |
958 | } |
4b2720f5 |
959 | } |
78bc908d |
960 | |
4b2720f5 |
961 | /* |
962 | * Section about removing the last element was removed |
963 | * We don't return "* OK" anymore from sqimap_read_data |
964 | */ |
bac13dd7 |
965 | |
4b2720f5 |
966 | $sorted_lsub_ary = array(); |
967 | $cnt = count($lsub_ary); |
968 | for ($i = 0; $i < $cnt; $i++) { |
969 | $mbx = find_mailbox_name($lsub_ary[$i]); |
970 | |
971 | // only do the noselect test if !uw, is checked later. FIX ME see conf.pl setting |
972 | if ($imap_server_type != "uw") { |
973 | $noselect = check_is_noselect($lsub_ary[$i]); |
974 | $noinferiors = check_is_noinferiors($lsub_ary[$i]); |
975 | } |
976 | if (substr($mbx, -1) == $delimiter) { |
977 | $mbx = substr($mbx, 0, strlen($mbx) - 1); |
978 | } |
979 | $sorted_lsub_ary[] = array ('mbx' => $mbx, 'noselect' => $noselect, 'noinferiors' => $noinferiors); |
980 | } |
981 | // FIX ME this requires a config setting inside conf.pl instead of checking on server type |
982 | if ($imap_server_type == "uw") { |
983 | $aQuery = array(); |
984 | $aTag = array(); |
985 | // prepare an array with queries |
986 | foreach ($sorted_lsub_ary as $aMbx) { |
987 | $mbx = stripslashes($aMbx['mbx']); |
988 | sqimap_prepare_pipelined_query('LIST "" ' . sqimap_encode_mailbox_name($mbx), $tag, $aQuery, false); |
989 | $aTag[$tag] = $mbx; |
990 | } |
60b5724d |
991 | $sorted_lsub_ary = array(); |
4b2720f5 |
992 | // execute all the queries at once |
993 | $aResponse = sqimap_run_pipelined_command ($imap_stream, $aQuery, false, $aServerResponse, $aServerMessage); |
994 | foreach($aTag as $tag => $mbx) { |
995 | if ($aServerResponse[$tag] == 'OK') { |
996 | $sResponse = implode('', $aResponse[$tag]); |
997 | $noselect = check_is_noselect($sResponse); |
998 | $noinferiors = check_is_noinferiors($sResponse); |
999 | $sorted_lsub_ary[] = array ('mbx' => $mbx, 'noselect' => $noselect, 'noinferiors' => $noinferiors); |
a2e66c6d |
1000 | } |
60b5724d |
1001 | } |
4b2720f5 |
1002 | $cnt = count($sorted_lsub_ary); |
60b5724d |
1003 | } |
4b2720f5 |
1004 | $sorted_lsub_ary = array_values($sorted_lsub_ary); |
1005 | usort($sorted_lsub_ary, 'mbxSort'); |
1006 | $boxestree = sqimap_fill_mailbox_tree($sorted_lsub_ary,false,$imap_stream); |
1007 | return $boxestree; |
60b5724d |
1008 | } |
1009 | |
3131bc8d |
1010 | /** |
1011 | * Callback function used for sorting mailboxes in sqimap_mailbox_tree |
1012 | * @param string $a |
1013 | * @param string $b |
1014 | * @return integer see php strnatcasecmp() |
1015 | * @since 1.5.1 |
1016 | */ |
9d8d1ebd |
1017 | function mbxSort($a, $b) { |
1018 | return strnatcasecmp($a['mbx'], $b['mbx']); |
1019 | } |
1020 | |
3131bc8d |
1021 | /** |
4b2720f5 |
1022 | * Fills mailbox object |
1023 | * |
1024 | * Some code fragments are present in 1.3.0 - 1.4.4. |
3131bc8d |
1025 | * @param array $mbx_ary |
1026 | * @param $mbxs |
4b2720f5 |
1027 | * @param stream $imap_stream imap connection resource |
3131bc8d |
1028 | * @return object see mailboxes class |
4b2720f5 |
1029 | * @since 1.5.0 |
3131bc8d |
1030 | */ |
483f9ef9 |
1031 | function sqimap_fill_mailbox_tree($mbx_ary, $mbxs=false,$imap_stream) { |
60b5724d |
1032 | global $data_dir, $username, $list_special_folders_first, |
1033 | $folder_prefix, $trash_folder, $sent_folder, $draft_folder, |
1034 | $move_to_trash, $move_to_sent, $save_as_draft, |
43a31298 |
1035 | $delimiter, $imap_server_type; |
60b5724d |
1036 | |
8d8da447 |
1037 | // $special_folders = array ('INBOX', $sent_folder, $draft_folder, $trash_folder); |
ff245fbd |
1038 | |
60b5724d |
1039 | /* create virtual root node */ |
1040 | $mailboxes= new mailboxes(); |
1041 | $mailboxes->is_root = true; |
ff245fbd |
1042 | $trail_del = false; |
78bc908d |
1043 | $start = 0; |
1044 | |
587ec647 |
1045 | |
43a31298 |
1046 | if (isset($folder_prefix) && ($folder_prefix != '')) { |
ff245fbd |
1047 | $start = substr_count($folder_prefix,$delimiter); |
1048 | if (strrpos($folder_prefix, $delimiter) == (strlen($folder_prefix)-1)) { |
ff245fbd |
1049 | $mailboxes->mailboxname_full = substr($folder_prefix,0, (strlen($folder_prefix)-1)); |
1050 | } else { |
1051 | $mailboxes->mailboxname_full = $folder_prefix; |
1052 | $start++; |
1053 | } |
1054 | $mailboxes->mailboxname_sub = $mailboxes->mailboxname_full; |
1055 | } else { |
1056 | $start = 0; |
1057 | } |
78bc908d |
1058 | |
9d8d1ebd |
1059 | $cnt = count($mbx_ary); |
e4c6fe41 |
1060 | for ($i=0; $i < $cnt; $i++) { |
ff245fbd |
1061 | if ($mbx_ary[$i]['mbx'] !='' ) { |
1062 | $mbx = new mailboxes(); |
1063 | $mailbox = $mbx_ary[$i]['mbx']; |
cc82c2b7 |
1064 | |
4669e892 |
1065 | /* |
ae9e2adc |
1066 | * Set the is_special flag if it concerned a special mailbox. |
1067 | * Used for displaying the special folders on top in the mailbox |
1068 | * tree displaying code. |
1069 | */ |
8edc9f31 |
1070 | $mbx->is_special |= ($mbx->is_inbox = (strtoupper($mailbox) == 'INBOX')); |
1071 | $mbx->is_special |= ($mbx->is_trash = isTrashMailbox($mailbox)); |
1072 | $mbx->is_special |= ($mbx->is_sent = isSentMailbox($mailbox)); |
1073 | $mbx->is_special |= ($mbx->is_draft = isDraftMailbox($mailbox)); |
ae9e2adc |
1074 | |
8edc9f31 |
1075 | if (!$mbx->is_special) |
fda01075 |
1076 | $mbx->is_special = boolean_hook_function('special_mailbox', $mailbox, 1); |
4669e892 |
1077 | |
ff245fbd |
1078 | if (isset($mbx_ary[$i]['unseen'])) { |
1079 | $mbx->unseen = $mbx_ary[$i]['unseen']; |
1080 | } |
1081 | if (isset($mbx_ary[$i]['nummessages'])) { |
1082 | $mbx->total = $mbx_ary[$i]['nummessages']; |
1083 | } |
1084 | |
1085 | $mbx->is_noselect = $mbx_ary[$i]['noselect']; |
86c2763d |
1086 | $mbx->is_noinferiors = $mbx_ary[$i]['noinferiors']; |
ff245fbd |
1087 | |
60b5724d |
1088 | $r_del_pos = strrpos($mbx_ary[$i]['mbx'], $delimiter); |
ff245fbd |
1089 | if ($r_del_pos) { |
587ec647 |
1090 | $mbx->mailboxname_sub = substr($mbx_ary[$i]['mbx'],$r_del_pos+1); |
ff245fbd |
1091 | } else { /* mailbox is root folder */ |
587ec647 |
1092 | $mbx->mailboxname_sub = $mbx_ary[$i]['mbx']; |
ff245fbd |
1093 | } |
1094 | $mbx->mailboxname_full = $mbx_ary[$i]['mbx']; |
38068e69 |
1095 | |
9871bdaa |
1096 | $mailboxes->addMbx($mbx, $delimiter, $start, $list_special_folders_first); |
ff245fbd |
1097 | } |
60b5724d |
1098 | } |
587ec647 |
1099 | sqimap_utf7_decode_mbx_tree($mailboxes); |
483f9ef9 |
1100 | sqimap_get_status_mbx_tree($imap_stream,$mailboxes); |
60b5724d |
1101 | return $mailboxes; |
1102 | } |
259faa39 |
1103 | |
3131bc8d |
1104 | /** |
1105 | * @param object $mbx_tree |
1106 | * @since 1.5.0 |
1107 | */ |
587ec647 |
1108 | function sqimap_utf7_decode_mbx_tree(&$mbx_tree) { |
bd27b70b |
1109 | if (strtoupper($mbx_tree->mailboxname_full) == 'INBOX') |
d94c8d61 |
1110 | $mbx_tree->mailboxname_sub = _("INBOX"); |
1111 | else |
1112 | $mbx_tree->mailboxname_sub = imap_utf7_decode_local($mbx_tree->mailboxname_sub); |
587ec647 |
1113 | if ($mbx_tree->mbxs) { |
1114 | $iCnt = count($mbx_tree->mbxs); |
1115 | for ($i=0;$i<$iCnt;++$i) { |
d94c8d61 |
1116 | $mbxs_tree->mbxs[$i] = sqimap_utf7_decode_mbx_tree($mbx_tree->mbxs[$i]); |
587ec647 |
1117 | } |
1118 | } |
483f9ef9 |
1119 | } |
1120 | |
3131bc8d |
1121 | /** |
1122 | * @param object $mbx_tree |
1123 | * @param array $aMbxs |
1124 | * @since 1.5.0 |
1125 | */ |
483f9ef9 |
1126 | function sqimap_tree_to_ref_array(&$mbx_tree,&$aMbxs) { |
5c300c60 |
1127 | if ($mbx_tree) |
483f9ef9 |
1128 | $aMbxs[] =& $mbx_tree; |
1129 | if ($mbx_tree->mbxs) { |
1130 | $iCnt = count($mbx_tree->mbxs); |
1131 | for ($i=0;$i<$iCnt;++$i) { |
5c300c60 |
1132 | sqimap_tree_to_ref_array($mbx_tree->mbxs[$i],$aMbxs); |
483f9ef9 |
1133 | } |
1134 | } |
4669e892 |
1135 | } |
483f9ef9 |
1136 | |
3131bc8d |
1137 | /** |
1138 | * @param stream $imap_stream imap connection resource |
1139 | * @param object $mbx_tree |
1140 | * @since since 1.5.0 |
1141 | */ |
483f9ef9 |
1142 | function sqimap_get_status_mbx_tree($imap_stream,&$mbx_tree) { |
1143 | global $unseen_notify, $unseen_type, $trash_folder,$move_to_trash; |
8d8da447 |
1144 | $aMbxs = $aQuery = array(); |
483f9ef9 |
1145 | sqimap_tree_to_ref_array($mbx_tree,$aMbxs); |
1146 | // remove the root node |
1147 | array_shift($aMbxs); |
1148 | |
1149 | if($unseen_notify == 3) { |
1150 | $cnt = count($aMbxs); |
1151 | for($i=0;$i<$cnt;++$i) { |
5c300c60 |
1152 | $oMbx =& $aMbxs[$i]; |
1153 | if (!$oMbx->is_noselect) { |
483f9ef9 |
1154 | $mbx = $oMbx->mailboxname_full; |
5c300c60 |
1155 | if ($unseen_type == 2 || |
1156 | ($move_to_trash && $oMbx->mailboxname_full == $trash_folder)) { |
568cb884 |
1157 | $query = 'STATUS ' . sqimap_encode_mailbox_name($mbx) . ' (MESSAGES UNSEEN)'; |
5c300c60 |
1158 | } else { |
568cb884 |
1159 | $query = 'STATUS ' . sqimap_encode_mailbox_name($mbx) . ' (UNSEEN)'; |
5c300c60 |
1160 | } |
483f9ef9 |
1161 | sqimap_prepare_pipelined_query($query,$tag,$aQuery,false); |
5c300c60 |
1162 | } else { |
1163 | $oMbx->unseen = $oMbx->total = false; |
1164 | $tag = false; |
1165 | } |
1166 | $oMbx->tag = $tag; |
1167 | $aMbxs[$i] =& $oMbx; |
483f9ef9 |
1168 | } |
1169 | // execute all the queries at once |
1170 | $aResponse = sqimap_run_pipelined_command ($imap_stream, $aQuery, false, $aServerResponse, $aServerMessage); |
1171 | $cnt = count($aMbxs); |
1172 | for($i=0;$i<$cnt;++$i) { |
5c300c60 |
1173 | $oMbx =& $aMbxs[$i]; |
1174 | $tag = $oMbx->tag; |
1175 | if ($tag && $aServerResponse[$tag] == 'OK') { |
1176 | $sResponse = implode('', $aResponse[$tag]); |
483f9ef9 |
1177 | if (preg_match('/UNSEEN\s+([0-9]+)/i', $sResponse, $regs)) { |
1178 | $oMbx->unseen = $regs[1]; |
1179 | } |
1180 | if (preg_match('/MESSAGES\s+([0-9]+)/i', $sResponse, $regs)) { |
1181 | $oMbx->total = $regs[1]; |
5c300c60 |
1182 | } |
1183 | } |
1184 | unset($oMbx->tag); |
1185 | } |
483f9ef9 |
1186 | } else if ($unseen_notify == 2) { // INBOX only |
1187 | $cnt = count($aMbxs); |
1188 | for($i=0;$i<$cnt;++$i) { |
5c300c60 |
1189 | $oMbx =& $aMbxs[$i]; |
1190 | if (strtoupper($oMbx->mailboxname_full) == 'INBOX' || |
1191 | ($move_to_trash && $oMbx->mailboxname_full == $trash_folder)) { |
4669e892 |
1192 | if ($unseen_type == 2 || |
5c300c60 |
1193 | ($oMbx->mailboxname_full == $trash_folder && $move_to_trash)) { |
1194 | $aStatus = sqimap_status_messages($imap_stream,$oMbx->mailboxname_full); |
1195 | $oMbx->unseen = $aStatus['UNSEEN']; |
1196 | $oMbx->total = $aStatus['MESSAGES']; |
1197 | } else { |
1198 | $oMbx->unseen = sqimap_unseen_messages($imap_stream,$oMbx->mailboxname_full); |
1199 | } |
1200 | $aMbxs[$i] =& $oMbx; |
1201 | if (!$move_to_trash && $trash_folder) { |
1202 | break; |
1203 | } else { |
1204 | // trash comes after INBOX |
1205 | if ($oMbx->mailboxname_full == $trash_folder) { |
1206 | break; |
1207 | } |
1208 | } |
1209 | } |
1210 | } |
4669e892 |
1211 | } |
1212 | } |
587ec647 |
1213 | |
c957afd1 |
1214 | ?> |