X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=functions%2Fimap_general.php;h=82c1b832d6e29ddafca950a53d02415245ae226e;hp=f4b4e347bc9f3436c2dfe5b5442a582383f24817;hb=edde1f5c1a79d459b1c5f060a666edc82424bd27;hpb=6441f7c6b523c5874f702a2bb859a9daddf1cc4f

diff --git a/functions/imap_general.php b/functions/imap_general.php
index f4b4e347..d03cebac 100755
--- a/functions/imap_general.php
+++ b/functions/imap_general.php
@@ -1,242 +1,1112 @@
-<?
-   /**
-    **  imap.php
-    **
-    **  This implements all functions that do general imap functions.
-    **/
-
-   /******************************************************************************
-    **  Reads the output from the IMAP stream.  If handle_errors is set to true,
-    **  this will also handle all errors that are received.  If it is not set,
-    **  the errors will be sent back through $response and $message
-    ******************************************************************************/
-   function sqimap_read_data ($imap_stream, $pre, $handle_errors, $response, $message) {
-      global $color;
-
-      $read = fgets ($imap_stream, 1024);
-      $counter = 0;
-      while ((substr($read, 0, strlen("$pre OK")) != "$pre OK") &&
-             (substr($read, 0, strlen("$pre BAD")) != "$pre BAD") &&
-             (substr($read, 0, strlen("$pre NO")) != "$pre NO")) {
-         $data[$counter] = $read;
-         $read = fgets ($imap_stream, 1024);
-         $counter++;
-      }       
-      if (substr($read, 0, strlen("$pre OK")) == "$pre OK") {
-         $response = "OK";
-         $message = trim(substr($read, strlen("$pre OK"), strlen($read)));
-      }
-      else if (substr($read, 0, strlen("$pre BAD")) == "$pre BAD") {
-         $response = "BAD";
-         $message = trim(substr($read, strlen("$pre BAD"), strlen($read)));
-      }
-      else {   
-         $response = "NO";
-         $message = trim(substr($read, strlen("$pre NO"), strlen($read)));
-      }
-
-      if ($handle_errors == true) {
-         if ($response == "NO") {
-            echo "<br><b><font color=$color[2]>";
-            echo _("ERROR : Could not complete request.");
-            echo "</b><br>";
-            echo _("Reason Given: ");
-            echo "$message</font><br>";
+<?php
+
+/**
+ * imap_general.php
+ *
+ * Copyright (c) 1999-2005 The SquirrelMail Project Team
+ * Licensed under the GNU GPL. For full terms see the file COPYING.
+ *
+ * This implements all functions that do general imap functions.
+ *
+ * @version $Id$
+ * @package squirrelmail
+ * @subpackage imap
+ */
+
+/** Includes.. */
+require_once(SM_PATH . 'functions/page_header.php');
+require_once(SM_PATH . 'functions/auth.php');
+
+
+/**
+ * Generates a new session ID by incrementing the last one used;
+ * this ensures that each command has a unique ID.
+ * @param bool $unique_id (since 1.3.0) controls use of unique 
+ *  identifiers/message sequence numbers in IMAP commands. See IMAP
+ *  rfc 'UID command' chapter.
+ * @return string IMAP session id of the form 'A000'.
+ * @since 1.2.0
+ */
+function sqimap_session_id($unique_id = FALSE) {
+    static $sqimap_session_id = 1;
+
+    if (!$unique_id) {
+        return( sprintf("A%03d", $sqimap_session_id++) );
+    } else {
+        return( sprintf("A%03d", $sqimap_session_id++) . ' UID' );
+    }
+}
+
+/**
+ * Both send a command and accept the result from the command.
+ * This is to allow proper session number handling.
+ * @param resource $imap_stream imap connection resource
+ * @param string $query imap command
+ * @param boolean $handle_errors see sqimap_retrieve_imap_response()
+ * @param mixed $response
+ * @param mixed $message
+ * @param boolean $unique_id (since 1.3.0) controls use of unique 
+ *  identifiers/message sequence numbers in IMAP commands. See IMAP
+ *  rfc 'UID command' chapter.
+ * @return mixed returns false on imap error. displays error message 
+ *  if imap stream is not available.
+ * @since 1.2.3
+ */
+function sqimap_run_command_list ($imap_stream, $query, $handle_errors, &$response, &$message, $unique_id = false) {
+    if ($imap_stream) {
+        $sid = sqimap_session_id($unique_id);
+        fputs ($imap_stream, $sid . ' ' . $query . "\r\n");
+        $tag_uid_a = explode(' ',trim($sid));
+        $tag = $tag_uid_a[0];
+        $read = sqimap_retrieve_imap_response ($imap_stream, $tag, $handle_errors, $response, $message, $query );
+        /* get the response and the message */
+        $message = $message[$tag];
+        $response = $response[$tag];
+        return $read[$tag];
+    } else {
+        global $squirrelmail_language, $color;
+        set_up_language($squirrelmail_language);
+        require_once(SM_PATH . 'functions/display_messages.php');
+        $string = "<b><font color=\"$color[2]\">\n" .
+                _("ERROR : No available imapstream.") .
+                "</b></font>\n";
+        error_box($string,$color);
+        return false;
+    }
+}
+
+/**
+ * @param resource $imap_stream imap connection resource
+ * @param string $query imap command
+ * @param boolean $handle_errors see sqimap_retrieve_imap_response()
+ * @param mixed $response
+ * @param mixed $message
+ * @param boolean $unique_id (since 1.3.0) controls use of unique 
+ *  identifiers/message sequence numbers in IMAP commands. See IMAP
+ *  rfc 'UID command' chapter.
+ * @param mixed $filter (since 1.4.1 and 1.5.0)
+ * @param mixed $outputstream (since 1.4.1 and 1.5.0)
+ * @param mixed $no_return (since 1.4.1 and 1.5.0)
+ * @return mixed returns false on imap error. displays error message 
+ *  if imap stream is not available.
+ * @since 1.2.3
+ */
+function sqimap_run_command ($imap_stream, $query, $handle_errors, &$response,
+                            &$message, $unique_id = false,$filter=false,
+                             $outputstream=false,$no_return=false) {
+    if ($imap_stream) {
+        $sid = sqimap_session_id($unique_id);
+        fputs ($imap_stream, $sid . ' ' . $query . "\r\n");
+        $tag_uid_a = explode(' ',trim($sid));
+        $tag = $tag_uid_a[0];
+
+        $read = sqimap_read_data ($imap_stream, $tag, $handle_errors, $response,
+                                  $message, $query,$filter,$outputstream,$no_return);
+        if (empty($read)) {    //Imap server dropped its connection
+            $response = '';
+            $message = '';
+            return false;
+        }
+        /* retrieve the response and the message */
+        $response = $response[$tag];
+        $message  = $message[$tag];
+
+        if (!empty($read[$tag])) {
+            return $read[$tag][0];
+        } else {
+            return $read[$tag];
+        }
+    } else {
+        global $squirrelmail_language, $color;
+        set_up_language($squirrelmail_language);
+        require_once(SM_PATH . 'functions/display_messages.php');
+        $string = "<b><font color=\"$color[2]\">\n" .
+                _("ERROR : No available imapstream.") .
+                "</b></font>\n";
+        error_box($string,$color);
+        return false;
+    }
+}
+
+/**
+ * @param mixed $new_query
+ * @param string $tag
+ * @param array $aQuery
+ * @param boolean $unique_id
+ * @since 1.5.0
+ */
+function sqimap_prepare_pipelined_query($new_query,&$tag,&$aQuery,$unique_id) {
+    $sid = sqimap_session_id($unique_id);
+    $tag_uid_a = explode(' ',trim($sid));
+    $tag = $tag_uid_a[0];
+    $query = $sid . ' '.$new_query."\r\n";
+    $aQuery[$tag] = $query;
+}
+
+/**
+ * @param stream $imap_stream
+ * @param array $aQueryList
+ * @param boolean $handle_errors
+ * @param array $aServerResponse
+ * @param array $aServerMessage
+ * @param boolean $unique_id
+ * @param mixed $filter see sqimap_retrieve_imap_response()
+ * @param mixed $outputstream see sqimap_retrieve_imap_response()
+ * @param mixed $no_return see sqimap_retrieve_imap_response()
+ * @since 1.5.0
+ */
+function sqimap_run_pipelined_command ($imap_stream, $aQueryList, $handle_errors,
+                       &$aServerResponse, &$aServerMessage, $unique_id = false,
+                       $filter=false,$outputstream=false,$no_return=false) {
+    $aResponse = false;
+
+    /*
+       Do not fire all calls at once to the imap-server but split the calls up
+       in portions of $iChunkSize. If we do not do that I think we misbehave as
+       IMAP client or should handle BYE calls if the IMAP-server drops the
+       connection because the number of queries is to large. This isn't tested
+       but a wild guess how it could work in the field.
+
+       After testing it on Exchange 2000 we discovered that a chunksize of 32
+       was quicker then when we raised it to 128.
+    */
+    $iQueryCount = count($aQueryList);
+    $iChunkSize = 32;
+    // array_chunk would also do the job but it's supported from php > 4.2
+    $aQueryChunks = array();
+    $iLoops = floor($iQueryCount / $iChunkSize);
+
+    if ($iLoops * $iChunkSize != $iQueryCount) ++$iLoops;
+
+    if (!function_exists('array_chunk')) { // arraychunk replacement
+        reset($aQueryList);
+        for($i=0;$i<$iLoops;++$i) {
+            for($j=0;$j<$iChunkSize;++$j) {
+                $key = key($aQueryList);
+                $aTmp[$key] = $aQueryList[$key];
+                if (next($aQueryList) === false) break;
+            }
+            $aQueryChunks[] = $aTmp;
+        }
+    } else {
+        $aQueryChunks = array_chunk($aQueryList,$iChunkSize,true);
+    }
+
+    for ($i=0;$i<$iLoops;++$i) {
+        $aQuery = $aQueryChunks[$i];
+        foreach($aQuery as $tag => $query) {
+            fputs($imap_stream,$query);
+            $aResults[$tag] = false;
+        }
+        foreach($aQuery as $tag => $query) {
+            if ($aResults[$tag] == false) {
+                $aReturnedResponse = sqimap_retrieve_imap_response ($imap_stream, $tag,
+                                    $handle_errors, $response, $message, $query,
+                                    $filter,$outputstream,$no_return);
+                foreach ($aReturnedResponse as $returned_tag => $aResponse) {
+                    if (!empty($aResponse)) {
+                        $aResults[$returned_tag] = $aResponse[0];
+                    } else {
+                        $aResults[$returned_tag] = $aResponse;
+                    }
+                    $aServerResponse[$returned_tag] = $response[$returned_tag];
+                    $aServerMessage[$returned_tag] = $message[$returned_tag];
+                }
+            }
+        }
+    }
+    return $aResults;
+}
+
+/**
+ * Custom fgets function: gets a line from the IMAP-server,
+ * no matter how big it may be.
+ * @param stream imap_stream the stream to read from
+ * @return string a line
+ * @since 1.2.8
+ */
+function sqimap_fgets($imap_stream) {
+    $read = '';
+    $buffer = 4096;
+    $results = '';
+    $offset = 0;
+    while (strpos($results, "\r\n", $offset) === false) {
+        if (!($read = fgets($imap_stream, $buffer))) {
+        /* this happens in case of an error */
+        /* reset $results because it's useless */
+        $results = false;
+            break;
+        }
+        if ( $results != '' ) {
+            $offset = strlen($results) - 1;
+        }
+        $results .= $read;
+    }
+    return $results;
+}
+
+/**
+ * @param stream $imap_stream
+ * @param integer $iSize
+ * @param mixed $filter see sqimap_retrieve_imap_response()
+ * @param mixed $outputstream see sqimap_retrieve_imap_response()
+ * @param mixed $no_return see sqimap_retrieve_imap_response()
+ * @return string
+ * @since 1.4.1
+ */
+function sqimap_fread($imap_stream,$iSize,$filter=false,
+                      $outputstream=false, $no_return=false) {
+    if (!$filter || !$outputstream) {
+        $iBufferSize = $iSize;
+    } else {
+        // see php bug 24033. They changed fread behaviour %$^&$%
+        $iBufferSize = 7800; // multiple of 78 in case of base64 decoding.
+    }
+    if ($iSize < $iBufferSize) {
+        $iBufferSize = $iSize;
+    }
+
+    $iRetrieved = 0;
+    $results = '';
+    $sRead = $sReadRem = '';
+    // NB: fread can also stop at end of a packet on sockets.
+    while ($iRetrieved < $iSize) {
+        $sRead = fread($imap_stream,$iBufferSize);
+        $iLength = strlen($sRead);
+        $iRetrieved += $iLength ;
+        $iRemaining = $iSize - $iRetrieved;
+        if ($iRemaining < $iBufferSize) {
+            $iBufferSize = $iRemaining;
+        }
+        if ($sRead == '') {
+            $results = false;
+            break;
+        }
+        if ($sReadRem != '') {
+            $sRead = $sReadRem . $sRead;
+            $sReadRem = '';
+        }
+
+        if ($filter && $sRead != '') {
+           // in case the filter is base64 decoding we return a remainder
+           $sReadRem = $filter($sRead);
+        }
+        if ($outputstream && $sRead != '') {
+           if (is_resource($outputstream)) {
+               fwrite($outputstream,$sRead);
+           } else if ($outputstream == 'php://stdout') {
+               echo $sRead;
+           }
+        }
+        if ($no_return) {
+            $sRead = '';
+        } else {
+            $results .= $sRead;
+        }
+    }
+    return $results;
+}
+
+
+/**
+ * Obsolete function, inform plugins that use it
+ * @since 1.1.3
+ * @deprecated (since 1.5.0) use sqimap_run_command or sqimap_run_command_list instead
+ */
+function sqimap_read_data_list($imap_stream, $tag, $handle_errors,
+          &$response, &$message, $query = '') {
+    global $color, $squirrelmail_language;
+    set_up_language($squirrelmail_language);
+    require_once(SM_PATH . 'functions/display_messages.php');
+    $string = "<b><font color=\"$color[2]\">\n" .
+        _("ERROR : Bad function call.") .
+        "</b><br />\n" .
+        _("Reason:") . ' '.
+          'There is a plugin installed which make use of the  <br />' .
+          'SquirrelMail internal function sqimap_read_data_list.<br />'.
+          'Please adapt the installed plugin and let it use<br />'.
+          'sqimap_run_command or sqimap_run_command_list instead<br /><br />'.
+          'The following query was issued:<br />'.
+           htmlspecialchars($query) . '<br />' . "</font><br />\n";
+    error_box($string,$color);
+    echo '</body></html>';
+    exit;
+}
+
+/**
+ * Function to display an error related to an IMAP-query.
+ * @param string title the caption of the error box
+ * @param string query the query that went wrong
+ * @param string message_title optional message title
+ * @param string message optional error message
+ * @param string $link an optional link to try again
+ * @return void
+ * @since 1.5.0
+ */
+function sqimap_error_box($title, $query = '', $message_title = '', $message = '', $link = '')
+{
+    global $color, $squirrelmail_language;
+
+    set_up_language($squirrelmail_language);
+    require_once(SM_PATH . 'functions/display_messages.php');
+    $string = "<font color=\"$color[2]\"><b>\n" . $title . "</b><br />\n";
+    $cmd = explode(' ',$query);
+    $cmd= strtolower($cmd[0]);
+
+    if ($query != '' &&  $cmd != 'login')
+        $string .= _("Query:") . ' ' . htmlspecialchars($query) . '<br />';
+    if ($message_title != '')
+        $string .= $message_title;
+    if ($message != '')
+        $string .= htmlspecialchars($message);
+    $string .= "</font><br />\n";
+    if ($link != '')
+        $string .= $link;
+    error_box($string,$color);
+}
+
+/**
+ * Reads the output from the IMAP stream.  If handle_errors is set to true,
+ * this will also handle all errors that are received.  If it is not set,
+ * the errors will be sent back through $response and $message.
+ * @param stream $imap_stream
+ * @param mixed $tag
+ * @param boolean $handle_errors
+ * @param array $response
+ * @param array $message
+ * @param mixed $query
+ * @param mixed $filter
+ * @param mixed $outputstream
+ * @param mixed $no_return
+ * @since 1.5.0
+ */
+function sqimap_retrieve_imap_response($imap_stream, $tag, $handle_errors,
+          &$response, &$message, $query = '',
+           $filter = false, $outputstream = false, $no_return = false) {
+    global $color, $squirrelmail_language;
+    $read = '';
+    if (!is_array($message)) $message = array();
+    if (!is_array($response)) $response = array();
+    $aResponse = '';
+    $resultlist = array();
+    $data = array();
+    $read = sqimap_fgets($imap_stream);
+    $i = 0;
+    while ($read) {
+        $char = $read{0};
+        switch ($char)
+        {
+          case '+':
+          default:
+            $read = sqimap_fgets($imap_stream);
+            break;
+
+          case $tag{0}:
+          {
+            /* get the command */
+            $arg = '';
+            $i = strlen($tag)+1;
+            $s = substr($read,$i);
+            if (($j = strpos($s,' ')) || ($j = strpos($s,"\n"))) {
+                $arg = substr($s,0,$j);
+            }
+            $found_tag = substr($read,0,$i-1);
+            if ($found_tag) {
+                switch ($arg)
+                {
+                  case 'OK':
+                  case 'BAD':
+                  case 'NO':
+                  case 'BYE':
+                  case 'PREAUTH':
+                    $response[$found_tag] = $arg;
+                    $message[$found_tag] = trim(substr($read,$i+strlen($arg)));
+                    if (!empty($data)) {
+                        $resultlist[] = $data;
+                    }
+                    $aResponse[$found_tag] = $resultlist;
+                    $data = $resultlist = array();
+                    if ($found_tag == $tag) {
+                        break 3; /* switch switch while */
+                    }
+                  break;
+                  default:
+                    /* this shouldn't happen */
+                    $response[$found_tag] = $arg;
+                    $message[$found_tag] = trim(substr($read,$i+strlen($arg)));
+                    if (!empty($data)) {
+                        $resultlist[] = $data;
+                    }
+                    $aResponse[$found_tag] = $resultlist;
+                    $data = $resultlist = array();
+                    if ($found_tag == $tag) {
+                        break 3; /* switch switch while */
+                    }
+                }
+            }
+            $read = sqimap_fgets($imap_stream);
+            if ($read === false) { /* error */
+                 break 2; /* switch while */
+            }
+            break;
+          } // end case $tag{0}
+
+          case '*':
+          {
+            if (preg_match('/^\*\s\d+\sFETCH/',$read)) {
+                /* check for literal */
+                $s = substr($read,-3);
+                $fetch_data = array();
+                do { /* outer loop, continue until next untagged fetch
+                        or tagged reponse */
+                    do { /* innerloop for fetching literals. with this loop
+                            we prohibid that literal responses appear in the
+                            outer loop so we can trust the untagged and
+                            tagged info provided by $read */
+                        if ($s === "}\r\n") {
+                            $j = strrpos($read,'{');
+                            $iLit = substr($read,$j+1,-3);
+                            $fetch_data[] = $read;
+                            $sLiteral = sqimap_fread($imap_stream,$iLit,$filter,$outputstream,$no_return);
+                            if ($sLiteral === false) { /* error */
+                                break 4; /* while while switch while */
+                            }
+                            /* backwards compattibility */
+                            $aLiteral = explode("\n", $sLiteral);
+                            /* release not neaded data */
+                            unset($sLiteral);
+                            foreach ($aLiteral as $line) {
+                                $fetch_data[] = $line ."\n";
+                            }
+                            /* release not neaded data */
+                            unset($aLiteral);
+                            /* next fgets belongs to this fetch because
+                               we just got the exact literalsize and there
+                               must follow data to complete the response */
+                            $read = sqimap_fgets($imap_stream);
+                            if ($read === false) { /* error */
+                                break 4; /* while while switch while */
+                            }
+                            $fetch_data[] = $read;
+                        } else {
+                            $fetch_data[] = $read;
+                        }
+                        /* retrieve next line and check in the while
+                           statements if it belongs to this fetch response */
+                        $read = sqimap_fgets($imap_stream);
+                        if ($read === false) { /* error */
+                            break 4; /* while while switch while */
+                        }
+                        /* check for next untagged reponse and break */
+                        if ($read{0} == '*') break 2;
+                        $s = substr($read,-3);
+                    } while ($s === "}\r\n");
+                    $s = substr($read,-3);
+                } while ($read{0} !== '*' &&
+                         substr($read,0,strlen($tag)) !== $tag);
+                $resultlist[] = $fetch_data;
+                /* release not neaded data */
+                unset ($fetch_data);
+            } else {
+                $s = substr($read,-3);
+                do {
+                    if ($s === "}\r\n") {
+                        $j = strrpos($read,'{');
+                        $iLit = substr($read,$j+1,-3);
+                        $data[] = $read;
+                        $sLiteral = fread($imap_stream,$iLit);
+                        if ($sLiteral === false) { /* error */
+                            $read = false;
+                            break 3; /* while switch while */
+                        }
+                        $data[] = $sLiteral;
+                        $data[] = sqimap_fgets($imap_stream);
+                    } else {
+                         $data[] = $read;
+                    }
+                    $read = sqimap_fgets($imap_stream);
+                    if ($read === false) {
+                        break 3; /* while switch while */
+                    } else if ($read{0} == '*') {
+                        break;
+                    }
+                    $s = substr($read,-3);
+                } while ($s === "}\r\n");
+                break 1;
+            }
+            break;
+          } // end case '*'
+        }   // end switch
+    } // end while
+
+    /* error processing in case $read is false */
+    if ($read === false) {
+        // try to retrieve an untagged bye respons from the results
+        $sResponse = array_pop($data);
+        if ($sResponse !== NULL && strpos($sResponse,'* BYE') !== false) {
+            if (!$handle_errors) {
+                $query = '';
+            }
+            sqimap_error_box(_("ERROR : Imap server closed the connection."), $query, _("Server responded:"),$sResponse);
+            echo '</body></html>';
             exit;
-         } else if ($response == "BAD") {
-            echo "<br><b><font color=$color[2]>";
-            echo _("ERROR : Bad or malformed request.");
-            echo "</b><br>";
-            echo _("Server responded: ");
-            echo "$message</font><br>";
+        } else if ($handle_errors) {
+            unset($data);
+            sqimap_error_box(_("ERROR : Connection dropped by imap-server."), $query);
             exit;
-         }
-      }
-      
-      return $data;
-   }
-   
-
-
-   
-   /******************************************************************************
-    **  Logs the user into the imap server.  If $hide is set, no error messages
-    **  will be displayed.  This function returns the imap connection handle.
-    ******************************************************************************/
-   function sqimap_login ($username, $password, $imap_server_address, $imap_port, $hide) {
-      global $color;
-      $imap_stream = fsockopen ($imap_server_address, $imap_port, &$error_number, &$error_string);
-      $server_info = fgets ($imap_stream, 1024);
-      
-      /** Do some error correction **/
-      if (!$imap_stream) {
-         if (!$hide) {
-            echo "Error connecting to IMAP server: $imap_server_address.<br>\r\n";
-            echo "$error_number : $error_string<br>\r\n";
-         }
-         exit;
-      }
-
-      fputs ($imap_stream, "a001 LOGIN \"$username\" \"$password\"\r\n");
-      $read = fgets ($imap_stream, 1024);
-
-      /** If the connection was not successful, lets see why **/
-      if (substr($read, 0, 7) != "a001 OK") {
-         if (!$hide) {
-            if (substr($read, 0, 8) == "a001 BAD") {
-               echo "Bad request: $read<br>\r\n";
-               exit;
-            } else if (substr($read, 0, 7) == "a001 NO") {
-               ?>
-                  <html>
-                     <body bgcolor=ffffff>
-                        <br>
-                        <center>
-                        <table width=70% noborder bgcolor=ffffff align=center>
-                           <tr>
-                              <td bgcolor=dcdcdc>
-                                 <font color=cc0000>
-                                 <center>
-                                 <? echo _("ERROR") ?>
-                                 </center>
-                                 </font>
-                              </td>
-                           </tr>
-                           <tr>
-                              <td>
-                                 <center>
-                                 <? echo _("Unknown user or password incorrect.") ?><br>
-                                 <a href="login.php"><? echo _("Click here to try again") ?></a>
-                                 </center>
-                              </td>
-                           </tr>
-                        </table>
-                        </center>
-                     </body>
-                  </html>
-               <?
-               exit;
+        }
+    }
+
+    /* Set $resultlist array */
+    if (!empty($data)) {
+        //$resultlist[] = $data;
+    }
+    elseif (empty($resultlist)) {
+        $resultlist[] = array();
+    }
+
+    /* Return result or handle errors */
+    if ($handle_errors == false) {
+        return $aResponse;
+    }
+    switch ($response[$tag]) {
+    case 'OK':
+        return $aResponse;
+        break;
+    case 'NO':
+        /* ignore this error from M$ exchange, it is not fatal (aka bug) */
+        if (strstr($message[$tag], 'command resulted in') === false) {
+            sqimap_error_box(_("ERROR : Could not complete request."), $query, _("Reason Given: "), $message[$tag]);
+            echo '</body></html>';
+            exit;
+        }
+        break;
+    case 'BAD':
+        sqimap_error_box(_("ERROR : Bad or malformed request."), $query, _("Server responded: "), $message[$tag]);
+        echo '</body></html>';
+        exit;
+    case 'BYE':
+        sqimap_error_box(_("ERROR : Imap server closed the connection."), $query, _("Server responded: "), $message[$tag]);
+        echo '</body></html>';
+        exit;
+    default:
+        sqimap_error_box(_("ERROR : Unknown imap response."), $query, _("Server responded: "), $message[$tag]);
+       /* the error is displayed but because we don't know the reponse we
+          return the result anyway */
+       return $aResponse;
+       break;
+    }
+}
+
+/**
+ * @param stream $imap_stream
+ * @param string $tag_uid
+ * @param boolean $handle_errors
+ * @param array $response
+ * @param array $message
+ * @param mixed $query (since 1.2.5)
+ * @param mixed $filter (since 1.4.1) see sqimap_retrieve_imap_response()
+ * @param mixed $outputstream (since 1.4.1) see sqimap_retrieve_imap_response()
+ * @param mixed $no_return (since 1.4.1) see sqimap_retrieve_imap_response()
+ */
+function sqimap_read_data ($imap_stream, $tag_uid, $handle_errors,
+                           &$response, &$message, $query = '',
+                           $filter=false,$outputstream=false,$no_return=false) {
+
+    $tag_uid_a = explode(' ',trim($tag_uid));
+    $tag = $tag_uid_a[0];
+
+    $res = sqimap_retrieve_imap_response($imap_stream, $tag, $handle_errors,
+              $response, $message, $query,$filter,$outputstream,$no_return);
+    return $res;
+}
+
+/**
+ * Connects to the IMAP server and returns a resource identifier for use with
+ * the other SquirrelMail IMAP functions.  Does NOT login!
+ * @param string server hostname of IMAP server
+ * @param int port port number to connect to
+ * @param bool tls whether to use TLS when connecting.
+ * @return imap-stream resource identifier
+ * @since 1.5.0 (usable only in 1.5.1 or later)
+ */
+function sqimap_create_stream($server,$port,$tls=false) {
+    global $squirrelmail_language;
+
+    if ($tls == true) {
+        if ((check_php_version(4,3)) and (extension_loaded('openssl'))) {
+            /* Use TLS by prefixing "tls://" to the hostname */
+            $server = 'tls://' . $server;
+        } else {
+            require_once(SM_PATH . 'functions/display_messages.php');
+            logout_error( sprintf(_("Error connecting to IMAP server: %s."), $server).
+                '<br />'.
+                _("TLS is enabled, but this version of PHP does not support TLS sockets, or is missing the openssl extension.").
+                '<br /><br />'.
+                _("Please contact your system administrator and report this error.") );
+        }
+    }
+
+    $imap_stream = @fsockopen($server, $port, $error_number, $error_string, 15);
+
+    /* Do some error correction */
+    if (!$imap_stream) {
+        set_up_language($squirrelmail_language, true);
+        require_once(SM_PATH . 'functions/display_messages.php');
+        logout_error( sprintf(_("Error connecting to IMAP server: %s."), $server).
+            "<br />\r\n$error_number : $error_string<br />\r\n" );
+        exit;
+    }
+    $server_info = fgets ($imap_stream, 1024);
+    return $imap_stream;
+}
+
+/**
+ * Logs the user into the imap server.  If $hide is set, no error messages
+ * will be displayed.  This function returns the imap connection handle.
+ * @param string $username user name
+ * @param string $password encrypted password
+ * @param string $imap_server_address address of imap server
+ * @param integer $imap_port port of imap server
+ * @param boolean $hide controls display connection errors
+ * @return stream
+ */
+function sqimap_login ($username, $password, $imap_server_address, $imap_port, $hide) {
+    global $color, $squirrelmail_language, $onetimepad, $use_imap_tls,
+           $imap_auth_mech, $sqimap_capabilities;
+
+    if (!isset($onetimepad) || empty($onetimepad)) {
+        sqgetglobalvar('onetimepad' , $onetimepad , SQ_SESSION );
+    }
+    if (!isset($sqimap_capabilities)) {
+        sqgetglobalvar('sqimap_capabilities' , $capability , SQ_SESSION );
+    }
+
+    $host = $imap_server_address;
+    $imap_server_address = sqimap_get_user_server($imap_server_address, $username);
+
+    $imap_stream = sqimap_create_stream($imap_server_address,$imap_port,$use_imap_tls);
+
+    /* Decrypt the password */
+    $password = OneTimePadDecrypt($password, $onetimepad);
+
+    if (($imap_auth_mech == 'cram-md5') OR ($imap_auth_mech == 'digest-md5')) {
+        // We're using some sort of authentication OTHER than plain or login
+        $tag=sqimap_session_id(false);
+        if ($imap_auth_mech == 'digest-md5') {
+            $query = $tag . " AUTHENTICATE DIGEST-MD5\r\n";
+        } elseif ($imap_auth_mech == 'cram-md5') {
+            $query = $tag . " AUTHENTICATE CRAM-MD5\r\n";
+        }
+        fputs($imap_stream,$query);
+        $answer=sqimap_fgets($imap_stream);
+        // Trim the "+ " off the front
+        $response=explode(" ",$answer,3);
+        if ($response[0] == '+') {
+            // Got a challenge back
+            $challenge=$response[1];
+            if ($imap_auth_mech == 'digest-md5') {
+                $reply = digest_md5_response($username,$password,$challenge,'imap',$host);
+            } elseif ($imap_auth_mech == 'cram-md5') {
+                $reply = cram_md5_response($username,$password,$challenge);
+            }
+            fputs($imap_stream,$reply);
+            $read=sqimap_fgets($imap_stream);
+            if ($imap_auth_mech == 'digest-md5') {
+                // DIGEST-MD5 has an extra step..
+                if (substr($read,0,1) == '+') { // OK so far..
+                    fputs($imap_stream,"\r\n");
+                    $read=sqimap_fgets($imap_stream);
+                }
+            }
+            $results=explode(" ",$read,3);
+            $response=$results[1];
+            $message=$results[2];
+        } else {
+            // Fake the response, so the error trap at the bottom will work
+            $response="BAD";
+            $message='IMAP server does not appear to support the authentication method selected.';
+            $message .= '  Please contact your system administrator.';
+        }
+    } elseif ($imap_auth_mech == 'login') {
+    // Original IMAP login code
+        $query = 'LOGIN "' . quoteimap($username) .  '" "' . quoteimap($password) . '"';
+        $read = sqimap_run_command ($imap_stream, $query, false, $response, $message);
+    } elseif ($imap_auth_mech == 'plain') {
+        /***
+         * SASL PLAIN
+         *
+         *  RFC 2595 Chapter 6
+         *
+         *  The mechanism consists of a single message from the client to the
+         *  server.  The client sends the authorization identity (identity to
+         *  login as), followed by a US-ASCII NUL character, followed by the
+         *  authentication identity (identity whose password will be used),
+         *  followed by a US-ASCII NUL character, followed by the clear-text
+         *  password.  The client may leave the authorization identity empty to
+         *  indicate that it is the same as the authentication identity.
+         *
+         **/
+        $tag=sqimap_session_id(false);
+        $sasl = (isset($capability['SASL-IR']) && $capability['SASL-IR']) ? true : false;
+        $auth = base64_encode("$username\0$username\0$password");
+        if ($sasl) {
+            // IMAP Extension for SASL Initial Client Response
+            // <draft-siemborski-imap-sasl-initial-response-01b.txt>
+            $query = $tag . " AUTHENTICATE PLAIN $auth\r\n";
+            fputs($imap_stream, $query);
+            $read = sqimap_fgets($imap_stream);
+        } else {
+            $query = $tag . " AUTHENTICATE PLAIN\r\n";
+            fputs($imap_stream, $query);
+            $read=sqimap_fgets($imap_stream);
+            if (substr($read,0,1) == '+') { // OK so far..
+                fputs($imap_stream, "$auth\r\n");
+                $read = sqimap_fgets($imap_stream);
+            }
+        }
+        $results=explode(" ",$read,3);
+        $response=$results[1];
+        $message=$results[2];
+    } else {
+        $response="BAD";
+        $message="Internal SquirrelMail error - unknown IMAP authentication method chosen.  Please contact the developers.";
+    }
+
+    /* If the connection was not successful, lets see why */
+    if ($response != 'OK') {
+        if (!$hide) {
+            if ($response != 'NO') {
+                /* "BAD" and anything else gets reported here. */
+                $message = htmlspecialchars($message);
+                set_up_language($squirrelmail_language, true);
+                require_once(SM_PATH . 'functions/display_messages.php');
+                if ($response == 'BAD') {
+                    $string = sprintf (_("Bad request: %s")."<br />\r\n", $message);
+                } else {
+                    $string = sprintf (_("Unknown error: %s") . "<br />\n", $message);
+                }
+                if (isset($read) && is_array($read)) {
+                    $string .= '<br />' . _("Read data:") . "<br />\n";
+                    foreach ($read as $line) {
+                        $string .= htmlspecialchars($line) . "<br />\n";
+                    }
+                }
+                error_box($string,$color);
+                exit;
             } else {
-               echo "Unknown error: $read<br>";
-               exit;
+                /*
+                 * If the user does not log in with the correct
+                 * username and password it is not possible to get the
+                 * correct locale from the user's preferences.
+                 * Therefore, apply the same hack as on the login
+                 * screen.
+                 *
+                 * $squirrelmail_language is set by a cookie when
+                 * the user selects language and logs out
+                 */
+
+                set_up_language($squirrelmail_language, true);
+                include_once(SM_PATH . 'functions/display_messages.php' );
+                sqsession_destroy();
+                /* terminate the session nicely */
+                sqimap_logout($imap_stream);
+                logout_error( _("Unknown user or password incorrect.") );
+                exit;
             }
-         } else {
+        } else {
             exit;
-         }
-      }
+        }
+    }
 
-      return $imap_stream;
-   }
+    /* Special error case:
+     * Login referrals. The server returns:
+	 * ? OK [REFERRAL <imap url>]
+	 * Check RFC 2221 for details. Since we do not support login referrals yet
+	 * we log the user out.
+	 */
+    if ( stristr($message, 'REFERRAL imap') === TRUE ) {
+        sqimap_logout($imap_stream);   
+        set_up_language($squirrelmail_language, true);
+        include_once(SM_PATH . 'functions/display_messages.php' );
+        sqsession_destroy();
+        logout_error( _("Your mailbox is not located at this server. Try a different server or consult your system administrator") );
+        exit;
+    }
+    
+    return $imap_stream;
+}
 
+/**
+ * Simply logs out the IMAP session
+ * @param stream imap_stream the IMAP connection to log out.
+ * @return void
+ */
+function sqimap_logout ($imap_stream) {
+    /* Logout is not valid until the server returns 'BYE'
+     * If we don't have an imap_ stream we're already logged out */
+    if(isset($imap_stream) && $imap_stream)
+        sqimap_run_command($imap_stream, 'LOGOUT', false, $response, $message);
+}
 
-   
-   
-   /******************************************************************************
-    **  Simply logs out the imap session
-    ******************************************************************************/
-   function sqimap_logout ($imap_stream) {
-      fputs ($imap_stream, "a001 LOGOUT\r\n");
-   }
+/**
+ * Retreive the CAPABILITY string from the IMAP server.
+ * If capability is set, returns only that specific capability,
+ * else returns array of all capabilities.
+ * @param $imap_stream
+ * @param string $capability (optional since 1.3.0)
+ * @return mixed (string if $capability is set and found, 
+ *  false, if $capability is set and not found,
+ *  array if $capability not set)
+ */
+function sqimap_capability($imap_stream, $capability='') {
+    global $sqimap_capabilities;
+    if (!is_array($sqimap_capabilities)) {
+        $read = sqimap_run_command($imap_stream, 'CAPABILITY', true, $a, $b);
 
+        $c = explode(' ', $read[0]);
+        for ($i=2; $i < count($c); $i++) {
+            $cap_list = explode('=', $c[$i]);
+            if (isset($cap_list[1])) {
+                // FIX ME. capabilities can occure multiple times.
+                // THREAD=REFERENCES THREAD=ORDEREDSUBJECT
+                $sqimap_capabilities[$cap_list[0]] = $cap_list[1];
+            } else {
+                $sqimap_capabilities[$cap_list[0]] = TRUE;
+            }
+        }
+    }
+    if ($capability) {
+        if (isset($sqimap_capabilities[$capability])) {
+                return $sqimap_capabilities[$capability];
+        } else {
+                return false;
+        }
+    }
+    return $sqimap_capabilities;
+}
 
+/**
+ * Returns the delimeter between mailboxes: INBOX/Test, or INBOX.Test
+ * @param stream $imap_stream
+ * @return string
+ */
+function sqimap_get_delimiter ($imap_stream = false) {
+    global $sqimap_delimiter, $optional_delimiter;
 
-   /******************************************************************************
-    **  Returns the delimeter between mailboxes:  INBOX/Test, or INBOX.Test... 
-    ******************************************************************************/
-   function sqimap_get_delimiter ($imap_stream) {
-      fputs ($imap_stream, ". LIST \"\" *\r\n");
-      $read = sqimap_read_data($imap_stream, ".", true, $a, $b);
-      $quote_position = strpos ($read[0], "\"");
-      $delim = substr ($read[0], $quote_position+1, 1);
+    /* Use configured delimiter if set */
+    if((!empty($optional_delimiter)) && $optional_delimiter != 'detect') {
+        return $optional_delimiter;
+    }
 
-      return $delim;
-   }
+    /* Do some caching here */
+    if (!$sqimap_delimiter) {
+        if (sqimap_capability($imap_stream, 'NAMESPACE')) {
+            /*
+             * According to something that I can't find, this is supposed to work on all systems
+             * OS: This won't work in Courier IMAP.
+             * OS: According to rfc2342 response from NAMESPACE command is:
+             * OS: * NAMESPACE (PERSONAL NAMESPACES) (OTHER_USERS NAMESPACE) (SHARED NAMESPACES)
+             * OS: We want to lookup all personal NAMESPACES...
+             */
+            $read = sqimap_run_command($imap_stream, 'NAMESPACE', true, $a, $b);
+            if (eregi('\\* NAMESPACE +(\\( *\\(.+\\) *\\)|NIL) +(\\( *\\(.+\\) *\\)|NIL) +(\\( *\\(.+\\) *\\)|NIL)', $read[0], $data)) {
+                if (eregi('^\\( *\\((.*)\\) *\\)', $data[1], $data2)) {
+                    $pn = $data2[1];
+                }
+                $pna = explode(')(', $pn);
+                while (list($k, $v) = each($pna)) {
+                    $lst = explode('"', $v);
+                    if (isset($lst[3])) {
+                        $pn[$lst[1]] = $lst[3];
+                    } else {
+                        $pn[$lst[1]] = '';
+                    }
+                }
+            }
+            $sqimap_delimiter = $pn[0];
+        } else {
+            fputs ($imap_stream, ". LIST \"INBOX\" \"\"\r\n");
+            $read = sqimap_read_data($imap_stream, '.', true, $a, $b);
+            $read = $read['.'][0];    //sqimap_read_data() now returns a tag array of response array
+            $quote_position = strpos ($read[0], '"');
+            $sqimap_delimiter = substr ($read[0], $quote_position+1, 1);
+        }
+    }
+    return $sqimap_delimiter;
+}
 
+/**
+ * This encodes a mailbox name for use in IMAP commands.
+ * @param string what the mailbox to encode
+ * @return string the encoded mailbox string
+ * @since 1.5.0
+ */
+function sqimap_encode_mailbox_name($what)
+{
+    if (ereg("[\"\\\r\n]", $what))
+        return '{' . strlen($what) . "}\r\n" . $what;        /* 4.3 literal form */
+    return '"' . $what . '"';        /* 4.3 quoted string form */
+}
 
+/**
+ * Gets the number of messages in the current mailbox.
+ *
+ * OBSOLETE use sqimap_status_messages instead.
+ */
+function sqimap_get_num_messages ($imap_stream, $mailbox) {
+    $read_ary = sqimap_run_command ($imap_stream, 'EXAMINE ' . sqimap_encode_mailbox_name($mailbox), false, $result, $message);
+    for ($i = 0; $i < count($read_ary); $i++) {
+        if (ereg("[^ ]+ +([^ ]+) +EXISTS", $read_ary[$i], $regs)) {
+            return $regs[1];
+        }
+    }
+    return false; //"BUG! Couldn't get number of messages in $mailbox!";
+}
+include_once(SM_PATH . 'functions/rfc822address.php');
 
+/**
+ * OBSOLETE FUNCTION should be removed after mailbox_display,
+ * printMessage function is adapted
+ */
+function parseAddress($address, $max=0) {
+    $aAddress = parseRFC822Address($address,array('limit'=> $max));
+    /*
+     * Because the expected format of the array element is changed we adapt it now.
+     * This also implies that this function is obsolete and should be removed after the
+     * rest of the source is adapted. See Rfc822Address.php for the new function.
+     */
+     array_walk($aAddress, '_adaptAddress');
+     return $aAddress;
+}
 
-   /******************************************************************************
-    **  Gets the number of messages in the current mailbox. 
-    ******************************************************************************/
-   function sqimap_get_num_messages ($imap_stream, $mailbox) {
-      fputs ($imap_stream, "a001 EXAMINE \"$mailbox\"\r\n");
-      $read_ary = sqimap_read_data ($imap_stream, "a001", true, $result, $message);
-      for ($i = 0; $i < count($read_ary); $i++) {
-         if (substr(trim($read_ary[$i]), -6) == EXISTS) {
-            $array = explode (" ", $read_ary[$i]);
-            $num = $array[1];
-         }
-      }
-      return $num;
-   }
+/**
+ * OBSOLETE FUNCTION should be removed after mailbox_display,
+ * printMessage function is adapted
+ */
+function _adaptAddress(&$aAddr,$k) {
+   $sPersonal = (isset($aAddr[SQM_ADDR_PERSONAL]) && $aAddr[SQM_ADDR_PERSONAL]) ?
+       $aAddr[SQM_ADDR_PERSONAL] : '';
+   $sEmail = ($aAddr[SQM_ADDR_HOST]) ?
+       $aAddr[SQM_ADDR_MAILBOX] . '@'.$aAddr[SQM_ADDR_HOST] :
+       $aAddr[SQM_ADDR_MAILBOX];
+   $aAddr = array($sEmail,$sPersonal);
+}
 
-   
-   /******************************************************************************
-    **  Returns a displayable email address 
-    ******************************************************************************/
-   function sqimap_find_email ($string) {
-      /** Luke Ehresman <lehresma@css.tayloru.edu>
-       ** <lehresma@css.tayloru.edu>
-       ** lehresma@css.tayloru.edu
-       **/
-
-      if (strpos($string, "<") && strpos($string, ">")) {
-         $string = substr($string, strpos($string, "<")+1);
-         $string = substr($string, 0, strpos($string, ">"));
-      }
-      return trim($string); 
-   }
+/**
+ * Returns the number of unseen messages in this folder.
+ * obsoleted by sqimap_status_messages !
+ */
+function sqimap_unseen_messages ($imap_stream, $mailbox) {
+    $aStatus = sqimap_status_messages($imap_stream,$mailbox,array('UNSEEN'));
+    return $aStatus['UNSEEN'];
+}
 
-   
-   /******************************************************************************
-    **  Takes the From: field, and creates a displayable name.
-    **    Luke Ehresman <lkehresman@yahoo.com>
-    **           becomes:   Luke Ehresman
-    **    <lkehresman@yahoo.com>
-    **           becomes:   lkehresman@yahoo.com
-    ******************************************************************************/
-   function sqimap_find_displayable_name ($string) {
-      $string = " ".trim($string);
-      if (strpos($string, "<") && strpos($string, ">")) {
-         if (strpos($string, "<") == 1) {
-            $string = sqimap_find_email($string);
-         } else {
-            $string = trim($string);
-            $string = substr($string, 0, strpos($string, "<"));
-            $string = ereg_replace ("\"", "", $string);   
-         }   
-      }
-      return $string; 
-   }
+/**
+ * Returns the status items of a mailbox.
+ * Default it returns MESSAGES,UNSEEN and RECENT
+ * Supported status items are MESSAGES, UNSEEN, RECENT, UIDNEXT and UIDVALIDITY
+ */
+function sqimap_status_messages ($imap_stream, $mailbox,
+                       $aStatusItems = array('MESSAGES','UNSEEN','RECENT')) {
+
+    $aStatusItems = implode(' ',$aStatusItems);
+    $read_ary = sqimap_run_command ($imap_stream, 'STATUS ' . sqimap_encode_mailbox_name($mailbox) .
+                                    " ($aStatusItems)", false, $result, $message);
+    $i = 0;
+    $messages = $unseen = $recent = $uidnext = $uidvalidity = false;
+    $regs = array(false,false);
+    while (isset($read_ary[$i])) {
+        if (preg_match('/UNSEEN\s+([0-9]+)/i', $read_ary[$i], $regs)) {
+            $unseen = $regs[1];
+        }
+        if (preg_match('/MESSAGES\s+([0-9]+)/i', $read_ary[$i], $regs)) {
+            $messages = $regs[1];
+        }
+        if (preg_match('/RECENT\s+([0-9]+)/i', $read_ary[$i], $regs)) {
+            $recent = $regs[1];
+        }
+        if (preg_match('/UIDNEXT\s+([0-9]+)/i', $read_ary[$i], $regs)) {
+            $uidnext = $regs[1];
+        }
+        if (preg_match('/UIDVALIDITY\s+([0-9]+)/i', $read_ary[$i], $regs)) {
+            $uidvalidity = $regs[1];
+        }
+        $i++;
+    }
+    return array('MESSAGES' => $messages,
+                 'UNSEEN'=>$unseen,
+                 'RECENT' => $recent,
+                 'UIDNEXT' => $uidnext,
+                 'UIDVALIDITY' => $uidvalidity);
+}
+
+
+/**
+ * Saves a message to a given folder -- used for saving sent messages
+ */
+function sqimap_append ($imap_stream, $sent_folder, $length) {
+    fputs ($imap_stream, sqimap_session_id() . ' APPEND ' . sqimap_encode_mailbox_name($sent_folder) . " (\\Seen) \{$length}\r\n");
+    $tmp = fgets ($imap_stream, 1024);
+    sqimap_append_checkresponse($tmp, $sent_folder);
+}
 
+function sqimap_append_done ($imap_stream, $folder='') {
+    fputs ($imap_stream, "\r\n");
+    $tmp = fgets ($imap_stream, 1024);
+    sqimap_append_checkresponse($tmp, $folder);
+}
 
-   
-   /******************************************************************************
-    **  Returns the number of unseen messages in this folder 
-    ******************************************************************************/
-   function sqimap_unseen_messages ($imap_stream, &$num_unseen) {
-      fputs ($imap_stream, "a001 SEARCH UNSEEN NOT DELETED\r\n");
-      $read_ary = sqimap_read_data ($imap_stream, "a001", true, $result, $message);
-      $unseen = false;
-      
-      if (strlen($read_ary[0]) > 10) {
-         $unseen = true;
-         $ary = explode (" ", $read_ary[0]);
-         $num_unseen = count($ary) - 2;
-      } else {
-         $unseen = false;
-         $num_unseen = 0;
-      }
-
-      return $unseen;
+function sqimap_append_checkresponse($response, $folder) {
+    
+    if (preg_match("/(.*)(BAD|NO)(.*)$/", $response, $regs)) {
+        global $squirrelmail_language, $color;
+        set_up_language($squirrelmail_language);
+        require_once(SM_PATH . 'functions/display_messages.php');
+
+        $reason = $regs[3];
+        if ($regs[2] == 'NO') {
+           $string = "<b><font color=\"$color[2]\">\n" .
+                  _("ERROR : Could not append message to") ." $folder." .
+                  "</b><br />\n" .
+                  _("Server responded: ") .
+                  $reason . "<br />\n";
+           if (preg_match("/(.*)(quota)(.*)$/i", $reason, $regs)) {
+              $string .= _("Solution: ") .
+            _("Remove unneccessary messages from your folder and start with your Trash folder.")
+              ."<br />\n";
+           }
+           $string .= "</font>\n";
+           error_box($string,$color);
+        } else {
+           $string = "<b><font color=\"$color[2]\">\n" .
+                  _("ERROR : Bad or malformed request.") .
+                  "</b><br />\n" .
+                  _("Server responded: ") .
+                  $reason . "</font><br />\n";
+           error_box($string,$color);
+           exit;
+        }
+    }
+}
+
+function sqimap_get_user_server ($imap_server, $username) {
+   if (substr($imap_server, 0, 4) != "map:") {
+       return $imap_server;
    }
- 
-  
-   /******************************************************************************
-    **  Saves a message to a given folder -- used for saving sent messages
-    ******************************************************************************/
-   function sqimap_append ($imap_stream, $sent_folder, $length) {
-      fputs ($imap_stream, "a001 APPEND $sent_folder (\\Seen) \{$length}\r\n");
-      $read_ary = sqimap_read_data ($imap_stream, "a001", true, $result, $message);
-   } 
-?>
+   $function = substr($imap_server, 4);
+   return $function($username);
+}
+
+/**
+ * This is an example that gets imapservers from yellowpages (NIS).
+ * you can simple put map:map_yp_alias in your $imap_server_address
+ * in config.php use your own function instead map_yp_alias to map your
+ * LDAP whatever way to find the users imapserver.
+ */
+function map_yp_alias($username) {
+   $yp = `ypmatch $username aliases`;
+   return chop(substr($yp, strlen($username)+1));
+}
+
+?>
\ No newline at end of file