6 * Copyright (c) 1999-2001 The Squirrelmail Development Team
7 * Licensed under the GNU GPL. For full terms see the file COPYING.
9 * This implements all functions that do general imap functions.
17 * Sets an unique session id in order to avoid simultanous sessions crash.
19 * @return string a 4 chars unique string
21 function sqimap_session_id() {
23 global $data_dir, $username;
25 $IMAPSessionID = substr(session_id(), -4);
26 if( $IMAPSessionID == '' ) {
27 $IMAPSessionID = str_pad( dechex( getPref( $data_dir, $username, 'counter', 0 ) ),
28 4, '0', STR_PAD_LEFT
);
31 return( $IMAPSessionID );
35 /******************************************************************************
36 ** Reads the output from the IMAP stream. If handle_errors is set to true,
37 ** this will also handle all errors that are received. If it is not set,
38 ** the errors will be sent back through $response and $message
39 ******************************************************************************/
41 function sqimap_read_data_list ($imap_stream, $pre, $handle_errors,
42 &$response, &$message) {
43 global $color, $squirrelmail_language;
46 $resultlist = array();
52 while (strpos($read, "\n") === false) {
53 $read .= fgets($imap_stream, 9096);
56 if (ereg("^\\* [0-9]+ FETCH.*\\{([0-9]+)\\}", $read, $regs)) {
58 } else if (ereg("^\\* [0-9]+ FETCH", $read, $regs)) {
59 // Sizeless response, probably single-line
62 $read = fgets($imap_stream, 9096);
67 while (strpos($read, "\n") === false) {
68 $read .= fgets($imap_stream, 9096);
70 // If we know the size, no need to look at the end parameters
72 if ($total_size == $size) {
73 // We've reached the end of this 'message', switch to the next one.
76 } else if ($total_size > $size) {
77 $difference = $total_size - $size;
78 $total_size = $total_size - strlen($read);
79 $data[] = substr ($read, 0, strlen($read)-$difference);
80 $read = substr ($read, strlen($read)-$difference, strlen($read));
84 $read = fgets($imap_stream, 9096);
85 while (strpos($read, "\n") === false) {
86 $read .= fgets($imap_stream, 9096);
89 $total_size +
= strlen($read);
91 if (ereg("^$pre (OK|BAD|NO)(.*)", $read, $regs) ||
92 (($size == -1) && ereg("^\\* [0-9]+ FETCH.*", $read, $regs))) {
96 $read = fgets ($imap_stream, 9096);
101 while (($more_msgs = !ereg("^$pre (OK|BAD|NO)(.*)$", $read, $regs)) &&
102 !ereg("^\\* [0-9]+ FETCH.*", $read, $regs)) {
103 $read = fgets($imap_stream, 9096);
105 $resultlist[] = $data;
107 $response = $regs[1];
108 $message = trim($regs[2]);
110 if ($handle_errors == false) { return $resultlist; }
112 if ($response == 'NO') {
113 // ignore this error from m$ exchange, it is not fatal (aka bug)
114 if (strstr($message, 'command resulted in') === false) {
115 set_up_language($squirrelmail_language);
116 echo "<br><b><font color=$color[2]>\n";
117 echo _("ERROR : Could not complete request.");
119 echo _("Reason Given: ");
120 echo $message . "</font><br>\n";
123 } else if ($response == 'BAD') {
124 set_up_language($squirrelmail_language);
125 echo "<br><b><font color=$color[2]>\n";
126 echo _("ERROR : Bad or malformed request.");
128 echo _("Server responded: ");
129 echo $message . "</font><br>\n";
135 function sqimap_read_data ($imap_stream, $pre, $handle_errors, &$response, &$message) {
136 $res = sqimap_read_data_list($imap_stream, $pre, $handle_errors, $response, $message);
140 /******************************************************************************
141 ** Logs the user into the imap server. If $hide is set, no error messages
142 ** will be displayed. This function returns the imap connection handle.
143 ******************************************************************************/
144 function sqimap_login ($username, $password, $imap_server_address, $imap_port, $hide) {
146 global $color, $squirrelmail_language, $HTTP_ACCEPT_LANGUAGE, $onetimepad;
148 $imap_stream = fsockopen ( $imap_server_address, $imap_port,
149 $error_number, $error_string, 15);
150 $server_info = fgets ($imap_stream, 1024);
152 // Decrypt the password
153 $password = OneTimePadDecrypt($password, $onetimepad);
155 /** Do some error correction **/
158 set_up_language($squirrelmail_language, true);
159 printf (_("Error connecting to IMAP server: %s.")."<br>\r\n", $imap_server_address);
160 echo "$error_number : $error_string<br>\r\n";
165 fputs ($imap_stream, sqimap_session_id() . ' LOGIN "' . quoteIMAP($username) .
166 '" "' . quoteIMAP($password) . "\"\r\n");
167 $read = sqimap_read_data ($imap_stream, sqimap_session_id(), false, $response, $message);
169 /** If the connection was not successful, lets see why **/
170 if ($response != "OK") {
172 if ($response != 'NO') {
173 // "BAD" and anything else gets reported here.
174 set_up_language($squirrelmail_language, true);
175 if ($response == 'BAD')
176 printf (_("Bad request: %s")."<br>\r\n", $message);
178 printf (_("Unknown error: %s") . "<br>\n", $message);
180 echo _("Read data:") . "<br>\n";
183 foreach ($read as $line)
185 echo htmlspecialchars($line) . "<br>\n";
190 // If the user does not log in with the correct
191 // username and password it is not possible to get the
192 // correct locale from the user's preferences.
193 // Therefore, apply the same hack as on the login
196 // $squirrelmail_language is set by a cookie when
197 // the user selects language and logs out
199 set_up_language($squirrelmail_language, true);
203 <body bgcolor
="ffffff">
206 <table width
="70%" noborder bgcolor
="ffffff" align
="center">
208 <td bgcolor
="dcdcdc">
209 <font color
="cc0000">
211 <?php
echo _("ERROR") ?
>
219 <?php
echo _("Unknown user or password incorrect.") ?
><br
>
220 <a href
="login.php" target
="_top"><?php
echo _("Click here to try again") ?
></a
>
243 /******************************************************************************
244 ** Simply logs out the imap session
245 ******************************************************************************/
246 function sqimap_logout ($imap_stream) {
247 fputs ($imap_stream, sqimap_session_id() . " LOGOUT\r\n");
250 function sqimap_capability($imap_stream, $capability) {
251 global $sqimap_capabilities;
253 if (!is_array($sqimap_capabilities)) {
254 fputs ($imap_stream, sqimap_session_id() . " CAPABILITY\r\n");
255 $read = sqimap_read_data($imap_stream, sqimap_session_id(), true, $a, $b);
257 $c = explode(' ', $read[0]);
258 for ($i=2; $i < count($c); $i++
) {
259 $cap_list = explode('=', $c[$i]);
260 if (isset($cap_list[1]))
261 $sqimap_capabilities[$cap_list[0]] = $cap_list[1];
263 $sqimap_capabilities[$cap_list[0]] = TRUE;
266 if (! isset($sqimap_capabilities[$capability]))
268 return $sqimap_capabilities[$capability];
271 /******************************************************************************
272 ** Returns the delimeter between mailboxes: INBOX/Test, or INBOX.Test...
273 ******************************************************************************/
274 function sqimap_get_delimiter ($imap_stream = false) {
276 global $sqimap_delimiter;
277 global $optional_delimiter;
279 /* Use configured delimiter if set */
280 if((!empty($optional_delimiter)) && $optional_delimiter != "detect")
281 return $optional_delimiter;
283 /* Do some caching here */
284 if (!$sqimap_delimiter) {
285 if (sqimap_capability($imap_stream, "NAMESPACE")) {
286 /* According to something that I can't find, this is supposed to work on all systems
287 OS: This won't work in Courier IMAP.
288 OS: According to rfc2342 response from NAMESPACE command is:
289 OS: * NAMESPACE (PERSONAL NAMESPACES) (OTHER_USERS NAMESPACE) (SHARED NAMESPACES)
290 OS: We want to lookup all personal NAMESPACES...
292 fputs ($imap_stream, sqimap_session_id() . " NAMESPACE\r\n");
293 $read = sqimap_read_data($imap_stream, sqimap_session_id(), true, $a, $b);
294 if (eregi('\\* NAMESPACE +(\\( *\\(.+\\) *\\)|NIL) +(\\( *\\(.+\\) *\\)|NIL) +(\\( *\\(.+\\) *\\)|NIL)', $read[0], $data)) {
295 if (eregi('^\\( *\\((.*)\\) *\\)', $data[1], $data2))
297 $pna = explode(')(', $pn);
298 while (list($k, $v) = each($pna))
300 $lst = explode('"', $v);
301 if (isset($lst[3])) {
302 $pn[$lst[1]] = $lst[3];
308 $sqimap_delimiter = $pn[0];
310 fputs ($imap_stream, ". LIST \"INBOX\" \"\"\r\n");
311 $read = sqimap_read_data($imap_stream, '.', true, $a, $b);
312 $quote_position = strpos ($read[0], '"');
313 $sqimap_delimiter = substr ($read[0], $quote_position+
1, 1);
316 return $sqimap_delimiter;
320 /******************************************************************************
321 ** Gets the number of messages in the current mailbox.
322 ******************************************************************************/
323 function sqimap_get_num_messages ($imap_stream, $mailbox) {
324 fputs ($imap_stream, sqimap_session_id() . " EXAMINE \"$mailbox\"\r\n");
325 $read_ary = sqimap_read_data ($imap_stream, sqimap_session_id(), true, $result, $message);
326 for ($i = 0; $i < count($read_ary); $i++
) {
327 if (ereg("[^ ]+ +([^ ]+) +EXISTS", $read_ary[$i], $regs)) {
331 return "BUG! Couldn't get number of messages in $mailbox!";
335 /******************************************************************************
336 ** Returns a displayable email address
337 ******************************************************************************/
338 function sqimap_find_email ($string) {
339 /** Luke Ehresman <lehresma@css.tayloru.edu>
340 ** <lehresma@css.tayloru.edu>
341 ** lehresma@css.tayloru.edu
344 ** lehresma@css.tayloru.edu (Luke Ehresman)
347 if (ereg("<([^>]+)>", $string, $regs)) {
350 return trim($string);
354 /******************************************************************************
355 ** Takes the From: field, and creates a displayable name.
356 ** Luke Ehresman <lkehresman@yahoo.com>
357 ** becomes: Luke Ehresman
358 ** <lkehresman@yahoo.com>
359 ** becomes: lkehresman@yahoo.com
360 ******************************************************************************/
361 function sqimap_find_displayable_name ($string) {
362 $string = ' '.trim($string);
363 $orig_string = $string;
364 if (strpos($string, '<') && strpos($string, '>')) {
365 if (strpos($string, '<') == 1) {
366 $string = sqimap_find_email($string);
368 $string = trim($string);
369 $string = substr($string, 0, strpos($string, '<'));
370 $string = ereg_replace ('"', '', $string);
373 if (trim($string) == '') {
374 $string = sqimap_find_email($orig_string);
381 /******************************************************************************
382 ** Returns the number of unseen messages in this folder
383 ******************************************************************************/
384 function sqimap_unseen_messages ($imap_stream, $mailbox) {
385 //fputs ($imap_stream, sqimap_session_id() . " SEARCH UNSEEN NOT DELETED\r\n");
386 fputs ($imap_stream, sqimap_session_id() . " STATUS \"$mailbox\" (UNSEEN)\r\n");
387 $read_ary = sqimap_read_data ($imap_stream, sqimap_session_id(), true, $result, $message);
388 ereg("UNSEEN ([0-9]+)", $read_ary[0], $regs);
393 /******************************************************************************
394 ** Saves a message to a given folder -- used for saving sent messages
395 ******************************************************************************/
396 function sqimap_append ($imap_stream, $sent_folder, $length) {
397 fputs ($imap_stream, sqimap_session_id() . " APPEND \"$sent_folder\" (\\Seen) \{$length}\r\n");
398 $tmp = fgets ($imap_stream, 1024);
401 function sqimap_append_done ($imap_stream) {
402 fputs ($imap_stream, "\r\n");
403 $tmp = fgets ($imap_stream, 1024);