5 ** This impliments all functions that manipulate mailboxes
10 /******************************************************************************
12 ******************************************************************************/
13 function sqimap_mailbox_expunge ($imap_stream, $mailbox,$handle_errors = true) {
14 sqimap_mailbox_select ($imap_stream, $mailbox);
15 fputs ($imap_stream, "a001 EXPUNGE\r\n");
16 $read = sqimap_read_data($imap_stream, "a001", $handle_errors, $response, $message);
20 /******************************************************************************
21 ** Checks whether or not the specified mailbox exists
22 ******************************************************************************/
23 function sqimap_mailbox_exists ($imap_stream, $mailbox) {
24 fputs ($imap_stream, "a001 LIST \"\" \"$mailbox\"\r\n");
25 $mbx = sqimap_read_data($imap_stream, "a001", true, $response, $message);
27 return !!(ereg ("$mailbox", $mbx[0])); // To force into true/false
31 /******************************************************************************
33 ******************************************************************************/
34 function sqimap_mailbox_select ($imap_stream, $mailbox, $hide=true, $recent=false) {
37 fputs ($imap_stream, "a001 SELECT \"$mailbox\"\r\n");
38 $read = sqimap_read_data($imap_stream, "a001", true, $response, $message);
40 for ($i=0; $i<count($read); $i++
) {
41 if (strpos(strtolower($read[$i]), "recent")) {
42 $r = explode(" ", $read[$i]);
48 fputs ($imap_stream, "a001 EXPUNGE\r\n");
49 $tmp = sqimap_read_data($imap_stream, "a001", false, $a, $b);
55 /******************************************************************************
57 ******************************************************************************/
58 function sqimap_mailbox_create ($imap_stream, $mailbox, $type) {
59 if (strtolower($type) == "noselect") {
60 $dm = sqimap_get_delimiter($imap_stream);
61 $mailbox = $mailbox.$dm;
63 fputs ($imap_stream, "a001 CREATE \"$mailbox\"\r\n");
64 $read_ary = sqimap_read_data($imap_stream, "a001", true, $response, $message);
66 sqimap_subscribe ($imap_stream, $mailbox);
71 /******************************************************************************
72 ** Subscribes to an existing folder
73 ******************************************************************************/
74 function sqimap_subscribe ($imap_stream, $mailbox) {
75 fputs ($imap_stream, "a001 SUBSCRIBE \"$mailbox\"\r\n");
76 $read_ary = sqimap_read_data($imap_stream, "a001", true, $response, $message);
82 /******************************************************************************
83 ** Unsubscribes to an existing folder
84 ******************************************************************************/
85 function sqimap_unsubscribe ($imap_stream, $mailbox) {
86 global $imap_server_type;
88 fputs ($imap_stream, "a001 UNSUBSCRIBE \"$mailbox\"\r\n");
89 $read_ary = sqimap_read_data($imap_stream, "a001", true, $response, $message);
95 /******************************************************************************
96 ** This function simply deletes the given folder
97 ******************************************************************************/
98 function sqimap_mailbox_delete ($imap_stream, $mailbox) {
99 fputs ($imap_stream, "a001 DELETE \"$mailbox\"\r\n");
100 $read_ary = sqimap_read_data($imap_stream, "a001", true, $response, $message);
101 sqimap_unsubscribe ($imap_stream, $mailbox);
105 /******************************************************************************
106 ** Formats a mailbox into 4 parts for the $boxes array
108 ** The four parts are:
110 ** raw - Raw LIST/LSUB response from the IMAP server
111 ** formatted - nicely formatted folder name
112 ** unformatted - unformatted, but with delimiter at end removed
113 ** unformatted-dm - folder name as it appears in raw response
114 ** unformatted-disp - unformatted without $folder_prefix
116 ******************************************************************************/
117 function sqimap_mailbox_parse ($line, $line_lsub, $dm) {
118 global $folder_prefix;
120 // Process each folder line
121 for ($g=0; $g < count($line); $g++
) {
123 // Store the raw IMAP reply
124 $boxes[$g]["raw"] = $line[$g];
126 // Count number of delimiters ($dm) in folder name
127 $mailbox = trim($line_lsub[$g]);
128 $dm_count = countCharInString($mailbox, $dm);
129 if (substr($mailbox, -1) == $dm)
130 $dm_count--; // If name ends in delimiter - decrement count by one
132 // Format folder name, but only if it's a INBOX.* or have
134 $boxesbyname[$mailbox] = $g;
135 $parentfolder = readMailboxParent($mailbox, $dm);
136 if((eregi("^inbox".quotemeta($dm), $mailbox)) ||
137 (ereg("^".$folder_prefix, $mailbox)) ||
138 ( isset($boxesbyname[$parentfolder]) && (strlen($parentfolder) > 0) ) ) {
139 $indent = $dm_count - (countCharInString($folder_prefix, $dm));
141 $boxes[$g]["formatted"] = str_repeat(" ", $indent);
143 $boxes[$g]["formatted"] = '';
144 $boxes[$g]["formatted"] .= readShortMailboxName($mailbox, $dm);
146 $boxes[$g]["formatted"] = $mailbox;
149 $boxes[$g]["unformatted-dm"] = $mailbox;
150 if (substr($mailbox, -1) == $dm)
151 $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
152 $boxes[$g]["unformatted"] = $mailbox;
153 $boxes[$g]["unformatted-disp"] = ereg_replace("^" . $folder_prefix, "", $mailbox);
154 $boxes[$g]["id"] = $g;
156 ereg("\(([^)]*)\)",$line[$g],$regs);
157 $flags = trim(strtolower(str_replace("\\", "",$regs[1])));
159 $boxes[$g]["flags"] = explode(" ", $flags);
166 /* patch from dave_michmerhuizen@yahoo.com
167 * allows case insensativity when sorting folders
169 function _icmp ($a, $b) {
170 return strcasecmp($a, $b);
173 /******************************************************************************
174 ** Returns sorted mailbox lists in several different ways.
175 ** See comment on sqimap_mailbox_parse() for info about the returned array.
176 ******************************************************************************/
177 function sqimap_mailbox_list ($imap_stream) {
178 global $load_prefs_php, $prefs_php, $config_php;
179 global $data_dir, $username, $list_special_folders_first;
180 global $trash_folder, $sent_folder;
181 global $move_to_trash, $move_to_sent;
183 $inbox_in_list = false;
184 $inbox_subscribed = false;
186 if (!isset($load_prefs_php)) include "../src/load_prefs.php";
187 else global $folder_prefix;
188 if (!function_exists ("ary_sort")) include "../functions/array.php";
190 $dm = sqimap_get_delimiter ($imap_stream);
193 $inbox_subscribed = false;
194 fputs ($imap_stream, "a001 LSUB \"\" \"*\"\r\n");
195 $lsub_ary = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
197 /** OS: we don't want to parse last element of array, 'cause it is OK command, so we unset it **/
198 unset($lsub_ary[count($lsub_ary)-1]);
200 for ($i=0;$i < count($lsub_ary); $i++
) {
201 $sorted_lsub_ary[$i] = find_mailbox_name($lsub_ary[$i]);
202 if ($sorted_lsub_ary[$i] == "INBOX")
203 $inbox_subscribed = true;
206 for ($i=0; $i < count($sorted_lsub_ary); $i++
) {
207 if (!in_array($sorted_lsub_ary[$i], $new_ary)) {
208 $new_ary[] = $sorted_lsub_ary[$i];
211 $sorted_lsub_ary = $new_ary;
212 if (isset($sorted_lsub_ary)) {
213 usort($sorted_lsub_ary, "_icmp");
214 //sort($sorted_lsub_ary);
218 for ($i=0; $i < count($sorted_lsub_ary); $i++
) {
219 if (substr($sorted_lsub_ary[$i], -1) == $dm)
220 $mbx = substr($sorted_lsub_ary[$i], 0, strlen($sorted_lsub_ary[$i])-1);
222 $mbx = $sorted_lsub_ary[$i];
224 fputs ($imap_stream, "a001 LIST \"\" \"$mbx\"\r\n");
225 $read = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
226 $sorted_list_ary[$i] = $read[0];
227 if (find_mailbox_name($sorted_list_ary[$i]) == "INBOX")
228 $inbox_in_list = true;
231 /** Just in case they're not subscribed to their inbox, we'll get it for them anyway **/
232 if ($inbox_subscribed == false ||
$inbox_in_list == false) {
233 fputs ($imap_stream, "a001 LIST \"\" \"INBOX\"\r\n");
234 $inbox_ary = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
236 $pos = count($sorted_list_ary);
237 $sorted_list_ary[$pos] = $inbox_ary[0];
239 $pos = count($sorted_lsub_ary);
240 $sorted_lsub_ary[$pos] = find_mailbox_name($inbox_ary[0]);
243 $boxes = sqimap_mailbox_parse ($sorted_list_ary, $sorted_lsub_ary, $dm);
246 /** Now, lets sort for special folders **/
251 for ($i = 0; $i < count($boxes); $i++
) {
252 if (strtolower($boxes[$i]["unformatted"]) == "inbox") {
253 $boxesnew[] = $boxes[$i];
254 $boxes[$i]["used"] = true;
259 if ($list_special_folders_first == true) {
261 // Then list special folders and their subfolders
262 for ($i = 0 ; $i < count($boxes) ; $i++
) {
263 if ($move_to_trash &&
264 eregi("^" . quotemeta($trash_folder) . "(" .
265 quotemeta($dm) . ".*)?$", $boxes[$i]["unformatted"])) {
266 $boxesnew[] = $boxes[$i];
267 $boxes[$i]["used"] = true;
269 elseif ($move_to_sent &&
270 eregi("^" . quotemeta($sent_folder) . "(" .
271 quotemeta($dm) . ".*)?$", $boxes[$i]["unformatted"])) {
272 $boxesnew[] = $boxes[$i];
273 $boxes[$i]["used"] = true;
277 // Put INBOX.* folders ahead of the rest
278 for ($i = 0; $i < count($boxes); $i++
) {
279 if (eregi("^inbox\.", $boxes[$i]["unformatted"]) &&
280 (!isset($boxes[$i]["used"]) ||
$boxes[$i]["used"] == false)) {
281 $boxesnew[] = $boxes[$i];
282 $boxes[$i]["used"] = true;
288 // Rest of the folders
289 for ($i = 0; $i < count($boxes); $i++
) {
290 if ((strtolower($boxes[$i]["unformatted"]) != "inbox") &&
291 ($boxes[$i]["used"] == false)) {
292 $boxesnew[] = $boxes[$i];
293 $boxes[$i]["used"] = true;
300 /******************************************************************************
301 ** Returns a list of all folders, subscribed or not
302 ******************************************************************************/
303 function sqimap_mailbox_list_all ($imap_stream) {
304 global $list_special_folders_first, $folder_prefix;
306 if (!function_exists ("ary_sort"))
307 include ("../functions/array.php");
309 $dm = sqimap_get_delimiter ($imap_stream);
311 fputs ($imap_stream, "a001 LIST \"$folder_prefix\" *\r\n");
312 $read_ary = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
316 for ($i = 0; $i < count($read_ary); $i++
) {
317 if (substr ($read_ary[$i], 0, 4) != "a001") {
319 // Store the raw IMAP reply
320 $boxes[$g]["raw"] = $read_ary[$i];
322 // Count number of delimiters ($dm) in folder name
323 $mailbox = find_mailbox_name($read_ary[$i]);
324 $dm_count = countCharInString($mailbox, $dm);
325 if (substr($mailbox, -1) == $dm)
326 $dm_count--; // If name ends in delimiter - decrement count by one
328 // Format folder name, but only if it's a INBOX.* or have
330 $boxesbyname[$mailbox] = $g;
331 $parentfolder = readMailboxParent($mailbox, $dm);
332 if((eregi("^inbox".quotemeta($dm), $mailbox)) ||
333 (ereg("^".$folder_prefix, $mailbox)) ||
334 ( isset($boxesbyname[$parentfolder]) && (strlen($parentfolder) > 0) ) ) {
336 $boxes[$g]["formatted"] = str_repeat(" ", $dm_count);
338 $boxes[$g]["formatted"] = '';
339 $boxes[$g]["formatted"] .= readShortMailboxName($mailbox, $dm);
341 $boxes[$g]["formatted"] = $mailbox;
344 $boxes[$g]["unformatted-dm"] = $mailbox;
345 if (substr($mailbox, -1) == $dm)
346 $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
347 $boxes[$g]["unformatted"] = $mailbox;
348 $boxes[$g]["unformatted-disp"] = ereg_replace("^" . $folder_prefix, "", $mailbox);
349 $boxes[$g]["id"] = $g;
351 /** Now lets get the flags for this mailbox **/
352 fputs ($imap_stream, "a002 LIST \"\" \"$mailbox\"\r\n");
353 $read_mlbx = sqimap_read_data ($imap_stream, "a002", true, $response, $message);
355 $flags = substr($read_mlbx[0], strpos($read_mlbx[0], "(")+
1);
356 $flags = substr($flags, 0, strpos($flags, ")"));
357 $flags = str_replace("\\", "", $flags);
358 $flags = trim(strtolower($flags));
360 $boxes[$g]["flags"] = explode(" ", $flags);
365 if(is_array($boxes)) {
366 $boxes = ary_sort ($boxes, "unformatted", 1);