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