<?php
- /**
- ** 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, $squirrelmail_language;
-
- //$imap_general_debug = true;
- $imap_general_debug = false;
-
- $read = fgets ($imap_stream, 1024);
- if ($imap_general_debug) echo "<small><tt><font color=cc0000>$read</font></tt></small><br>";
- $counter = 0;
- while (! ereg("^$pre (OK|BAD|NO)(.*)$", $read, $regs)) {
- $data[$counter] = $read;
- $read = fgets ($imap_stream, 1024);
- if ($imap_general_debug) echo "<small><tt><font color=cc0000>$read</font></tt></small><br>";
- $counter++;
- }
-
- $response = $regs[1];
- $message = trim($regs[2]);
-
- if ($imap_general_debug) echo "--<br>";
-
- if ($handle_errors == true) {
- if ($response == "NO") {
- set_up_language($squirrelmail_language);
- echo "<br><b><font color=$color[2]>\n";
- echo _("ERROR : Could not complete request.");
- echo "</b><br>\n";
- echo _("Reason Given: ");
- echo $message . "</font><br>\n";
- exit;
- } else if ($response == "BAD") {
+/**
+ * imap.php
+ *
+ * Copyright (c) 1999-2002 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.
+ *
+ * $Id$
+ */
+
+require_once('../functions/page_header.php');
+require_once('../functions/display_messages.php');
+
+/**
+ * Unique SessionId
+ *
+ * Sets an unique session id in order to avoid simultanous sessions crash.
+ *
+ * @return string a 4 chars unique string
+ */
+
+global $sqimap_session_id;
+$sqimap_session_id = 1;
+function sqimap_session_id() {
+
+ global $data_dir, $username, $sqimap_session_id;
+
+ return( sprintf("A%03d", $sqimap_session_id++) );
+}
+
+/******************************************************************************
+** Both send a command and accept the result from the command. This is
+** to allow proper session number handling.
+******************************************************************************/
+
+function sqimap_run_command_list ($imap_stream, $query, $handle_errors, &$response, &$message) {
+ $sid = sqimap_session_id();
+ fputs ($imap_stream, $sid . ' ' . $query . "\r\n");
+ $read = sqimap_read_data_list ($imap_stream, $sid, $handle_errors, $response, $message);
+ return $read;
+}
+
+function sqimap_run_command ($imap_stream, $query, $handle_errors, &$response, &$message) {
+ $sid = sqimap_session_id();
+ fputs ($imap_stream, $sid . ' ' . $query . "\r\n");
+ $read = sqimap_read_data ($imap_stream, $sid, $handle_errors, $response, $message);
+ return $read;
+}
+
+
+/******************************************************************************
+** 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_list ($imap_stream, $pre, $handle_errors,
+ &$response, &$message) {
+ global $color, $squirrelmail_language;
+
+ $read = '';
+ $resultlist = array();
+
+ $more_msgs = true;
+ while ($more_msgs) {
+ $data = array();
+ $total_size = 0;
+ while (strpos($read, "\n") === false) {
+ $read .= fgets($imap_stream, 9096);
+ }
+
+ if (ereg("^\\* [0-9]+ FETCH.*\\{([0-9]+)\\}", $read, $regs)) {
+ $size = $regs[1];
+ } else if (ereg("^\\* [0-9]+ FETCH", $read, $regs)) {
+ // Sizeless response, probably single-line
+ $size = -1;
+ $data[] = $read;
+ $read = fgets($imap_stream, 9096);
+ } else {
+ $size = -1;
+ }
+ while (1) {
+ while (strpos($read, "\n") === false) {
+ $read .= fgets($imap_stream, 9096);
+ }
+ // If we know the size, no need to look at the end parameters
+ if ($size > 0) {
+ if ($total_size == $size) {
+ // We've reached the end of this 'message', switch to the next one.
+ $data[] = $read;
+ break;
+ } else if ($total_size > $size) {
+ $difference = $total_size - $size;
+ $total_size = $total_size - strlen($read);
+ $data[] = substr ($read, 0, strlen($read)-$difference);
+ $read = substr ($read, strlen($read)-$difference, strlen($read));
+ break;
+ } else {
+ $data[] = $read;
+ $read = fgets($imap_stream, 9096);
+ while (strpos($read, "\n") === false) {
+ $read .= fgets($imap_stream, 9096);
+ }
+ }
+ $total_size += strlen($read);
+ } else {
+ if (ereg("^$pre (OK|BAD|NO)(.*)", $read, $regs) ||
+ (($size == -1) && ereg("^\\* [0-9]+ FETCH.*", $read, $regs))) {
+ break;
+ } else {
+ $data[] = $read;
+ $read = fgets ($imap_stream, 9096);
+ }
+ }
+ }
+
+ while (($more_msgs = !ereg("^$pre (OK|BAD|NO)(.*)$", $read, $regs)) &&
+ !ereg("^\\* [0-9]+ FETCH.*", $read, $regs)) {
+ $read = fgets($imap_stream, 9096);
+ }
+ $resultlist[] = $data;
+ }
+ $response = $regs[1];
+ $message = trim($regs[2]);
+
+ if ($handle_errors == false) { return $resultlist; }
+
+ if ($response == 'NO') {
+ // ignore this error from m$ exchange, it is not fatal (aka bug)
+ if (strstr($message, 'command resulted in') === false) {
set_up_language($squirrelmail_language);
- echo "<br><b><font color=$color[2]>\n";
- echo _("ERROR : Bad or malformed request.");
- echo "</b><br>\n";
- echo _("Server responded: ");
- echo $message . "</font><br>\n";
+ echo "<br><b><font color=$color[2]>\n" .
+ _("ERROR : Could not complete request.") .
+ "</b><br>\n" .
+ _("Reason Given: ") .
+ $message . "</font><br>\n";
exit;
- }
- }
-
- return $data;
- }
-
+ }
+ } else if ($response == 'BAD') {
+ set_up_language($squirrelmail_language);
+ echo "<br><b><font color=$color[2]>\n" .
+ _("ERROR : Bad or malformed request.") .
+ "</b><br>\n" .
+ _("Server responded: ") .
+ $message . "</font><br>\n";
+ exit;
+ }
+ return $resultlist;
+}
+function sqimap_read_data ($imap_stream, $pre, $handle_errors, &$response, &$message) {
-
- /******************************************************************************
- ** 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, $squirrelmail_language, $HTTP_ACCEPT_LANGUAGE, $onetimepad;
-
- $imap_stream = fsockopen ($imap_server_address, $imap_port, &$error_number, &$error_string);
- $server_info = fgets ($imap_stream, 1024);
-
- // Decrypt the password
- $password = OneTimePadDecrypt($password, $onetimepad);
-
- /** Do some error correction **/
- if (!$imap_stream) {
- if (!$hide) {
+ $res = sqimap_read_data_list($imap_stream, $pre, $handle_errors, $response, $message);
+ return $res[0];
+
+}
+
+/******************************************************************************
+** 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, $squirrelmail_language, $HTTP_ACCEPT_LANGUAGE, $onetimepad;
+
+ $imap_stream = fsockopen ( $imap_server_address, $imap_port,
+ $error_number, $error_string, 15);
+ if ( !$imap_stream ) {
+ return FALSE;
+ }
+ $server_info = fgets ($imap_stream, 1024);
+
+ // Decrypt the password
+ $password = OneTimePadDecrypt($password, $onetimepad);
+
+ /** Do some error correction **/
+ if (!$imap_stream) {
+ if (!$hide) {
set_up_language($squirrelmail_language, true);
printf (_("Error connecting to IMAP server: %s.")."<br>\r\n", $imap_server_address);
echo "$error_number : $error_string<br>\r\n";
- }
- exit;
- }
-
- fputs ($imap_stream, "a001 LOGIN \"$username\" \"$password\"\r\n");
- $read = sqimap_read_data ($imap_stream, "a001", false, $response, $message);
-
- /** If the connection was not successful, lets see why **/
- if ($response != "OK") {
- if (!$hide) {
- if ($response != "NO") {
- // "BAD" and anything else gets reported here.
- set_up_language($squirrelmail_language, true);
- if ($response == "BAD")
+ }
+ exit;
+ }
+
+ $query = 'LOGIN "' . quoteIMAP($username) . '" "' . quoteIMAP($password) . '"';
+ $read = sqimap_run_command ($imap_stream, $query, false, $response, $message);
+
+ /** If the connection was not successful, lets see why **/
+ if ($response != 'OK') {
+ if (!$hide) {
+ if ($response != 'NO') {
+ // "BAD" and anything else gets reported here.
+ set_up_language($squirrelmail_language, true);
+ if ($response == 'BAD') {
printf (_("Bad request: %s")."<br>\r\n", $message);
- else
+ } else {
printf (_("Unknown error: %s") . "<br>\n", $message);
- echo "<br>";
- echo _("Read data:") . "<br>\n";
- foreach ($read as $line)
- {
- echo htmlspecialchars($line) . "<br>\n";
- }
- exit;
+ }
+ echo '<br>' . _("Read data:") . "<br>\n";
+ if (is_array($read)) {
+ foreach ($read as $line) {
+ echo htmlspecialchars($line) . "<br>\n";
+ }
+ }
+ exit;
} else {
- // 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);
-
- ?>
- <html>
- <body bgcolor=ffffff>
- <br>
- <center>
- <table width=70% noborder bgcolor=ffffff align=center>
- <tr>
- <td bgcolor=dcdcdc>
- <font color=cc0000>
- <center>
- <?php echo _("ERROR") ?>
- </center>
- </font>
- </td>
- </tr>
- <tr>
- <td>
- <center>
- <?php echo _("Unknown user or password incorrect.") ?><br>
- <a href="login.php" target="_top"><?php echo _("Click here to try again") ?></a>
- </center>
- </td>
- </tr>
- </table>
- </center>
- </body>
- </html>
- <?php
- session_destroy();
- 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);
+
+ displayHtmlHeader( _("Unknown user or password incorrect.") );
+ echo "<body bgcolor=\"#ffffff\">\n";
+ error_username_password_incorrect();
+ session_destroy();
+ exit;
}
- } else {
+ } else {
exit;
- }
- }
+ }
+ }
+
+ return $imap_stream;
+}
- return $imap_stream;
- }
+/*
+ * Simply logs out the imap session
+ */
+function sqimap_logout ($imap_stream) {
+ /* Logout is not valid until the server returns 'BYE' */
+ sqimap_run_command($imap_stream, 'LOGOUT', false, $response, $message);
+}
+function sqimap_capability($imap_stream, $capability) {
+ global $sqimap_capabilities;
+
+ if (!is_array($sqimap_capabilities)) {
+ $read = sqimap_run_command($imap_stream, 'CAPABILITY', true, $a, $b);
-
-
- /******************************************************************************
- ** Simply logs out the imap session
- ******************************************************************************/
- function sqimap_logout ($imap_stream) {
- fputs ($imap_stream, "a001 LOGOUT\r\n");
- }
-
-
-
- /******************************************************************************
- ** Returns the delimeter between mailboxes: INBOX/Test, or INBOX.Test...
- ******************************************************************************/
- function sqimap_get_delimiter ($imap_stream = false) {
- global $optional_delimiter;
- if (!$optional_delimiter) $optional_delimiter = "detect";
-
- if (strtolower($optional_delimiter) == "detect") {
- fputs ($imap_stream, ". LIST \"INBOX\" \"\"\r\n");
- $read = sqimap_read_data($imap_stream, ".", true, $a, $b);
- $quote_position = strpos ($read[0], "\"");
- $delim = substr ($read[0], $quote_position+1, 1);
- return $delim;
- } else {
- return $optional_delimiter;
- }
-
- /* According to something that I can't find, this is supposed to work on all systems
-
- fputs ($imap_stream, "a001 NAMESPACE\r\n");
- $read = sqimap_read_data($imap_stream, "a001", true, $a, $b);
- eregi("\"\" \"(.)\"", $read[0], $regs);
- return $regs[1];
- */
- }
-
-
-
-
- /******************************************************************************
- ** 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 (ereg("[^ ]+ +([^ ]+) +EXISTS", $read_ary[$i], $regs)) {
- return $regs[1];
- }
- }
- return "BUG! Couldn't get number of messages in $mailbox!";
- }
+ $c = explode(' ', $read[0]);
+ for ($i=2; $i < count($c); $i++) {
+ $cap_list = explode('=', $c[$i]);
+ if (isset($cap_list[1]))
+ $sqimap_capabilities[$cap_list[0]] = $cap_list[1];
+ else
+ $sqimap_capabilities[$cap_list[0]] = TRUE;
+ }
+ }
+ if (! isset($sqimap_capabilities[$capability])) {
+ return false;
+ } else {
+ return $sqimap_capabilities[$capability];
+ }
+}
-
- /******************************************************************************
- ** Returns a displayable email address
- ******************************************************************************/
- function sqimap_find_email ($string) {
- /** Luke Ehresman <lehresma@css.tayloru.edu>
- ** <lehresma@css.tayloru.edu>
- ** lehresma@css.tayloru.edu
- **
- ** What about
- ** lehresma@css.tayloru.edu (Luke Ehresman)
- **/
-
- if (ereg("<([^>]+)>", $string, $regs)) {
- $string = $regs[1];
- }
- return trim($string);
- }
+/******************************************************************************
+** Returns the delimeter between mailboxes: INBOX/Test, or INBOX.Test...
+******************************************************************************/
+function sqimap_get_delimiter ($imap_stream = false) {
+
+ global $sqimap_delimiter;
+ global $optional_delimiter;
+
+ /* Use configured delimiter if set */
+ if((!empty($optional_delimiter)) && $optional_delimiter != 'detect') {
+ return $optional_delimiter;
+ }
+
+ /* 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);
+ $quote_position = strpos ($read[0], '"');
+ $sqimap_delimiter = substr ($read[0], $quote_position+1, 1);
+ }
+ }
+ return $sqimap_delimiter;
+}
+
+
+/*
+ * Gets the number of messages in the current mailbox.
+ */
+function sqimap_get_num_messages ($imap_stream, $mailbox) {
+
+ $read_ary = sqimap_run_command ($imap_stream, "EXAMINE \"$mailbox\"", true, $result, $message);
+ for ($i = 0; $i < count($read_ary); $i++) {
+ if (ereg("[^ ]+ +([^ ]+) +EXISTS", $read_ary[$i], $regs)) {
+ return $regs[1];
+ }
+ }
+ return sprintf( "BUG! Couldn't get number of messages in %s!", $mailbox );
+
+}
+
+
+/*
+* Returns a displayable email address
+*/
+function sqimap_find_email ($string) {
+ /** Luke Ehresman <lehresma@css.tayloru.edu>
+ ** <lehresma@css.tayloru.edu>
+ ** lehresma@css.tayloru.edu
+ **
+ ** What about
+ ** lehresma@css.tayloru.edu (Luke Ehresman)
+ **/
+
+ if (ereg("<([^>]+)>", $string, $regs)) {
+ $string = $regs[1];
+ }
+ return trim($string);
+}
+
+
+/*
+ * Takes the From: field, and creates a displayable name.
+ * Luke Ehresman <lkehresman@yahoo.com>
+ * "Luke Ehresman" <lkehresman@yahoo.com>
+ * lkehresman@yahoo.com (Luke Ehresman)
+ * becomes: Luke Ehresman
+ * <lkehresman@yahoo.com>
+ * becomes: lkehresman@yahoo.com
+ */
+function sqimap_find_displayable_name ($string) {
+ $string = trim($string);
+
+ if ( ereg('^(.+)<.*>', $string, $regs) ) {
+ $string = ereg_replace ('"', '', $regs[1] );
+ if( $string == '' || $string == ' ' ){
+ $string = ' ';
+ }
+ }
+ elseif ( ereg('\((.*)\)', $string, $regs) ) {
+ if( ( $regs[1] == '' ) || ( $regs[1] == ' ' ) ){
+ if ( ereg('^(.+) \(', $string, $regs) ) {
+ $string = ereg_replace( ' \(\)$', '', $string );
+ } else {
+ $string = ' ';
+ }
+ } else {
+ $string = $regs[1];
+ }
+ }
+ else {
+ $string = sqimap_find_email($string);
+ }
+
+ return trim($string);
+}
+
+/*
+* Returns the number of unseen messages in this folder
+*/
+function sqimap_unseen_messages ($imap_stream, $mailbox) {
+ //fputs ($imap_stream, sqimap_session_id() . " SEARCH UNSEEN NOT DELETED\r\n");
+ $read_ary = sqimap_run_command ($imap_stream, "STATUS \"$mailbox\" (UNSEEN)", true, $result, $message);
+ ereg("UNSEEN ([0-9]+)", $read_ary[0], $regs);
+ return $regs[1];
+}
+
+
+/*
+* 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 \"$sent_folder\" (\\Seen) \{$length}\r\n");
+ $tmp = fgets ($imap_stream, 1024);
+}
+function sqimap_append_done ($imap_stream) {
+ fputs ($imap_stream, "\r\n");
+ $tmp = fgets ($imap_stream, 1024);
+}
- /******************************************************************************
- ** 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);
- $orig_string = $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);
- }
-
- if (trim($string) == "") {
- $string = sqimap_find_email($orig_string);
- }
- }
- return $string;
- }
-
-
- /******************************************************************************
- ** Returns the number of unseen messages in this folder
- ******************************************************************************/
- function sqimap_unseen_messages ($imap_stream, &$num_unseen, $mailbox) {
- //fputs ($imap_stream, "a001 SEARCH UNSEEN NOT DELETED\r\n");
- fputs ($imap_stream, "a001 STATUS \"$mailbox\" (UNSEEN)\r\n");
- $read_ary = sqimap_read_data ($imap_stream, "a001", true, $result, $message);
- ereg("UNSEEN ([0-9]+)", $read_ary[0], $regs);
- return $regs[1];
- }
-
-
- /******************************************************************************
- ** 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");
- $tmp = fgets ($imap_stream, 1024);
- }
-
- function sqimap_append_done ($imap_stream) {
- fputs ($imap_stream, "\r\n");
- $tmp = fgets ($imap_stream, 1024);
- }
?>