59177427 |
1 | <?php |
62f7daa5 |
2 | |
35586184 |
3 | /** |
4 | * imap_mailbox.php |
5 | * |
4b2720f5 |
6 | * This implements all functions that manipulate mailboxes |
35586184 |
7 | * |
4b5049de |
8 | * @copyright © 1999-2007 The SquirrelMail Project Team |
4b4abf93 |
9 | * @license http://opensource.org/licenses/gpl-license.php GNU Public License |
eb19bc67 |
10 | * @version $Id$ |
d6c32258 |
11 | * @package squirrelmail |
eb19bc67 |
12 | * @subpackage imap |
35586184 |
13 | */ |
d6c32258 |
14 | |
15 | /** UTF7 support */ |
334a77f8 |
16 | require_once(SM_PATH . 'functions/imap_utf7_local.php'); |
17 | |
1da22cda |
18 | |
d6c32258 |
19 | /** |
20 | * Mailboxes class |
4669e892 |
21 | * |
22 | * FIXME. This class should be extracted and placed in a separate file that |
d6c32258 |
23 | * can be included before we start the session. That makes caching of the tree |
4669e892 |
24 | * possible. On a refresh mailboxes from left_main.php the only function that |
25 | * should be called is the sqimap_get_status_mbx_tree. In case of subscribe |
26 | * / rename / delete / new we have to create methods for adding/changing the |
d6c32258 |
27 | * mailbox in the mbx_tree without the need for a refresh. |
4b2720f5 |
28 | * |
29 | * Some code fragments are present in 1.3.0 - 1.4.4. |
d6c32258 |
30 | * @package squirrelmail |
dc027257 |
31 | * @subpackage imap |
4b2720f5 |
32 | * @since 1.5.0 |
dc027257 |
33 | */ |
60b5724d |
34 | class mailboxes { |
86c2763d |
35 | var $mailboxname_full = '', $mailboxname_sub= '', $is_noselect = false, $is_noinferiors = false, |
ff245fbd |
36 | $is_special = false, $is_root = false, $is_inbox = false, $is_sent = false, |
4669e892 |
37 | $is_trash = false, $is_draft = false, $mbxs = array(), |
48879ef0 |
38 | $unseen = false, $total = false, $recent = false; |
ff245fbd |
39 | |
40 | function addMbx($mbx, $delimiter, $start, $specialfirst) { |
41 | $ary = explode($delimiter, $mbx->mailboxname_full); |
ae7df16e |
42 | $mbx_parent =& $this; |
ff245fbd |
43 | for ($i = $start, $c = count($ary)-1; $i < $c; $i++) { |
ae7df16e |
44 | $mbx_childs =& $mbx_parent->mbxs; |
ff245fbd |
45 | $found = false; |
46 | if ($mbx_childs) { |
47 | foreach ($mbx_childs as $key => $parent) { |
48 | if ($parent->mailboxname_sub == $ary[$i]) { |
ae7df16e |
49 | $mbx_parent =& $mbx_parent->mbxs[$key]; |
ff245fbd |
50 | $found = true; |
ae7df16e |
51 | break; |
ff245fbd |
52 | } |
53 | } |
54 | } |
55 | if (!$found) { |
56 | $no_select_mbx = new mailboxes(); |
57 | if (isset($mbx_parent->mailboxname_full) && $mbx_parent->mailboxname_full != '') { |
58 | $no_select_mbx->mailboxname_full = $mbx_parent->mailboxname_full.$delimiter.$ary[$i]; |
59 | } else { |
60 | $no_select_mbx->mailboxname_full = $ary[$i]; |
61 | } |
587ec647 |
62 | $no_select_mbx->mailboxname_sub = $ary[$i]; |
ff245fbd |
63 | $no_select_mbx->is_noselect = true; |
64 | $mbx_parent->mbxs[] = $no_select_mbx; |
65 | $i--; |
66 | } |
67 | } |
68 | $mbx_parent->mbxs[] = $mbx; |
69 | if ($mbx->is_special && $specialfirst) { |
70 | usort($mbx_parent->mbxs, 'sortSpecialMbx'); |
71 | } |
72 | } |
60b5724d |
73 | } |
74 | |
dc027257 |
75 | /** |
76 | * array callback used for sorting in mailboxes class |
77 | * @param object $a |
78 | * @param object $b |
3131bc8d |
79 | * @return integer see php strnatcasecmp() |
dc027257 |
80 | * @since 1.3.0 |
81 | */ |
60b5724d |
82 | function sortSpecialMbx($a, $b) { |
83 | if ($a->is_inbox) { |
ff245fbd |
84 | $acmp = '0'. $a->mailboxname_full; |
60b5724d |
85 | } else if ($a->is_special) { |
ff245fbd |
86 | $acmp = '1'. $a->mailboxname_full; |
60b5724d |
87 | } else { |
ff245fbd |
88 | $acmp = '2' . $a->mailboxname_full; |
89 | } |
60b5724d |
90 | if ($b->is_inbox) { |
ff245fbd |
91 | $bcmp = '0'. $b->mailboxname_full; |
60b5724d |
92 | }else if ($b->is_special) { |
ff245fbd |
93 | $bcmp = '1' . $b->mailboxname_full; |
60b5724d |
94 | } else { |
ff245fbd |
95 | $bcmp = '2' . $b->mailboxname_full; |
60b5724d |
96 | } |
4669e892 |
97 | return strnatcasecmp($acmp, $bcmp); |
ff245fbd |
98 | } |
60b5724d |
99 | |
dc027257 |
100 | /** |
101 | * @param array $ary |
102 | * @return array |
103 | * @since 1.5.0 |
104 | */ |
105 | function compact_mailboxes_response($ary) { |
86c2763d |
106 | /* |
107 | * Workaround for mailboxes returned as literal |
4669e892 |
108 | * FIXME : Doesn't work if the mailbox name is multiple lines |
86c2763d |
109 | * (larger then fgets buffer) |
110 | */ |
111 | for ($i = 0, $iCnt=count($ary); $i < $iCnt; $i++) { |
112 | if (isset($ary[$i + 1]) && substr($ary[$i], -3) == "}\r\n") { |
113 | if (ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$", |
114 | $ary[$i], $regs)) { |
115 | $ary[$i] = $regs[1] . '"' . addslashes(trim($ary[$i+1])) . '"' . $regs[2]; |
116 | array_splice($ary, $i+1, 2); |
117 | } |
118 | } |
119 | } |
120 | /* remove duplicates and ensure array is contiguous */ |
121 | return array_values(array_unique($ary)); |
122 | } |
123 | |
48af4b64 |
124 | /** |
125 | * Extract the mailbox name from an untagged LIST (7.2.2) or LSUB (7.2.3) answer |
126 | * (LIST|LSUB) (<Flags list>) (NIL|"<separator atom>") <mailbox name string>\r\n |
127 | * mailbox name in quoted string MUST be unquoted and stripslashed (sm API) |
dc027257 |
128 | * |
f8a1ed5a |
129 | * Originally stored in functions/strings.php. Since 1.2.6 stored in |
dc027257 |
130 | * functions/imap_mailbox.php |
131 | * @param string $line imap LIST/LSUB response line |
132 | * @return string mailbox name |
48af4b64 |
133 | */ |
dc027257 |
134 | function find_mailbox_name($line) { |
bac13dd7 |
135 | if (preg_match('/^\* (?:LIST|LSUB) \([^\)]*\) (?:NIL|\"[^\"]*\") ([^\r\n]*)[\r\n]*$/i', $line, $regs)) { |
136 | if (substr($regs[1], 0, 1) == '"') |
137 | return stripslashes(substr($regs[1], 1, -1)); |
138 | return $regs[1]; |
139 | } |
140 | return ''; |
141 | } |
142 | |
48af4b64 |
143 | /** |
dc027257 |
144 | * Detects if mailbox has noselect flag (can't store messages) |
ae9e2adc |
145 | * In versions older than 1.4.5 function checks only LSUB responses |
146 | * and can produce pcre warnings. |
dc027257 |
147 | * @param string $lsub_line mailbox line from untagged LIST or LSUB response |
48af4b64 |
148 | * @return bool whether this is a Noselect mailbox. |
dc027257 |
149 | * @since 1.3.2 |
48af4b64 |
150 | */ |
f73348a3 |
151 | function check_is_noselect ($lsub_line) { |
3698bd49 |
152 | return preg_match("/^\* (LSUB|LIST) \([^\)]*\\\\Noselect[^\)]*\)/i", $lsub_line); |
79e07c7e |
153 | } |
154 | |
48af4b64 |
155 | /** |
dc027257 |
156 | * Detects if mailbox has noinferiors flag (can't store subfolders) |
157 | * @param string $lsub_line mailbox line from untagged LIST or LSUB response |
48af4b64 |
158 | * @return bool whether this is a Noinferiors mailbox. |
dc027257 |
159 | * @since 1.5.0 |
48af4b64 |
160 | */ |
86c2763d |
161 | function check_is_noinferiors ($lsub_line) { |
162 | return preg_match("/^\* (LSUB|LIST) \([^\)]*\\\\Noinferiors[^\)]*\)/i", $lsub_line); |
163 | } |
164 | |
97b1248c |
165 | /** |
d43853c7 |
166 | * Detects mailbox's parent folder |
167 | * |
97b1248c |
168 | * If $haystack is a full mailbox name, and $needle is the mailbox |
169 | * separator character, returns the second last part of the full |
170 | * mailbox name (i.e. the mailbox's parent mailbox) |
d43853c7 |
171 | * |
f8a1ed5a |
172 | * Originally stored in functions/strings.php. Since 1.2.6 stored in |
d43853c7 |
173 | * functions/imap_mailbox.php |
174 | * @param string $haystack full mailbox name |
175 | * @param string $needle delimiter |
f8a1ed5a |
176 | * @return string parent mailbox |
97b1248c |
177 | */ |
178 | function readMailboxParent($haystack, $needle) { |
97b1248c |
179 | if ($needle == '') { |
180 | $ret = ''; |
181 | } else { |
182 | $parts = explode($needle, $haystack); |
183 | $elem = array_pop($parts); |
184 | while ($elem == '' && count($parts)) { |
185 | $elem = array_pop($parts); |
186 | } |
187 | $ret = join($needle, $parts); |
188 | } |
189 | return( $ret ); |
190 | } |
191 | |
4669e892 |
192 | /** |
6a8e7cae |
193 | * Check if $subbox is below the specified $parentbox |
d43853c7 |
194 | * @param string $subbox potential sub folder |
195 | * @param string $parentbox potential parent |
196 | * @return boolean |
197 | * @since 1.2.3 |
6a8e7cae |
198 | */ |
199 | function isBoxBelow( $subbox, $parentbox ) { |
cef054e4 |
200 | global $delimiter; |
4669e892 |
201 | /* |
202 | * Eliminate the obvious mismatch, where the |
6a8e7cae |
203 | * subfolder path is shorter than that of the potential parent |
204 | */ |
205 | if ( strlen($subbox) < strlen($parentbox) ) { |
206 | return false; |
207 | } |
cef054e4 |
208 | /* check for delimiter */ |
c3ce607e |
209 | if (substr($parentbox,-1) != $delimiter) { |
210 | $parentbox .= $delimiter; |
211 | } |
212 | |
213 | return (substr($subbox,0,strlen($parentbox)) == $parentbox); |
1e18bf95 |
214 | } |
215 | |
48af4b64 |
216 | /** |
217 | * Defines special mailboxes: given a mailbox name, it checks if this is a |
218 | * "special" one: INBOX, Trash, Sent or Draft. |
f8a1ed5a |
219 | * |
d43853c7 |
220 | * Since 1.2.5 function includes special_mailbox hook.<br> |
221 | * Since 1.4.3 hook supports more than one plugin. |
222 | * @param string $box mailbox name |
ceb7ad3c |
223 | * @param boolean $include_subs (since 1.5.2) if true, subfolders of system |
224 | * folders are special. if false, subfolders are not special mailboxes |
225 | * unless they are tagged as special in 'special_mailbox' hook. |
d43853c7 |
226 | * @return boolean |
227 | * @since 1.2.3 |
48af4b64 |
228 | */ |
ceb7ad3c |
229 | function isSpecialMailbox($box,$include_subs=true) { |
90de1755 |
230 | $ret = ( (strtolower($box) == 'inbox') || |
ceb7ad3c |
231 | isTrashMailbox($box,$include_subs) || |
232 | isSentMailbox($box,$include_subs) || |
233 | isDraftMailbox($box,$include_subs) ); |
90de1755 |
234 | |
2586d588 |
235 | if ( !$ret ) { |
d849b570 |
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 |
ceb7ad3c |
244 | * @param boolean $include_subs (since 1.5.2) if true, subfolders of system |
245 | * folders are special. if false, subfolders are not special mailboxes. |
48af4b64 |
246 | * @return bool whether this is a Trash folder |
d43853c7 |
247 | * @since 1.4.0 |
48af4b64 |
248 | */ |
ceb7ad3c |
249 | function isTrashMailbox ($box,$include_subs=true) { |
6a8e7cae |
250 | global $trash_folder, $move_to_trash; |
251 | return $move_to_trash && $trash_folder && |
ceb7ad3c |
252 | ( $box == $trash_folder || |
253 | ($include_subs && isBoxBelow($box, $trash_folder)) ); |
6a8e7cae |
254 | } |
255 | |
48af4b64 |
256 | /** |
d43853c7 |
257 | * Detects if mailbox is a Sent folder or subfolder of Sent |
258 | * @param string $box mailbox name |
ceb7ad3c |
259 | * @param boolean $include_subs (since 1.5.2) if true, subfolders of system |
260 | * folders are special. if false, subfolders are not special mailboxes. |
48af4b64 |
261 | * @return bool whether this is a Sent folder |
d43853c7 |
262 | * @since 1.4.0 |
48af4b64 |
263 | */ |
ceb7ad3c |
264 | function isSentMailbox($box,$include_subs=true) { |
6a8e7cae |
265 | global $sent_folder, $move_to_sent; |
266 | return $move_to_sent && $sent_folder && |
ceb7ad3c |
267 | ( $box == $sent_folder || |
268 | ($include_subs && isBoxBelow($box, $sent_folder)) ); |
6a8e7cae |
269 | } |
270 | |
48af4b64 |
271 | /** |
d43853c7 |
272 | * Detects if mailbox is a Drafts folder or subfolder of Drafts |
273 | * @param string $box mailbox name |
ceb7ad3c |
274 | * @param boolean $include_subs (since 1.5.2) if true, subfolders of system |
275 | * folders are special. if false, subfolders are not special mailboxes. |
48af4b64 |
276 | * @return bool whether this is a Draft folder |
d43853c7 |
277 | * @since 1.4.0 |
48af4b64 |
278 | */ |
ceb7ad3c |
279 | function isDraftMailbox($box,$include_subs=true) { |
6a8e7cae |
280 | global $draft_folder, $save_as_draft; |
281 | return $save_as_draft && |
ceb7ad3c |
282 | ( $box == $draft_folder || |
283 | ($include_subs && isBoxBelow($box, $draft_folder)) ); |
6a8e7cae |
284 | } |
285 | |
48af4b64 |
286 | /** |
d43853c7 |
287 | * Expunges a mailbox |
f8a1ed5a |
288 | * |
d43853c7 |
289 | * WARNING: Select mailbox before calling this function. |
f8a1ed5a |
290 | * |
291 | * permanently removes all messages that have the \Deleted flag |
292 | * set from the selected mailbox. See EXPUNGE command chapter in |
d43853c7 |
293 | * IMAP RFC. |
294 | * @param stream $imap_stream imap connection resource |
295 | * @param string $mailbox mailbox name (unused since 1.1.3). |
296 | * @param boolean $handle_errors error handling control (displays error_box on error). |
297 | * @param mixed $id (since 1.3.0) integer message id or array with integer ids |
298 | * @return integer number of expunged messages |
3131bc8d |
299 | * @since 1.0 or older |
48af4b64 |
300 | */ |
8f6505f6 |
301 | function sqimap_mailbox_expunge ($imap_stream, $mailbox, $handle_errors = true, $id='') { |
06b5c3ff |
302 | if ($id) { |
ff245fbd |
303 | if (is_array($id)) { |
304 | $id = sqimap_message_list_squisher($id); |
305 | } |
306 | $id = ' '.$id; |
9d8d1ebd |
307 | $uid = TRUE; |
06b5c3ff |
308 | } else { |
ff245fbd |
309 | $uid = false; |
8f6505f6 |
310 | } |
06b5c3ff |
311 | $read = sqimap_run_command($imap_stream, 'EXPUNGE'.$id, $handle_errors, |
312 | $response, $message, $uid); |
63240b90 |
313 | $cnt = 0; |
ff245fbd |
314 | |
315 | if (is_array($read)) { |
63240b90 |
316 | foreach ($read as $r) { |
ff245fbd |
317 | if (preg_match('/^\*\s[0-9]+\sEXPUNGE/AUi',$r,$regs)) { |
318 | $cnt++; |
319 | } |
63240b90 |
320 | } |
8f6505f6 |
321 | } |
ff245fbd |
322 | return $cnt; |
43b698c7 |
323 | } |
324 | |
48af4b64 |
325 | /** |
326 | * Checks whether or not the specified mailbox exists |
a462b928 |
327 | * |
d43853c7 |
328 | * @param stream $imap_stream imap connection resource |
329 | * @param string $mailbox mailbox name |
92ffe525 |
330 | * @param array $mailboxlist (since 1.5.1) optional array of mailboxes from |
a462b928 |
331 | * sqimap_get_mailboxes() (to avoid having to talk to imap server) |
d43853c7 |
332 | * @return boolean |
333 | * @since 1.0 or older |
48af4b64 |
334 | */ |
a462b928 |
335 | function sqimap_mailbox_exists ($imap_stream, $mailbox, $mailboxlist=null) { |
247f700e |
336 | if (!isset($mailbox) || empty($mailbox)) { |
43b698c7 |
337 | return false; |
338 | } |
a462b928 |
339 | |
340 | if (is_array($mailboxlist)) { |
341 | // use previously retrieved mailbox list |
342 | foreach ($mailboxlist as $mbox) { |
343 | if ($mbox['unformatted-dm'] == $mailbox) { return true; } |
344 | } |
345 | return false; |
346 | } else { |
347 | // go to imap server |
348 | $mbx = sqimap_run_command($imap_stream, 'LIST "" ' . sqimap_encode_mailbox_name($mailbox), |
349 | true, $response, $message); |
350 | return isset($mbx[0]); |
351 | } |
43b698c7 |
352 | } |
353 | |
48af4b64 |
354 | /** |
355 | * Selects a mailbox |
3d548be7 |
356 | * Before 1.3.0 used more arguments and returned data depended on those arguments. |
d43853c7 |
357 | * @param stream $imap_stream imap connection resource |
358 | * @param string $mailbox mailbox name |
f8a1ed5a |
359 | * @return array results of select command (on success - permanentflags, flags and rights) |
d43853c7 |
360 | * @since 1.0 or older |
48af4b64 |
361 | */ |
e4c6fe41 |
362 | function sqimap_mailbox_select ($imap_stream, $mailbox) { |
876fdb60 |
363 | if (empty($mailbox)) { |
43b698c7 |
364 | return; |
365 | } |
3824e89a |
366 | |
92ffe525 |
367 | // cleanup $mailbox in order to prevent IMAP injection attacks |
368 | $mailbox = str_replace(array("\r","\n"), array("",""),$mailbox); |
3824e89a |
369 | |
370 | /** |
371 | * Default UW IMAP server configuration allows to access other files |
372 | * on server. $imap_server_type is not checked because interface can |
373 | * be used with 'other' or any other server type setting. $mailbox |
374 | * variable can be modified in any script that uses variable from GET |
375 | * or POST. This code blocks all standard SquirrelMail IMAP API requests |
376 | * that use mailbox with full path (/etc/passwd) or with ../ characters |
377 | * in path (../../etc/passwd) |
378 | */ |
379 | if (strstr($mailbox, '../') || substr($mailbox, 0, 1) == '/') { |
380 | global $oTemplate; |
381 | error_box(sprintf(_("Invalid mailbox name: %s"),htmlspecialchars($mailbox))); |
382 | sqimap_logout($imap_stream); |
383 | $oTemplate->display('footer.tpl'); |
384 | die(); |
385 | } |
386 | |
568cb884 |
387 | $read = sqimap_run_command($imap_stream, 'SELECT ' . sqimap_encode_mailbox_name($mailbox), |
3411d4ec |
388 | true, $response, $message); |
e4c6fe41 |
389 | $result = array(); |
ff245fbd |
390 | for ($i = 0, $cnt = count($read); $i < $cnt; $i++) { |
e4c6fe41 |
391 | if (preg_match('/^\*\s+OK\s\[(\w+)\s(\w+)\]/',$read[$i], $regs)) { |
ff245fbd |
392 | $result[strtoupper($regs[1])] = $regs[2]; |
393 | } else if (preg_match('/^\*\s([0-9]+)\s(\w+)/',$read[$i], $regs)) { |
394 | $result[strtoupper($regs[2])] = $regs[1]; |
395 | } else { |
396 | if (preg_match("/PERMANENTFLAGS(.*)/i",$read[$i], $regs)) { |
397 | $regs[1]=trim(preg_replace ( array ("/\(/","/\)/","/\]/") ,'', $regs[1])) ; |
4669e892 |
398 | $result['PERMANENTFLAGS'] = explode(' ',strtolower($regs[1])); |
ff245fbd |
399 | } else if (preg_match("/FLAGS(.*)/i",$read[$i], $regs)) { |
400 | $regs[1]=trim(preg_replace ( array ("/\(/","/\)/") ,'', $regs[1])) ; |
4669e892 |
401 | $result['FLAGS'] = explode(' ',strtolower($regs[1])); |
ff245fbd |
402 | } |
403 | } |
e4c6fe41 |
404 | } |
4669e892 |
405 | if (!isset($result['PERMANENTFLAGS'])) { |
406 | $result['PERMANENTFLAGS'] = $result['FLAGS']; |
407 | } |
e4c6fe41 |
408 | if (preg_match('/^\[(.+)\]/',$message, $regs)) { |
4669e892 |
409 | $result['RIGHTS']=strtoupper($regs[1]); |
e4c6fe41 |
410 | } |
f69feefe |
411 | |
e4c6fe41 |
412 | return $result; |
43b698c7 |
413 | } |
414 | |
48af4b64 |
415 | /** |
416 | * Creates a folder. |
d43853c7 |
417 | * |
418 | * Mailbox is automatically subscribed. |
f8a1ed5a |
419 | * |
420 | * Set $type to string that does not match 'noselect' (case insensitive), |
421 | * if you don't want to prepend delimiter to mailbox name. Please note |
422 | * that 'noinferiors' might be used someday as keyword for folders |
d43853c7 |
423 | * that store only messages. |
424 | * @param stream $imap_steam imap connection resource |
425 | * @param string $mailbox mailbox name |
426 | * @param string $type folder type. |
427 | * @since 1.0 or older |
48af4b64 |
428 | */ |
3411d4ec |
429 | function sqimap_mailbox_create ($imap_stream, $mailbox, $type) { |
43b698c7 |
430 | global $delimiter; |
431 | if (strtolower($type) == 'noselect') { |
5221db27 |
432 | $create_mailbox = $mailbox . $delimiter; |
433 | } else { |
434 | $create_mailbox = $mailbox; |
43b698c7 |
435 | } |
e429f014 |
436 | |
48af4b64 |
437 | $read_ary = sqimap_run_command($imap_stream, 'CREATE ' . |
5221db27 |
438 | sqimap_encode_mailbox_name($create_mailbox), |
3411d4ec |
439 | true, $response, $message); |
43b698c7 |
440 | sqimap_subscribe ($imap_stream, $mailbox); |
441 | } |
442 | |
48af4b64 |
443 | /** |
444 | * Subscribes to an existing folder. |
d43853c7 |
445 | * @param stream $imap_stream imap connection resource |
446 | * @param string $mailbox mailbox name |
447 | * @param boolean $debug (since 1.5.1) |
448 | * @since 1.0 or older |
48af4b64 |
449 | */ |
852abae7 |
450 | function sqimap_subscribe ($imap_stream, $mailbox,$debug=true) { |
48af4b64 |
451 | $read_ary = sqimap_run_command($imap_stream, 'SUBSCRIBE ' . |
452 | sqimap_encode_mailbox_name($mailbox), |
852abae7 |
453 | $debug, $response, $message); |
43b698c7 |
454 | } |
455 | |
48af4b64 |
456 | /** |
457 | * Unsubscribes from an existing folder |
d43853c7 |
458 | * @param stream $imap_stream imap connection resource |
459 | * @param string $mailbox mailbox name |
460 | * @since 1.0 or older |
48af4b64 |
461 | */ |
3411d4ec |
462 | function sqimap_unsubscribe ($imap_stream, $mailbox) { |
48af4b64 |
463 | $read_ary = sqimap_run_command($imap_stream, 'UNSUBSCRIBE ' . |
464 | sqimap_encode_mailbox_name($mailbox), |
e2e8b92b |
465 | false, $response, $message); |
43b698c7 |
466 | } |
467 | |
48af4b64 |
468 | /** |
469 | * Deletes the given folder |
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 $mailbox mailbox name |
473 | * @since 1.0 or older |
48af4b64 |
474 | */ |
3411d4ec |
475 | function sqimap_mailbox_delete ($imap_stream, $mailbox) { |
78cc4b12 |
476 | global $data_dir, $username; |
e2e8b92b |
477 | sqimap_unsubscribe ($imap_stream, $mailbox); |
c957afd1 |
478 | |
479 | if (sqimap_mailbox_exists($imap_stream, $mailbox)) { |
480 | |
481 | $read_ary = sqimap_run_command($imap_stream, 'DELETE ' . |
482 | sqimap_encode_mailbox_name($mailbox), |
483 | true, $response, $message); |
484 | if ($response !== 'OK') { |
485 | // subscribe again |
486 | sqimap_subscribe ($imap_stream, $mailbox); |
487 | } else { |
d9b05bb3 |
488 | $temp = array(&$mailbox, 'delete', ''); |
489 | do_hook('rename_or_delete_folder', $temp); |
c957afd1 |
490 | removePref($data_dir, $username, "thread_$mailbox"); |
491 | removePref($data_dir, $username, "collapse_folder_$mailbox"); |
492 | } |
e2e8b92b |
493 | } |
43b698c7 |
494 | } |
495 | |
48af4b64 |
496 | /** |
497 | * Determines if the user is subscribed to the folder or not |
3131bc8d |
498 | * @param stream $imap_stream imap connection resource |
499 | * @param string $mailbox mailbox name |
500 | * @return boolean |
501 | * @since 1.2.0 |
48af4b64 |
502 | */ |
1da22cda |
503 | function sqimap_mailbox_is_subscribed($imap_stream, $folder) { |
1da22cda |
504 | $boxesall = sqimap_mailbox_list ($imap_stream); |
505 | foreach ($boxesall as $ref) { |
43b698c7 |
506 | if ($ref['unformatted'] == $folder) { |
3411d4ec |
507 | return true; |
43b698c7 |
508 | } |
509 | } |
510 | return false; |
511 | } |
512 | |
48af4b64 |
513 | /** |
514 | * Renames a mailbox. |
3131bc8d |
515 | * Since 1.2.6 and 1.3.0 contains rename_or_delete_folder hook |
516 | * @param stream $imap_stream imap connection resource |
517 | * @param string $old_name mailbox name |
518 | * @param string $new_name new mailbox name |
519 | * @since 1.2.3 |
48af4b64 |
520 | */ |
1c52ba77 |
521 | function sqimap_mailbox_rename( $imap_stream, $old_name, $new_name ) { |
3411d4ec |
522 | if ( $old_name != $new_name ) { |
78cc4b12 |
523 | global $delimiter, $imap_server_type, $data_dir, $username; |
1c52ba77 |
524 | if ( substr( $old_name, -1 ) == $delimiter ) { |
525 | $old_name = substr( $old_name, 0, strlen( $old_name ) - 1 ); |
526 | $new_name = substr( $new_name, 0, strlen( $new_name ) - 1 ); |
527 | $postfix = $delimiter; |
1c52ba77 |
528 | } else { |
529 | $postfix = ''; |
1c52ba77 |
530 | } |
68f2ce7a |
531 | |
5659ad2e |
532 | $boxesall = sqimap_mailbox_list_all($imap_stream); |
48af4b64 |
533 | $cmd = 'RENAME ' . sqimap_encode_mailbox_name($old_name) . |
91e0dccc |
534 | ' ' . sqimap_encode_mailbox_name($new_name); |
3411d4ec |
535 | $data = sqimap_run_command($imap_stream, $cmd, true, $response, $message); |
1c52ba77 |
536 | sqimap_unsubscribe($imap_stream, $old_name.$postfix); |
5659ad2e |
537 | $oldpref_thread = getPref($data_dir, $username, 'thread_'.$old_name.$postfix); |
538 | $oldpref_collapse = getPref($data_dir, $username, 'collapse_folder_'.$old_name.$postfix); |
68f2ce7a |
539 | removePref($data_dir, $username, 'thread_'.$old_name.$postfix); |
5659ad2e |
540 | removePref($data_dir, $username, 'collapse_folder_'.$old_name.$postfix); |
1c52ba77 |
541 | sqimap_subscribe($imap_stream, $new_name.$postfix); |
5659ad2e |
542 | setPref($data_dir, $username, 'thread_'.$new_name.$postfix, $oldpref_thread); |
543 | setPref($data_dir, $username, 'collapse_folder_'.$new_name.$postfix, $oldpref_collapse); |
d9b05bb3 |
544 | $temp = array(&$old_name, 'rename', &$new_name); |
545 | do_hook('rename_or_delete_folder', $temp); |
648713af |
546 | $l = strlen( $old_name ) + 1; |
547 | $p = 'unformatted'; |
68f2ce7a |
548 | |
ff245fbd |
549 | foreach ($boxesall as $box) { |
550 | if (substr($box[$p], 0, $l) == $old_name . $delimiter) { |
648713af |
551 | $new_sub = $new_name . $delimiter . substr($box[$p], $l); |
5659ad2e |
552 | /* With Cyrus IMAPd >= 2.0 rename is recursive, so don't check for errors here */ |
648713af |
553 | if ($imap_server_type == 'cyrus') { |
68f2ce7a |
554 | $cmd = 'RENAME "' . $box[$p] . '" "' . $new_sub . '"'; |
5659ad2e |
555 | $data = sqimap_run_command($imap_stream, $cmd, false, |
648713af |
556 | $response, $message); |
1c52ba77 |
557 | } |
5659ad2e |
558 | $was_subscribed = sqimap_mailbox_is_subscribed($imap_stream, $box[$p]); |
559 | if ( $was_subscribed ) { |
560 | sqimap_unsubscribe($imap_stream, $box[$p]); |
561 | } |
562 | $oldpref_thread = getPref($data_dir, $username, 'thread_'.$box[$p]); |
563 | $oldpref_collapse = getPref($data_dir, $username, 'collapse_folder_'.$box[$p]); |
68f2ce7a |
564 | removePref($data_dir, $username, 'thread_'.$box[$p]); |
5659ad2e |
565 | removePref($data_dir, $username, 'collapse_folder_'.$box[$p]); |
566 | if ( $was_subscribed ) { |
567 | sqimap_subscribe($imap_stream, $new_sub); |
568 | } |
569 | setPref($data_dir, $username, 'thread_'.$new_sub, $oldpref_thread); |
570 | setPref($data_dir, $username, 'collapse_folder_'.$new_sub, $oldpref_collapse); |
d9b05bb3 |
571 | $temp = array(&$box[$p], 'rename', &$new_sub); |
572 | do_hook('rename_or_delete_folder', $temp); |
1c52ba77 |
573 | } |
574 | } |
1c52ba77 |
575 | } |
1c52ba77 |
576 | } |
43b698c7 |
577 | |
48af4b64 |
578 | /** |
86c2763d |
579 | * Formats a mailbox into parts for the $boxesall array |
3411d4ec |
580 | * |
86c2763d |
581 | * The parts are: |
3131bc8d |
582 | * <ul> |
583 | * <li>raw - Raw LIST/LSUB response from the IMAP server |
584 | * <li>formatted - nicely formatted folder name |
585 | * <li>unformatted - unformatted, but with delimiter at end removed |
586 | * <li>unformatted-dm - folder name as it appears in raw response |
587 | * <li>unformatted-disp - unformatted without $folder_prefix |
588 | * <li>id - TODO: document me |
589 | * <li>flags - TODO: document me |
590 | * </ul> |
591 | * Before 1.2.0 used third argument for delimiter. |
a462b928 |
592 | * |
593 | * Before 1.5.1 used second argument for lsub line. Argument was removed in order to use |
92ffe525 |
594 | * find_mailbox_name() on the raw input. Since 1.5.1 includes RFC3501 names in flags |
a462b928 |
595 | * array (for example, "\NoSelect" in addition to "noselect") |
596 | * @param array $line |
3131bc8d |
597 | * @return array |
598 | * @since 1.0 or older |
599 | * @todo document id and flags keys in boxes array and function arguments. |
3411d4ec |
600 | */ |
a462b928 |
601 | function sqimap_mailbox_parse ($line) { |
43b698c7 |
602 | global $folder_prefix, $delimiter; |
3411d4ec |
603 | |
43b698c7 |
604 | /* Process each folder line */ |
cef054e4 |
605 | for ($g = 0, $cnt = count($line); $g < $cnt; ++$g) { |
43b698c7 |
606 | /* Store the raw IMAP reply */ |
607 | if (isset($line[$g])) { |
e429f014 |
608 | $boxesall[$g]['raw'] = $line[$g]; |
ff245fbd |
609 | } else { |
e429f014 |
610 | $boxesall[$g]['raw'] = ''; |
43b698c7 |
611 | } |
3411d4ec |
612 | |
43b698c7 |
613 | /* Count number of delimiters ($delimiter) in folder name */ |
a462b928 |
614 | $mailbox = find_mailbox_name($line[$g]); |
ff245fbd |
615 | $dm_count = substr_count($mailbox, $delimiter); |
43b698c7 |
616 | if (substr($mailbox, -1) == $delimiter) { |
3411d4ec |
617 | /* If name ends in delimiter, decrement count by one */ |
618 | $dm_count--; |
43b698c7 |
619 | } |
3411d4ec |
620 | |
621 | /* Format folder name, but only if it's a INBOX.* or has a parent. */ |
1da22cda |
622 | $boxesallbyname[$mailbox] = $g; |
43b698c7 |
623 | $parentfolder = readMailboxParent($mailbox, $delimiter); |
624 | if ( (strtolower(substr($mailbox, 0, 5)) == "inbox") || |
625 | (substr($mailbox, 0, strlen($folder_prefix)) == $folder_prefix) || |
ff245fbd |
626 | (isset($boxesallbyname[$parentfolder]) && |
627 | (strlen($parentfolder) > 0) ) ) { |
628 | $indent = $dm_count - (substr_count($folder_prefix, $delimiter)); |
43b698c7 |
629 | if ($indent > 0) { |
ff245fbd |
630 | $boxesall[$g]['formatted'] = str_repeat(' ', $indent); |
631 | } else { |
1da22cda |
632 | $boxesall[$g]['formatted'] = ''; |
43b698c7 |
633 | } |
447b2166 |
634 | $boxesall[$g]['formatted'] .= imap_utf7_decode_local(readShortMailboxName($mailbox, $delimiter)); |
ff245fbd |
635 | } else { |
447b2166 |
636 | $boxesall[$g]['formatted'] = imap_utf7_decode_local($mailbox); |
43b698c7 |
637 | } |
90de1755 |
638 | |
1da22cda |
639 | $boxesall[$g]['unformatted-dm'] = $mailbox; |
43b698c7 |
640 | if (substr($mailbox, -1) == $delimiter) { |
8e9e8afa |
641 | $mailbox = substr($mailbox, 0, strlen($mailbox) - 1); |
43b698c7 |
642 | } |
1da22cda |
643 | $boxesall[$g]['unformatted'] = $mailbox; |
43b698c7 |
644 | if (substr($mailbox,0,strlen($folder_prefix))==$folder_prefix) { |
631b9da3 |
645 | $mailbox = substr($mailbox, strlen($folder_prefix)); |
43b698c7 |
646 | } |
1da22cda |
647 | $boxesall[$g]['unformatted-disp'] = $mailbox; |
648 | $boxesall[$g]['id'] = $g; |
90de1755 |
649 | |
1da22cda |
650 | $boxesall[$g]['flags'] = array(); |
43b698c7 |
651 | if (isset($line[$g])) { |
36dfb0c9 |
652 | ereg("\(([^)]*)\)",$line[$g],$regs); |
a462b928 |
653 | /** |
654 | * Since 1.5.1 flags are stored with RFC3501 naming |
655 | * and also the old way for backwards compatibility |
656 | * so for example "\NoSelect" and "noselect" |
657 | */ |
658 | $flags = trim($regs[1]); |
43b698c7 |
659 | if ($flags) { |
a462b928 |
660 | $flagsarr = explode(' ',$flags); |
661 | $flagsarrnew=$flagsarr; |
662 | // add old type |
663 | foreach ($flagsarr as $flag) { |
664 | $flagsarrnew[]=strtolower(str_replace('\\', '',$flag)); |
665 | } |
666 | $boxesall[$g]['flags']=$flagsarrnew; |
43b698c7 |
667 | } |
668 | } |
669 | } |
1da22cda |
670 | return $boxesall; |
43b698c7 |
671 | } |
672 | |
48af4b64 |
673 | /** |
f5b3b0fc |
674 | * Returns an array of mailboxes available. Separated from sqimap_mailbox_option_list() |
675 | * below for template development. |
676 | * |
677 | * @author Steve Brown |
678 | * @since 1.5.2 |
be2d5495 |
679 | */ |
f5b3b0fc |
680 | function sqimap_mailbox_option_array($imap_stream, $folder_skip = 0, $boxes = 0, |
59a8e3e8 |
681 | $flag = 'noselect', $use_long_format = false ) { |
dbd9ce25 |
682 | global $username, $data_dir, $translate_special_folders, $sent_folder, |
683 | $trash_folder, $draft_folder; |
684 | |
685 | $delimiter = sqimap_get_delimiter($imap_stream); |
686 | |
be2d5495 |
687 | $mbox_options = ''; |
45f836eb |
688 | if ( $use_long_format ) { |
689 | $shorten_box_names = 0; |
690 | } else { |
d56050e1 |
691 | $shorten_box_names = getPref($data_dir, $username, 'mailbox_select_style', SMPREF_MAILBOX_SELECT_INDENTED); |
45f836eb |
692 | } |
ff245fbd |
693 | |
694 | if ($boxes == 0) { |
be2d5495 |
695 | $boxes = sqimap_mailbox_list($imap_stream); |
ff245fbd |
696 | } |
59a8e3e8 |
697 | |
f5b3b0fc |
698 | $a = array(); |
be2d5495 |
699 | foreach ($boxes as $boxes_part) { |
4df5d823 |
700 | if ($flag == NULL || (is_array($boxes_part['flags']) |
701 | && !in_array($flag, $boxes_part['flags']))) { |
be2d5495 |
702 | $box = $boxes_part['unformatted']; |
be2d5495 |
703 | |
d0928dd5 |
704 | if ($folder_skip != 0 && in_array($box, $folder_skip) ) { |
be2d5495 |
705 | continue; |
706 | } |
4669e892 |
707 | $lowerbox = strtolower($box); |
5c300c60 |
708 | // mailboxes are casesensitive => inbox.sent != inbox.Sent |
709 | // nevermind, to many dependencies this should be fixed! |
4669e892 |
710 | |
d0928dd5 |
711 | if (strtolower($box) == 'inbox') { // inbox is special and not casesensitive |
be2d5495 |
712 | $box2 = _("INBOX"); |
4669e892 |
713 | } else { |
5c300c60 |
714 | switch ($shorten_box_names) |
715 | { |
d56050e1 |
716 | case SMPREF_MAILBOX_SELECT_DELIMITED: |
dbd9ce25 |
717 | if ($translate_special_folders && $boxes_part['unformatted-dm']==$sent_folder) { |
718 | /* |
719 | * calculate pad level from number of delimiters. do it inside if control in order |
720 | * to reduce number of calculations. Other folders don't need it. |
721 | */ |
722 | $pad = str_pad('',7 * (count(explode($delimiter,$boxes_part['unformatted-dm']))-1),'. '); |
723 | // i18n: Name of Sent folder |
724 | $box2 = $pad . _("Sent"); |
725 | } elseif ($translate_special_folders && $boxes_part['unformatted-dm']==$trash_folder) { |
726 | $pad = str_pad('',7 * (count(explode($delimiter,$boxes_part['unformatted-dm']))-1),'. '); |
727 | // i18n: Name of Trash folder |
728 | $box2 = $pad . _("Trash"); |
729 | } elseif ($translate_special_folders && $boxes_part['unformatted-dm']==$draft_folder) { |
730 | $pad = str_pad('',7 * (count(explode($delimiter,$boxes_part['unformatted-dm']))-1),'. '); |
731 | // i18n: Name of Drafts folder |
732 | $box2 = $pad . _("Drafts"); |
733 | } else { |
734 | $box2 = str_replace('&nbsp;&nbsp;', '. ', htmlspecialchars($boxes_part['formatted'])); |
735 | } |
5c300c60 |
736 | break; |
d56050e1 |
737 | case SMPREF_MAILBOX_SELECT_INDENTED: |
dbd9ce25 |
738 | if ($translate_special_folders && $boxes_part['unformatted-dm']==$sent_folder) { |
739 | $pad = str_pad('',12 * (count(explode($delimiter,$boxes_part['unformatted-dm']))-1),' '); |
740 | $box2 = $pad . _("Sent"); |
741 | } elseif ($translate_special_folders && $boxes_part['unformatted-dm']==$trash_folder) { |
742 | $pad = str_pad('',12 * (count(explode($delimiter,$boxes_part['unformatted-dm']))-1),' '); |
743 | $box2 = $pad . _("Trash"); |
744 | } elseif ($translate_special_folders && $boxes_part['unformatted-dm']==$draft_folder) { |
745 | $pad = str_pad('',12 * (count(explode($delimiter,$boxes_part['unformatted-dm']))-1),' '); |
746 | $box2 = $pad . _("Drafts"); |
747 | } else { |
748 | $box2 = str_replace('&nbsp;&nbsp;', ' ', htmlspecialchars($boxes_part['formatted'])); |
749 | } |
5c300c60 |
750 | break; |
d0928dd5 |
751 | default: /* default, long names, style = 0 */ |
6c4f0fa1 |
752 | $box2 = str_replace(' ', ' ', htmlspecialchars(imap_utf7_decode_local($boxes_part['unformatted-disp']))); |
5c300c60 |
753 | break; |
754 | } |
be2d5495 |
755 | } |
f5b3b0fc |
756 | |
757 | $a[htmlspecialchars($box)] = $box2; |
758 | } |
759 | } |
760 | |
761 | return $a; |
762 | } |
763 | |
764 | /** |
765 | * Returns list of options (to be echoed into select statement |
766 | * based on available mailboxes and separators |
767 | * Caller should surround options with <select ...> </select> and |
768 | * any formatting. |
769 | * @param stream $imap_stream imap connection resource to query for mailboxes |
770 | * @param array $show_selected array containing list of mailboxes to pre-select (0 if none) |
771 | * @param array $folder_skip array of folders to keep out of option list (compared in lower) |
772 | * @param $boxes list of already fetched boxes (for places like folder panel, where |
773 | * you know these options will be shown 3 times in a row.. (most often unset). |
774 | * @param string $flag (since 1.4.1) flag to check for in mailbox flags, used to filter out mailboxes. |
775 | * 'noselect' by default to remove unselectable mailboxes. |
776 | * 'noinferiors' used to filter out folders that can not contain subfolders. |
777 | * NULL to avoid flag check entirely. |
778 | * NOTE: noselect and noiferiors are used internally. The IMAP representation is |
779 | * \NoSelect and \NoInferiors |
780 | * @param boolean $use_long_format (since 1.4.1) override folder display preference and always show full folder name. |
781 | * @return string html formated mailbox selection options |
782 | * @since 1.3.2 |
783 | */ |
784 | function sqimap_mailbox_option_list($imap_stream, $show_selected = 0, $folder_skip = 0, $boxes = 0, |
785 | $flag = 'noselect', $use_long_format = false ) { |
786 | global $username, $data_dir, $translate_special_folders, $sent_folder, |
787 | $trash_folder, $draft_folder; |
788 | |
789 | $boxes = sqimap_mailbox_option_array($imap_stream, $folder_skip, $boxes, $flag, $use_long_format); |
790 | |
791 | $str = ''; |
792 | foreach ($boxes as $value=>$option) { |
793 | $lowerbox = strtolower(htmlspecialchars($value)); |
794 | $sel = false; |
795 | if ($show_selected != 0) { |
796 | reset($show_selected); |
797 | while (!$sel && (list($x, $val) = each($show_selected))) { |
798 | if (strtolower($value) == strtolower(htmlspecialchars($val))) { |
799 | $sel = true; |
800 | } |
be2d5495 |
801 | } |
802 | } |
f5b3b0fc |
803 | |
804 | $str .= '<option value="'. $value .'"'. ($sel ? ' selected="selected"' : '').'>'. $option ."</option>\n"; |
be2d5495 |
805 | } |
f5b3b0fc |
806 | |
807 | return $str; |
be2d5495 |
808 | } |
43b698c7 |
809 | |
48af4b64 |
810 | /** |
4669e892 |
811 | * Returns sorted mailbox lists in several different ways. |
a462b928 |
812 | * |
813 | * Since 1.5.1 most of the functionality has been moved to new function sqimap_get_mailboxes |
814 | * |
3411d4ec |
815 | * See comment on sqimap_mailbox_parse() for info about the returned array. |
3e9441a2 |
816 | * @param resource $imap_stream imap connection resource |
817 | * @param boolean $force force update of mailbox listing. available since 1.4.2 and 1.5.0 |
818 | * @return array list of mailboxes |
3131bc8d |
819 | * @since 1.0 or older |
3411d4ec |
820 | */ |
fe6efa94 |
821 | function sqimap_mailbox_list($imap_stream, $force=false) { |
a462b928 |
822 | global $boxesnew,$show_only_subscribed_folders; |
fe6efa94 |
823 | if (!sqgetGlobalVar('boxesnew',$boxesnew,SQ_SESSION) || $force) { |
a462b928 |
824 | $boxesnew=sqimap_get_mailboxes($imap_stream,$force,$show_only_subscribed_folders); |
825 | } |
826 | return $boxesnew; |
827 | } |
4669e892 |
828 | |
a462b928 |
829 | /** |
830 | * Returns a list of all folders, subscribed or not |
831 | * |
832 | * Since 1.5.1 code moved to sqimap_get_mailboxes() |
833 | * |
834 | * @param stream $imap_stream imap connection resource |
835 | * @return array see sqimap_mailbox_parse() |
836 | * @since 1.0 or older |
837 | */ |
838 | function sqimap_mailbox_list_all($imap_stream) { |
839 | global $show_only_subscribed_folders; |
840 | // fourth argument prevents registration of retrieved list of mailboxes in session |
841 | $boxes=sqimap_get_mailboxes($imap_stream,true,false,false); |
842 | return $boxes; |
843 | } |
7e235a1a |
844 | |
159d2af7 |
845 | |
a462b928 |
846 | /** |
847 | * Gets the list of mailboxes for sqimap_maolbox_tree and sqimap_mailbox_list |
848 | * |
849 | * This is because both of those functions had duplicated logic, but with slightly different |
850 | * implementations. This will make both use the same implementation, which should make it |
851 | * easier to maintain and easier to modify in the future |
852 | * @param stream $imap_stream imap connection resource |
853 | * @param bool $force force a reload and ignore cache |
854 | * @param bool $show_only_subscribed controls listing of visible or all folders |
855 | * @param bool $session_register controls registration of retrieved data in session. |
856 | * @return object boxesnew - array of mailboxes and their attributes |
857 | * @since 1.5.1 |
858 | */ |
859 | function sqimap_get_mailboxes($imap_stream,$force=false,$show_only_subscribed=true,$session_register=true) { |
860 | global $show_only_subscribed_folders,$noselect_fix_enable,$folder_prefix, |
861 | $list_special_folders_first,$imap_server_type; |
862 | $inbox_subscribed = false; |
863 | $listsubscribed = sqimap_capability($imap_stream,'LIST-SUBSCRIBED'); |
cef054e4 |
864 | |
a462b928 |
865 | if ($show_only_subscribed) { $show_only_subscribed=$show_only_subscribed_folders; } |
fe6efa94 |
866 | |
202bcbcc |
867 | //require_once(SM_PATH . 'include/load_prefs.php'); |
4669e892 |
868 | |
a462b928 |
869 | /** |
870 | * There are three main listing commands we can use in IMAP: |
871 | * LSUB shows just the list of subscribed folders |
872 | * may include flags, but these are not necessarily accurate or authoratative |
92ffe525 |
873 | * \NoSelect has special meaning: the folder does not exist -OR- it means this |
a462b928 |
874 | * folder is not subscribed but children may be |
875 | * [RFC-2060] |
876 | * LIST this shows every mailbox on the system |
877 | * flags are always included and are accurate and authoratative |
878 | * \NoSelect means folder should not be selected |
879 | * [RFC-2060] |
880 | * LIST (SUBSCRIBED) implemented with LIST-SUBSCRIBED extension |
881 | * this is like list but returns only subscribed folders |
882 | * flag meanings are like LIST, not LSUB |
883 | * \NonExistent means mailbox doesn't exist |
884 | * \PlaceHolder means parent is not valid (selectable), but one or more children are |
885 | * \NoSelect indeed means that the folder should not be selected |
886 | * IMAPEXT-LIST-EXTENSIONS-04 August 2003 B. Leiba |
887 | */ |
888 | if (!$show_only_subscribed) { |
889 | $lsub = 'LIST'; |
890 | $sub_cache_name='list_cache'; |
891 | } elseif ($listsubscribed) { |
892 | $lsub = 'LIST (SUBSCRIBED)'; |
893 | $sub_cache_name='listsub_cache'; |
894 | } else { |
895 | $lsub = 'LSUB'; |
896 | $sub_cache_name='lsub_cache'; |
897 | } |
4669e892 |
898 | |
a462b928 |
899 | // Some IMAP servers allow subfolders to exist even if the parent folders do not |
900 | // This fixes some problems with the folder list when this is the case, causing the |
901 | // NoSelect folders to be displayed |
902 | if ($noselect_fix_enable) { |
903 | $lsub_args = "$lsub \"$folder_prefix\" \"*%\""; |
904 | $list_args = "LIST \"$folder_prefix\" \"*%\""; |
905 | } else { |
906 | $lsub_args = "$lsub \"$folder_prefix\" \"*\""; |
907 | $list_args = "LIST \"$folder_prefix\" \"*\""; |
908 | } |
7e235a1a |
909 | |
a462b928 |
910 | // get subscribed mailbox list from cache (session) |
911 | // if not there, then get it from the imap server and store in cache |
7e235a1a |
912 | |
a462b928 |
913 | if (!$force) { |
914 | sqgetGlobalVar($sub_cache_name,$lsub_cache,SQ_SESSION); |
915 | } |
7e235a1a |
916 | |
76682066 |
917 | $lsub_assoc_ary=array(); |
a462b928 |
918 | if (!empty($lsub_cache)) { |
919 | $lsub_assoc_ary=$lsub_cache; |
920 | } else { |
921 | $lsub_ary = sqimap_run_command ($imap_stream, $lsub_args, true, $response, $message); |
922 | $lsub_ary = compact_mailboxes_response($lsub_ary); |
923 | if (!empty($lsub_ary)) { |
924 | foreach ($lsub_ary as $rawline) { |
925 | $temp_mailbox_name=find_mailbox_name($rawline); |
926 | $lsub_assoc_ary[$temp_mailbox_name]=$rawline; |
7e235a1a |
927 | } |
a462b928 |
928 | unset($lsub_ary); |
929 | sqsession_register($lsub_assoc_ary,$sub_cache_name); |
930 | } |
931 | } |
932 | |
933 | // Now to get the mailbox flags |
934 | // The LSUB response may return \NoSelect flags, etc. but it is optional |
935 | // according to RFC3501, and even when returned it may not be accurate |
936 | // or authoratative. LIST will always return accurate results. |
937 | if (($lsub == 'LIST') || ($lsub == 'LIST (SUBSCRIBED)')) { |
938 | // we've already done a LIST or LIST (SUBSCRIBED) |
939 | // and NOT a LSUB, so no need to do it again |
940 | $list_assoc_ary = $lsub_assoc_ary; |
941 | } else { |
92ffe525 |
942 | // we did a LSUB so now we need to do a LIST |
a462b928 |
943 | // first see if it is in cache |
944 | $list_cache_name='list_cache'; |
945 | if (!$force) { |
946 | sqgetGlobalVar($list_cache_name,$list_cache,SQ_SESSION); |
7e235a1a |
947 | } |
a462b928 |
948 | |
949 | if (!empty($list_cache)) { |
950 | $list_assoc_ary=$list_cache; |
951 | // we could store this in list_cache_name but not necessary |
952 | } else { |
953 | // not in cache so we need to go get it from the imap server |
954 | $list_assoc_ary = array(); |
955 | $list_ary = sqimap_run_command($imap_stream, $list_args, |
956 | true, $response, $message); |
957 | $list_ary = compact_mailboxes_response($list_ary); |
958 | if (!empty($list_ary)) { |
959 | foreach ($list_ary as $rawline) { |
960 | $temp_mailbox_name=find_mailbox_name($rawline); |
961 | $list_assoc_ary[$temp_mailbox_name]=$rawline; |
7e235a1a |
962 | } |
a462b928 |
963 | unset($list_ary); |
964 | sqsession_register($list_assoc_ary,$list_cache_name); |
5c300c60 |
965 | } |
966 | } |
a462b928 |
967 | } |
c3ce607e |
968 | |
a462b928 |
969 | // If they aren't subscribed to the inbox, then add it anyway (if its in LIST) |
970 | $inbox_subscribed=false; |
971 | if (!empty($lsub_assoc_ary)) { |
972 | foreach ($lsub_assoc_ary as $temp_mailbox_name=>$rawline) { |
973 | if (strtoupper($temp_mailbox_name) == 'INBOX') { |
974 | $inbox_subscribed=true; |
f8a1ed5a |
975 | } |
c3ce607e |
976 | } |
a462b928 |
977 | } |
978 | if (!$inbox_subscribed) { |
979 | if (!empty($list_assoc_ary)) { |
980 | foreach ($list_assoc_ary as $temp_mailbox_name=>$rawline) { |
981 | if (strtoupper($temp_mailbox_name) == 'INBOX') { |
982 | $lsub_assoc_ary[$temp_mailbox_name]=$rawline; |
983 | } |
984 | } |
985 | } |
986 | } |
f8a1ed5a |
987 | |
a462b928 |
988 | // Now we have the raw output, we need to create an array of mailbox names we will return |
989 | if (!$show_only_subscribed) { |
990 | $final_folders_assoc_ary=$list_assoc_ary; |
991 | } else { |
992 | /** |
993 | * only show subscribed folders |
994 | * we need to merge the folders here... we can't trust the flags, etc. from the lsub_assoc_array |
995 | * so we use the lsub_assoc_array as the list of folders and the values come from list_assoc_array |
996 | */ |
997 | if (!empty($lsub_assoc_ary)) { |
998 | foreach ($lsub_assoc_ary as $temp_mailbox_name=>$rawline) { |
999 | if (!empty($list_assoc_ary[$temp_mailbox_name])) { |
1000 | $final_folders_assoc_ary[$temp_mailbox_name]=$list_assoc_ary[$temp_mailbox_name]; |
1001 | } |
7e235a1a |
1002 | } |
1003 | } |
43b698c7 |
1004 | } |
43b698c7 |
1005 | |
bac13dd7 |
1006 | |
a462b928 |
1007 | // Now produce a flat, sorted list |
1008 | if (!empty($final_folders_assoc_ary)) { |
1009 | uksort($final_folders_assoc_ary,'strnatcasecmp'); |
1010 | foreach ($final_folders_assoc_ary as $temp_mailbox_name=>$rawline) { |
1011 | $final_folders_ary[]=$rawline; |
1012 | } |
1013 | } |
bac13dd7 |
1014 | |
a462b928 |
1015 | // this will put it into an array we can use later |
1016 | // containing: |
1017 | // raw - Raw LIST/LSUB response from the IMAP server |
1018 | // formatted - formatted folder name |
1019 | // unformatted - unformatted, but with the delimiter at the end removed |
1020 | // unformated-dm - folder name as it appears in raw response |
1021 | // unformatted-disp - unformatted without $folder_prefix |
1022 | // id - the array element number (0, 1, 2, etc.) |
1023 | // flags - mailbox flags |
1024 | if (!empty($final_folders_ary)) { |
1025 | $boxesall = sqimap_mailbox_parse($final_folders_ary); |
1026 | } else { |
1027 | // they have no mailboxes |
1028 | $boxesall=array(); |
1029 | } |
90de1755 |
1030 | |
a462b928 |
1031 | /* Now, lets sort for special folders */ |
1032 | $boxesnew = $used = array(); |
90de1755 |
1033 | |
a462b928 |
1034 | /* Find INBOX */ |
1035 | $cnt = count($boxesall); |
1036 | $used = array_pad($used,$cnt,false); |
1037 | $has_inbox = false; |
1038 | for($k = 0; $k < $cnt; ++$k) { |
1039 | if (strtoupper($boxesall[$k]['unformatted']) == 'INBOX') { |
1040 | $boxesnew[] = $boxesall[$k]; |
1041 | $used[$k] = true; |
1042 | $has_inbox = true; |
1043 | break; |
1044 | } |
1045 | } |
92ffe525 |
1046 | |
a462b928 |
1047 | if ($has_inbox == false) { |
1048 | // do a list request for inbox because we should always show |
1049 | // inbox even if the user isn't subscribed to it. |
1050 | $inbox_ary = sqimap_run_command($imap_stream, 'LIST "" "INBOX"', |
1051 | true, $response, $message); |
1052 | $inbox_ary = compact_mailboxes_response($inbox_ary); |
1053 | if (count($inbox_ary)) { |
1054 | $inbox_entry = sqimap_mailbox_parse($inbox_ary); |
1055 | // add it on top of the list |
1056 | if (!empty($boxesnew)) { |
1057 | array_unshift($boxesnew,$inbox_entry[0]); |
90de1755 |
1058 | } else { |
a462b928 |
1059 | $boxesnew[]=$inbox_entry[0]; |
12d61439 |
1060 | } |
a462b928 |
1061 | /* array_unshift($used,true); */ |
780dd344 |
1062 | } |
a462b928 |
1063 | } |
780dd344 |
1064 | |
a462b928 |
1065 | /* List special folders and their subfolders, if requested. */ |
1066 | if ($list_special_folders_first) { |
1067 | for($k = 0; $k < $cnt; ++$k) { |
1068 | if (!$used[$k] && isSpecialMailbox($boxesall[$k]['unformatted'])) { |
1069 | $boxesnew[] = $boxesall[$k]; |
1070 | $used[$k] = true; |
1071 | } |
780dd344 |
1072 | } |
a462b928 |
1073 | } |
1074 | |
1075 | /* Find INBOX's children */ |
1076 | for($k = 0; $k < $cnt; ++$k) { |
1077 | $isboxbelow=isBoxBelow(strtoupper($boxesall[$k]['unformatted']),'INBOX'); |
1078 | if (strtoupper($boxesall[$k]['unformatted']) == 'INBOX') { |
1079 | $is_inbox=1; |
780dd344 |
1080 | } else { |
a462b928 |
1081 | $is_inbox=0; |
1082 | } |
1083 | |
1084 | if (!$used[$k] && $isboxbelow && $is_inbox) { |
1085 | $boxesnew[] = $boxesall[$k]; |
1086 | $used[$k] = true; |
43b698c7 |
1087 | } |
43b698c7 |
1088 | } |
90de1755 |
1089 | |
a462b928 |
1090 | /* Rest of the folders */ |
1091 | for($k = 0; $k < $cnt; $k++) { |
1092 | if (!$used[$k]) { |
1093 | $boxesnew[] = $boxesall[$k]; |
1094 | } |
1095 | } |
1096 | /** |
1097 | * Don't register boxes in session, if $session_register is set to false |
1098 | * Prevents registration of sqimap_mailbox_list_all() results. |
1099 | */ |
1100 | if ($session_register) sqsession_register($boxesnew,'boxesnew'); |
1101 | return $boxesnew; |
43b698c7 |
1102 | } |
5bdd7223 |
1103 | |
3131bc8d |
1104 | /** |
4b2720f5 |
1105 | * Fills mailbox object |
1106 | * |
a462b928 |
1107 | * this is passed the mailbox array by left_main.php |
1108 | * who has previously obtained it from sqimap_get_mailboxes |
1109 | * that way, the raw mailbox list is available in left_main to other |
1110 | * things besides just sqimap_mailbox_tree |
1111 | * imap_stream is just used now to get status info |
1112 | * |
1113 | * most of the functionality is moved to sqimap_get_mailboxes |
1114 | * also takes care of TODO items: |
1115 | * caching mailbox tree |
1116 | * config setting for UW imap section (not needed now) |
1117 | * |
4b2720f5 |
1118 | * Some code fragments are present in 1.3.0 - 1.4.4. |
3131bc8d |
1119 | * @param stream $imap_stream imap connection resource |
a462b928 |
1120 | * @param array $lsub_ary output array from sqimap_get_mailboxes (contains mailboxes and flags) |
3131bc8d |
1121 | * @return object see mailboxes class. |
4b2720f5 |
1122 | * @since 1.5.0 |
3131bc8d |
1123 | */ |
a462b928 |
1124 | function sqimap_mailbox_tree($imap_stream,$lsub_ary) { |
bac13dd7 |
1125 | |
4b2720f5 |
1126 | $sorted_lsub_ary = array(); |
1127 | $cnt = count($lsub_ary); |
1128 | for ($i = 0; $i < $cnt; $i++) { |
a462b928 |
1129 | $mbx=$lsub_ary[$i]['unformatted']; |
1130 | $flags=$lsub_ary[$i]['flags']; |
1131 | |
1132 | $noinferiors=0; |
1133 | if (in_array('\Noinferiors',$flags)) { $noinferiors=1; } |
1134 | if (in_array('\NoInferiors',$flags)) { $noinferiors=1; } |
1135 | if (in_array('\HasNoChildren',$flags)) { $noinferiors=1; } |
1136 | |
1137 | $noselect=0; |
92ffe525 |
1138 | if (in_array('\NoSelect',$flags)) { $noselect=1; } |
a462b928 |
1139 | /** |
1140 | * LIST (SUBSCRIBED) has two new flags, \NonExistent which means the mailbox is subscribed to |
1141 | * but doesn't exist, and \PlaceHolder which is similar (but not the same) as \NoSelect |
1142 | * For right now, we'll treat these the same as \NoSelect and this behavior can be changed |
1143 | * later if needed |
1144 | */ |
92ffe525 |
1145 | if (in_array('\NonExistent',$flags)) { $noselect=1; } |
a462b928 |
1146 | if (in_array('\PlaceHolder',$flags)) { $noselect=1; } |
4b2720f5 |
1147 | $sorted_lsub_ary[] = array ('mbx' => $mbx, 'noselect' => $noselect, 'noinferiors' => $noinferiors); |
1148 | } |
a462b928 |
1149 | |
4b2720f5 |
1150 | $sorted_lsub_ary = array_values($sorted_lsub_ary); |
1151 | usort($sorted_lsub_ary, 'mbxSort'); |
1152 | $boxestree = sqimap_fill_mailbox_tree($sorted_lsub_ary,false,$imap_stream); |
1153 | return $boxestree; |
60b5724d |
1154 | } |
1155 | |
3131bc8d |
1156 | /** |
1157 | * Callback function used for sorting mailboxes in sqimap_mailbox_tree |
1158 | * @param string $a |
1159 | * @param string $b |
1160 | * @return integer see php strnatcasecmp() |
1161 | * @since 1.5.1 |
1162 | */ |
9d8d1ebd |
1163 | function mbxSort($a, $b) { |
1164 | return strnatcasecmp($a['mbx'], $b['mbx']); |
1165 | } |
1166 | |
3131bc8d |
1167 | /** |
4b2720f5 |
1168 | * Fills mailbox object |
1169 | * |
1170 | * Some code fragments are present in 1.3.0 - 1.4.4. |
3131bc8d |
1171 | * @param array $mbx_ary |
1172 | * @param $mbxs |
4b2720f5 |
1173 | * @param stream $imap_stream imap connection resource |
3131bc8d |
1174 | * @return object see mailboxes class |
4b2720f5 |
1175 | * @since 1.5.0 |
3131bc8d |
1176 | */ |
483f9ef9 |
1177 | function sqimap_fill_mailbox_tree($mbx_ary, $mbxs=false,$imap_stream) { |
60b5724d |
1178 | global $data_dir, $username, $list_special_folders_first, |
1179 | $folder_prefix, $trash_folder, $sent_folder, $draft_folder, |
1180 | $move_to_trash, $move_to_sent, $save_as_draft, |
43a31298 |
1181 | $delimiter, $imap_server_type; |
60b5724d |
1182 | |
8d8da447 |
1183 | // $special_folders = array ('INBOX', $sent_folder, $draft_folder, $trash_folder); |
ff245fbd |
1184 | |
60b5724d |
1185 | /* create virtual root node */ |
1186 | $mailboxes= new mailboxes(); |
1187 | $mailboxes->is_root = true; |
ff245fbd |
1188 | $trail_del = false; |
78bc908d |
1189 | $start = 0; |
1190 | |
43a31298 |
1191 | if (isset($folder_prefix) && ($folder_prefix != '')) { |
ff245fbd |
1192 | $start = substr_count($folder_prefix,$delimiter); |
1193 | if (strrpos($folder_prefix, $delimiter) == (strlen($folder_prefix)-1)) { |
ff245fbd |
1194 | $mailboxes->mailboxname_full = substr($folder_prefix,0, (strlen($folder_prefix)-1)); |
1195 | } else { |
1196 | $mailboxes->mailboxname_full = $folder_prefix; |
1197 | $start++; |
1198 | } |
1199 | $mailboxes->mailboxname_sub = $mailboxes->mailboxname_full; |
1200 | } else { |
1201 | $start = 0; |
1202 | } |
78bc908d |
1203 | |
9d8d1ebd |
1204 | $cnt = count($mbx_ary); |
e4c6fe41 |
1205 | for ($i=0; $i < $cnt; $i++) { |
ff245fbd |
1206 | if ($mbx_ary[$i]['mbx'] !='' ) { |
1207 | $mbx = new mailboxes(); |
1208 | $mailbox = $mbx_ary[$i]['mbx']; |
cc82c2b7 |
1209 | |
4669e892 |
1210 | /* |
ae9e2adc |
1211 | * Set the is_special flag if it concerned a special mailbox. |
1212 | * Used for displaying the special folders on top in the mailbox |
1213 | * tree displaying code. |
1214 | */ |
8edc9f31 |
1215 | $mbx->is_special |= ($mbx->is_inbox = (strtoupper($mailbox) == 'INBOX')); |
1216 | $mbx->is_special |= ($mbx->is_trash = isTrashMailbox($mailbox)); |
1217 | $mbx->is_special |= ($mbx->is_sent = isSentMailbox($mailbox)); |
1218 | $mbx->is_special |= ($mbx->is_draft = isDraftMailbox($mailbox)); |
ae9e2adc |
1219 | |
8edc9f31 |
1220 | if (!$mbx->is_special) |
fda01075 |
1221 | $mbx->is_special = boolean_hook_function('special_mailbox', $mailbox, 1); |
4669e892 |
1222 | |
ff245fbd |
1223 | if (isset($mbx_ary[$i]['unseen'])) { |
1224 | $mbx->unseen = $mbx_ary[$i]['unseen']; |
1225 | } |
1226 | if (isset($mbx_ary[$i]['nummessages'])) { |
1227 | $mbx->total = $mbx_ary[$i]['nummessages']; |
1228 | } |
1229 | |
1230 | $mbx->is_noselect = $mbx_ary[$i]['noselect']; |
86c2763d |
1231 | $mbx->is_noinferiors = $mbx_ary[$i]['noinferiors']; |
ff245fbd |
1232 | |
60b5724d |
1233 | $r_del_pos = strrpos($mbx_ary[$i]['mbx'], $delimiter); |
ff245fbd |
1234 | if ($r_del_pos) { |
587ec647 |
1235 | $mbx->mailboxname_sub = substr($mbx_ary[$i]['mbx'],$r_del_pos+1); |
ff245fbd |
1236 | } else { /* mailbox is root folder */ |
587ec647 |
1237 | $mbx->mailboxname_sub = $mbx_ary[$i]['mbx']; |
ff245fbd |
1238 | } |
1239 | $mbx->mailboxname_full = $mbx_ary[$i]['mbx']; |
38068e69 |
1240 | |
9871bdaa |
1241 | $mailboxes->addMbx($mbx, $delimiter, $start, $list_special_folders_first); |
ff245fbd |
1242 | } |
60b5724d |
1243 | } |
587ec647 |
1244 | sqimap_utf7_decode_mbx_tree($mailboxes); |
483f9ef9 |
1245 | sqimap_get_status_mbx_tree($imap_stream,$mailboxes); |
60b5724d |
1246 | return $mailboxes; |
1247 | } |
259faa39 |
1248 | |
3131bc8d |
1249 | /** |
1250 | * @param object $mbx_tree |
1251 | * @since 1.5.0 |
1252 | */ |
587ec647 |
1253 | function sqimap_utf7_decode_mbx_tree(&$mbx_tree) { |
3d548be7 |
1254 | global $draft_folder, $sent_folder, $trash_folder, $translate_special_folders; |
1255 | |
1256 | /* decode folder name and set mailboxname_sub */ |
1257 | if ($translate_special_folders && strtoupper($mbx_tree->mailboxname_full) == 'INBOX') { |
1258 | $mbx_tree->mailboxname_sub = _("INBOX"); |
1259 | } elseif ($translate_special_folders && $mbx_tree->mailboxname_full == $draft_folder) { |
1260 | $mbx_tree->mailboxname_sub = _("Drafts"); |
1261 | } elseif ($translate_special_folders && $mbx_tree->mailboxname_full == $sent_folder) { |
1262 | $mbx_tree->mailboxname_sub = _("Sent"); |
1263 | } elseif ($translate_special_folders && $mbx_tree->mailboxname_full == $trash_folder) { |
1264 | $mbx_tree->mailboxname_sub = _("Trash"); |
1265 | } else { |
1266 | $mbx_tree->mailboxname_sub = imap_utf7_decode_local($mbx_tree->mailboxname_sub); |
1267 | } |
9e0f10a8 |
1268 | |
3d548be7 |
1269 | if ($mbx_tree->mbxs) { |
1270 | $iCnt = count($mbx_tree->mbxs); |
1271 | for ($i=0;$i<$iCnt;++$i) { |
9e0f10a8 |
1272 | sqimap_utf7_decode_mbx_tree($mbx_tree->mbxs[$i]); |
3d548be7 |
1273 | } |
1274 | } |
483f9ef9 |
1275 | } |
1276 | |
3131bc8d |
1277 | /** |
1278 | * @param object $mbx_tree |
1279 | * @param array $aMbxs |
1280 | * @since 1.5.0 |
1281 | */ |
483f9ef9 |
1282 | function sqimap_tree_to_ref_array(&$mbx_tree,&$aMbxs) { |
5c300c60 |
1283 | if ($mbx_tree) |
483f9ef9 |
1284 | $aMbxs[] =& $mbx_tree; |
1285 | if ($mbx_tree->mbxs) { |
1286 | $iCnt = count($mbx_tree->mbxs); |
1287 | for ($i=0;$i<$iCnt;++$i) { |
5c300c60 |
1288 | sqimap_tree_to_ref_array($mbx_tree->mbxs[$i],$aMbxs); |
483f9ef9 |
1289 | } |
1290 | } |
4669e892 |
1291 | } |
483f9ef9 |
1292 | |
3131bc8d |
1293 | /** |
1294 | * @param stream $imap_stream imap connection resource |
1295 | * @param object $mbx_tree |
1296 | * @since since 1.5.0 |
1297 | */ |
483f9ef9 |
1298 | function sqimap_get_status_mbx_tree($imap_stream,&$mbx_tree) { |
1299 | global $unseen_notify, $unseen_type, $trash_folder,$move_to_trash; |
8d8da447 |
1300 | $aMbxs = $aQuery = array(); |
483f9ef9 |
1301 | sqimap_tree_to_ref_array($mbx_tree,$aMbxs); |
1302 | // remove the root node |
1303 | array_shift($aMbxs); |
1304 | |
1305 | if($unseen_notify == 3) { |
1306 | $cnt = count($aMbxs); |
1307 | for($i=0;$i<$cnt;++$i) { |
5c300c60 |
1308 | $oMbx =& $aMbxs[$i]; |
1309 | if (!$oMbx->is_noselect) { |
483f9ef9 |
1310 | $mbx = $oMbx->mailboxname_full; |
5c300c60 |
1311 | if ($unseen_type == 2 || |
1312 | ($move_to_trash && $oMbx->mailboxname_full == $trash_folder)) { |
48879ef0 |
1313 | $query = 'STATUS ' . sqimap_encode_mailbox_name($mbx) . ' (MESSAGES UNSEEN RECENT)'; |
5c300c60 |
1314 | } else { |
48879ef0 |
1315 | $query = 'STATUS ' . sqimap_encode_mailbox_name($mbx) . ' (UNSEEN RECENT)'; |
5c300c60 |
1316 | } |
483f9ef9 |
1317 | sqimap_prepare_pipelined_query($query,$tag,$aQuery,false); |
5c300c60 |
1318 | } else { |
48879ef0 |
1319 | $oMbx->unseen = $oMbx->total = $oMbx->recent = false; |
5c300c60 |
1320 | $tag = false; |
1321 | } |
1322 | $oMbx->tag = $tag; |
1323 | $aMbxs[$i] =& $oMbx; |
483f9ef9 |
1324 | } |
1325 | // execute all the queries at once |
1326 | $aResponse = sqimap_run_pipelined_command ($imap_stream, $aQuery, false, $aServerResponse, $aServerMessage); |
1327 | $cnt = count($aMbxs); |
1328 | for($i=0;$i<$cnt;++$i) { |
5c300c60 |
1329 | $oMbx =& $aMbxs[$i]; |
1330 | $tag = $oMbx->tag; |
1331 | if ($tag && $aServerResponse[$tag] == 'OK') { |
1332 | $sResponse = implode('', $aResponse[$tag]); |
483f9ef9 |
1333 | if (preg_match('/UNSEEN\s+([0-9]+)/i', $sResponse, $regs)) { |
1334 | $oMbx->unseen = $regs[1]; |
1335 | } |
1336 | if (preg_match('/MESSAGES\s+([0-9]+)/i', $sResponse, $regs)) { |
1337 | $oMbx->total = $regs[1]; |
5c300c60 |
1338 | } |
48879ef0 |
1339 | if (preg_match('/RECENT\s+([0-9]+)/i', $sResponse, $regs)) { |
1340 | $oMbx->recent = $regs[1]; |
1341 | } |
1342 | |
5c300c60 |
1343 | } |
1344 | unset($oMbx->tag); |
1345 | } |
483f9ef9 |
1346 | } else if ($unseen_notify == 2) { // INBOX only |
1347 | $cnt = count($aMbxs); |
1348 | for($i=0;$i<$cnt;++$i) { |
5c300c60 |
1349 | $oMbx =& $aMbxs[$i]; |
1350 | if (strtoupper($oMbx->mailboxname_full) == 'INBOX' || |
1351 | ($move_to_trash && $oMbx->mailboxname_full == $trash_folder)) { |
4669e892 |
1352 | if ($unseen_type == 2 || |
5c300c60 |
1353 | ($oMbx->mailboxname_full == $trash_folder && $move_to_trash)) { |
1354 | $aStatus = sqimap_status_messages($imap_stream,$oMbx->mailboxname_full); |
1355 | $oMbx->unseen = $aStatus['UNSEEN']; |
1356 | $oMbx->total = $aStatus['MESSAGES']; |
48879ef0 |
1357 | $oMbx->recent = $aStatus['RECENT']; |
5c300c60 |
1358 | } else { |
1359 | $oMbx->unseen = sqimap_unseen_messages($imap_stream,$oMbx->mailboxname_full); |
1360 | } |
1361 | $aMbxs[$i] =& $oMbx; |
1362 | if (!$move_to_trash && $trash_folder) { |
1363 | break; |
1364 | } else { |
1365 | // trash comes after INBOX |
1366 | if ($oMbx->mailboxname_full == $trash_folder) { |
1367 | break; |
1368 | } |
1369 | } |
1370 | } |
1371 | } |
4669e892 |
1372 | } |
48879ef0 |
1373 | |
1374 | $cnt = count($aMbxs); |
1375 | for($i=0;$i<$cnt;++$i) { |
1376 | $oMbx =& $aMbxs[$i]; |
1377 | unset($hook_status); |
1378 | if (!empty($oMbx->unseen)) { $hook_status['UNSEEN']=$oMbx->unseen; } |
1379 | if (!empty($oMbx->total)) { $hook_status['MESSAGES']=$oMbx->total; } |
1380 | if (!empty($oMbx->recent)) { $hook_status['RECENT']=$oMbx->recent; } |
1381 | if (!empty($hook_status)) |
1382 | { |
1383 | $hook_status['MAILBOX']=$oMbx->mailboxname_full; |
1384 | $hook_status['CALLER']='sqimap_get_status_mbx_tree'; // helps w/ debugging |
d849b570 |
1385 | do_hook('folder_status', $hook_status); |
48879ef0 |
1386 | } |
1387 | } |
4669e892 |
1388 | } |
587ec647 |
1389 | |
367fb0ca |
1390 | /** |
1391 | * Checks if folder is noselect (can't store messages) |
1392 | * |
1393 | * Function does not check if folder subscribed. |
1394 | * @param stream $oImapStream imap connection resource |
1395 | * @param string $sImapFolder imap folder name |
1396 | * @param object $oBoxes mailboxes class object. |
1397 | * @return boolean true, when folder has noselect flag. false in any other case. |
1398 | * @since 1.5.1 |
1399 | */ |
1400 | function sqimap_mailbox_is_noselect($oImapStream,$sImapFolder,&$oBoxes) { |
1401 | // build mailbox object if it is not available |
1402 | if (! is_object($oBoxes)) $oBoxes=sqimap_mailbox_list($oImapStream); |
1403 | foreach($oBoxes as $box) { |
1404 | if ($box['unformatted']==$sImapFolder) { |
1405 | return (bool) check_is_noselect($box['raw']); |
1406 | } |
1407 | } |
1408 | return false; |
1409 | } |
1410 | |
1411 | /** |
1412 | * Checks if folder is noinferiors (can't store other folders) |
1413 | * |
1414 | * Function does not check if folder subscribed. |
1415 | * @param stream $oImapStream imap connection resource |
1416 | * @param string $sImapFolder imap folder name |
1417 | * @param object $oBoxes mailboxes class object. |
1418 | * @return boolean true, when folder has noinferiors flag. false in any other case. |
1419 | * @since 1.5.1 |
1420 | */ |
1421 | function sqimap_mailbox_is_noinferiors($oImapStream,$sImapFolder,&$oBoxes) { |
1422 | // build mailbox object if it is not available |
1423 | if (! is_object($oBoxes)) $oBoxes=sqimap_mailbox_list($oImapStream); |
1424 | foreach($oBoxes as $box) { |
1425 | if ($box['unformatted']==$sImapFolder) { |
1426 | return (bool) check_is_noinferiors($box['raw']); |
1427 | } |
1428 | } |
1429 | return false; |
1430 | } |