2 /////////////////////////////////////////////////////////
4 // Iloha IMAP Library (IIL)
6 // (C)Copyright 2002 Ryo Chijiiwa <Ryo@IlohaMail.org>
8 // This file is part of IlohaMail. IlohaMail is free software released
9 // under the GPL license. See enclosed file COPYING for details, or
10 // see http://www.fsf.org/copyleft/gpl.html
12 /////////////////////////////////////////////////////////
14 /********************************************************
16 FILE: include/imap.inc
18 Provide alternative IMAP library that doesn't rely on the standard
19 C-Client based version. This allows IlohaMail to function regardless
20 of whether or not the PHP build it's running on has IMAP functionality
23 Function containing "_C_" in name require connection handler to be
24 passed as one of the parameters. To obtain connection handler, use
27 IlohaMail-0.9-20050415
29 File altered by Thomas Bruederli <roundcube@gmail.com>
30 to fit enhanced equirements by the RoundCube Webmail:
31 - Added list of server capabilites and check these before invoking commands
32 - Added junk flag to iilBasicHeader
33 - Enhanced error reporting on fsockopen()
34 - Additional parameter for SORT command
35 - Removed Call-time pass-by-reference because deprecated
36 - Parse charset from content-type in iil_C_FetchHeaders()
37 - Enhanced heaer sorting
38 - Pass message as reference in iil_C_Append (to save memory)
39 - Added BCC and REFERENCE to the list of headers to fetch in iil_C_FetchHeaders()
40 - Leave messageID unchanged in iil_C_FetchHeaders()
41 - Avoid stripslahes in iil_Connect()
42 - Escape quotes and backslashes in iil_C_Login()
43 - Added patch to iil_SortHeaders() by Richard Green
44 - Removed <br> from error messages (better for logging)
45 - Added patch to iil_C_Sort() enabling UID SORT commands
46 - Added function iil_C_ID2UID()
47 - Casting date parts in iil_StrToTime() to avoid mktime() warnings
48 - Also acceppt LIST responses in iil_C_ListSubscribed()
49 - Sanity check of $message_set in iil_C_FetchHeaders(), iil_C_FetchHeaderIndex(), iil_C_FetchThreadHeaders()
50 - Implemented UID FETCH in iil_C_FetchHeaders()
51 - Abort do-loop on socket errors (fgets returns false)
52 - $ICL_SSL is not boolean anymore but contains the connection schema (ssl or tls)
53 - Removed some debuggers (echo ...)
54 File altered by Aleksander Machniak <alec@alec.pl>
55 - trim(chop()) replaced by trim()
56 - added iil_Escape()/iil_UnEscape() with support for " and \ in folder names
57 - support \ character in username in iil_C_Login()
58 - fixed iil_MultLine(): use iil_ReadBytes() instead of iil_ReadLine()
59 - fixed iil_C_FetchStructureString() to handle many literal strings in response
60 - removed hardcoded data size in iil_ReadLine()
61 - added iil_PutLine() wrapper for fputs()
62 - code cleanup and identation fixes
63 - removed flush() calls in iil_C_HandlePartBody() to prevent from memory leak (#1485187)
64 - don't return "??" from iil_C_GetQuota()
65 - RFC3501 [7.1] don't call CAPABILITY if was returned in server
66 optional resposne in iil_Connect(), added iil_C_GetCapability()
67 - remove 'undisclosed-recipients' string from 'To' header
68 - iil_C_HandlePartBody(): added 6th argument and fixed endless loop
69 - added iil_PutLineC()
70 - fixed iil_C_Sort() to support very long and/or divided responses
71 - added BYE/BAD response simple support for endless loop prevention
72 - added 3rd argument in iil_StartsWith* functions
73 - fix iil_C_FetchPartHeader() in some cases by use of iil_C_HandlePartBody()
74 - allow iil_C_HandlePartBody() to fetch whole message
75 - optimize iil_C_FetchHeaders() to use only one FETCH command
76 - added 4th argument to iil_Connect()
77 - allow setting rootdir and delimiter before connect
78 - support multiquota result
79 - include BODYSTRUCTURE in iil_C_FetchHeaders()
80 - added iil_C_FetchMIMEHeaders() function
81 - added \* flag support
82 - use PREG instead of EREG
83 - removed caching functions
84 - handling connection startup response
85 - added UID EXPUNGE support
86 - fixed problem with double quotes and spaces in folder names in LIST and LSUB
87 - rewritten iil_C_FetchHeaderIndex()
89 ********************************************************/
92 * @todo Possibly clean up more CS.
93 * @todo Try to replace most double-quotes with single-quotes.
94 * @todo Split this file into smaller files.
95 * @todo Refactor code.
96 * @todo Replace echo-debugging (make it adhere to config setting and log)
100 if (!isset($IMAP_USE_HEADER_DATE) || !$IMAP_USE_HEADER_DATE) {
101 $IMAP_USE_INTERNAL_DATE = true;
104 $GLOBALS['IMAP_FLAGS'] = array(
106 'DELETED' => '\\Deleted',
107 'RECENT' => '\\Recent',
108 'ANSWERED' => '\\Answered',
109 'DRAFT' => '\\Draft',
110 'FLAGGED' => '\\Flagged',
111 'FORWARDED' => '$Forwarded',
112 'MDNSENT' => '$MDNSent',
121 * @todo Change class vars to public/private
135 var $capability = array();
136 var $permanentflags = array();
137 var $capability_readed = false;
141 * @todo Change class vars to public/private
167 var $mdn_sent = false;
168 var $is_draft = false;
170 var $deleted = false;
172 var $answered = false;
173 var $forwarded = false;
175 var $flagged = false;
176 var $others = array();
180 * @todo Change class vars to public/private
182 class iilThreadHeader
190 function iil_xor($string, $string2) {
192 $size = strlen($string);
193 for ($i=0; $i<$size; $i++) {
194 $result .= chr(ord($string[$i]) ^ ord($string2[$i]));
199 function iil_PutLine($fp, $string, $endln=true) {
202 if (!empty($my_prefs['debug_mode']))
203 write_log('imap', 'C: '. rtrim($string));
205 return fputs($fp, $string . ($endln ? "\r\n" : ''));
208 // iil_PutLine replacement with Command Continuation Requests (RFC3501 7.5) support
209 function iil_PutLineC($fp, $string, $endln=true) {
214 if ($parts = preg_split('/(\{[0-9]+\}\r\n)/m', $string, -1, PREG_SPLIT_DELIM_CAPTURE)) {
215 for($i=0, $cnt=count($parts); $i<$cnt; $i++) {
216 if(preg_match('/^\{[0-9]+\}\r\n$/', $parts[$i+1])) {
217 $res += iil_PutLine($fp, $parts[$i].$parts[$i+1], false);
218 $line = iil_ReadLine($fp, 1000);
219 // handle error in command
225 $res += iil_PutLine($fp, $parts[$i], false);
231 function iil_ReadLine($fp, $size=1024) {
245 $buffer = fgets($fp, $size);
247 if ($buffer === false) {
250 if (!empty($my_prefs['debug_mode']))
251 write_log('imap', 'S: '. chop($buffer));
253 } while ($buffer[strlen($buffer)-1] != "\n");
258 function iil_MultLine($fp, $line, $escape=false) {
260 if (preg_match('/\{[0-9]+\}$/', $line)) {
263 preg_match_all('/(.*)\{([0-9]+)\}$/', $line, $a);
265 while (strlen($out) < $bytes) {
266 $line = iil_ReadBytes($fp, $bytes);
270 $line = $a[1][0] . '"' . ($escape ? iil_Escape($out) : $out) . '"';
275 function iil_ReadBytes($fp, $bytes) {
280 $d = fread($fp, $bytes-$len);
281 if (!empty($my_prefs['debug_mode']))
282 write_log('imap', 'S: '. $d);
284 $data_len = strlen($data);
285 if ($len == $data_len) {
286 break; //nothing was read -> exit to avoid apache lockups
289 } while ($len < $bytes);
294 // don't use it in loops, until you exactly know what you're doing
295 function iil_ReadReply($fp) {
297 $line = trim(iil_ReadLine($fp, 1024));
298 } while ($line[0] == '*');
303 function iil_ParseResult($string) {
304 $a = explode(' ', trim($string));
305 if (count($a) >= 2) {
306 $res = strtoupper($a[1]);
309 } else if ($res == 'NO') {
311 } else if ($res == 'BAD') {
313 } else if ($res == 'BYE') {
320 // check if $string starts with $match (or * BYE/BAD)
321 function iil_StartsWith($string, $match, $error=false) {
322 $len = strlen($match);
326 if (strncmp($string, $match, $len) == 0) {
329 if ($error && preg_match('/^\* (BYE|BAD) /i', $string)) {
335 function iil_StartsWithI($string, $match, $error=false) {
336 $len = strlen($match);
340 if (strncasecmp($string, $match, $len) == 0) {
343 if ($error && preg_match('/^\* (BYE|BAD) /i', $string)) {
349 function iil_Escape($string)
351 return strtr($string, array('"'=>'\\"', '\\' => '\\\\'));
354 function iil_UnEscape($string)
356 return strtr($string, array('\\"'=>'"', '\\\\' => '\\'));
359 function iil_C_GetCapability(&$conn, $name)
361 if (in_array($name, $conn->capability)) {
364 else if ($conn->capability_readed) {
368 // get capabilities (only once) because initial
369 // optional CAPABILITY response may differ
370 $conn->capability = array();
372 iil_PutLine($conn->fp, "cp01 CAPABILITY");
374 $line = trim(iil_ReadLine($conn->fp, 1024));
375 $a = explode(' ', $line);
376 if ($line[0] == '*') {
377 while (list($k, $w) = each($a)) {
378 if ($w != '*' && $w != 'CAPABILITY')
379 $conn->capability[] = strtoupper($w);
382 } while ($a[0] != 'cp01');
384 $conn->capability_readed = true;
386 if (in_array($name, $conn->capability)) {
393 function iil_C_ClearCapability(&$conn)
395 $conn->capability = array();
396 $conn->capability_readed = false;
399 function iil_C_Authenticate(&$conn, $user, $pass, $encChallenge) {
404 // initialize ipad, opad
405 for ($i=0;$i<64;$i++) {
410 // pad $pass so it's 64 bytes
411 $padLen = 64 - strlen($pass);
412 for ($i=0;$i<$padLen;$i++) {
417 $hash = md5(iil_xor($pass,$opad) . pack("H*", md5(iil_xor($pass, $ipad) . base64_decode($encChallenge))));
420 $reply = base64_encode($user . ' ' . $hash);
422 // send result, get reply
423 iil_PutLine($conn->fp, $reply);
424 $line = iil_ReadLine($conn->fp, 1024);
427 $result = iil_ParseResult($line);
434 if ($result == -3) fclose($conn->fp); // BYE response
436 $conn->error .= 'Authentication for ' . $user . ' failed (AUTH): "';
437 $conn->error .= htmlspecialchars($line) . '"';
438 $conn->errorNum = $result;
443 function iil_C_Login(&$conn, $user, $password) {
445 iil_PutLine($conn->fp, 'a001 LOGIN "'.iil_Escape($user).'" "'.iil_Escape($password).'"');
447 $line = iil_ReadReply($conn->fp);
450 $result = iil_ParseResult($line);
460 $conn->error .= 'Authentication for ' . $user . ' failed (LOGIN): "';
461 $conn->error .= htmlspecialchars($line)."\"";
462 $conn->errorNum = $result;
467 function iil_ParseNamespace2($str, &$i, $len=0, $l) {
469 $str = str_replace('NIL', '()', $str);
477 for ($i;$i<$len;$i++) {
478 $c = (string)$str[$i];
479 if ($c == '(' && !$in_quotes) {
481 $data[$elem] = iil_ParseNamespace2($str, $i, $len, $l++);
483 } else if ($c == ')' && !$in_quotes) {
485 } else if ($c == '\\') {
488 $data[$elem] .= $c.$str[$i];
490 } else if ($c == '"') {
491 $in_quotes = !$in_quotes;
495 } else if ($in_quotes) {
502 function iil_C_NameSpace(&$conn) {
505 if (isset($my_prefs['rootdir']) && is_string($my_prefs['rootdir'])) {
506 $conn->rootdir = $my_prefs['rootdir'];
510 if (!iil_C_GetCapability($conn, 'NAMESPACE')) {
514 iil_PutLine($conn->fp, "ns1 NAMESPACE");
516 $line = iil_ReadLine($conn->fp, 1024);
517 if (iil_StartsWith($line, '* NAMESPACE')) {
519 $line = iil_UnEscape($line);
520 $data = iil_ParseNamespace2(substr($line,11), $i, 0, 0);
522 } while (!iil_StartsWith($line, 'ns1', true));
524 if (!is_array($data)) {
528 $user_space_data = $data[0];
529 if (!is_array($user_space_data)) {
533 $first_userspace = $user_space_data[0];
534 if (count($first_userspace)!=2) {
538 $conn->rootdir = $first_userspace[0];
539 $conn->delimiter = $first_userspace[1];
540 $my_prefs['rootdir'] = substr($conn->rootdir, 0, -1);
541 $my_prefs['delimiter'] = $conn->delimiter;
546 function iil_Connect($host, $user, $password, $options=null) {
547 global $iil_error, $iil_errornum;
548 global $ICL_SSL, $ICL_PORT;
549 global $my_prefs, $IMAP_USE_INTERNAL_DATE;
554 // set some imap options
555 if (is_array($options)) {
556 foreach($options as $optkey => $optval) {
557 if ($optkey == 'imap') {
558 $auth_method = strtoupper($optval);
559 } else if ($optkey == 'rootdir') {
560 $my_prefs['rootdir'] = $optval;
561 } else if ($optkey == 'delimiter') {
562 $my_prefs['delimiter'] = $optval;
563 } else if ($optkey == 'debug_mode') {
564 $my_prefs['debug_mode'] = $optval;
569 if (empty($auth_method))
570 $auth_method = 'CHECK';
572 $message = "INITIAL: $auth_method\n";
576 // initialize connection
577 $conn = new iilConnection;
580 $conn->selected = '';
584 if ($my_prefs['sort_field'] == 'INTERNALDATE') {
585 $IMAP_USE_INTERNAL_DATE = true;
586 } else if ($my_prefs['sort_field'] == 'DATE') {
587 $IMAP_USE_INTERNAL_DATE = false;
592 $iil_error = "Empty host";
597 $iil_error = "Empty user";
601 if (empty($password)) {
602 $iil_error = "Empty password";
611 if ($ICL_SSL && $ICL_SSL != 'tls') {
612 $host = $ICL_SSL . '://' . $host;
615 $conn->fp = @fsockopen($host, $ICL_PORT, $errno, $errstr, 10);
617 $iil_error = "Could not connect to $host at port $ICL_PORT: $errstr";
622 stream_set_timeout($conn->fp, 10);
623 $line = trim(fgets($conn->fp, 8192));
625 if ($my_prefs['debug_mode'] && $line)
626 write_log('imap', 'S: '. $line);
628 // Connected to wrong port or connection error?
629 if (!preg_match('/^\* (OK|PREAUTH)/i', $line)) {
631 $iil_error = "Wrong startup greeting ($host:$ICL_PORT): $line";
633 $iil_error = "Empty startup greeting ($host:$ICL_PORT)";
638 // RFC3501 [7.1] optional CAPABILITY response
639 if (preg_match('/\[CAPABILITY ([^]]+)\]/i', $line, $matches)) {
640 $conn->capability = explode(' ', strtoupper($matches[1]));
643 $conn->message .= $line . "\n";
646 if ($ICL_SSL == 'tls' && iil_C_GetCapability($conn, 'STARTTLS')) {
647 if (version_compare(PHP_VERSION, '5.1.0', '>=')) {
648 iil_PutLine($conn->fp, 'stls000 STARTTLS');
650 $line = iil_ReadLine($conn->fp, 4096);
651 if (!iil_StartsWith($line, 'stls000 OK')) {
652 $iil_error = "Server responded to STARTTLS with: $line";
657 if (!stream_socket_enable_crypto($conn->fp, true, STREAM_CRYPTO_METHOD_TLS_CLIENT)) {
658 $iil_error = "Unable to negotiate TLS";
663 // Now we're authenticated, capabilities need to be reread
664 iil_C_ClearCapability($conn);
668 if ($auth_method == 'CHECK') {
669 //check for supported auth methods
670 if (iil_C_GetCapability($conn, 'AUTH=CRAM-MD5') || iil_C_GetCapability($conn, 'AUTH=CRAM_MD5')) {
671 $auth_method = 'AUTH';
674 //default to plain text auth
675 $auth_method = 'PLAIN';
679 if ($auth_method == 'AUTH') {
680 //do CRAM-MD5 authentication
681 iil_PutLine($conn->fp, "a000 AUTHENTICATE CRAM-MD5");
682 $line = trim(iil_ReadLine($conn->fp, 1024));
684 if ($line[0] == '+') {
685 //got a challenge string, try CRAM-5
686 $result = iil_C_Authenticate($conn, $user, $password, substr($line,2));
688 // stop if server sent BYE response
690 $iil_error = $conn->error;
691 $iil_errornum = $conn->errorNum;
694 $conn->message .= "AUTH CRAM-MD5: $result\n";
696 $conn->message .= "AUTH CRAM-MD5: failed\n";
697 $auth_method = 'PLAIN';
701 if (!$result || $auth_method == 'PLAIN') {
703 $result = iil_C_Login($conn, $user, $password);
704 $conn->message .= "AUTH PLAIN: $result\n";
707 if (!is_int($result)) {
708 iil_C_Namespace($conn);
711 $iil_error = $conn->error;
712 $iil_errornum = $conn->errorNum;
717 function iil_Close(&$conn) {
718 if (iil_PutLine($conn->fp, "I LOGOUT")) {
719 fgets($conn->fp, 1024);
725 function iil_ExplodeQuotedString($delimiter, $string) {
727 $strlen = strlen($string);
729 for ($q=$p=$i=0; $i < $strlen; $i++) {
730 if ($string[$i] == "\"" && $string[$i-1] != "\\") {
731 $q = $q ? false : true;
733 else if (!$q && preg_match("/$delimiter/", $string[$i])) {
734 $result[] = substr($string, $p, $i - $p);
739 $result[] = substr($string, $p);
743 function iil_CheckForRecent($host, $user, $password, $mailbox) {
744 if (empty($mailbox)) {
748 $conn = iil_Connect($host, $user, $password, 'plain');
751 iil_PutLine($fp, "a002 EXAMINE \"".iil_Escape($mailbox)."\"");
753 $line=chop(iil_ReadLine($fp, 300));
754 $a=explode(' ', $line);
755 if (($a[0] == '*') && (strcasecmp($a[2], 'RECENT') == 0)) {
756 $result = (int) $a[1];
758 } while (!iil_StartsWith($a[0], 'a002', true));
760 iil_PutLine($fp, "a003 LOGOUT");
769 function iil_C_Select(&$conn, $mailbox) {
771 if (empty($mailbox)) {
774 if ($conn->selected == $mailbox) {
778 if (iil_PutLine($conn->fp, "sel1 SELECT \"".iil_Escape($mailbox).'"')) {
780 $line = chop(iil_ReadLine($conn->fp, 300));
781 $a = explode(' ', $line);
782 if (count($a) == 3) {
783 $token = strtoupper($a[2]);
784 if ($token == 'EXISTS') {
785 $conn->exists = (int) $a[1];
787 else if ($token == 'RECENT') {
788 $conn->recent = (int) $a[1];
791 else if (preg_match('/\[?PERMANENTFLAGS\s+\(([^\)]+)\)\]/U', $line, $match)) {
792 $conn->permanentflags = explode(' ', $match[1]);
794 } while (!iil_StartsWith($line, 'sel1', true));
796 if (strcasecmp($a[1], 'OK') == 0) {
797 $conn->selected = $mailbox;
804 function iil_C_CheckForRecent(&$conn, $mailbox) {
805 if (empty($mailbox)) {
809 iil_C_Select($conn, $mailbox);
810 if ($conn->selected == $mailbox) {
811 return $conn->recent;
816 function iil_C_CountMessages(&$conn, $mailbox, $refresh = false) {
818 $conn->selected = '';
821 iil_C_Select($conn, $mailbox);
822 if ($conn->selected == $mailbox) {
823 return $conn->exists;
828 function iil_SplitHeaderLine($string) {
829 $pos=strpos($string, ':');
831 $res[0] = substr($string, 0, $pos);
832 $res[1] = trim(substr($string, $pos+1));
838 function iil_StrToTime($date) {
840 // support non-standard "GMTXXXX" literal
841 $date = preg_replace('/GMT\s*([+-][0-9]+)/', '\\1', $date);
842 // if date parsing fails, we have a date in non-rfc format.
843 // remove token from the end and try again
844 while ((($ts = @strtotime($date))===false) || ($ts < 0))
846 $d = explode(' ', $date);
849 $date = implode(' ', $d);
854 return $ts < 0 ? 0 : $ts;
857 function iil_C_Sort(&$conn, $mailbox, $field, $add='', $is_uid=FALSE,
858 $encoding = 'US-ASCII') {
860 $field = strtoupper($field);
861 if ($field == 'INTERNALDATE') {
865 $fields = array('ARRIVAL' => 1,'CC' => 1,'DATE' => 1,
866 'FROM' => 1, 'SIZE' => 1, 'SUBJECT' => 1, 'TO' => 1);
868 if (!$fields[$field]) {
872 /* Do "SELECT" command */
873 if (!iil_C_Select($conn, $mailbox)) {
877 $is_uid = $is_uid ? 'UID ' : '';
883 $command = 's ' . $is_uid . 'SORT (' . $field . ') ';
884 $command .= $encoding . ' ALL' . $add;
887 if (!iil_PutLineC($conn->fp, $command)) {
891 $line = chop(iil_ReadLine($conn->fp));
892 if (iil_StartsWith($line, '* SORT')) {
893 $data .= substr($line, 7);
894 } else if (preg_match('/^[0-9 ]+$/', $line)) {
897 } while (!iil_StartsWith($line, 's ', true));
899 $result_code = iil_ParseResult($line);
901 if ($result_code != 0) {
902 $conn->error = 'iil_C_Sort: ' . $line . "\n";
906 return preg_split('/\s+/', $data, -1, PREG_SPLIT_NO_EMPTY);
909 function iil_C_FetchHeaderIndex(&$conn, $mailbox, $message_set, $index_field='', $skip_deleted=true) {
911 list($from_idx, $to_idx) = explode(':', $message_set);
912 if (empty($message_set) ||
913 (isset($to_idx) && $to_idx != '*' && (int)$from_idx > (int)$to_idx)) {
917 $index_field = empty($index_field) ? 'DATE' : strtoupper($index_field);
919 $fields_a['DATE'] = 1;
920 $fields_a['INTERNALDATE'] = 4;
921 $fields_a['FROM'] = 1;
922 $fields_a['REPLY-TO'] = 1;
923 $fields_a['SENDER'] = 1;
925 $fields_a['SUBJECT'] = 1;
926 $fields_a['UID'] = 2;
927 $fields_a['SIZE'] = 2;
928 $fields_a['SEEN'] = 3;
929 $fields_a['RECENT'] = 3;
930 $fields_a['DELETED'] = 3;
932 if (!($mode = $fields_a[$index_field])) {
936 /* Do "SELECT" command */
937 if (!iil_C_Select($conn, $mailbox)) {
941 // build FETCH command string
943 $deleted = $skip_deleted ? ' FLAGS' : '';
946 $request = " FETCH $message_set (BODY.PEEK[HEADER.FIELDS ($index_field)]$deleted)";
947 else if ($mode == 2) {
948 if ($index_field == 'SIZE')
949 $request = " FETCH $message_set (RFC822.SIZE$deleted)";
951 $request = " FETCH $message_set ($index_field$deleted)";
952 } else if ($mode == 3)
953 $request = " FETCH $message_set (FLAGS)";
955 $request = " FETCH $message_set (INTERNALDATE$deleted)";
957 $request = $key . $request;
959 if (!iil_PutLine($conn->fp, $request))
965 $line = chop(iil_ReadLine($conn->fp, 200));
966 $line = iil_MultLine($conn->fp, $line);
968 if (preg_match('/^\* ([0-9]+) FETCH/', $line, $m)) {
973 if ($skip_deleted && preg_match('/FLAGS \(([^)]+)\)/', $line, $matches)) {
974 $flags = explode(' ', strtoupper($matches[1]));
975 if (in_array('\\DELETED', $flags)) {
982 if (preg_match('/BODY\[HEADER\.FIELDS \("?(DATE|FROM|REPLY-TO|SENDER|TO|SUBJECT)"?\)\] (.*)/', $line, $matches)) {
983 $value = preg_replace(array('/^"*[a-z]+:/i', '/\s+$/sm'), array('', ''), $matches[2]);
984 $value = trim($value);
985 if ($index_field == 'DATE') {
986 $result[$id] = iil_StrToTime($value);
988 $result[$id] = $value;
993 } else if ($mode == 2) {
994 if (preg_match('/\((UID|RFC822\.SIZE) ([0-9]+)/', $line, $matches)) {
995 $result[$id] = trim($matches[2]);
999 } else if ($mode == 3) {
1000 if (!$flags && preg_match('/FLAGS \(([^)]+)\)/', $line, $matches)) {
1001 $flags = explode(' ', $matches[1]);
1003 $result[$id] = in_array('\\'.$index_field, $flags) ? 1 : 0;
1004 } else if ($mode == 4) {
1005 if (preg_match('/INTERNALDATE "([^"]+)"/', $line, $matches)) {
1006 $result[$id] = iil_StrToTime($matches[1]);
1012 } while (!iil_StartsWith($line, $key, true));
1015 //check number of elements...
1016 if (is_numeric($from_idx) && is_numeric($to_idx)) {
1017 //count how many we should have
1018 $should_have = $to_idx - $from_idx + 1;
1020 //if we have less, try and fill in the "gaps"
1021 if (count($result) < $should_have) {
1022 for ($i=$from_idx; $i<=$to_idx; $i++) {
1023 if (!isset($result[$i])) {
1033 function iil_CompressMessageSet($message_set) {
1034 //given a comma delimited list of independent mid's,
1035 //compresses by grouping sequences together
1037 //if less than 255 bytes long, let's not bother
1038 if (strlen($message_set)<255) {
1039 return $message_set;
1042 //see if it's already been compress
1043 if (strpos($message_set, ':') !== false) {
1044 return $message_set;
1047 //separate, then sort
1048 $ids = explode(',', $message_set);
1052 $start = $prev = $ids[0];
1054 foreach ($ids as $id) {
1055 $incr = $id - $prev;
1056 if ($incr > 1) { //found a gap
1057 if ($start == $prev) {
1058 $result[] = $prev; //push single id
1060 $result[] = $start . ':' . $prev; //push sequence as start_id:end_id
1062 $start = $id; //start of new sequence
1067 //handle the last sequence/id
1068 if ($start==$prev) {
1071 $result[] = $start.':'.$prev;
1074 //return as comma separated string
1075 return implode(',', $result);
1078 function iil_C_UIDsToMIDs(&$conn, $mailbox, $uids) {
1079 if (!is_array($uids) || count($uids) == 0) {
1082 return iil_C_Search($conn, $mailbox, 'UID ' . implode(',', $uids));
1085 function iil_C_UIDToMID(&$conn, $mailbox, $uid) {
1086 $result = iil_C_UIDsToMIDs($conn, $mailbox, array($uid));
1087 if (count($result) == 1) {
1093 function iil_C_FetchUIDs(&$conn,$mailbox) {
1096 $num = iil_C_CountMessages($conn, $mailbox);
1100 $message_set = '1' . ($num>1?':' . $num:'');
1102 return iil_C_FetchHeaderIndex($conn, $mailbox, $message_set, 'UID');
1105 function iil_SortThreadHeaders($headers, $index_a, $uids) {
1108 foreach ($index_a as $mid=>$foobar) {
1110 $result[$uid] = $headers[$uid];
1115 function iil_C_FetchThreadHeaders(&$conn, $mailbox, $message_set) {
1119 list($from_idx, $to_idx) = explode(':', $message_set);
1120 if (empty($message_set) || (isset($to_idx)
1121 && (int)$from_idx > (int)$to_idx)) {
1126 $uids = iil_C_FetchUIDs($conn, $mailbox);
1129 $message_set = iil_CompressMessageSet($message_set);
1131 /* if we're missing any, get them */
1133 /* FETCH date,from,subject headers */
1136 $request = $key . " FETCH $message_set ";
1137 $request .= "(BODY.PEEK[HEADER.FIELDS (SUBJECT MESSAGE-ID IN-REPLY-TO)])";
1138 $mid_to_id = array();
1139 if (!iil_PutLine($fp, $request)) {
1143 $line = chop(iil_ReadLine($fp, 1024));
1147 if (preg_match('/\{[0-9]+\}$/', $line)) {
1148 $a = explode(' ', $line);
1151 $new_thhd = new iilThreadHeader;
1152 $new_thhd->id = $a[1];
1154 $line = chop(iil_ReadLine($fp, 1024), "\r\n");
1155 if (iil_StartsWithI($line, 'Message-ID:')
1156 || (iil_StartsWithI($line,'In-Reply-To:'))
1157 || (iil_StartsWithI($line,'SUBJECT:'))) {
1159 $pos = strpos($line, ':');
1160 $field_name = substr($line, 0, $pos);
1161 $field_val = substr($line, $pos+1);
1163 $new[strtoupper($field_name)] = trim($field_val);
1165 } else if (preg_match('/^\s+/', $line)) {
1166 $new[strtoupper($field_name)] .= trim($line);
1168 } while ($line[0] != ')');
1170 $new_thhd->sbj = $new['SUBJECT'];
1171 $new_thhd->mid = substr($new['MESSAGE-ID'], 1, -1);
1172 $new_thhd->irt = substr($new['IN-REPLY-TO'], 1, -1);
1174 $result[$uids[$new_thhd->id]] = $new_thhd;
1176 } while (!iil_StartsWith($line, 'fh'));
1180 if (is_array($index_a)) {
1181 $result = iil_SortThreadHeaders($result, $index_a, $uids);
1184 //echo 'iil_FetchThreadHeaders:'."\n";
1190 function iil_C_BuildThreads2(&$conn, $mailbox, $message_set, &$clock) {
1193 list($from_idx, $to_idx) = explode(':', $message_set);
1194 if (empty($message_set) || (isset($to_idx)
1195 && (int)$from_idx > (int)$to_idx)) {
1201 $root_mids = array();
1202 $sub_mids = array();
1204 $messages = array();
1208 $sbj_filter_pat = '/[a-z]{2,3}(\[[0-9]*\])?:(\s*)/i';
1210 /* Do "SELECT" command */
1211 if (!iil_C_Select($conn, $mailbox)) {
1215 /* FETCH date,from,subject headers */
1216 $mid_to_id = array();
1217 $messages = array();
1218 $headers = iil_C_FetchThreadHeaders($conn, $mailbox, $message_set);
1220 $clock->register('fetched headers');
1227 /* go through header records */
1228 foreach ($headers as $header) {
1229 //$id = $header['i'];
1230 //$new = array('id'=>$id, 'MESSAGE-ID'=>$header['m'],
1231 // 'IN-REPLY-TO'=>$header['r'], 'SUBJECT'=>$header['s']);
1233 $new = array('id' => $id, 'MESSAGE-ID' => $header->mid,
1234 'IN-REPLY-TO' => $header->irt, 'SUBJECT' => $header->sbj);
1236 /* add to message-id -> mid lookup table */
1237 $mid_to_id[$new['MESSAGE-ID']] = $id;
1239 /* if no subject, use message-id */
1240 if (empty($new['SUBJECT'])) {
1241 $new['SUBJECT'] = $new['MESSAGE-ID'];
1244 /* if subject contains 'RE:' or has in-reply-to header, it's a reply */
1247 if (preg_match($sbj_filter_pat, $new['SUBJECT'])) {
1250 if ($has_re || $new['IN-REPLY-TO']) {
1254 /* strip out 're:', 'fw:' etc */
1256 $sbj = preg_replace($sbj_filter_pat, '', $new['SUBJECT']);
1258 $sbj = $new['SUBJECT'];
1260 $new['SUBJECT'] = $sbj_pre.$sbj;
1263 /* if subject not a known thread-root, add to list */
1265 echo $id . ' ' . $new['SUBJECT'] . "\t" . $new['MESSAGE-ID'] . "\n";
1267 $root_id = $roots[$sbj];
1269 if ($root_id && ($has_re || !$root_in_root[$root_id])) {
1271 echo "\tfound root: $root_id\n";
1273 $sub_mids[$new['MESSAGE-ID']] = $root_id;
1274 $result[$root_id][] = $id;
1275 } else if (!isset($roots[$sbj]) || (!$has_re && $root_in_root[$root_id])) {
1276 /* try to use In-Reply-To header to find root
1277 unless subject contains 'Re:' */
1278 if ($has_re&&$new['IN-REPLY-TO']) {
1280 echo "\tlooking: ".$new['IN-REPLY-TO']."\n";
1282 //reply to known message?
1283 $temp = $sub_mids[$new['IN-REPLY-TO']];
1286 //found it, root:=parent's root
1288 echo "\tfound parent: ".$new['SUBJECT']."\n";
1290 $result[$temp][] = $id;
1291 $sub_mids[$new['MESSAGE-ID']] = $temp;
1294 //if we can't find referenced parent, it's a "stray"
1295 $strays[$id] = $new['IN-REPLY-TO'];
1299 //add subject as root
1302 echo "\t added to root\n";
1305 $root_in_root[$id] = !$has_re;
1306 $sub_mids[$new['MESSAGE-ID']] = $id;
1307 $result[$id] = array($id);
1310 echo $new['MESSAGE-ID'] . "\t" . $sbj . "\n";
1315 //now that we've gone through all the messages,
1316 //go back and try and link up the stray threads
1317 if (count($strays) > 0) {
1318 foreach ($strays as $id=>$irt) {
1319 $root_id = $sub_mids[$irt];
1320 if (!$root_id || $root_id==$id) {
1323 $result[$root_id] = array_merge($result[$root_id],$result[$id]);
1324 unset($result[$id]);
1329 $clock->register('data prepped');
1339 function iil_SortThreads(&$tree, $index, $sort_order = 'ASC') {
1340 if (!is_array($tree) || !is_array($index)) {
1344 //create an id to position lookup table
1346 foreach ($index as $id=>$val) {
1352 //for each tree, set array key to position
1354 foreach ($tree as $id=>$node) {
1355 if (count($tree[$id])<=1) {
1356 //for "threads" with only one message, key is position of that message
1358 $itree[$n] = array($n=>$id);
1360 //for "threads" with multiple messages,
1363 foreach ($tree[$id] as $mid) {
1364 $new_a[$index[$mid]] = $mid; //create new sub-array mapping position to id
1365 $pos = $index[$mid];
1366 if ($pos&&$pos<$min) {
1367 $min = $index[$mid]; //find smallest position
1370 $n = $min; //smallest position of child is thread position
1372 //assign smallest position to root level key
1373 //set children array to one created above
1375 $itree[$n] = $new_a;
1379 //sort by key, this basically sorts all threads
1383 foreach ($itree as $k=>$node) {
1384 $out[$i] = $itree[$k];
1391 function iil_IndexThreads(&$tree) {
1392 /* creates array mapping mid to thread id */
1394 if (!is_array($tree)) {
1399 foreach ($tree as $pos=>$kids) {
1400 foreach ($kids as $kid) $t_index[$kid] = $pos;
1406 function iil_C_FetchHeaders(&$conn, $mailbox, $message_set, $uidfetch=false, $bodystr=false, $add='')
1408 global $IMAP_USE_INTERNAL_DATE;
1413 /* Do "SELECT" command */
1414 if (!iil_C_Select($conn, $mailbox)) {
1415 $conn->error = "Couldn't select $mailbox";
1419 $message_set = iil_CompressMessageSet($message_set);
1422 $add = ' '.strtoupper(trim($add));
1424 /* FETCH uid, size, flags and headers */
1426 $request = $key . ($uidfetch ? ' UID' : '') . " FETCH $message_set ";
1427 $request .= "(UID RFC822.SIZE FLAGS INTERNALDATE ";
1429 $request .= "BODYSTRUCTURE ";
1430 $request .= "BODY.PEEK[HEADER.FIELDS ";
1431 $request .= "(DATE FROM TO SUBJECT REPLY-TO IN-REPLY-TO CC BCC ";
1432 $request .= "CONTENT-TRANSFER-ENCODING CONTENT-TYPE MESSAGE-ID ";
1433 $request .= "REFERENCES DISPOSITION-NOTIFICATION-TO X-PRIORITY".$add.")])";
1435 if (!iil_PutLine($fp, $request)) {
1439 $line = iil_ReadLine($fp, 1024);
1440 $line = iil_MultLine($fp, $line);
1442 $a = explode(' ', $line);
1443 if (($line[0] == '*') && ($a[2] == 'FETCH')) {
1446 $result[$id] = new iilBasicHeader;
1447 $result[$id]->id = $id;
1448 $result[$id]->subject = '';
1449 $result[$id]->messageID = 'mid:' . $id;
1455 * 321 FETCH (UID 2417 RFC822.SIZE 2730 FLAGS (\Seen)
1456 INTERNALDATE "16-Nov-2008 21:08:46 +0100" BODYSTRUCTURE (...)
1457 BODY[HEADER.FIELDS ...
1460 if (preg_match('/^\* [0-9]+ FETCH \((.*) BODY/s', $line, $matches)) {
1463 // swap parents with quotes, then explode
1464 $str = preg_replace('/[()]/', '"', $str);
1465 $a = iil_ExplodeQuotedString(' ', $str);
1467 // did we get the right number of replies?
1468 $parts_count = count($a);
1469 if ($parts_count>=6) {
1470 for ($i=0; $i<$parts_count; $i=$i+2) {
1471 if ($a[$i] == 'UID')
1472 $result[$id]->uid = $a[$i+1];
1473 else if ($a[$i] == 'RFC822.SIZE')
1474 $result[$id]->size = $a[$i+1];
1475 else if ($a[$i] == 'INTERNALDATE')
1476 $time_str = $a[$i+1];
1477 else if ($a[$i] == 'FLAGS')
1478 $flags_str = $a[$i+1];
1481 $time_str = str_replace('"', '', $time_str);
1483 // if time is gmt...
1484 $time_str = str_replace('GMT','+0000',$time_str);
1486 $result[$id]->internaldate = $time_str;
1487 $result[$id]->timestamp = iil_StrToTime($time_str);
1488 $result[$id]->date = $time_str;
1493 while (!preg_match('/ BODYSTRUCTURE (.*) BODY\[HEADER.FIELDS/s', $line, $m)) {
1494 $line2 = iil_ReadLine($fp, 1024);
1495 $line .= iil_MultLine($fp, $line2, true);
1497 $result[$id]->body_structure = $m[1];
1500 // the rest of the result
1501 preg_match('/ BODY\[HEADER.FIELDS \(.*?\)\]\s*(.*)$/s', $line, $m);
1502 $reslines = explode("\n", trim($m[1], '"'));
1503 // re-parse (see below)
1504 foreach ($reslines as $resln) {
1505 if (ord($resln[0])<=32) {
1506 $lines[$ln] .= (empty($lines[$ln])?'':"\n").trim($resln);
1508 $lines[++$ln] = trim($resln);
1514 Start parsing headers. The problem is, some header "lines" take up multiple lines.
1515 So, we'll read ahead, and if the one we're reading now is a valid header, we'll
1516 process the previous line. Otherwise, we'll keep adding the strings until we come
1517 to the next valid header line.
1521 $line = chop(iil_ReadLine($fp, 300), "\r\n");
1523 // The preg_match below works around communigate imap, which outputs " UID <number>)".
1524 // Without this, the while statement continues on and gets the "FH0 OK completed" message.
1525 // If this loop gets the ending message, then the outer loop does not receive it from radline on line 1249.
1526 // This in causes the if statement on line 1278 to never be true, which causes the headers to end up missing
1527 // If the if statement was changed to pick up the fh0 from this loop, then it causes the outer loop to spin
1528 // An alternative might be:
1529 // if (!preg_match("/:/",$line) && preg_match("/\)$/",$line)) break;
1530 // however, unsure how well this would work with all imap clients.
1531 if (preg_match("/^\s*UID [0-9]+\)$/", $line)) {
1535 // handle FLAGS reply after headers (AOL, Zimbra?)
1536 if (preg_match('/\s+FLAGS \((.*)\)\)$/', $line, $matches)) {
1537 $flags_str = $matches[1];
1541 if (ord($line[0])<=32) {
1542 $lines[$ln] .= (empty($lines[$ln])?'':"\n").trim($line);
1544 $lines[++$ln] = trim($line);
1546 // patch from "Maksim Rubis" <siburny@hotmail.com>
1547 } while ($line[0] != ')' && !iil_StartsWith($line, $key, true));
1549 if (strncmp($line, $key, strlen($key))) {
1550 // process header, fill iilBasicHeader obj.
1552 if (is_array($headers)) {
1554 while (list($k, $bar) = each($headers)) {
1559 // create array with header field:data
1560 while ( list($lines_key, $str) = each($lines) ) {
1561 list($field, $string) = iil_SplitHeaderLine($str);
1563 $field = strtolower($field);
1564 $string = preg_replace('/\n\s*/', ' ', $string);
1568 if (!$IMAP_USE_INTERNAL_DATE) {
1569 $result[$id]->date = $string;
1570 $result[$id]->timestamp = iil_StrToTime($string);
1574 $result[$id]->from = $string;
1577 $result[$id]->to = preg_replace('/undisclosed-recipients:[;,]*/', '', $string);
1580 $result[$id]->subject = $string;
1583 $result[$id]->replyto = $string;
1586 $result[$id]->cc = $string;
1589 $result[$id]->bcc = $string;
1591 case 'content-transfer-encoding':
1592 $result[$id]->encoding = $string;
1594 case 'content-type':
1595 $ctype_parts = preg_split('/[; ]/', $string);
1596 $result[$id]->ctype = array_shift($ctype_parts);
1597 if (preg_match('/charset\s*=\s*"?([a-z0-9\-\.\_]+)"?/i', $string, $regs)) {
1598 $result[$id]->charset = $regs[1];
1602 $result[$id]->in_reply_to = preg_replace('/[\n<>]/', '', $string);
1605 $result[$id]->references = $string;
1607 case 'return-receipt-to':
1608 case 'disposition-notification-to':
1609 case 'x-confirm-reading-to':
1610 $result[$id]->mdn_to = $string;
1613 $result[$id]->messageID = $string;
1616 if (preg_match('/^(\d+)/', $string, $matches))
1617 $result[$id]->priority = intval($matches[1]);
1620 if (strlen($field) > 2)
1621 $result[$id]->others[$field] = $string;
1626 $a = explode(' ', $line);
1630 if (!empty($flags_str)) {
1631 $flags_str = preg_replace('/[\\\"]/', '', $flags_str);
1632 $flags_a = explode(' ', $flags_str);
1634 if (is_array($flags_a)) {
1636 foreach($flags_a as $flag) {
1637 $flag = strtoupper($flag);
1638 if ($flag == 'SEEN') {
1639 $result[$id]->seen = true;
1640 } else if ($flag == 'DELETED') {
1641 $result[$id]->deleted = true;
1642 } else if ($flag == 'RECENT') {
1643 $result[$id]->recent = true;
1644 } else if ($flag == 'ANSWERED') {
1645 $result[$id]->answered = true;
1646 } else if ($flag == '$FORWARDED') {
1647 $result[$id]->forwarded = true;
1648 } else if ($flag == 'DRAFT') {
1649 $result[$id]->is_draft = true;
1650 } else if ($flag == '$MDNSENT') {
1651 $result[$id]->mdn_sent = true;
1652 } else if ($flag == 'FLAGGED') {
1653 $result[$id]->flagged = true;
1656 $result[$id]->flags = $flags_a;
1660 } while (!iil_StartsWith($line, $key, true));
1665 function iil_C_FetchHeader(&$conn, $mailbox, $id, $uidfetch=false, $bodystr=false, $add='') {
1667 $a = iil_C_FetchHeaders($conn, $mailbox, $id, $uidfetch, $bodystr, $add);
1669 return array_shift($a);
1674 function iil_SortHeaders($a, $field, $flag) {
1675 if (empty($field)) {
1678 $field = strtolower($field);
1679 if ($field == 'date' || $field == 'internaldate') {
1680 $field = 'timestamp';
1686 $flag = strtoupper($flag);
1687 $stripArr = ($field=='subject') ? array('Re: ','Fwd: ','Fw: ','"') : array('"');
1693 First, we'll create an "index" array.
1694 Then, we'll use sort() on that array,
1695 and use that to sort the main array.
1698 // create "index" array
1701 while (list($key, $val)=each($a)) {
1703 if ($field == 'timestamp') {
1704 $data = iil_StrToTime($val->date);
1706 $data = $val->timestamp;
1709 $data = $val->$field;
1710 if (is_string($data)) {
1711 $data=strtoupper(str_replace($stripArr, '', $data));
1719 if ($flag == 'ASC') {
1725 // form new array based on index
1728 while (list($key, $val)=each($index)) {
1729 $result[$key]=$a[$key];
1737 function iil_C_Expunge(&$conn, $mailbox, $messages=NULL) {
1739 if (iil_C_Select($conn, $mailbox)) {
1741 $command = $messages ? "UID EXPUNGE $messages" : "EXPUNGE";
1743 iil_PutLine($conn->fp, "exp1 $command");
1745 $line=chop(iil_ReadLine($conn->fp, 100));
1746 if ($line[0] == '*') {
1749 } while (!iil_StartsWith($line, 'exp1', true));
1751 if (iil_ParseResult($line) == 0) {
1752 $conn->selected = ''; //state has changed, need to reselect
1753 //$conn->exists-=$c;
1756 $conn->error = $line;
1762 function iil_C_ModFlag(&$conn, $mailbox, $messages, $flag, $mod) {
1763 if ($mod != '+' && $mod != '-') {
1768 $flags = $GLOBALS['IMAP_FLAGS'];
1770 $flag = strtoupper($flag);
1771 $flag = $flags[$flag];
1773 if (iil_C_Select($conn, $mailbox)) {
1775 iil_PutLine($fp, "flg UID STORE $messages " . $mod . "FLAGS (" . $flag . ")");
1777 $line=chop(iil_ReadLine($fp, 100));
1778 if ($line[0] == '*') {
1781 } while (!iil_StartsWith($line, 'flg', true));
1783 if (iil_ParseResult($line) == 0) {
1786 $conn->error = $line;
1789 $conn->error = 'Select failed';
1793 function iil_C_Flag(&$conn, $mailbox, $messages, $flag) {
1794 return iil_C_ModFlag($conn, $mailbox, $messages, $flag, '+');
1797 function iil_C_Unflag(&$conn, $mailbox, $messages, $flag) {
1798 return iil_C_ModFlag($conn, $mailbox, $messages, $flag, '-');
1801 function iil_C_Delete(&$conn, $mailbox, $messages) {
1802 return iil_C_ModFlag($conn, $mailbox, $messages, 'DELETED', '+');
1805 function iil_C_Copy(&$conn, $messages, $from, $to) {
1808 if (empty($from) || empty($to)) {
1812 if (iil_C_Select($conn, $from)) {
1815 iil_PutLine($fp, "cpy1 UID COPY $messages \"".iil_Escape($to)."\"");
1816 $line = iil_ReadReply($fp);
1817 return iil_ParseResult($line);
1823 function iil_C_CountUnseen(&$conn, $folder) {
1824 $index = iil_C_Search($conn, $folder, 'ALL UNSEEN');
1825 if (is_array($index))
1826 return count($index);
1830 function iil_C_UID2ID(&$conn, $folder, $uid) {
1832 $id_a = iil_C_Search($conn, $folder, "UID $uid");
1833 if (is_array($id_a) && count($id_a) == 1) {
1840 function iil_C_ID2UID(&$conn, $folder, $id) {
1846 if (iil_C_Select($conn, $folder)) {
1848 if (iil_PutLine($conn->fp, "$key FETCH $id (UID)")) {
1850 $line = chop(iil_ReadLine($conn->fp, 1024));
1851 if (preg_match("/^\* $id FETCH \(UID (.*)\)/i", $line, $r)) {
1854 } while (!iil_StartsWith($line, $key, true));
1860 function iil_C_Search(&$conn, $folder, $criteria) {
1862 if (iil_C_Select($conn, $folder)) {
1865 $query = 'srch1 SEARCH ' . chop($criteria);
1866 if (!iil_PutLineC($conn->fp, $query)) {
1870 $line = trim(iil_ReadLine($conn->fp));
1871 if (iil_StartsWith($line, '* SEARCH')) {
1872 $data .= substr($line, 8);
1873 } else if (preg_match('/^[0-9 ]+$/', $line)) {
1876 } while (!iil_StartsWith($line, 'srch1', true));
1878 $result_code = iil_ParseResult($line);
1879 if ($result_code == 0) {
1880 return preg_split('/\s+/', $data, -1, PREG_SPLIT_NO_EMPTY);
1882 $conn->error = 'iil_C_Search: ' . $line . "\n";
1885 $conn->error = "iil_C_Search: Couldn't select \"$folder\"\n";
1889 function iil_C_Move(&$conn, $messages, $from, $to) {
1891 if (!$from || !$to) {
1895 $r = iil_C_Copy($conn, $messages, $from, $to);
1898 return iil_C_Delete($conn, $from, $messages);
1904 * Gets the delimiter, for example:
1909 * @return mixed A delimiter (string), or false.
1910 * @param object $conn The current connection.
1911 * @see iil_Connect()
1913 function iil_C_GetHierarchyDelimiter(&$conn) {
1917 if ($conn->delimiter) {
1918 return $conn->delimiter;
1920 if (!empty($my_prefs['delimiter'])) {
1921 return ($conn->delimiter = $my_prefs['delimiter']);
1927 //try (LIST "" ""), should return delimiter (RFC2060 Sec 6.3.8)
1928 if (!iil_PutLine($fp, 'ghd LIST "" ""')) {
1933 $line=iil_ReadLine($fp, 500);
1934 if ($line[0] == '*') {
1935 $line = rtrim($line);
1936 $a=iil_ExplodeQuotedString(' ', iil_UnEscape($line));
1938 $delimiter = str_replace('"', '', $a[count($a)-2]);
1941 } while (!iil_StartsWith($line, 'ghd', true));
1943 if (strlen($delimiter)>0) {
1947 //if that fails, try namespace extension
1948 //try to fetch namespace data
1949 iil_PutLine($conn->fp, "ns1 NAMESPACE");
1951 $line = iil_ReadLine($conn->fp, 1024);
1952 if (iil_StartsWith($line, '* NAMESPACE')) {
1954 $line = iil_UnEscape($line);
1955 $data = iil_ParseNamespace2(substr($line,11), $i, 0, 0);
1957 } while (!iil_StartsWith($line, 'ns1', true));
1959 if (!is_array($data)) {
1963 //extract user space data (opposed to global/shared space)
1964 $user_space_data = $data[0];
1965 if (!is_array($user_space_data)) {
1970 $first_userspace = $user_space_data[0];
1971 if (!is_array($first_userspace)) {
1976 $delimiter = $first_userspace[1];
1981 function iil_C_ListMailboxes(&$conn, $ref, $mailbox) {
1982 global $IGNORE_FOLDERS;
1984 $ignore = $IGNORE_FOLDERS[strtolower($conn->host)];
1988 if (empty($mailbox)) {
1992 if (empty($ref) && $conn->rootdir) {
1993 $ref = $conn->rootdir;
1997 if (!iil_PutLine($fp, "lmb LIST \"".$ref."\" \"".iil_Escape($mailbox)."\"")) {
2004 $line = iil_ReadLine($fp, 500);
2005 $line = iil_MultLine($fp, $line, true);
2007 $a = explode(' ', $line);
2008 if (($line[0] == '*') && ($a[1] == 'LIST')) {
2009 $line = rtrim($line);
2011 $a = iil_ExplodeQuotedString(' ', $line);
2012 // last string is folder name
2013 $folder = preg_replace(array('/^"/', '/"$/'), '', iil_UnEscape($a[count($a)-1]));
2015 if (empty($ignore) || (!empty($ignore)
2016 && !preg_match('/'.preg_quote(ignore, '/').'/i', $folder))) {
2017 $folders[$i] = $folder;
2020 // second from last is delimiter
2021 $delim = trim($a[count($a)-2], '"');
2022 // is it a container?
2025 } while (!iil_StartsWith($line, 'lmb', true));
2027 if (is_array($folders)) {
2029 // if rootdir was specified, make sure it's the first element
2030 // some IMAP servers (i.e. Courier) won't return it
2031 if ($ref[strlen($ref)-1]==$delim)
2032 $ref = substr($ref, 0, strlen($ref)-1);
2033 if ($folders[0]!=$ref)
2034 array_unshift($folders, $ref);
2037 } else if (iil_ParseResult($line) == 0) {
2038 return array('INBOX');
2040 $conn->error = $line;
2045 function iil_C_ListSubscribed(&$conn, $ref, $mailbox) {
2046 global $IGNORE_FOLDERS;
2048 $ignore = $IGNORE_FOLDERS[strtolower($conn->host)];
2051 if (empty($mailbox)) {
2054 if (empty($ref) && $conn->rootdir) {
2055 $ref = $conn->rootdir;
2060 if (!iil_PutLine($fp, 'lsb LSUB "' . $ref . '" "' . iil_Escape($mailbox).'"')) {
2061 $conn->error = "Couldn't send LSUB command\n";
2069 $line = iil_ReadLine($fp, 500);
2070 $line = iil_MultLine($fp, $line, true);
2071 $a = explode(' ', $line);
2073 if (($line[0] == '*') && ($a[1] == 'LSUB' || $a[1] == 'LIST')) {
2074 $line = rtrim($line);
2077 $a = iil_ExplodeQuotedString(' ', $line);
2078 // last string is folder name
2079 $folder = preg_replace(array('/^"/', '/"$/'), '', iil_UnEscape($a[count($a)-1]));
2081 if ((!in_array($folder, $folders)) && (empty($ignore)
2082 || (!empty($ignore) && !preg_match('/'.preg_quote(ignore, '/').'/i', $folder)))) {
2083 $folders[$i] = $folder;
2086 // second from last is delimiter
2087 $delim = trim($a[count($a)-2], '"');
2089 // is it a container?
2092 } while (!iil_StartsWith($line, 'lsb', true));
2094 if (is_array($folders)) {
2096 // if rootdir was specified, make sure it's the first element
2097 // some IMAP servers (i.e. Courier) won't return it
2098 if ($ref[strlen($ref)-1]==$delim) {
2099 $ref = substr($ref, 0, strlen($ref)-1);
2101 if ($folders[0]!=$ref) {
2102 array_unshift($folders, $ref);
2107 $conn->error = $line;
2111 function iil_C_Subscribe(&$conn, $folder) {
2114 $query = 'sub1 SUBSCRIBE "' . iil_Escape($folder). '"';
2115 iil_PutLine($fp, $query);
2117 $line = trim(iil_ReadLine($fp, 512));
2118 return (iil_ParseResult($line) == 0);
2121 function iil_C_UnSubscribe(&$conn, $folder) {
2124 $query = 'usub1 UNSUBSCRIBE "' . iil_Escape($folder) . '"';
2125 iil_PutLine($fp, $query);
2127 $line = trim(iil_ReadLine($fp, 512));
2128 return (iil_ParseResult($line) == 0);
2131 function iil_C_FetchMIMEHeaders(&$conn, $mailbox, $id, $parts) {
2135 if (!iil_C_Select($conn, $mailbox)) {
2140 $parts = (array) $parts;
2146 foreach($parts as $part)
2147 $peeks[] = "BODY.PEEK[$part.MIME]";
2149 $request = "$key FETCH $id (" . implode(' ', $peeks) . ')';
2152 if (!iil_PutLine($fp, $request)) {
2157 $line = iil_ReadLine($fp, 1000);
2158 $line = iil_MultLine($fp, $line);
2160 if (preg_match('/BODY\[([0-9\.]+)\.MIME\]/', $line, $matches)) {
2162 $result[$idx] = preg_replace('/^(\* '.$id.' FETCH \()?\s*BODY\['.$idx.'\.MIME\]\s+/', '', $line);
2163 $result[$idx] = trim($result[$idx], '"');
2164 $result[$idx] = rtrim($result[$idx], "\t\r\n\0\x0B");
2166 } while (!iil_StartsWith($line, $key, true));
2171 function iil_C_FetchPartHeader(&$conn, $mailbox, $id, $is_uid=false, $part=NULL) {
2173 $part = empty($part) ? 'HEADER' : $part.'.MIME';
2175 return iil_C_HandlePartBody($conn, $mailbox, $id, $is_uid, $part);
2178 function iil_C_HandlePartBody(&$conn, $mailbox, $id, $is_uid=false, $part='', $encoding=NULL, $print=NULL, $file=NULL) {
2183 switch ($encoding) {
2187 case 'quoted-printable':
2200 if (iil_C_Select($conn, $mailbox)) {
2201 $reply_key = '* ' . $id;
2205 $request = $key . ($is_uid ? ' UID' : '') . " FETCH $id (BODY.PEEK[$part])";
2207 if (!iil_PutLine($fp, $request)) {
2211 // receive reply line
2213 $line = chop(iil_ReadLine($fp, 1000));
2214 $a = explode(' ', $line);
2215 } while (!($end = iil_StartsWith($line, $key, true)) && $a[2] != 'FETCH');
2216 $len = strlen($line);
2218 // handle empty "* X FETCH ()" response
2219 if ($line[$len-1] == ')' && $line[$len-2] != '(') {
2220 // one line response, get everything between first and last quotes
2221 if (substr($line, -4, 3) == 'NIL') {
2225 $from = strpos($line, '"') + 1;
2226 $to = strrpos($line, '"');
2228 $result = substr($line, $from, $len);
2232 $result = base64_decode($result);
2233 else if ($mode == 2)
2234 $result = quoted_printable_decode($result);
2235 else if ($mode == 3)
2236 $result = convert_uudecode($result);
2238 } else if ($line[$len-1] == '}') {
2239 //multi-line request, find sizes of content and receive that many bytes
2240 $from = strpos($line, '{') + 1;
2241 $to = strrpos($line, '}');
2243 $sizeStr = substr($line, $from, $len);
2244 $bytes = (int)$sizeStr;
2247 while ($bytes > 0) {
2248 $line = iil_ReadLine($fp, 1024);
2249 $len = strlen($line);
2251 if ($len > $bytes) {
2252 $line = substr($line, 0, $bytes);
2253 $len = strlen($line);
2258 $line = rtrim($line, "\t\r\n\0\x0B");
2259 // create chunks with proper length for base64 decoding
2260 $line = $prev.$line;
2261 $length = strlen($line);
2263 $length = floor($length / 4) * 4;
2264 $prev = substr($line, $length);
2265 $line = substr($line, 0, $length);
2271 fwrite($file, base64_decode($line));
2273 echo base64_decode($line);
2275 $result .= base64_decode($line);
2276 } else if ($mode == 2) {
2277 $line = rtrim($line, "\t\r\0\x0B");
2279 fwrite($file, quoted_printable_decode($line));
2281 echo quoted_printable_decode($line);
2283 $result .= quoted_printable_decode($line);
2284 } else if ($mode == 3) {
2285 $line = rtrim($line, "\t\r\n\0\x0B");
2286 if ($line == 'end' || preg_match('/^begin\s+[0-7]+\s+.+$/', $line))
2289 fwrite($file, convert_uudecode($line));
2291 echo convert_uudecode($line);
2293 $result .= convert_uudecode($line);
2295 $line = rtrim($line, "\t\r\n\0\x0B");
2297 fwrite($file, $line . "\n");
2301 $result .= $line . "\n";
2305 // read in anything up until last line
2308 $line = iil_ReadLine($fp, 1024);
2309 } while (!iil_StartsWith($line, $key, true));
2313 fwrite($file, $result);
2314 } else if ($print) {
2326 function iil_C_CreateFolder(&$conn, $folder) {
2328 if (iil_PutLine($fp, 'c CREATE "' . iil_Escape($folder) . '"')) {
2330 $line=iil_ReadLine($fp, 300);
2331 } while (!iil_StartsWith($line, 'c ', true));
2332 return (iil_ParseResult($line) == 0);
2337 function iil_C_RenameFolder(&$conn, $from, $to) {
2339 if (iil_PutLine($fp, 'r RENAME "' . iil_Escape($from) . '" "' . iil_Escape($to) . '"')) {
2341 $line = iil_ReadLine($fp, 300);
2342 } while (!iil_StartsWith($line, 'r ', true));
2343 return (iil_ParseResult($line) == 0);
2348 function iil_C_DeleteFolder(&$conn, $folder) {
2350 if (iil_PutLine($fp, 'd DELETE "' . iil_Escape($folder). '"')) {
2352 $line=iil_ReadLine($fp, 300);
2353 } while (!iil_StartsWith($line, 'd ', true));
2354 return (iil_ParseResult($line) == 0);
2359 function iil_C_Append(&$conn, $folder, &$message) {
2365 $message = str_replace("\r", '', $message);
2366 $message = str_replace("\n", "\r\n", $message);
2368 $len = strlen($message);
2373 $request = 'a APPEND "' . iil_Escape($folder) .'" (\\Seen) {' . $len . '}';
2375 if (iil_PutLine($fp, $request)) {
2376 $line = iil_ReadLine($fp, 512);
2378 if ($line[0] != '+') {
2379 // $errornum = iil_ParseResult($line);
2380 $conn->error .= "Cannot write to folder: $line\n";
2384 iil_PutLine($fp, $message);
2387 $line = iil_ReadLine($fp);
2388 } while (!iil_StartsWith($line, 'a ', true));
2390 $result = (iil_ParseResult($line) == 0);
2392 $conn->error .= $line . "\n";
2397 $conn->error .= "Couldn't send command \"$request\"\n";
2401 function iil_C_AppendFromFile(&$conn, $folder, $path) {
2408 if (file_exists(realpath($path))) {
2409 $in_fp = fopen($path, 'r');
2412 $conn->error .= "Couldn't open $path for reading\n";
2417 $len = filesize($path);
2422 //send APPEND command
2423 $request = 'a APPEND "' . iil_Escape($folder) . '" (\\Seen) {' . $len . '}';
2424 if (iil_PutLine($fp, $request)) {
2425 $line = iil_ReadLine($fp, 512);
2427 if ($line[0] != '+') {
2428 //$errornum = iil_ParseResult($line);
2429 $conn->error .= "Cannot write to folder: $line\n";
2434 while (!feof($in_fp)) {
2435 $buffer = fgets($in_fp, 4096);
2436 iil_PutLine($fp, $buffer, false);
2440 iil_PutLine($fp, ''); // \r\n
2444 $line = iil_ReadLine($fp);
2445 } while (!iil_StartsWith($line, 'a ', true));
2447 $result = (iil_ParseResult($line) == 0);
2449 $conn->error .= $line . "\n";
2455 $conn->error .= "Couldn't send command \"$request\"\n";
2459 function iil_C_FetchStructureString(&$conn, $folder, $id, $is_uid=false) {
2463 if (iil_C_Select($conn, $folder)) {
2466 if (iil_PutLine($fp, $key . ($is_uid ? ' UID' : '') ." FETCH $id (BODYSTRUCTURE)")) {
2468 $line = iil_ReadLine($fp, 5000);
2469 $line = iil_MultLine($fp, $line, true);
2470 if (!preg_match("/^$key/", $line))
2472 } while (!iil_StartsWith($line, $key, true));
2474 $result = trim(substr($result, strpos($result, 'BODYSTRUCTURE')+13, -1));
2480 function iil_C_GetQuota(&$conn) {
2482 * GETQUOTAROOT "INBOX"
2483 * QUOTAROOT INBOX user/rchijiiwa1
2484 * QUOTA user/rchijiiwa1 (STORAGE 654 9765)
2489 $quota_lines = array();
2491 // get line(s) containing quota info
2492 if (iil_PutLine($fp, 'QUOT1 GETQUOTAROOT "INBOX"')) {
2494 $line=chop(iil_ReadLine($fp, 5000));
2495 if (iil_StartsWith($line, '* QUOTA ')) {
2496 $quota_lines[] = $line;
2498 } while (!iil_StartsWith($line, 'QUOT1', true));
2501 // return false if not found, parse if found
2502 $min_free = PHP_INT_MAX;
2503 foreach ($quota_lines as $key => $quota_line) {
2504 $quota_line = preg_replace('/[()]/', '', $quota_line);
2505 $parts = explode(' ', $quota_line);
2506 $storage_part = array_search('STORAGE', $parts);
2508 if (!$storage_part) continue;
2510 $used = intval($parts[$storage_part+1]);
2511 $total = intval($parts[$storage_part+2]);
2512 $free = $total - $used;
2514 // return lowest available space from all quotas
2515 if ($free < $min_free) {
2517 $result['used'] = $used;
2518 $result['total'] = $total;
2519 $result['percent'] = min(100, round(($used/max(1,$total))*100));
2520 $result['free'] = 100 - $result['percent'];
2526 function iil_C_ClearFolder(&$conn, $folder) {
2527 $num_in_trash = iil_C_CountMessages($conn, $folder);
2528 if ($num_in_trash > 0) {
2529 iil_C_Delete($conn, $folder, '1:*');
2531 return (iil_C_Expunge($conn, $folder) >= 0);