/**
* imap_general.php
*
- * Copyright (c) 1999-2003 The SquirrelMail Project Team
+ * Copyright (c) 1999-2004 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$
+ * @version $Id$
+ * @package squirrelmail
+ * @subpackage imap
*/
+/** Includes.. */
require_once(SM_PATH . 'functions/page_header.php');
require_once(SM_PATH . 'functions/auth.php');
-global $sqimap_session_id;
-$sqimap_session_id = 1;
+/**
+ * Generates a new session ID by incrementing the last one used;
+ * this ensures that each command has a unique ID.
+ * @param bool unique_id
+ * @return string IMAP session id of the form 'A000'.
+ */
+function sqimap_session_id($unique_id = FALSE) {
+ static $sqimap_session_id = 1;
-/* Sets an unique session id in order to avoid simultanous sessions crash. */
-function sqimap_session_id($unique_id = false) {
- global $data_dir, $username, $sqimap_session_id;
if (!$unique_id) {
return( sprintf("A%03d", $sqimap_session_id++) );
} else {
}
}
-/*
+/**
* Both send a command and accept the result from the command.
* This is to allow proper session number handling.
*/
$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 false;
}
}
+
function sqimap_prepare_pipelined_query($new_query,&$tag,&$aQuery,$unique_id) {
$sid = sqimap_session_id($unique_id);
$tag_uid_a = explode(' ',trim($sid));
return $aResults;
}
-/*
- * custom fgets function. gets a line from IMAP
- * no matter how big it may be
+/**
+ * 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
*/
-
function sqimap_fgets($imap_stream) {
$read = '';
$buffer = 4096;
if ($iSize < $iBufferSize) {
$iBufferSize = $iSize;
}
+
$iRetrieved = 0;
$results = '';
$sRead = $sReadRem = '';
$sRead = $sReadRem . $sRead;
$sReadRem = '';
}
- if (substr($sRead,-1) !== "\n") {
- $i = strrpos($sRead,"\n");
- if ($i !== false && $iRetrieved<$iSize) {
- ++$i;
- $sReadRem = substr($sRead,$i);
- $sRead = substr($sRead,0,$i);
- } else if ($iLength && $iRetrieved<$iSize) { // linelength > received buffer
- $sReadRem = $sRead;
- $sRead = '';
- }
- }
+
if ($filter && $sRead) {
- $filter($sRead);
+ // in case the filter is base64 decoding we return a remainder
+ $sReadRem = $filter($sRead);
}
if ($outputstream && $sRead) {
if (is_resource($outputstream)) {
return $results;
}
-/* obsolete function, inform plugins that use it */
+
+/**
+ * Obsolete function, inform plugins that use it
+ * @deprecated 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;
exit;
}
-function sqimap_error_box($title, $query = '', $message_title = '', $message = '')
+/**
+ * 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
+ */
+function sqimap_error_box($title, $query = '', $message_title = '', $message = '', $link = '')
{
global $color, $squirrelmail_language;
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
+ * the errors will be sent back through $response and $message.
*/
-
function sqimap_retrieve_imap_response($imap_stream, $tag, $handle_errors,
&$response, &$message, $query = '',
$filter = false, $outputstream = false, $no_return = false) {
$read = '';
if (!is_array($message)) $message = array();
if (!is_array($response)) $response = array();
+ $aResponse = '';
$resultlist = array();
$data = array();
$read = sqimap_fgets($imap_stream);
/* error processing in case $read is false */
if ($read === false) {
- unset($data);
- sqimap_error_box(_("ERROR : Connection dropped by imap-server."), $query);
- exit;
+ // 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 ($handle_errors) {
+ unset($data);
+ sqimap_error_box(_("ERROR : Connection dropped by imap-server."), $query);
+ exit;
+ }
}
/* Set $resultlist array */
/* Return result or handle errors */
if ($handle_errors == false) {
return $aResponse;
- return( $resultlist ); //?? Why this?
}
switch ($response[$tag]) {
case 'OK':
}
}
-/** sqimap_create_stream()
- * @return imap-stream resource identifier
+/**
* 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
*/
function sqimap_create_stream($server,$port,$tls=false) {
global $username, $use_imap_tls;
- if ($use_imap_tls == true) {
+ if ($tls == true) {
if ((check_php_version(4,3)) and (extension_loaded('openssl'))) {
/* Use TLS by prefixing "tls://" to the hostname */
- $server = 'tls://' . $imap_server_address;
+ $server = 'tls://' . $server;
} else {
require_once(SM_PATH . 'functions/display_messages.php');
$string = "Unable to connect to IMAP server!<br>TLS is enabled, but this " .
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.
*/
function sqimap_login ($username, $password, $imap_server_address, $imap_port, $hide) {
- global $color, $squirrelmail_language, $onetimepad, $use_imap_tls, $imap_auth_mech;
+ 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);
$query = 'LOGIN "' . quoteimap($username) . '" "' . quoteimap($password) . '"';
$read = sqimap_run_command ($imap_stream, $query, false, $response, $message);
} elseif ($imap_auth_mech == 'plain') {
- /* SASL 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");
-
- $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");
+ 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];
$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) {
* $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();
return $imap_stream;
}
-/* Simply logs out the IMAP session */
+/**
+ * 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 */
sqimap_run_command($imap_stream, 'LOGOUT', false, $response, $message);
}
+/**
+ * Retreive the CAPABILITY string from the IMAP server.
+ * If capability is set, returns only that specific capability,
+ * else returns array of all capabilities.
+ */
function sqimap_capability($imap_stream, $capability='') {
global $sqimap_capabilities;
if (!is_array($sqimap_capabilities)) {
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;
return $sqimap_capabilities;
}
-/* Returns the delimeter between mailboxes: INBOX/Test, or INBOX.Test */
+/**
+ * Returns the delimeter between mailboxes: INBOX/Test, or INBOX.Test
+ */
function sqimap_get_delimiter ($imap_stream = false) {
global $sqimap_delimiter, $optional_delimiter;
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
+ */
function sqimap_encode_mailbox_name($what)
{
if (ereg("[\"\\\r\n]", $what))
}
-/* Gets the number of messages in the current mailbox. */
+/**
+ * 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 ' . sqimap_encode_mailbox_name($mailbox), false, $result, $message);
for ($i = 0; $i < count($read_ary); $i++) {
return false; //"BUG! Couldn't get number of messages in $mailbox!";
}
-
function parseAddress($address, $max=0) {
$aTokens = array();
$aAddress = array();
}
-
-/*
- * Returns the number of unseen messages in this folder
+/**
+ * Returns the number of unseen messages in this folder.
+ * obsoleted by sqimap_status_messages !
*/
function sqimap_unseen_messages ($imap_stream, $mailbox) {
- $read_ary = sqimap_run_command ($imap_stream, 'STATUS ' . sqimap_encode_mailbox_name($mailbox) . ' (UNSEEN)', false, $result, $message);
- $i = 0;
- $regs = array(false, false);
- while (isset($read_ary[$i])) {
- if (ereg("UNSEEN ([0-9]+)", $read_ary[$i], $regs)) {
- break;
- }
- $i++;
- }
- return $regs[1];
+ $aStatus = sqimap_status_messages($imap_stream,$mailbox,array('UNSEEN'));
+ return $aStatus['UNSEEN'];
}
-/*
- * Returns the number of total/unseen/recent messages in this folder
+/**
+ * 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) {
- $read_ary = sqimap_run_command ($imap_stream, 'STATUS ' . sqimap_encode_mailbox_name($mailbox) . ' (MESSAGES UNSEEN RECENT)', false, $result, $message);
+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 = false;
+ $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)) {
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);
+ return array('MESSAGES' => $messages,
+ 'UNSEEN'=>$unseen,
+ 'RECENT' => $recent,
+ 'UIDNEXT' => $uidnext,
+ 'UIDVALIDITY' => $uidvalidity);
}
-/*
- * Saves a message to a given folder -- used for saving sent messages
+/**
+ * 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");
return $function($username);
}
-/* This is an example that gets imapservers from yellowpages (NIS).
+/**
+ * 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. */
-
+ * LDAP whatever way to find the users imapserver.
+ */
function map_yp_alias($username) {
$yp = `ypmatch $username aliases`;
return chop(substr($yp, strlen($username)+1));