/**
* imap_general.php
*
- * Copyright (c) 1999-2004 The SquirrelMail Project Team
+ * 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.
/**
* Generates a new session ID by incrementing the last one used;
* this ensures that each command has a unique ID.
- * @param bool 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;
/**
* 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) {
}
}
+/**
+ * @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) {
$read = sqimap_read_data ($imap_stream, $tag, $handle_errors, $response,
$message, $query,$filter,$outputstream,$no_return);
- if (empty($read)) { //Imap server dropped its connection
+ if (empty($read)) { //Imap server dropped its connection
$response = '';
$message = '';
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));
$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) {
* 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 = '';
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) {
if ($iRemaining < $iBufferSize) {
$iBufferSize = $iRemaining;
}
- if (!$sRead) {
+ if ($sRead == '') {
$results = false;
break;
}
- if ($sReadRem) {
+ if ($sReadRem != '') {
$sRead = $sReadRem . $sRead;
$sReadRem = '';
}
- if ($filter && $sRead) {
+ if ($filter && $sRead != '') {
// in case the filter is base64 decoding we return a remainder
$sReadRem = $filter($sRead);
}
- if ($outputstream && $sRead) {
+ if ($outputstream && $sRead != '') {
if (is_resource($outputstream)) {
fwrite($outputstream,$sRead);
} else if ($outputstream == 'php://stdout') {
/**
* Obsolete function, inform plugins that use it
- * @deprecated use sqimap_run_command or sqimap_run_command_list instead
+ * @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 = '') {
* @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 = '')
{
* 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 = '',
$resultlist = array();
$data = array();
$read = sqimap_fgets($imap_stream);
- $i = $k = 0;
+ $i = 0;
while ($read) {
$char = $read{0};
switch ($char)
}
$read = sqimap_fgets($imap_stream);
if ($read === false) { /* error */
- break 3; /* switch switch while */
+ break 2; /* switch while */
}
break;
} // end case $tag{0}
}
}
+/**
+ * @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) {
* @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 $username, $use_imap_tls;
+ global $squirrelmail_language;
if ($tls == true) {
if ((check_php_version(4,3)) and (extension_loaded('openssl'))) {
$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 " .
- "version of PHP does not support TLS sockets, or is missing the openssl " .
- "extension.<br /><br />Please contact your system administrator.";
- logout_error($string,$color);
+ 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.") );
}
}
if (!$imap_stream) {
set_up_language($squirrelmail_language, true);
require_once(SM_PATH . 'functions/display_messages.php');
- $string = sprintf (_("Error connecting to IMAP server: %s.") .
- "<br />\r\n", $server) .
- "$error_number : $error_string<br />\r\n";
- logout_error($string,$color);
+ 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);
/**
* 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,
$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
+ // 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";
fputs($imap_stream,$reply);
$read=sqimap_fgets($imap_stream);
if ($imap_auth_mech == 'digest-md5') {
- // DIGEST-MD5 has an extra step..
+ // DIGEST-MD5 has an extra step..
if (substr($read,0,1) == '+') { // OK so far..
fputs($imap_stream,"\r\n");
$read=sqimap_fgets($imap_stream);
$response=$results[1];
$message=$results[2];
} else {
- // Fake the response, so the error trap at the bottom will work
+ // 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.';
exit;
}
}
+
+ /* 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;
}
* 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;
/**
* 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;
} 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
+ $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);
}
* 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 */
+ if (ereg("[\"\\\r\n]", $what))
+ return '{' . strlen($what) . "}\r\n" . $what; /* 4.3 literal form */
+ return '"' . $what . '"'; /* 4.3 quoted string form */
}
/**
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='') {
- global $squirrelmail_language, $color;
fputs ($imap_stream, "\r\n");
$tmp = fgets ($imap_stream, 1024);
- if (preg_match("/(.*)(BAD|NO)(.*)$/", $tmp, $regs)) {
+ sqimap_append_checkresponse($tmp, $folder);
+}
+
+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 : Bad or malformed request.") .
"</b><br />\n" .
_("Server responded: ") .
- $tmp . "</font><br />\n";
+ $reason . "</font><br />\n";
error_box($string,$color);
exit;
}
return chop(substr($yp, strlen($username)+1));
}
-?>
+?>
\ No newline at end of file
projects / squirrelmail.git / blobdiff