5 ** This impliments all functions that manipulate mailboxes
10 if (defined ('imap_mailbox_php'))
12 define ('imap_mailbox_php', true);
14 /******************************************************************************
16 ******************************************************************************/
17 function sqimap_mailbox_expunge ($imap_stream, $mailbox,$handle_errors = true) {
18 fputs ($imap_stream, sqimap_session_id() . " EXPUNGE\r\n");
19 $read = sqimap_read_data($imap_stream, sqimap_session_id(), $handle_errors, $response, $message);
23 /******************************************************************************
24 ** Checks whether or not the specified mailbox exists
25 ******************************************************************************/
26 function sqimap_mailbox_exists ($imap_stream, $mailbox) {
27 if (! isset($mailbox))
29 fputs ($imap_stream, sqimap_session_id() . " LIST \"\" \"$mailbox\"\r\n");
30 $mbx = sqimap_read_data($imap_stream, sqimap_session_id(), true, $response, $message);
31 return isset($mbx[0]);
34 /******************************************************************************
36 ******************************************************************************/
37 function sqimap_mailbox_select ($imap_stream, $mailbox, $hide=true, $recent=false) {
40 if( $mailbox == _("None") )
43 fputs ($imap_stream, sqimap_session_id() . " SELECT \"$mailbox\"\r\n");
44 $read = sqimap_read_data($imap_stream, sqimap_session_id(), true, $response, $message);
46 for ($i=0; $i<count($read); $i++
) {
47 if (strpos(strtolower($read[$i]), "recent")) {
48 $r = explode(" ", $read[$i]);
54 fputs ($imap_stream, sqimap_session_id() . " EXPUNGE\r\n");
55 $tmp = sqimap_read_data($imap_stream, sqimap_session_id(), false, $a, $b);
61 /******************************************************************************
63 ******************************************************************************/
64 function sqimap_mailbox_create ($imap_stream, $mailbox, $type) {
65 if (strtolower($type) == "noselect") {
66 $dm = sqimap_get_delimiter($imap_stream);
67 $mailbox = $mailbox.$dm;
69 fputs ($imap_stream, sqimap_session_id() . " CREATE \"$mailbox\"\r\n");
70 $read_ary = sqimap_read_data($imap_stream, sqimap_session_id(), true, $response, $message);
72 sqimap_subscribe ($imap_stream, $mailbox);
77 /******************************************************************************
78 ** Subscribes to an existing folder
79 ******************************************************************************/
80 function sqimap_subscribe ($imap_stream, $mailbox) {
81 fputs ($imap_stream, sqimap_session_id() . " SUBSCRIBE \"$mailbox\"\r\n");
82 $read_ary = sqimap_read_data($imap_stream, sqimap_session_id(), true, $response, $message);
88 /******************************************************************************
89 ** Unsubscribes to an existing folder
90 ******************************************************************************/
91 function sqimap_unsubscribe ($imap_stream, $mailbox) {
92 global $imap_server_type;
94 fputs ($imap_stream, sqimap_session_id() . " UNSUBSCRIBE \"$mailbox\"\r\n");
95 $read_ary = sqimap_read_data($imap_stream, sqimap_session_id(), true, $response, $message);
101 /******************************************************************************
102 ** This function simply deletes the given folder
103 ******************************************************************************/
104 function sqimap_mailbox_delete ($imap_stream, $mailbox) {
105 fputs ($imap_stream, sqimap_session_id() . " DELETE \"$mailbox\"\r\n");
106 $read_ary = sqimap_read_data($imap_stream, sqimap_session_id(), true, $response, $message);
107 sqimap_unsubscribe ($imap_stream, $mailbox);
110 /***********************************************************************
111 ** Determines if the user is subscribed to the folder or not
112 **********************************************************************/
113 function sqimap_mailbox_is_subscribed($imap_stream, $folder) {
114 $boxes = sqimap_mailbox_list ($imap_stream);
115 foreach ($boxes as $ref) {
116 if ($ref['unformatted'] == $folder)
124 /******************************************************************************
125 ** Formats a mailbox into 4 parts for the $boxes array
127 ** The four parts are:
129 ** raw - Raw LIST/LSUB response from the IMAP server
130 ** formatted - nicely formatted folder name
131 ** unformatted - unformatted, but with delimiter at end removed
132 ** unformatted-dm - folder name as it appears in raw response
133 ** unformatted-disp - unformatted without $folder_prefix
135 ******************************************************************************/
136 function sqimap_mailbox_parse ($line, $line_lsub, $dm) {
137 global $folder_prefix;
139 // Process each folder line
140 for ($g=0; $g < count($line); $g++
) {
142 // Store the raw IMAP reply
143 if (isset($line[$g]))
144 $boxes[$g]["raw"] = $line[$g];
146 $boxes[$g]["raw"] = "";
149 // Count number of delimiters ($dm) in folder name
150 $mailbox = trim($line_lsub[$g]);
151 $dm_count = countCharInString($mailbox, $dm);
152 if (substr($mailbox, -1) == $dm)
153 $dm_count--; // If name ends in delimiter - decrement count by one
155 // Format folder name, but only if it's a INBOX.* or have
157 $boxesbyname[$mailbox] = $g;
158 $parentfolder = readMailboxParent($mailbox, $dm);
159 if((strtolower(substr($mailbox, 0, 5)) == "inbox") ||
160 (substr($mailbox, 0, strlen($folder_prefix)) == $folder_prefix) ||
161 (isset($boxesbyname[$parentfolder]) && (strlen($parentfolder) > 0) ) ) {
162 $indent = $dm_count - (countCharInString($folder_prefix, $dm));
164 $boxes[$g]["formatted"] = str_repeat(" ", $indent);
166 $boxes[$g]["formatted"] = '';
167 $boxes[$g]["formatted"] .= readShortMailboxName($mailbox, $dm);
169 $boxes[$g]["formatted"] = $mailbox;
172 $boxes[$g]['unformatted-dm'] = $mailbox;
173 if (substr($mailbox, -1) == $dm)
174 $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
175 $boxes[$g]['unformatted'] = $mailbox;
176 if (substr($mailbox,0,strlen($folder_prefix))==$folder_prefix)
177 $mailbox = substr($mailbox, strlen($folder_prefix));
178 $boxes[$g]['unformatted-disp'] = $mailbox;
179 $boxes[$g]['id'] = $g;
181 $boxes[$g]['flags'] = array();
182 if (isset($line[$g])) {
183 ereg("\(([^)]*)\)",$line[$g],$regs);
184 $flags = trim(strtolower(str_replace('\\', '',$regs[1])));
186 $boxes[$g]['flags'] = explode(' ', $flags);
193 /* Apparently you must call a user function with usort instead
194 * of calling a built-in directly. Stupid.
195 * Patch from dave_michmerhuizen@yahoo.com
196 * Allows case insensitivity when sorting folders
198 function user_strcasecmp($a, $b)
200 return strcasecmp($a, $b);
204 /******************************************************************************
205 ** Returns sorted mailbox lists in several different ways.
206 ** See comment on sqimap_mailbox_parse() for info about the returned array.
207 ******************************************************************************/
208 function sqimap_mailbox_list ($imap_stream) {
209 global $data_dir, $username, $list_special_folders_first;
210 global $folder_prefix, $trash_folder, $sent_folder, $draft_folder;
211 global $move_to_trash, $move_to_sent, $save_as_draft;
213 $inbox_in_list = false;
214 $inbox_subscribed = false;
216 require_once('../src/load_prefs.php');
217 require_once('../functions/array.php');
219 $dm = sqimap_get_delimiter ($imap_stream);
222 fputs ($imap_stream, sqimap_session_id() . " LSUB \"$folder_prefix\" \"*\"\r\n");
223 $lsub_ary = sqimap_read_data ($imap_stream, sqimap_session_id(), true, $response, $message);
225 // Section about removing the last element was removed
226 // We don't return "* OK" anymore from sqimap_read_data
228 $sorted_lsub_ary = array();
229 for ($i=0;$i < count($lsub_ary); $i++
) {
230 // Workaround for EIMS
231 // Doesn't work if the mailbox name is multiple lines
232 if (isset($lsub_ary[$i +
1]) &&
233 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
234 $lsub_ary[$i], $regs)) {
236 $lsub_ary[$i] = $regs[1] . '"' . addslashes(trim($lsub_ary[$i])) .
239 $temp_mailbox_name = find_mailbox_name($lsub_ary[$i]);
240 $sorted_lsub_ary[] = $temp_mailbox_name;
241 if (strtoupper($temp_mailbox_name) == 'INBOX')
242 $inbox_subscribed = true;
245 for ($i=0; $i < count($sorted_lsub_ary); $i++
) {
246 if (!in_array($sorted_lsub_ary[$i], $new_ary)) {
247 $new_ary[] = $sorted_lsub_ary[$i];
250 $sorted_lsub_ary = $new_ary;
251 if (isset($sorted_lsub_ary)) {
252 usort($sorted_lsub_ary, 'user_strcasecmp');
253 //sort($sorted_lsub_ary);
257 $sorted_list_ary = array();
258 for ($i=0; $i < count($sorted_lsub_ary); $i++
) {
259 if (substr($sorted_lsub_ary[$i], -1) == $dm)
260 $mbx = substr($sorted_lsub_ary[$i], 0, strlen($sorted_lsub_ary[$i])-1);
262 $mbx = $sorted_lsub_ary[$i];
264 fputs ($imap_stream, sqimap_session_id() . " LIST \"\" \"$mbx\"\r\n");
265 $read = sqimap_read_data ($imap_stream, sqimap_session_id(), true, $response, $message);
266 // Another workaround for EIMS
267 if (isset($read[1]) &&
268 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
270 $read[0] = $regs[1] . '"' . addslashes(trim($read[1])) .
273 if (isset($sorted_list_ary[$i]))
274 $sorted_list_ary[$i] = "";
276 $sorted_list_ary[$i] = $read[0];
278 $sorted_list_ary[$i] = "";
279 if (isset($sorted_list_ary[$i]) &&
280 strtoupper(find_mailbox_name($sorted_list_ary[$i])) == "INBOX")
281 $inbox_in_list = true;
285 * Just in case they're not subscribed to their inbox,
286 * we'll get it for them anyway
288 if ($inbox_subscribed == false ||
$inbox_in_list == false) {
289 fputs ($imap_stream, sqimap_session_id() . " LIST \"\" \"INBOX\"\r\n");
290 $inbox_ary = sqimap_read_data ($imap_stream, sqimap_session_id(), true, $response, $message);
291 // Another workaround for EIMS
292 if (isset($inbox_ary[1]) &&
293 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
294 $inbox_ary[0], $regs)) {
295 $inbox_ary[0] = $regs[1] . '"' . addslashes(trim($inbox_ary[1])) .
299 $sorted_list_ary[] = $inbox_ary[0];
300 $sorted_lsub_ary[] = find_mailbox_name($inbox_ary[0]);
303 $boxes = sqimap_mailbox_parse ($sorted_list_ary, $sorted_lsub_ary, $dm);
305 /** Now, lets sort for special folders **/
309 for ($i = 0; $i < count($boxes); $i++
) {
310 if (strtolower($boxes[$i]["unformatted"]) == "inbox") {
311 $boxesnew[] = $boxes[$i];
317 /* List special folders and their subfolders, if requested. */
318 if ($list_special_folders_first == true) {
319 /* First list the trash folder. */
320 for ($i = 0 ; $i < count($boxes) ; $i++
) {
321 if ($move_to_trash &&
322 eregi('^' . quotemeta($trash_folder) . '(' .
323 quotemeta($dm) . '.*)?$', $boxes[$i]['unformatted'])) {
324 $boxesnew[] = $boxes[$i];
329 /* Then list the sent folder. */
330 for ($i = 0 ; $i < count($boxes) ; $i++
) {
332 eregi('^' . quotemeta($sent_folder) . '(' .
333 quotemeta($dm) . '.*)?$', $boxes[$i]['unformatted'])) {
334 $boxesnew[] = $boxes[$i];
339 /* Lastly, list the list the draft folder. */
340 for ($i = 0 ; $i < count($boxes) ; $i++
) {
341 if ($save_as_draft &&
342 eregi('^' . quotemeta($draft_folder) . '(' .
343 quotemeta($dm) . '.*)?$', $boxes[$i]['unformatted'])) {
344 $boxesnew[] = $boxes[$i];
349 /* Put INBOX.* folders ahead of the rest. */
350 for ($i = 0; $i < count($boxes); $i++
) {
351 if (eregi('^inbox\\.', $boxes[$i]["unformatted"]) &&
352 (!isset($used[$i]) ||
$used[$i] == false)) {
353 $boxesnew[] = $boxes[$i];
359 // Rest of the folders
360 for ($i = 0; $i < count($boxes); $i++
) {
361 if ((strtolower($boxes[$i]["unformatted"]) != "inbox") &&
362 (!isset($used[$i]) ||
$used[$i] == false)) {
363 $boxesnew[] = $boxes[$i];
371 /******************************************************************************
372 ** Returns a list of all folders, subscribed or not
373 ******************************************************************************/
374 function sqimap_mailbox_list_all ($imap_stream) {
375 global $list_special_folders_first, $folder_prefix;
377 if (!function_exists ("ary_sort"))
378 include_once('../functions/array.php');
380 $dm = sqimap_get_delimiter ($imap_stream);
382 $ssid = sqimap_session_id();
383 $lsid = strlen( $ssid );
384 fputs ($imap_stream, $ssid . " LIST \"$folder_prefix\" *\r\n");
385 $read_ary = sqimap_read_data ($imap_stream, $ssid, true, $response, $message);
389 for ($i = 0; $i < count($read_ary); $i++
) {
390 // Another workaround for EIMS
391 if (isset($read_ary[$i +
1]) &&
392 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
393 $read_ary[$i], $regs)) {
395 $read_ary[$i] = $regs[1] . '"' .
396 addslashes(trim($read_ary[$i])) .
399 if (substr ($read_ary[$i], 0, $lsid) != $ssid ) {
401 // Store the raw IMAP reply
402 $boxes[$g]["raw"] = $read_ary[$i];
404 // Count number of delimiters ($dm) in folder name
405 $mailbox = find_mailbox_name($read_ary[$i]);
406 $dm_count = countCharInString($mailbox, $dm);
407 if (substr($mailbox, -1) == $dm)
408 $dm_count--; // If name ends in delimiter - decrement count by one
410 // Format folder name, but only if it's a INBOX.* or have
412 $boxesbyname[$mailbox] = $g;
413 $parentfolder = readMailboxParent($mailbox, $dm);
414 if((eregi('^inbox'.quotemeta($dm), $mailbox)) ||
415 (ereg('^'.$folder_prefix, $mailbox)) ||
416 ( isset($boxesbyname[$parentfolder]) && (strlen($parentfolder) > 0) ) ) {
418 $boxes[$g]["formatted"] = str_repeat(" ", $dm_count);
420 $boxes[$g]["formatted"] = '';
421 $boxes[$g]["formatted"] .= readShortMailboxName($mailbox, $dm);
423 $boxes[$g]["formatted"] = $mailbox;
426 $boxes[$g]["unformatted-dm"] = $mailbox;
427 if (substr($mailbox, -1) == $dm)
428 $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
429 $boxes[$g]["unformatted"] = $mailbox;
430 $boxes[$g]["unformatted-disp"] = ereg_replace('^' . $folder_prefix, '', $mailbox);
431 $boxes[$g]["id"] = $g;
433 /** Now lets get the flags for this mailbox **/
434 fputs ($imap_stream, sqimap_session_id() . " LIST \"\" \"$mailbox\"\r\n");
435 $read_mlbx = sqimap_read_data ($imap_stream, sqimap_session_id(), true, $response, $message);
437 // Another workaround for EIMS
438 if (isset($read_mlbx[1]) &&
439 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
440 $read_mlbx[0], $regs)) {
441 $read_mlbx[0] = $regs[1] . '"' .
442 addslashes(trim($read_mlbx[1])) .
446 $flags = substr($read_mlbx[0], strpos($read_mlbx[0], "(")+
1);
447 $flags = substr($flags, 0, strpos($flags, ")"));
448 $flags = str_replace('\\', '', $flags);
449 $flags = trim(strtolower($flags));
451 $boxes[$g]['flags'] = explode(" ", $flags);
455 $boxes[$g]['flags'] = array();
460 if(is_array($boxes)) {
461 $boxes = ary_sort ($boxes, "unformatted", 1);