6 * Copyright (c) 1999-2004 The SquirrelMail Project Team
7 * Licensed under the GNU GPL. For full terms see the file COPYING.
9 * This implements all functions that do general imap functions.
12 * @package squirrelmail
17 require_once(SM_PATH
. 'functions/page_header.php');
18 require_once(SM_PATH
. 'functions/auth.php');
22 * Generates a new session ID by incrementing the last one used;
23 * this ensures that each command has a unique ID.
24 * @param bool unique_id
25 * @return string IMAP session id of the form 'A000'.
27 function sqimap_session_id($unique_id = FALSE) {
28 static $sqimap_session_id = 1;
31 return( sprintf("A%03d", $sqimap_session_id++
) );
33 return( sprintf("A%03d", $sqimap_session_id++
) . ' UID' );
38 * Both send a command and accept the result from the command.
39 * This is to allow proper session number handling.
41 function sqimap_run_command_list ($imap_stream, $query, $handle_errors, &$response, &$message, $unique_id = false) {
43 $sid = sqimap_session_id($unique_id);
44 fputs ($imap_stream, $sid . ' ' . $query . "\r\n");
45 $tag_uid_a = explode(' ',trim($sid));
47 $read = sqimap_retrieve_imap_response ($imap_stream, $tag, $handle_errors, $response, $message, $query );
48 /* get the response and the message */
49 $message = $message[$tag];
50 $response = $response[$tag];
53 global $squirrelmail_language, $color;
54 set_up_language($squirrelmail_language);
55 require_once(SM_PATH
. 'functions/display_messages.php');
56 $string = "<b><font color=$color[2]>\n" .
57 _("ERROR : No available imapstream.") .
59 error_box($string,$color);
64 function sqimap_run_command ($imap_stream, $query, $handle_errors, &$response,
65 &$message, $unique_id = false,$filter=false,
66 $outputstream=false,$no_return=false) {
68 $sid = sqimap_session_id($unique_id);
69 fputs ($imap_stream, $sid . ' ' . $query . "\r\n");
70 $tag_uid_a = explode(' ',trim($sid));
73 $read = sqimap_read_data ($imap_stream, $tag, $handle_errors, $response,
74 $message, $query,$filter,$outputstream,$no_return);
75 if (empty($read)) { //Imap server dropped its connection
80 /* retrieve the response and the message */
81 $response = $response[$tag];
82 $message = $message[$tag];
84 if (!empty($read[$tag])) {
85 return $read[$tag][0];
90 global $squirrelmail_language, $color;
91 set_up_language($squirrelmail_language);
92 require_once(SM_PATH
. 'functions/display_messages.php');
93 $string = "<b><font color=$color[2]>\n" .
94 _("ERROR : No available imapstream.") .
96 error_box($string,$color);
101 function sqimap_prepare_pipelined_query($new_query,&$tag,&$aQuery,$unique_id) {
102 $sid = sqimap_session_id($unique_id);
103 $tag_uid_a = explode(' ',trim($sid));
104 $tag = $tag_uid_a[0];
105 $query = $sid . ' '.$new_query."\r\n";
106 $aQuery[$tag] = $query;
109 function sqimap_run_pipelined_command ($imap_stream, $aQueryList, $handle_errors,
110 &$aServerResponse, &$aServerMessage, $unique_id = false,
111 $filter=false,$outputstream=false,$no_return=false) {
115 Do not fire all calls at once to the imap-server but split the calls up
116 in portions of $iChunkSize. If we do not do that I think we misbehave as
117 IMAP client or should handle BYE calls if the IMAP-server drops the
118 connection because the number of queries is to large. This isn't tested
119 but a wild guess how it could work in the field.
121 After testing it on Exchange 2000 we discovered that a chunksize of 32
122 was quicker then when we raised it to 128.
124 $iQueryCount = count($aQueryList);
126 // array_chunk would also do the job but it's supported from php > 4.2
127 $aQueryChunks = array();
128 $iLoops = floor($iQueryCount / $iChunkSize);
130 if ($iLoops * $iChunkSize != $iQueryCount) ++
$iLoops;
132 if (!function_exists('array_chunk')) { // arraychunk replacement
134 for($i=0;$i<$iLoops;++
$i) {
135 for($j=0;$j<$iChunkSize;++
$j) {
136 $key = key($aQueryList);
137 $aTmp[$key] = $aQueryList[$key];
138 if (next($aQueryList) === false) break;
140 $aQueryChunks[] = $aTmp;
143 $aQueryChunks = array_chunk($aQueryList,$iChunkSize,true);
146 for ($i=0;$i<$iLoops;++
$i) {
147 $aQuery = $aQueryChunks[$i];
148 foreach($aQuery as $tag => $query) {
149 fputs($imap_stream,$query);
150 $aResults[$tag] = false;
152 foreach($aQuery as $tag => $query) {
153 if ($aResults[$tag] == false) {
154 $aReturnedResponse = sqimap_retrieve_imap_response ($imap_stream, $tag,
155 $handle_errors, $response, $message, $query,
156 $filter,$outputstream,$no_return);
157 foreach ($aReturnedResponse as $returned_tag => $aResponse) {
158 if (!empty($aResponse)) {
159 $aResults[$returned_tag] = $aResponse[0];
161 $aResults[$returned_tag] = $aResponse;
163 $aServerResponse[$returned_tag] = $response[$returned_tag];
164 $aServerMessage[$returned_tag] = $message[$returned_tag];
173 * Custom fgets function: gets a line from the IMAP-server,
174 * no matter how big it may be.
175 * @param stream imap_stream the stream to read from
176 * @return string a line
178 function sqimap_fgets($imap_stream) {
183 while (strpos($results, "\r\n", $offset) === false) {
184 if (!($read = fgets($imap_stream, $buffer))) {
185 /* this happens in case of an error */
186 /* reset $results because it's useless */
190 if ( $results != '' ) {
191 $offset = strlen($results) - 1;
198 function sqimap_fread($imap_stream,$iSize,$filter=false,
199 $outputstream=false, $no_return=false) {
200 if (!$filter ||
!$outputstream) {
201 $iBufferSize = $iSize;
203 // see php bug 24033. They changed fread behaviour %$^&$%
204 $iBufferSize = 7800; // multiple of 78 in case of base64 decoding.
206 if ($iSize < $iBufferSize) {
207 $iBufferSize = $iSize;
211 $sRead = $sReadRem = '';
212 // NB: fread can also stop at end of a packet on sockets.
213 while ($iRetrieved < $iSize) {
214 $sRead = fread($imap_stream,$iBufferSize);
215 $iLength = strlen($sRead);
216 $iRetrieved +
= $iLength ;
217 $iRemaining = $iSize - $iRetrieved;
218 if ($iRemaining < $iBufferSize) {
219 $iBufferSize = $iRemaining;
226 $sRead = $sReadRem . $sRead;
229 if (substr($sRead,-1) !== "\n") {
230 $i = strrpos($sRead,"\n");
231 if ($i !== false && $iRetrieved<$iSize) {
233 $sReadRem = substr($sRead,$i);
234 $sRead = substr($sRead,0,$i);
235 } else if ($iLength && $iRetrieved<$iSize) { // linelength > received buffer
240 if ($filter && $sRead) {
243 if ($outputstream && $sRead) {
244 if (is_resource($outputstream)) {
245 fwrite($outputstream,$sRead);
246 } else if ($outputstream == 'php://stdout') {
260 * Obsolete function, inform plugins that use it
261 * @deprecated use sqimap_run_command or sqimap_run_command_list instead
263 function sqimap_read_data_list($imap_stream, $tag, $handle_errors,
264 &$response, &$message, $query = '') {
265 global $color, $squirrelmail_language;
266 set_up_language($squirrelmail_language);
267 require_once(SM_PATH
. 'functions/display_messages.php');
268 $string = "<b><font color=$color[2]>\n" .
269 _("ERROR : Bad function call.") .
272 'There is a plugin installed which make use of the <br>' .
273 'SquirrelMail internal function sqimap_read_data_list.<br>'.
274 'Please adapt the installed plugin and let it use<br>'.
275 'sqimap_run_command or sqimap_run_command_list instead<br><br>'.
276 'The following query was issued:<br>'.
277 htmlspecialchars($query) . '<br>' . "</font><br>\n";
278 error_box($string,$color);
279 echo '</body></html>';
284 * Function to display an error related to an IMAP-query.
285 * @param string title the caption of the error box
286 * @param string query the query that went wrong
287 * @param string message_title optional message title
288 * @param string message optional error message
289 * @param string $link an optional link to try again
292 function sqimap_error_box($title, $query = '', $message_title = '', $message = '', $link = '')
294 global $color, $squirrelmail_language;
296 set_up_language($squirrelmail_language);
297 require_once(SM_PATH
. 'functions/display_messages.php');
298 $string = "<font color=$color[2]><b>\n" . $title . "</b><br>\n";
299 $cmd = explode(' ',$query);
300 $cmd= strtolower($cmd[0]);
302 if ($query != '' && $cmd != 'login')
303 $string .= _("Query:") . ' ' . htmlspecialchars($query) . '<br>';
304 if ($message_title != '')
305 $string .= $message_title;
307 $string .= htmlspecialchars($message);
308 $string .= "</font><br>\n";
311 error_box($string,$color);
315 * Reads the output from the IMAP stream. If handle_errors is set to true,
316 * this will also handle all errors that are received. If it is not set,
317 * the errors will be sent back through $response and $message.
319 function sqimap_retrieve_imap_response($imap_stream, $tag, $handle_errors,
320 &$response, &$message, $query = '',
321 $filter = false, $outputstream = false, $no_return = false) {
322 global $color, $squirrelmail_language;
324 if (!is_array($message)) $message = array();
325 if (!is_array($response)) $response = array();
327 $resultlist = array();
329 $read = sqimap_fgets($imap_stream);
337 $read = sqimap_fgets($imap_stream);
342 /* get the command */
345 $s = substr($read,$i);
346 if (($j = strpos($s,' ')) ||
($j = strpos($s,"\n"))) {
347 $arg = substr($s,0,$j);
349 $found_tag = substr($read,0,$i-1);
358 $response[$found_tag] = $arg;
359 $message[$found_tag] = trim(substr($read,$i+
strlen($arg)));
361 $resultlist[] = $data;
363 $aResponse[$found_tag] = $resultlist;
364 $data = $resultlist = array();
365 if ($found_tag == $tag) {
366 break 3; /* switch switch while */
370 /* this shouldn't happen */
371 $response[$found_tag] = $arg;
372 $message[$found_tag] = trim(substr($read,$i+
strlen($arg)));
374 $resultlist[] = $data;
376 $aResponse[$found_tag] = $resultlist;
377 $data = $resultlist = array();
378 if ($found_tag == $tag) {
379 break 3; /* switch switch while */
383 $read = sqimap_fgets($imap_stream);
384 if ($read === false) { /* error */
385 break 3; /* switch switch while */
388 } // end case $tag{0}
392 if (preg_match('/^\*\s\d+\sFETCH/',$read)) {
393 /* check for literal */
394 $s = substr($read,-3);
395 $fetch_data = array();
396 do { /* outer loop, continue until next untagged fetch
398 do { /* innerloop for fetching literals. with this loop
399 we prohibid that literal responses appear in the
400 outer loop so we can trust the untagged and
401 tagged info provided by $read */
402 if ($s === "}\r\n") {
403 $j = strrpos($read,'{');
404 $iLit = substr($read,$j+
1,-3);
405 $fetch_data[] = $read;
406 $sLiteral = sqimap_fread($imap_stream,$iLit,$filter,$outputstream,$no_return);
407 if ($sLiteral === false) { /* error */
408 break 4; /* while while switch while */
410 /* backwards compattibility */
411 $aLiteral = explode("\n", $sLiteral);
412 /* release not neaded data */
414 foreach ($aLiteral as $line) {
415 $fetch_data[] = $line ."\n";
417 /* release not neaded data */
419 /* next fgets belongs to this fetch because
420 we just got the exact literalsize and there
421 must follow data to complete the response */
422 $read = sqimap_fgets($imap_stream);
423 if ($read === false) { /* error */
424 break 4; /* while while switch while */
426 $fetch_data[] = $read;
428 $fetch_data[] = $read;
430 /* retrieve next line and check in the while
431 statements if it belongs to this fetch response */
432 $read = sqimap_fgets($imap_stream);
433 if ($read === false) { /* error */
434 break 4; /* while while switch while */
436 /* check for next untagged reponse and break */
437 if ($read{0} == '*') break 2;
438 $s = substr($read,-3);
439 } while ($s === "}\r\n");
440 $s = substr($read,-3);
441 } while ($read{0} !== '*' &&
442 substr($read,0,strlen($tag)) !== $tag);
443 $resultlist[] = $fetch_data;
444 /* release not neaded data */
447 $s = substr($read,-3);
449 if ($s === "}\r\n") {
450 $j = strrpos($read,'{');
451 $iLit = substr($read,$j+
1,-3);
453 $sLiteral = fread($imap_stream,$iLit);
454 if ($sLiteral === false) { /* error */
456 break 3; /* while switch while */
459 $data[] = sqimap_fgets($imap_stream);
463 $read = sqimap_fgets($imap_stream);
464 if ($read === false) {
465 break 3; /* while switch while */
466 } else if ($read{0} == '*') {
469 $s = substr($read,-3);
470 } while ($s === "}\r\n");
478 /* error processing in case $read is false */
479 if ($read === false) {
481 if ($handle_errors) {
482 sqimap_error_box(_("ERROR : Connection dropped by imap-server."), $query);
487 /* Set $resultlist array */
489 //$resultlist[] = $data;
491 elseif (empty($resultlist)) {
492 $resultlist[] = array();
495 /* Return result or handle errors */
496 if ($handle_errors == false) {
499 switch ($response[$tag]) {
504 /* ignore this error from M$ exchange, it is not fatal (aka bug) */
505 if (strstr($message[$tag], 'command resulted in') === false) {
506 sqimap_error_box(_("ERROR : Could not complete request."), $query, _("Reason Given: "), $message[$tag]);
507 echo '</body></html>';
512 sqimap_error_box(_("ERROR : Bad or malformed request."), $query, _("Server responded: "), $message[$tag]);
513 echo '</body></html>';
516 sqimap_error_box(_("ERROR : Imap server closed the connection."), $query, _("Server responded: "), $message[$tag]);
517 echo '</body></html>';
520 sqimap_error_box(_("ERROR : Unknown imap response."), $query, _("Server responded: "), $message[$tag]);
521 /* the error is displayed but because we don't know the reponse we
522 return the result anyway */
528 function sqimap_read_data ($imap_stream, $tag_uid, $handle_errors,
529 &$response, &$message, $query = '',
530 $filter=false,$outputstream=false,$no_return=false) {
532 $tag_uid_a = explode(' ',trim($tag_uid));
533 $tag = $tag_uid_a[0];
535 $res = sqimap_retrieve_imap_response($imap_stream, $tag, $handle_errors,
536 $response, $message, $query,$filter,$outputstream,$no_return);
537 /* sqimap_read_data should be called for one response
538 but since it just calls sqimap_retrieve_imap_response which
539 handles multiple responses we need to check for that
540 and merge the $res array IF they are seperated and
541 IF it was a FETCH response. */
543 // if (isset($res[1]) && is_array($res[1]) && isset($res[1][0])
544 // && preg_match('/^\* \d+ FETCH/', $res[1][0])) {
545 // $result = array();
546 // foreach($res as $index=>$value) {
547 // $result = array_merge($result, $res["$index"]);
550 if (isset($result)) {
551 return $result[$tag];
559 * Connects to the IMAP server and returns a resource identifier for use with
560 * the other SquirrelMail IMAP functions. Does NOT login!
561 * @param string server hostname of IMAP server
562 * @param int port port number to connect to
563 * @param bool tls whether to use TLS when connecting.
564 * @return imap-stream resource identifier
566 function sqimap_create_stream($server,$port,$tls=false) {
567 global $username, $use_imap_tls;
570 if ((check_php_version(4,3)) and (extension_loaded('openssl'))) {
571 /* Use TLS by prefixing "tls://" to the hostname */
572 $server = 'tls://' . $server;
574 require_once(SM_PATH
. 'functions/display_messages.php');
575 $string = "Unable to connect to IMAP server!<br>TLS is enabled, but this " .
576 "version of PHP does not support TLS sockets, or is missing the openssl " .
577 "extension.<br><br>Please contact your system administrator.";
578 logout_error($string,$color);
582 $imap_stream = fsockopen($server, $port, $error_number, $error_string, 15);
584 /* Do some error correction */
586 set_up_language($squirrelmail_language, true);
587 require_once(SM_PATH
. 'functions/display_messages.php');
588 $string = sprintf (_("Error connecting to IMAP server: %s.") .
589 "<br>\r\n", $server) .
590 "$error_number : $error_string<br>\r\n";
591 logout_error($string,$color);
594 $server_info = fgets ($imap_stream, 1024);
599 * Logs the user into the imap server. If $hide is set, no error messages
600 * will be displayed. This function returns the imap connection handle.
602 function sqimap_login ($username, $password, $imap_server_address, $imap_port, $hide) {
603 global $color, $squirrelmail_language, $onetimepad, $use_imap_tls,
604 $imap_auth_mech, $sqimap_capabilities;
606 if (!isset($onetimepad) ||
empty($onetimepad)) {
607 sqgetglobalvar('onetimepad' , $onetimepad , SQ_SESSION
);
609 if (!isset($sqimap_capabilities)) {
610 sqgetglobalvar('sqimap_capabilities' , $capability , SQ_SESSION
);
613 $host = $imap_server_address;
614 $imap_server_address = sqimap_get_user_server($imap_server_address, $username);
616 $imap_stream = sqimap_create_stream($imap_server_address,$imap_port,$use_imap_tls);
618 /* Decrypt the password */
619 $password = OneTimePadDecrypt($password, $onetimepad);
621 if (($imap_auth_mech == 'cram-md5') OR ($imap_auth_mech == 'digest-md5')) {
622 // We're using some sort of authentication OTHER than plain or login
623 $tag=sqimap_session_id(false);
624 if ($imap_auth_mech == 'digest-md5') {
625 $query = $tag . " AUTHENTICATE DIGEST-MD5\r\n";
626 } elseif ($imap_auth_mech == 'cram-md5') {
627 $query = $tag . " AUTHENTICATE CRAM-MD5\r\n";
629 fputs($imap_stream,$query);
630 $answer=sqimap_fgets($imap_stream);
631 // Trim the "+ " off the front
632 $response=explode(" ",$answer,3);
633 if ($response[0] == '+') {
634 // Got a challenge back
635 $challenge=$response[1];
636 if ($imap_auth_mech == 'digest-md5') {
637 $reply = digest_md5_response($username,$password,$challenge,'imap',$host);
638 } elseif ($imap_auth_mech == 'cram-md5') {
639 $reply = cram_md5_response($username,$password,$challenge);
641 fputs($imap_stream,$reply);
642 $read=sqimap_fgets($imap_stream);
643 if ($imap_auth_mech == 'digest-md5') {
644 // DIGEST-MD5 has an extra step..
645 if (substr($read,0,1) == '+') { // OK so far..
646 fputs($imap_stream,"\r\n");
647 $read=sqimap_fgets($imap_stream);
650 $results=explode(" ",$read,3);
651 $response=$results[1];
652 $message=$results[2];
654 // Fake the response, so the error trap at the bottom will work
656 $message='IMAP server does not appear to support the authentication method selected.';
657 $message .= ' Please contact your system administrator.';
659 } elseif ($imap_auth_mech == 'login') {
660 // Original IMAP login code
661 $query = 'LOGIN "' . quoteimap($username) . '" "' . quoteimap($password) . '"';
662 $read = sqimap_run_command ($imap_stream, $query, false, $response, $message);
663 } elseif ($imap_auth_mech == 'plain') {
669 * The mechanism consists of a single message from the client to the
670 * server. The client sends the authorization identity (identity to
671 * login as), followed by a US-ASCII NUL character, followed by the
672 * authentication identity (identity whose password will be used),
673 * followed by a US-ASCII NUL character, followed by the clear-text
674 * password. The client may leave the authorization identity empty to
675 * indicate that it is the same as the authentication identity.
678 $tag=sqimap_session_id(false);
679 $sasl = (isset($capability['SASL-IR']) && $capability['SASL-IR']) ?
true : false;
680 $auth = base64_encode("$username\0$username\0$password");
682 // IMAP Extension for SASL Initial Client Response
683 // <draft-siemborski-imap-sasl-initial-response-01b.txt>
684 $query = $tag . " AUTHENTICATE PLAIN $auth\r\n";
685 fputs($imap_stream, $query);
686 $read = sqimap_fgets($imap_stream);
688 $query = $tag . " AUTHENTICATE PLAIN\r\n";
689 fputs($imap_stream, $query);
690 $read=sqimap_fgets($imap_stream);
691 if (substr($read,0,1) == '+') { // OK so far..
692 fputs($imap_stream, "$auth\r\n");
693 $read = sqimap_fgets($imap_stream);
696 $results=explode(" ",$read,3);
697 $response=$results[1];
698 $message=$results[2];
701 $message="Internal SquirrelMail error - unknown IMAP authentication method chosen. Please contact the developers.";
704 /* If the connection was not successful, lets see why */
705 if ($response != 'OK') {
707 if ($response != 'NO') {
708 /* "BAD" and anything else gets reported here. */
709 $message = htmlspecialchars($message);
710 set_up_language($squirrelmail_language, true);
711 require_once(SM_PATH
. 'functions/display_messages.php');
712 if ($response == 'BAD') {
713 $string = sprintf (_("Bad request: %s")."<br>\r\n", $message);
715 $string = sprintf (_("Unknown error: %s") . "<br>\n", $message);
717 if (isset($read) && is_array($read)) {
718 $string .= '<br>' . _("Read data:") . "<br>\n";
719 foreach ($read as $line) {
720 $string .= htmlspecialchars($line) . "<br>\n";
723 error_box($string,$color);
727 * If the user does not log in with the correct
728 * username and password it is not possible to get the
729 * correct locale from the user's preferences.
730 * Therefore, apply the same hack as on the login
733 * $squirrelmail_language is set by a cookie when
734 * the user selects language and logs out
737 set_up_language($squirrelmail_language, true);
738 include_once(SM_PATH
. 'functions/display_messages.php' );
740 logout_error( _("Unknown user or password incorrect.") );
751 * Simply logs out the IMAP session
752 * @param stream imap_stream the IMAP connection to log out.
755 function sqimap_logout ($imap_stream) {
756 /* Logout is not valid until the server returns 'BYE'
757 * If we don't have an imap_ stream we're already logged out */
758 if(isset($imap_stream) && $imap_stream)
759 sqimap_run_command($imap_stream, 'LOGOUT', false, $response, $message);
763 * Retreive the CAPABILITY string from the IMAP server.
764 * If capability is set, returns only that specific capability,
765 * else returns array of all capabilities.
767 function sqimap_capability($imap_stream, $capability='') {
768 global $sqimap_capabilities;
769 if (!is_array($sqimap_capabilities)) {
770 $read = sqimap_run_command($imap_stream, 'CAPABILITY', true, $a, $b);
772 $c = explode(' ', $read[0]);
773 for ($i=2; $i < count($c); $i++
) {
774 $cap_list = explode('=', $c[$i]);
775 if (isset($cap_list[1])) {
776 // FIX ME. capabilities can occure multiple times.
777 // THREAD=REFERENCES THREAD=ORDEREDSUBJECT
778 $sqimap_capabilities[$cap_list[0]] = $cap_list[1];
780 $sqimap_capabilities[$cap_list[0]] = TRUE;
785 if (isset($sqimap_capabilities[$capability])) {
786 return $sqimap_capabilities[$capability];
791 return $sqimap_capabilities;
795 * Returns the delimeter between mailboxes: INBOX/Test, or INBOX.Test
797 function sqimap_get_delimiter ($imap_stream = false) {
798 global $sqimap_delimiter, $optional_delimiter;
800 /* Use configured delimiter if set */
801 if((!empty($optional_delimiter)) && $optional_delimiter != 'detect') {
802 return $optional_delimiter;
805 /* Do some caching here */
806 if (!$sqimap_delimiter) {
807 if (sqimap_capability($imap_stream, 'NAMESPACE')) {
809 * According to something that I can't find, this is supposed to work on all systems
810 * OS: This won't work in Courier IMAP.
811 * OS: According to rfc2342 response from NAMESPACE command is:
812 * OS: * NAMESPACE (PERSONAL NAMESPACES) (OTHER_USERS NAMESPACE) (SHARED NAMESPACES)
813 * OS: We want to lookup all personal NAMESPACES...
815 $read = sqimap_run_command($imap_stream, 'NAMESPACE', true, $a, $b);
816 if (eregi('\\* NAMESPACE +(\\( *\\(.+\\) *\\)|NIL) +(\\( *\\(.+\\) *\\)|NIL) +(\\( *\\(.+\\) *\\)|NIL)', $read[0], $data)) {
817 if (eregi('^\\( *\\((.*)\\) *\\)', $data[1], $data2)) {
820 $pna = explode(')(', $pn);
821 while (list($k, $v) = each($pna)) {
822 $lst = explode('"', $v);
823 if (isset($lst[3])) {
824 $pn[$lst[1]] = $lst[3];
830 $sqimap_delimiter = $pn[0];
832 fputs ($imap_stream, ". LIST \"INBOX\" \"\"\r\n");
833 $read = sqimap_read_data($imap_stream, '.', true, $a, $b);
834 $read = $read['.'][0]; //sqimap_read_data() now returns a tag array of response array
835 $quote_position = strpos ($read[0], '"');
836 $sqimap_delimiter = substr ($read[0], $quote_position+
1, 1);
839 return $sqimap_delimiter;
843 * This encodes a mailbox name for use in IMAP commands.
844 * @param string what the mailbox to encode
845 * @return string the encoded mailbox string
847 function sqimap_encode_mailbox_name($what)
849 if (ereg("[\"\\\r\n]", $what))
850 return '{' . strlen($what) . "}\r\n" . $what; /* 4.3 literal form */
851 return '"' . $what . '"'; /* 4.3 quoted string form */
856 * Gets the number of messages in the current mailbox.
858 function sqimap_get_num_messages ($imap_stream, $mailbox) {
859 $read_ary = sqimap_run_command ($imap_stream, 'EXAMINE ' . sqimap_encode_mailbox_name($mailbox), false, $result, $message);
860 for ($i = 0; $i < count($read_ary); $i++
) {
861 if (ereg("[^ ]+ +([^ ]+) +EXISTS", $read_ary[$i], $regs)) {
865 return false; //"BUG! Couldn't get number of messages in $mailbox!";
868 function parseAddress($address, $max=0) {
871 $iCnt = strlen($address);
872 $aSpecials = array('(' ,'<' ,',' ,';' ,':');
873 $aReplace = array(' (',' <',' ,',' ;',' :');
874 $address = str_replace($aSpecials,$aReplace,$address);
875 $i = $iAddrFound = $bGroup = 0;
877 $cChar = $address{$i};
881 $iEnd = strpos($address,'>',$i+
1);
883 $sToken = substr($address,$i);
886 $sToken = substr($address,$i,$iEnd - $i +
1);
889 $sToken = str_replace($aReplace, $aSpecials,$sToken);
890 $aTokens[] = $sToken;
893 $iEnd = strpos($address,$cChar,$i+
1);
895 // skip escaped quotes
896 $prev_char = $address{$iEnd-1};
897 while ($prev_char === '\\' && substr($address,$iEnd-2,2) !== '\\\\') {
898 $iEnd = strpos($address,$cChar,$iEnd+
1);
900 $prev_char = $address{$iEnd-1};
907 $sToken = substr($address,$i);
910 // also remove the surrounding quotes
911 $sToken = substr($address,$i+
1,$iEnd - $i -1);
914 $sToken = str_replace($aReplace, $aSpecials,$sToken);
915 if ($sToken) $aTokens[] = $sToken;
918 $iEnd = strpos($address,')',$i);
920 $sToken = substr($address,$i);
923 $sToken = substr($address,$i,$iEnd - $i +
1);
926 $sToken = str_replace($aReplace, $aSpecials,$sToken);
927 $aTokens[] = $sToken;
937 if ($max && $max == $iAddrFound) {
949 $iEnd = strpos($address,' ',$i+
1);
951 $sToken = trim(substr($address,$i,$iEnd - $i));
954 $sToken = trim(substr($address,$i));
957 if ($sToken) $aTokens[] = $sToken;
961 $sPersonal = $sEmail = $sComment = $sGroup = '';
962 $aStack = $aComment = array();
963 foreach ($aTokens as $sToken) {
964 if ($max && $max == count($aAddress)) {
976 $aComment[] = substr($sToken,1,-1);
980 $sEmail = trim(implode(' ',$aStack));
981 $aAddress[] = array($sGroup,$sEmail);
982 $aStack = $aComment = array();
988 while (count($aStack) && !$sEmail) {
989 $sEmail = trim(array_pop($aStack));
992 if (count($aStack)) {
993 $sPersonal = trim(implode('',$aStack));
997 if (!$sPersonal && count($aComment)) {
998 $sComment = implode(' ',$aComment);
999 $sPersonal .= $sComment;
1001 $aAddress[] = array($sEmail,$sPersonal);
1002 $sPersonal = $sComment = $sEmail = '';
1003 $aStack = $aComment = array();
1006 $sGroup = implode(' ',$aStack); break;
1010 $sEmail = trim(substr($sToken,1,-1));
1015 default: $aStack[] = $sToken; break;
1018 /* now do the action again for the last address */
1020 while (count($aStack) && !$sEmail) {
1021 $sEmail = trim(array_pop($aStack));
1024 if (count($aStack)) {
1025 $sPersonal = trim(implode('',$aStack));
1029 if (!$sPersonal && count($aComment)) {
1030 $sComment = implode(' ',$aComment);
1031 $sPersonal .= $sComment;
1033 $aAddress[] = array($sEmail,$sPersonal);
1039 * Returns the number of unseen messages in this folder.
1041 function sqimap_unseen_messages ($imap_stream, $mailbox) {
1042 $read_ary = sqimap_run_command ($imap_stream, 'STATUS ' . sqimap_encode_mailbox_name($mailbox) . ' (UNSEEN)', false, $result, $message);
1044 $regs = array(false, false);
1045 while (isset($read_ary[$i])) {
1046 if (ereg("UNSEEN ([0-9]+)", $read_ary[$i], $regs)) {
1055 * Returns the number of total/unseen/recent messages in this folder
1057 function sqimap_status_messages ($imap_stream, $mailbox) {
1058 $read_ary = sqimap_run_command ($imap_stream, 'STATUS ' . sqimap_encode_mailbox_name($mailbox) . ' (MESSAGES UNSEEN RECENT)', false, $result, $message);
1060 $messages = $unseen = $recent = false;
1061 $regs = array(false,false);
1062 while (isset($read_ary[$i])) {
1063 if (preg_match('/UNSEEN\s+([0-9]+)/i', $read_ary[$i], $regs)) {
1066 if (preg_match('/MESSAGES\s+([0-9]+)/i', $read_ary[$i], $regs)) {
1067 $messages = $regs[1];
1069 if (preg_match('/RECENT\s+([0-9]+)/i', $read_ary[$i], $regs)) {
1074 return array('MESSAGES' => $messages, 'UNSEEN'=>$unseen, 'RECENT' => $recent);
1079 * Saves a message to a given folder -- used for saving sent messages
1081 function sqimap_append ($imap_stream, $sent_folder, $length) {
1082 fputs ($imap_stream, sqimap_session_id() . ' APPEND ' . sqimap_encode_mailbox_name($sent_folder) . " (\\Seen) \{$length}\r\n");
1083 $tmp = fgets ($imap_stream, 1024);
1086 function sqimap_append_done ($imap_stream, $folder='') {
1087 global $squirrelmail_language, $color;
1088 fputs ($imap_stream, "\r\n");
1089 $tmp = fgets ($imap_stream, 1024);
1090 if (preg_match("/(.*)(BAD|NO)(.*)$/", $tmp, $regs)) {
1091 set_up_language($squirrelmail_language);
1092 require_once(SM_PATH
. 'functions/display_messages.php');
1094 if ($regs[2] == 'NO') {
1095 $string = "<b><font color=$color[2]>\n" .
1096 _("ERROR : Could not append message to") ." $folder." .
1098 _("Server responded: ") .
1100 if (preg_match("/(.*)(quota)(.*)$/i", $reason, $regs)) {
1101 $string .= _("Solution: ") .
1102 _("Remove unneccessary messages from your folder and start with your Trash folder.")
1105 $string .= "</font>\n";
1106 error_box($string,$color);
1108 $string = "<b><font color=$color[2]>\n" .
1109 _("ERROR : Bad or malformed request.") .
1111 _("Server responded: ") .
1112 $tmp . "</font><br>\n";
1113 error_box($string,$color);
1119 function sqimap_get_user_server ($imap_server, $username) {
1120 if (substr($imap_server, 0, 4) != "map:") {
1121 return $imap_server;
1123 $function = substr($imap_server, 4);
1124 return $function($username);
1128 * This is an example that gets imapservers from yellowpages (NIS).
1129 * you can simple put map:map_yp_alias in your $imap_server_address
1130 * in config.php use your own function instead map_yp_alias to map your
1131 * LDAP whatever way to find the users imapserver.
1133 function map_yp_alias($username) {
1134 $yp = `ypmatch
$username aliases`
;
1135 return chop(substr($yp, strlen($username)+
1));