/**
* imap_general.php
*
- * 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.
+ * 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
/** 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 (since 1.3.0) controls use of unique
+ * @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'.
/**
* 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 stream $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
+ * @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
*/
set_up_language($squirrelmail_language);
require_once(SM_PATH . 'functions/display_messages.php');
$string = "<b><font color=\"$color[2]\">\n" .
- _("ERROR : No available imapstream.") .
+ _("ERROR: No available IMAP stream.") .
"</b></font>\n";
error_box($string,$color);
return false;
}
/**
- * @param resource $imap_stream imap connection resource
+ * @param stream $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
+ * @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
*/
$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;
set_up_language($squirrelmail_language);
require_once(SM_PATH . 'functions/display_messages.php');
$string = "<b><font color=\"$color[2]\">\n" .
- _("ERROR : No available imapstream.") .
+ _("ERROR: No available IMAP stream.") .
"</b></font>\n";
error_box($string,$color);
return false;
* @param mixed $new_query
* @param string $tag
* @param array $aQuery
- * @param boolean $unique_id
+ * @param boolean $unique_id see sqimap_session_id()
* @since 1.5.0
*/
function sqimap_prepare_pipelined_query($new_query,&$tag,&$aQuery,$unique_id) {
}
/**
- * @param stream $imap_stream
+ * @param stream $imap_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()
+ * @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,
$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.
}
/**
- * 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
*/
/**
* @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()
+ * @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
*/
/**
* Obsolete function, inform plugins that use it
+ * @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
*/
set_up_language($squirrelmail_language);
require_once(SM_PATH . 'functions/display_messages.php');
$string = "<b><font color=\"$color[2]\">\n" .
- _("ERROR : Bad function call.") .
+ _("ERROR: Bad function call.") .
"</b><br />\n" .
_("Reason:") . ' '.
'There is a plugin installed which make use of the <br />' .
}
/**
- * 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
* 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 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 mixed $query
- * @param mixed $filter
- * @param mixed $outputstream
- * @param mixed $no_return
+ * @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,
$aResponse = '';
$resultlist = array();
$data = array();
+ $sCommand = '';
+ if (preg_match("/^(\w+)\s*/",$query,$aMatch)) {
+ $sCommand = strtoupper($aMatch[1]);
+ } else {
+ // error reporting (shouldn't happen)
+ }
$read = sqimap_fgets($imap_stream);
$i = 0;
while ($read) {
case '*':
{
- if (preg_match('/^\*\s\d+\sFETCH/',$read)) {
+ if (($sCommand == "FETCH" || $sCommand == "STORE") && preg_match('/^\*\s\d+\sFETCH/',$read)) {
/* check for literal */
$s = substr($read,-3);
$fetch_data = array();
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 '</body></html>';
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;
}
}
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 '</body></html>';
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 '</body></html>';
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 '</body></html>';
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;
}
/**
- * @param stream $imap_stream
+ * @param stream $imap_stream imap string
* @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()
+ * @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 = '',
/**
* 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) {
+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;
'<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.") );
+ _("Please contact your system administrator and report this error."),
+ sprintf(_("Error connecting to IMAP server: %s."), $server));
}
}
set_up_language($squirrelmail_language, true);
require_once(SM_PATH . 'functions/display_messages.php');
logout_error( sprintf(_("Error connecting to IMAP server: %s."), $server).
- "<br />\r\n$error_number : $error_string<br />\r\n" );
+ "<br />\r\n$error_number : $error_string<br />\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
/* 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.
- */
+ * ? 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);
+ 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 on this server.<br>".
- "Try a different server or consult your Administrator") );
+ 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) {
}
/**
- * 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 $imap_stream
- * @param string $capability (optional since 1.3.0)
- * @return mixed (string if $capability is set and found,
+ * @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;
}
}
}
}
/**
- * 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
*/
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')) {
/**
* 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
*/
* 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);
- for ($i = 0; $i < count($read_ary); $i++) {
- if (ereg("[^ ]+ +([^ ]+) +EXISTS", $read_ary[$i], $regs)) {
- return $regs[1];
- }
- }
- return false; //"BUG! Couldn't get number of messages in $mailbox!";
+ $aStatus = sqimap_status_messages($imap_stream,$mailbox,array('MESSAGES'));
+ return $aStatus['MESSAGES'];
}
-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));
/**
* 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]) ?
/**
* 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'));
/**
* 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')) {
}
$i++;
}
- return array('MESSAGES' => $messages,
+
+ $status=array('MESSAGES' => $messages,
'UNSEEN'=>$unseen,
'RECENT' => $recent,
'UIDNEXT' => $uidnext,
'UIDVALIDITY' => $uidvalidity);
+
+ if (!empty($messages)) { $hook_status['MESSAGES']=$messages; }
+ if (!empty($unseen)) { $hook_status['UNSEEN']=$unseen; }
+ if (!empty($recent)) { $hook_status['RECENT']=$recent; }
+ if (!empty($hook_status)) {
+ $hook_status['MAILBOX']=$mailbox;
+ $hook_status['CALLER']='sqimap_status_messages';
+ do_hook_function('folder_status',$hook_status);
+ }
+ return $status;
}
/**
* Saves a message to a given folder -- used for saving sent messages
+ * @param stream $imap_stream
+ * @param string $sent_folder
+ * @param $length
+ * @return string $sid
*/
-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");
+function sqimap_append ($imap_stream, $sMailbox, $length) {
+ $sid = sqimap_session_id();
+ $query = $sid . ' APPEND ' . sqimap_encode_mailbox_name($sMailbox) . " (\\Seen) {".$length."}";
+ fputs ($imap_stream, "$query\r\n");
$tmp = fgets ($imap_stream, 1024);
- sqimap_append_checkresponse($tmp, $sent_folder);
+ sqimap_append_checkresponse($tmp, $sMailbox,$sid, $query);
+ return $sid;
}
-function sqimap_append_done ($imap_stream, $folder='') {
+/**
+ * @param stream imap_stream
+ * @param string $folder (since 1.3.2)
+ */
+function sqimap_append_done ($imap_stream, $sMailbox='') {
fputs ($imap_stream, "\r\n");
$tmp = fgets ($imap_stream, 1024);
- sqimap_append_checkresponse($tmp, $folder);
+ while (!sqimap_append_checkresponse($tmp, $sMailbox)) {
+ $tmp = fgets ($imap_stream, 1024);
+ }
}
-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');
+/**
+ * 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 $sMailbox
+ * @return bool $bDone
+ * @since 1.5.1 and 1.4.5
+ */
+function sqimap_append_checkresponse($response, $sMailbox, $sid='', $query='') {
+ // static vars to keep them available when sqimap_append_done calls this function.
+ static $imapquery, $imapsid;
- $reason = $regs[3];
- if ($regs[2] == 'NO') {
- $string = "<b><font color=\"$color[2]\">\n" .
- _("ERROR : Could not append message to") ." $folder." .
- "</b><br />\n" .
- _("Server responded: ") .
- $reason . "<br />\n";
- if (preg_match("/(.*)(quota)(.*)$/i", $reason, $regs)) {
- $string .= _("Solution: ") .
- _("Remove unneccessary messages from your folder and start with your Trash folder.")
- ."<br />\n";
- }
- $string .= "</font>\n";
- error_box($string,$color);
- } else {
- $string = "<b><font color=\"$color[2]\">\n" .
- _("ERROR : Bad or malformed request.") .
- "</b><br />\n" .
- _("Server responded: ") .
- $reason . "</font><br />\n";
- error_box($string,$color);
- exit;
+ $bDone = false;
+
+ if ($query) {
+ $imapquery = $query;
+ }
+ if ($sid) {
+ $imapsid = $sid;
+ }
+ if ($response{0} == '+') {
+ // continuation request triggerd by sqimap_append()
+ $bDone = true;
+ } else {
+ $i = strpos($response, ' ');
+ $sRsp = substr($response,0,$i);
+ $sMsg = substr($response,$i+1);
+ $aExtra = array('MAILBOX' => $sMailbox);
+ switch ($sRsp) {
+ case '*': //untagged response
+ $i = strpos($sMsg, ' ');
+ $sRsp = strtoupper(substr($sMsg,0,$i));
+ $sMsg = substr($sMsg,$i+1);
+ if ($sRsp == 'NO' || $sRsp == 'BAD') {
+ // for the moment disabled. Enable after 1.5.1 release.
+ // Notices could give valueable information about the mailbox
+ // sqm_trigger_imap_error('SQM_IMAP_APPEND_NOTICE',$imapquery,$sRsp,$sMsg);
+ }
+ $bDone = false;
+ case $imapsid:
+ // A001 OK message
+ // $imapsid<space>$sRsp<space>$sMsg
+ $bDone = true;
+ $i = strpos($sMsg, ' ');
+ $sRsp = strtoupper(substr($sMsg,0,$i));
+ $sMsg = substr($sMsg,$i+1);
+ switch ($sRsp) {
+ case 'NO':
+ if (preg_match("/(.*)(quota)(.*)$/i", $sMsg, $aMatch)) {
+ sqm_trigger_imap_error('SQM_IMAP_APPEND_QUOTA_ERROR',$imapquery,$sRsp,$sMsg,$aExtra);
+ } else {
+ sqm_trigger_imap_error('SQM_IMAP_APPEND_ERROR',$imapquery,$sRsp,$sMsg,$aExtra);
+ }
+ break;
+ case 'BAD':
+ sqm_trigger_imap_error('SQM_IMAP_ERROR',$imapquery,$sRsp,$sMsg,$aExtra);
+ break;
+ case 'BYE':
+ sqm_trigger_imap_error('SQM_IMAP_BYE',$imapquery,$sRsp,$sMsg,$aExtra);
+ break;
+ case 'OK':
+ break;
+ default:
+ break;
+ }
+ break;
+ default:
+ // should be false because of the unexpected response but i'm not sure if
+ // that will cause an endless loop in sqimap_append_done
+ $bDone = true;
}
}
+ return $bDone;
}
+/**
+ * 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;
}
/**
- * 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`;
projects / squirrelmail.git / blobdiff