** imap.php
**
** This implements all functions that do general imap functions.
+ **
+ ** $Id$
**/
- $imap_general_debug = false;
- //$imap_general_debug = false;
+ if (defined ('imap_general_php'))
+ return;
+ define ('imap_general_php', true);
+
+global $imap_general_debug;
+$imap_general_debug = false;
+
+ /******************************************************************************
+ ** Sets an unique session id in order to avoid simultanous sessions crash.
+ ******************************************************************************/
+
+ function sqimap_session_id() {
+ return( substr( session_id(), -4 ) );
+ }
+
/******************************************************************************
** 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;
- $counter = 0;
- do {
- $data[$counter] = $read = fgets ($imap_stream, 9096);
- if ($imap_general_debug) { echo "<small><tt><font color=cc0000>$read</font></tt></small><br>"; flush(); }
- $counter++;
- } while (! ereg("^$pre (OK|BAD|NO)(.*)$", $read, $regs));
+ function sqimap_read_data_list ($imap_stream, $pre, $handle_errors,
+ &$response, &$message) {
+ global $color, $squirrelmail_language;
+ global $imap_general_debug;
+
+ $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
+
+ // For debugging purposes
+ if ($imap_general_debug) {
+ echo "<small><tt><font color=\"#CC0000\">$read</font></tt></small><br>\n";
+ flush();
+ }
+
+ $size = -1;
+ $data[] = $read;
+ $read = fgets($imap_stream, 9096);
+ } else {
+ $size = -1;
+ }
+ while (1) {
+ while (strpos($read, "\n") === false) {
+ $read .= fgets($imap_stream, 9096);
+ }
+
+ // For debugging purposes
+ if ($imap_general_debug) {
+ echo "<small><tt><font color=\"#CC0000\">$read</font></tt></small><br>\n";
+ flush();
+ }
+ // 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 ($imap_general_debug) echo "--<br>";
-
- if ($handle_errors == true) {
- if ($response == "NO") {
- // ignore this error from m$ exchange, it is not fatal (aka bug)
- if (!ereg("command resulted in",$message)) {
- 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") {
+ if ($imap_general_debug) { echo '--<br>'; }
+ 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 _("ERROR : Could not complete request.");
echo "</b><br>\n";
- echo _("Server responded: ");
+ echo _("Reason Given: ");
echo $message . "</font><br>\n";
exit;
}
+ } else if ($response == 'BAD') {
+ 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";
+ exit;
}
-
- return $data;
+ return $resultlist;
}
-
+
+ function sqimap_read_data ($imap_stream, $pre, $handle_errors, &$response, &$message) {
+ $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.
global $color, $squirrelmail_language, $HTTP_ACCEPT_LANGUAGE, $onetimepad;
$imap_stream = fsockopen ($imap_server_address, $imap_port,
- &$error_number, &$error_string, 15);
+ $error_number, $error_string, 15);
$server_info = fgets ($imap_stream, 1024);
-
+
// Decrypt the password
$password = OneTimePadDecrypt($password, $onetimepad);
exit;
}
- fputs ($imap_stream, "a001 LOGIN \"" . quotemeta($username) .
- "\" \"" . quotemeta($password) . "\"\r\n");
- $read = sqimap_read_data ($imap_stream, "a001", false, $response, $message);
+ fputs ($imap_stream, sqimap_session_id() . ' LOGIN "' . quoteIMAP($username) .
+ '" "' . quoteIMAP($password) . "\"\r\n");
+ $read = sqimap_read_data ($imap_stream, sqimap_session_id(), false, $response, $message);
/** If the connection was not successful, lets see why **/
if ($response != "OK") {
if (!$hide) {
- if ($response != "NO") {
+ if ($response != 'NO') {
// "BAD" and anything else gets reported here.
set_up_language($squirrelmail_language, true);
- if ($response == "BAD")
+ if ($response == 'BAD')
printf (_("Bad request: %s")."<br>\r\n", $message);
else
printf (_("Unknown error: %s") . "<br>\n", $message);
- echo "<br>";
+ echo '<br>';
echo _("Read data:") . "<br>\n";
- if (is_array($read))
- {
- foreach ($read as $line)
- {
- echo htmlspecialchars($line) . "<br>\n";
- }
+ if (is_array($read))
+ {
+ foreach ($read as $line)
+ {
+ echo htmlspecialchars($line) . "<br>\n";
+ }
}
exit;
} else {
// $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>
+ <body bgcolor="ffffff">
<br>
<center>
- <table width=70% noborder bgcolor=ffffff align=center>
+ <table width="70%" noborder bgcolor="ffffff" align="center">
<tr>
- <td bgcolor=dcdcdc>
- <font color=cc0000>
+ <td bgcolor="dcdcdc">
+ <font color="cc0000">
<center>
<?php echo _("ERROR") ?>
</center>
** Simply logs out the imap session
******************************************************************************/
function sqimap_logout ($imap_stream) {
- fputs ($imap_stream, "a001 LOGOUT\r\n");
+ fputs ($imap_stream, sqimap_session_id() . " LOGOUT\r\n");
}
-function sqimap_capability($imap_stream, $capability) {
- global $sqimap_capabilities;
- global $imap_general_debug;
+ function sqimap_capability($imap_stream, $capability) {
+ global $sqimap_capabilities;
+global $imap_general_debug;
- if (!is_array($sqimap_capabilities)) {
- fputs ($imap_stream, "a001 CAPABILITY\r\n");
- $read = sqimap_read_data($imap_stream, "a001", true, $a, $b);
+ if (!is_array($sqimap_capabilities)) {
+ fputs ($imap_stream, sqimap_session_id() . " CAPABILITY\r\n");
+ $read = sqimap_read_data($imap_stream, sqimap_session_id(), true, $a, $b);
- $c = explode(' ', $read[0]);
- for ($i=2; $i < count($c); $i++) {
- list($k, $v) = explode('=', $c[$i]);
- $sqimap_capabilities[$k] = ($v)?$v:TRUE;
- }
- }
- return $sqimap_capabilities[$capability];
-}
+ $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;
+ return $sqimap_capabilities[$capability];
+ }
/******************************************************************************
** Returns the delimeter between mailboxes: INBOX/Test, or INBOX.Test...
******************************************************************************/
-function sqimap_get_delimiter ($imap_stream = false) {
- global $imap_general_debug;
- global $sqimap_delimiter;
- global $optional_delimiter;
-
- /* Use configured delimiter if set */
- if((!empty($optional_delimiter)) && $optional_delimiter != "detect") {
- return $optional_delimiter;
- }
+ function sqimap_get_delimiter ($imap_stream = false) {
+global $imap_general_debug;
+ 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...
- */
- fputs ($imap_stream, "a001 NAMESPACE\r\n");
- $read = sqimap_read_data($imap_stream, "a001", 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))
- {
- list($_, $n, $_, $d) = explode('"', $v);
- $pn[$n] = $d;
- }
-/* OS: We don't need this code right now, it is for other_users and shared folders
- if (eregi('^\( *\((.*)\) *\)', $data[2], $data2))
- $on = $data2[1];
- if (eregi('^\( *\((.*)\) *\)', $data[3], $data2))
- $sn = $data2[1];
- unset($data);
- $ona = explode(')(', $on);
- while (list($k, $v) = each($ona))
- {
- list($_, $n, $_, $d) = explode('"', $v);
- $on[$n] = $d;
- }
- $sna = explode(')(', $sn);
- while (list($k, $v) = each($sna))
- {
- list($_, $n, $_, $d) = explode('"', $v);
- $sn[$n] = $d;
- }
-*/
- }
- $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;
-}
+ /* 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...
+ */
+ fputs ($imap_stream, sqimap_session_id() . " NAMESPACE\r\n");
+ $read = sqimap_read_data($imap_stream, sqimap_session_id(), 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) {
- fputs ($imap_stream, "a001 EXAMINE \"$mailbox\"\r\n");
- $read_ary = sqimap_read_data ($imap_stream, "a001", true, $result, $message);
+ fputs ($imap_stream, sqimap_session_id() . " EXAMINE \"$mailbox\"\r\n");
+ $read_ary = sqimap_read_data ($imap_stream, sqimap_session_id(), true, $result, $message);
for ($i = 0; $i < count($read_ary); $i++) {
if (ereg("[^ ]+ +([^ ]+) +EXISTS", $read_ary[$i], $regs)) {
- return $regs[1];
+ return $regs[1];
}
}
return "BUG! Couldn't get number of messages in $mailbox!";
** becomes: lkehresman@yahoo.com
******************************************************************************/
function sqimap_find_displayable_name ($string) {
- $string = " ".trim($string);
+ $string = ' '.trim($string);
$orig_string = $string;
- if (strpos($string, "<") && strpos($string, ">")) {
- if (strpos($string, "<") == 1) {
+ 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);
+ $string = substr($string, 0, strpos($string, '<'));
+ $string = ereg_replace ('"', '', $string);
}
- if (trim($string) == "") {
+ if (trim($string) == '') {
$string = sqimap_find_email($orig_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);
+ function sqimap_unseen_messages ($imap_stream, $mailbox) {
+ //fputs ($imap_stream, sqimap_session_id() . " SEARCH UNSEEN NOT DELETED\r\n");
+ fputs ($imap_stream, sqimap_session_id() . " STATUS \"$mailbox\" (UNSEEN)\r\n");
+ $read_ary = sqimap_read_data ($imap_stream, sqimap_session_id(), 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");
+ fputs ($imap_stream, sqimap_session_id() . " APPEND \"$sent_folder\" (\\Seen) \{$length}\r\n");
$tmp = fgets ($imap_stream, 1024);
}