X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=functions%2Fimap_general.php;h=7551cbaf18365df65138ea39f097ee55d3317c89;hp=8167374957a1885c87c95f1de592f44118910e74;hb=4ae9beb7abe3443809f17e80bf10399bf21c430c;hpb=6fd953618853477f6ffe569ce3c9733ca9f9c2d0 diff --git a/functions/imap_general.php b/functions/imap_general.php index 81673749..7551cbaf 100755 --- a/functions/imap_general.php +++ b/functions/imap_general.php @@ -3,11 +3,10 @@ /** * imap_general.php * - * 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. + * This implements all functions that do general IMAP functions. * + * @copyright © 1999-2006 The SquirrelMail Project Team + * @license http://opensource.org/licenses/gpl-license.php GNU Public License * @version $Id$ * @package squirrelmail * @subpackage imap @@ -16,13 +15,17 @@ /** Includes.. */ require_once(SM_PATH . 'functions/page_header.php'); require_once(SM_PATH . 'functions/auth.php'); +include_once(SM_PATH . 'functions/rfc822address.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 + * @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; @@ -37,6 +40,15 @@ function sqimap_session_id($unique_id = FALSE) { /** * Both send a command and accept the result from the command. * This is to allow proper session number handling. + * @param stream $imap_stream imap connection resource + * @param string $query imap command + * @param boolean $handle_errors see sqimap_retrieve_imap_response() + * @param array $response + * @param array $message + * @param boolean $unique_id (since 1.3.0) see sqimap_session_id(). + * @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) { @@ -54,13 +66,27 @@ function sqimap_run_command_list ($imap_stream, $query, $handle_errors, &$respon set_up_language($squirrelmail_language); require_once(SM_PATH . 'functions/display_messages.php'); $string = "\n" . - _("ERROR : No available imapstream.") . + _("ERROR: No available IMAP stream.") . "\n"; error_box($string,$color); return false; } } +/** + * @param stream $imap_stream imap connection resource + * @param string $query imap command + * @param boolean $handle_errors see sqimap_retrieve_imap_response() + * @param array $response empty string, if return = false + * @param array $message empty string, if return = false + * @param boolean $unique_id (since 1.3.0) see sqimap_session_id() + * @param boolean $filter (since 1.4.1 and 1.5.0) see sqimap_fread() + * @param mixed $outputstream (since 1.4.1 and 1.5.0) see sqimap_fread() + * @param boolean $no_return (since 1.4.1 and 1.5.0) see sqimap_fread() + * @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) { @@ -72,7 +98,7 @@ function sqimap_run_command ($imap_stream, $query, $handle_errors, &$response, $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; @@ -91,13 +117,20 @@ function sqimap_run_command ($imap_stream, $query, $handle_errors, &$response, set_up_language($squirrelmail_language); require_once(SM_PATH . 'functions/display_messages.php'); $string = "\n" . - _("ERROR : No available imapstream.") . + _("ERROR: No available IMAP stream.") . "\n"; error_box($string,$color); return false; } } +/** + * @param mixed $new_query + * @param string $tag + * @param array $aQuery + * @param boolean $unique_id see sqimap_session_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)); @@ -106,15 +139,27 @@ function sqimap_prepare_pipelined_query($new_query,&$tag,&$aQuery,$unique_id) { $aQuery[$tag] = $query; } +/** + * @param stream $imap_stream imap stream + * @param array $aQueryList + * @param boolean $handle_errors + * @param array $aServerResponse + * @param array $aServerMessage + * @param boolean $unique_id see sqimap_session_id() + * @param boolean $filter see sqimap_fread() + * @param mixed $outputstream see sqimap_fread() + * @param boolean $no_return see sqimap_fread() + * @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 + 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 + 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. @@ -170,10 +215,11 @@ function sqimap_run_pipelined_command ($imap_stream, $aQueryList, $handle_errors } /** - * Custom fgets function: gets a line from the IMAP-server, + * 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 + * @param stream $imap_stream the stream to read from * @return string a line + * @since 1.2.8 */ function sqimap_fgets($imap_stream) { $read = ''; @@ -195,6 +241,15 @@ function sqimap_fgets($imap_stream) { return $results; } +/** + * @param stream $imap_stream + * @param integer $iSize + * @param boolean $filter + * @param mixed $outputstream stream or 'php://stdout' string + * @param boolean $no_return controls data returned by function + * @return string + * @since 1.4.1 + */ function sqimap_fread($imap_stream,$iSize,$filter=false, $outputstream=false, $no_return=false) { if (!$filter || !$outputstream) { @@ -219,20 +274,20 @@ function sqimap_fread($imap_stream,$iSize,$filter=false, 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') { @@ -251,7 +306,14 @@ function sqimap_fread($imap_stream,$iSize,$filter=false, /** * Obsolete function, inform plugins that use it - * @deprecated use sqimap_run_command or sqimap_run_command_list instead + * @param stream $imap_stream + * @param string $tag + * @param boolean $handle_errors + * @param array $response + * @param array $message + * @param string $query + * @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 = '') { @@ -259,7 +321,7 @@ function sqimap_read_data_list($imap_stream, $tag, $handle_errors, set_up_language($squirrelmail_language); require_once(SM_PATH . 'functions/display_messages.php'); $string = "\n" . - _("ERROR : Bad function call.") . + _("ERROR: Bad function call.") . "
\n" . _("Reason:") . ' '. 'There is a plugin installed which make use of the
' . @@ -274,13 +336,14 @@ function sqimap_read_data_list($imap_stream, $tag, $handle_errors, } /** - * Function to display an error related to an IMAP-query. + * 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 = '') { @@ -308,6 +371,16 @@ function sqimap_error_box($title, $query = '', $message_title = '', $message = ' * 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 imap stream + * @param string $tag + * @param boolean $handle_errors handle errors internally or send them in $response and $message. + * @param array $response + * @param array $message + * @param string $query command that can be printed if something fails + * @param boolean $filter see sqimap_fread() + * @param mixed $outputstream see sqimap_fread() + * @param boolean $no_return see sqimap_fread() + * @since 1.5.0 */ function sqimap_retrieve_imap_response($imap_stream, $tag, $handle_errors, &$response, &$message, $query = '', @@ -320,7 +393,7 @@ function sqimap_retrieve_imap_response($imap_stream, $tag, $handle_errors, $resultlist = array(); $data = array(); $read = sqimap_fgets($imap_stream); - $i = $k = 0; + $i = 0; while ($read) { $char = $read{0}; switch ($char) @@ -375,7 +448,7 @@ function sqimap_retrieve_imap_response($imap_stream, $tag, $handle_errors, } $read = sqimap_fgets($imap_stream); if ($read === false) { /* error */ - break 3; /* switch switch while */ + break 2; /* switch while */ } break; } // end case $tag{0} @@ -476,12 +549,12 @@ function sqimap_retrieve_imap_response($imap_stream, $tag, $handle_errors, if (!$handle_errors) { $query = ''; } - sqimap_error_box(_("ERROR : Imap server closed the connection."), $query, _("Server responded:"),$sResponse); + sqimap_error_box(_("ERROR: IMAP server closed the connection."), $query, _("Server responded:"),$sResponse); echo ''; exit; } else if ($handle_errors) { unset($data); - sqimap_error_box(_("ERROR : Connection dropped by imap-server."), $query); + sqimap_error_box(_("ERROR: Connection dropped by IMAP server."), $query); exit; } } @@ -505,21 +578,21 @@ function sqimap_retrieve_imap_response($imap_stream, $tag, $handle_errors, 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]); + sqimap_error_box(_("ERROR: Could not complete request."), $query, _("Reason Given:") . ' ', $message[$tag]); echo ''; exit; } break; case 'BAD': - sqimap_error_box(_("ERROR : Bad or malformed request."), $query, _("Server responded: "), $message[$tag]); + sqimap_error_box(_("ERROR: Bad or malformed request."), $query, _("Server responded:") . ' ', $message[$tag]); echo ''; exit; case 'BYE': - sqimap_error_box(_("ERROR : Imap server closed the connection."), $query, _("Server responded: "), $message[$tag]); + sqimap_error_box(_("ERROR: IMAP server closed the connection."), $query, _("Server responded:") . ' ', $message[$tag]); echo ''; exit; default: - sqimap_error_box(_("ERROR : Unknown imap response."), $query, _("Server responded: "), $message[$tag]); + 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; @@ -527,6 +600,17 @@ function sqimap_retrieve_imap_response($imap_stream, $tag, $handle_errors, } } +/** + * @param stream $imap_stream imap string + * @param string $tag_uid + * @param boolean $handle_errors + * @param array $response + * @param array $message + * @param string $query (since 1.2.5) + * @param boolean $filter (since 1.4.1) see sqimap_fread() + * @param mixed $outputstream (since 1.4.1) see sqimap_fread() + * @param boolean $no_return (since 1.4.1) see sqimap_fread() + */ function sqimap_read_data ($imap_stream, $tag_uid, $handle_errors, &$response, &$message, $query = '', $filter=false,$outputstream=false,$no_return=false) { @@ -541,25 +625,34 @@ function sqimap_read_data ($imap_stream, $tag_uid, $handle_errors, /** * Connects to the IMAP server and returns a resource identifier for use with - * the other SquirrelMail IMAP functions. Does NOT login! + * 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. + * @param integer $tls whether to use plain text(0), TLS(1) or STARTTLS(2) when connecting. + * Argument was boolean before 1.5.1. * @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; +function sqimap_create_stream($server,$port,$tls=0) { + global $squirrelmail_language; - if ($tls == true) { + if (strstr($server,':') && ! preg_match("/^\[.*\]$/",$server)) { + // numerical IPv6 address must be enclosed in square brackets + $server = '['.$server.']'; + } + + if ($tls == 1) { 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'); - $string = "Unable to connect to IMAP server!
TLS is enabled, but this " . - "version of PHP does not support TLS sockets, or is missing the openssl " . - "extension.

Please contact your system administrator."; - logout_error($string,$color); + logout_error( sprintf(_("Error connecting to IMAP server: %s."), $server). + '
'. + _("TLS is enabled, but this version of PHP does not support TLS sockets, or is missing the openssl extension."). + '

'. + _("Please contact your system administrator and report this error."), + sprintf(_("Error connecting to IMAP server: %s."), $server)); } } @@ -569,19 +662,91 @@ function sqimap_create_stream($server,$port,$tls=false) { 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.") . - "
\r\n", $server) . - "$error_number : $error_string
\r\n"; - logout_error($string,$color); + logout_error( sprintf(_("Error connecting to IMAP server: %s."), $server). + "
\r\n$error_number : $error_string
\r\n", + sprintf(_("Error connecting to IMAP server: %s."), $server) ); exit; } $server_info = fgets ($imap_stream, 1024); + + /** + * Implementing IMAP STARTTLS (rfc2595) in php 5.1.0+ + * http://www.php.net/stream-socket-enable-crypto + */ + if ($tls == 2) { + if (function_exists('stream_socket_enable_crypto')) { + // check starttls capability, don't use cached capability version + if (! sqimap_capability($imap_stream, 'STARTTLS', false)) { + // imap server does not declare starttls support + sqimap_error_box(sprintf(_("Error connecting to IMAP server: %s."), $server), + '','', + _("IMAP STARTTLS is enabled in SquirrelMail configuration, but used IMAP server does not support STARTTLS.")); + exit; + } + + // issue starttls command and check response + sqimap_run_command($imap_stream, 'STARTTLS', false, $starttls_response, $starttls_message); + // check response + if ($starttls_response!='OK') { + // starttls command failed + sqimap_error_box(sprintf(_("Error connecting to IMAP server: %s."), $server), + 'STARTTLS', + _("Server replied:") . ' ', + $starttls_message); + exit(); + } + + // start crypto on connection. suppress function errors. + if (@stream_socket_enable_crypto($imap_stream,true,STREAM_CRYPTO_METHOD_TLS_CLIENT)) { + // starttls was successful + + /** + * RFC 2595 requires to discard CAPABILITY information after successful + * STARTTLS command. We don't follow RFC, because SquirrelMail stores CAPABILITY + * information only after successful login (src/redirect.php) and cached information + * is used only in other php script connections after successful STARTTLS. If script + * issues sqimap_capability() call before sqimap_login() and wants to get initial + * capability response, script should set third sqimap_capability() argument to false. + */ + //sqsession_unregister('sqimap_capabilities'); + } else { + /** + * stream_socket_enable_crypto() call failed. Possible issues: + * - broken ssl certificate (uw drops connection, error is in syslog mail facility) + * - some ssl error (can reproduce with STREAM_CRYPTO_METHOD_SSLv3_CLIENT, PHP E_WARNING + * suppressed in stream_socket_enable_crypto() call) + */ + sqimap_error_box(sprintf(_("Error connecting to IMAP server: %s."), $server), + '','', + _("Unable to start TLS.")); + /** + * Bug: stream_socket_enable_crypto() does not register SSL errors in + * openssl_error_string() or stream notification wrapper and displays + * them in E_WARNING level message. It is impossible to retrieve error + * message without own error handler. + */ + exit; + } + } else { + // php install does not support stream_socket_enable_crypto() function + sqimap_error_box(sprintf(_("Error connecting to IMAP server: %s."), $server), + '','', + _("IMAP STARTTLS is enabled in SquirrelMail configuration, but used PHP version does not support functions that allow to enable encryption on open socket.")); + exit; + } + } 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. + * 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, @@ -603,7 +768,7 @@ function sqimap_login ($username, $password, $imap_server_address, $imap_port, $ $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"; @@ -625,7 +790,7 @@ function sqimap_login ($username, $password, $imap_server_address, $imap_port, $ 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); @@ -635,7 +800,7 @@ function sqimap_login ($username, $password, $imap_server_address, $imap_port, $ $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.'; @@ -721,6 +886,8 @@ function sqimap_login ($username, $password, $imap_server_address, $imap_port, $ 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; } @@ -728,12 +895,28 @@ function sqimap_login ($username, $password, $imap_server_address, $imap_port, $ exit; } } + + /* Special error case: + * Login referrals. The server returns: + * ? OK [REFERRAL ] + * 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. + * @param stream $imap_stream the IMAP connection to log out. * @return void */ function sqimap_logout ($imap_stream) { @@ -744,24 +927,29 @@ function sqimap_logout ($imap_stream) { } /** - * Retreive the CAPABILITY string from the IMAP server. + * Retrieve the CAPABILITY string from the IMAP server. * If capability is set, returns only that specific capability, * else returns array of all capabilities. + * @param stream $imap_stream + * @param string $capability (since 1.3.0) + * @param boolean $bUseCache (since 1.5.1) Controls use of capability data stored in session + * @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)) { +function sqimap_capability($imap_stream, $capability='', $bUseCache=true) { + // sqgetGlobalVar('sqimap_capabilities', $sqimap_capabilities, SQ_SESSION); + + if (!$bUseCache || ! sqgetGlobalVar('sqimap_capabilities', $sqimap_capabilities, SQ_SESSION)) { $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]; + $sqimap_capabilities[trim($cap_list[0])][] = $cap_list[1]; } else { - $sqimap_capabilities[$cap_list[0]] = TRUE; + $sqimap_capabilities[trim($cap_list[0])] = TRUE; } } } @@ -776,7 +964,9 @@ function sqimap_capability($imap_stream, $capability='') { } /** - * Returns the delimeter between mailboxes: INBOX/Test, or INBOX.Test + * Returns the delimiter 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; @@ -786,6 +976,11 @@ function sqimap_get_delimiter ($imap_stream = false) { return $optional_delimiter; } + /* Delimiter is stored in the session from redirect. Try fetching from there first */ + if (empty($sqimap_delimiter)) { + sqgetGlobalVar('delimiter',$sqimap_delimiter,SQ_SESSION); + } + /* Do some caching here */ if (!$sqimap_delimiter) { if (sqimap_capability($imap_stream, 'NAMESPACE')) { @@ -815,7 +1010,7 @@ function sqimap_get_delimiter ($imap_stream = false) { } 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); } @@ -825,20 +1020,24 @@ function sqimap_get_delimiter ($imap_stream = false) { /** * This encodes a mailbox name for use in IMAP commands. - * @param string what the mailbox to encode + * @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 */ } /** * Gets the number of messages in the current mailbox. * * OBSOLETE use sqimap_status_messages instead. + * @param stream $imap_stream imap stream + * @param string $mailbox + * @deprecated */ function sqimap_get_num_messages ($imap_stream, $mailbox) { $read_ary = sqimap_run_command ($imap_stream, 'EXAMINE ' . sqimap_encode_mailbox_name($mailbox), false, $result, $message); @@ -849,11 +1048,15 @@ function sqimap_get_num_messages ($imap_stream, $mailbox) { } 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 + * $addr_ar = array(), $group = '' and $host='' arguments are used in 1.4.0 + * @param string $address + * @param integer $max + * @since 1.4.0 + * @deprecated See Rfc822Address.php */ function parseAddress($address, $max=0) { $aAddress = parseRFC822Address($address,array('limit'=> $max)); @@ -869,6 +1072,13 @@ function parseAddress($address, $max=0) { /** * OBSOLETE FUNCTION should be removed after mailbox_display, * printMessage function is adapted + * + * callback function used for formating of addresses array in + * parseAddress() function + * @param array $aAddr + * @param integer $k array key + * @since 1.5.1 + * @deprecated */ function _adaptAddress(&$aAddr,$k) { $sPersonal = (isset($aAddr[SQM_ADDR_PERSONAL]) && $aAddr[SQM_ADDR_PERSONAL]) ? @@ -882,6 +1092,11 @@ function _adaptAddress(&$aAddr,$k) { /** * Returns the number of unseen messages in this folder. * obsoleted by sqimap_status_messages ! + * Arguments differ in 1.0.x + * @param stream $imap_stream + * @param string $mailbox + * @return integer + * @deprecated */ function sqimap_unseen_messages ($imap_stream, $mailbox) { $aStatus = sqimap_status_messages($imap_stream,$mailbox,array('UNSEEN')); @@ -891,7 +1106,13 @@ function sqimap_unseen_messages ($imap_stream, $mailbox) { /** * Returns the status items of a mailbox. * Default it returns MESSAGES,UNSEEN and RECENT - * Supported status items are MESSAGES, UNSEEN, RECENT, UIDNEXT and UIDVALIDITY + * Supported status items are MESSAGES, UNSEEN, RECENT (since 1.4.0), + * UIDNEXT (since 1.5.1) and UIDVALIDITY (since 1.5.1) + * @param stream $imap_stream imap stream + * @param string $mailbox mail folder + * @param array $aStatusItems status items + * @return array + * @since 1.3.2 */ function sqimap_status_messages ($imap_stream, $mailbox, $aStatusItems = array('MESSAGES','UNSEEN','RECENT')) { @@ -930,28 +1151,49 @@ function sqimap_status_messages ($imap_stream, $mailbox, /** * Saves a message to a given folder -- used for saving sent messages + * @param stream $imap_stream + * @param string $sent_folder + * @param $length */ 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"); + 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); } +/** + * @param stream imap_stream + * @param string $folder (since 1.3.2) + */ 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); +} + +/** + * Displays error messages, if there are errors in responses to + * commands issues by sqimap_append() and sqimap_append_done() functions. + * @param string $response + * @param string $folder + * @since 1.5.1 and 1.4.5 + */ +function sqimap_append_checkresponse($response, $folder) { + // TODO use error handler, see how sort and thread errors are handled and see errors.php + 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 = "\n" . - _("ERROR : Could not append message to") ." $folder." . + _("ERROR: Could not append message to") ." $folder." . "
\n" . - _("Server responded: ") . + _("Server responded:") . ' ' . $reason . "
\n"; if (preg_match("/(.*)(quota)(.*)$/i", $reason, $regs)) { - $string .= _("Solution: ") . + $string .= _("Solution:") . ' ' . _("Remove unneccessary messages from your folder and start with your Trash folder.") ."
\n"; } @@ -959,16 +1201,24 @@ function sqimap_append_done ($imap_stream, $folder='') { error_box($string,$color); } else { $string = "\n" . - _("ERROR : Bad or malformed request.") . + _("ERROR: Bad or malformed request.") . "
\n" . - _("Server responded: ") . - $tmp . "
\n"; + _("Server responded:") . ' ' . + $reason . "
\n"; error_box($string,$color); exit; } } } +/** + * Allows mapping of IMAP server address with custom function + * see map_yp_alias() + * @param string $imap_server imap server address or mapping + * @param string $username + * @return string + * @since 1.3.0 + */ function sqimap_get_user_server ($imap_server, $username) { if (substr($imap_server, 0, 4) != "map:") { return $imap_server; @@ -978,10 +1228,16 @@ function sqimap_get_user_server ($imap_server, $username) { } /** - * This is an example that gets imapservers from yellowpages (NIS). + * This is an example that gets IMAP servers 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 IMAP server. + * + * Requires access to external ypmatch program + * FIXME: it can be implemented in php yp extension or pecl (since php 5.1.0) + * @param string $username + * @return string + * @since 1.3.0 */ function map_yp_alias($username) { $yp = `ypmatch $username aliases`;