6 * Copyright (c) 1999-2003 The SquirrelMail Project Team
7 * Licensed under the GNU GPL. For full terms see the file COPYING.
9 * This implements functions that manipulate messages
10 * NOTE: Quite a few functions in this file are obsolete
13 * @package squirrelmail
17 * Copies specified messages to specified folder
18 * @param int $imap_stream The resource ID for the IMAP connection
19 * @param string $start Beginning of range to copy
20 * @param string $end End of the range to copy
21 * @param string $mailbox Which box to copy to
22 * @deprecated This function is obsolete and should not be used
24 function sqimap_messages_copy ($imap_stream, $start, $end, $mailbox) {
26 $read = sqimap_run_command ($imap_stream, "COPY $start:$end " . sqimap_encode_mailbox_name($mailbox), true, $response, $message, $uid_support);
30 * copy a range of messages ($id) to another mailbox ($mailbox)
31 * @param int $imap_stream The resource ID for the IMAP socket
32 * @param string $id The list of messages to copy
33 * @param string $mailbox The destination to copy to
36 function sqimap_msgs_list_copy ($imap_stream, $id, $mailbox) {
38 $msgs_id = sqimap_message_list_squisher($id);
39 $read = sqimap_run_command ($imap_stream, "COPY $msgs_id " . sqimap_encode_mailbox_name($mailbox), true, $response, $message, $uid_support);
43 * move a range of messages ($id) to another mailbox. Deletes the originals.
44 * @param int $imap_stream The resource ID for the IMAP socket
45 * @param string $id The list of messages to move
46 * @param string $mailbox The destination to move to
49 function sqimap_msgs_list_move ($imap_stream, $id, $mailbox) {
51 $msgs_id = sqimap_message_list_squisher($id);
52 $read = sqimap_run_command ($imap_stream, "COPY $msgs_id " . sqimap_encode_mailbox_name($mailbox), true, $response, $message, $uid_support);
53 $read = sqimap_run_command ($imap_stream, "STORE $msgs_id +FLAGS (\\Deleted)", true, $response,$message, $uid_support);
58 * Deletes specified messages and moves them to trash if possible
59 * @deprecated This function is obsolete and should no longer be used
60 * @param int $imap_steam The resource ID for the IMAP connection
61 * @param string $start Start of range
62 * @param string $end End of range
63 * @param string $mailbox Mailbox messages are being deleted from
66 function sqimap_messages_delete ($imap_stream, $start, $end, $mailbox) {
67 global $move_to_trash, $trash_folder, $auto_expunge, $uid_support;
69 if (($move_to_trash == true) && (sqimap_mailbox_exists($imap_stream, $trash_folder) && ($mailbox != $trash_folder))) {
70 sqimap_messages_copy ($imap_stream, $start, $end, $trash_folder);
72 sqimap_messages_flag ($imap_stream, $start, $end, "Deleted", true);
75 function sqimap_msgs_list_delete ($imap_stream, $mailbox, $id, $bypass_trash=false) {
76 global $move_to_trash, $trash_folder, $uid_support;
77 $msgs_id = sqimap_message_list_squisher($id);
78 if (($move_to_trash == true) && (sqimap_mailbox_exists($imap_stream, $trash_folder) && ($mailbox != $trash_folder)) && ($bypass_trash != true)) {
79 $read = sqimap_run_command ($imap_stream, "COPY $msgs_id " . sqimap_encode_mailbox_name($trash_folder), true, $response, $message, $uid_support);
81 $read = sqimap_run_command ($imap_stream, "STORE $msgs_id +FLAGS (\\Deleted)", true, $response, $message, $uid_support);
86 * Sets the specified messages with specified flag
88 function sqimap_messages_flag ($imap_stream, $start, $end, $flag, $handle_errors) {
90 $read = sqimap_run_command ($imap_stream, "STORE $start:$end +FLAGS (\\$flag)", $handle_errors, $response, $message, $uid_support);
93 function sqimap_toggle_flag($imap_stream, $id, $flag, $set, $handle_errors) {
95 $msgs_id = sqimap_message_list_squisher($id);
96 $set_string = ($set ?
'+' : '-');
97 $read = sqimap_run_command ($imap_stream, "STORE $msgs_id ".$set_string."FLAGS ($flag)", $handle_errors, $response, $message, $uid_support);
101 function sqimap_get_small_header ($imap_stream, $id, $sent) {
102 $res = sqimap_get_small_header_list($imap_stream, $id, $sent);
107 * Sort the message list and crunch to be as small as possible
108 * (overflow could happen, so make it small if possible)
110 function sqimap_message_list_squisher($messages_array) {
111 if( !is_array( $messages_array ) ) {
112 return $messages_array;
115 sort($messages_array, SORT_NUMERIC
);
117 while ($messages_array) {
118 $start = array_shift($messages_array);
120 while (isset($messages_array[0]) && $messages_array[0] == $end +
1) {
121 $end = array_shift($messages_array);
123 if ($msgs_str != '') {
127 if ($start != $end) {
128 $msgs_str .= ':' . $end;
135 * Get sort order from server and return it as the $id array for mailbox_display.
137 function sqimap_get_sort_order ($imap_stream, $sort, $mbxresponse) {
138 global $default_charset, $thread_sort_messages,
139 $internal_date_sort, $server_sort_array,
140 $sent_folder, $mailbox, $uid_support;
142 if (sqsession_is_registered('server_sort_array')) {
143 sqsession_unregister('server_sort_array');
148 $server_sort_array = array();
149 $sort_test = array();
154 if (isset($mbxresponse['UIDNEXT']) && $mbxresponse['UIDNEXT']) {
155 $uidnext = $mbxresponse['UIDNEXT']-1;
159 $query = "SEARCH UID 1:$uidnext";
160 $uids = sqimap_run_command ($imap_stream, $query, true, $response, $message, true);
161 if (isset($uids[0])) {
162 if (preg_match("/^\* SEARCH (.+)$/", $uids[0], $regs)) {
163 $server_sort_array = preg_split("/ /", trim($regs[1]));
166 if (!preg_match("/OK/", $response)) {
167 $server_sort_array = 'no';
170 $qty = $mbxresponse['EXISTS'];
171 $server_sort_array = range(1, $qty);
173 $server_sort_array = array_reverse($server_sort_array);
174 sqsession_register($server_sort_array, 'server_sort_array');
175 return $server_sort_array;
178 $sort_on = array (0=> 'DATE',
184 if ($internal_date_sort == true) {
185 $sort_on[0] = 'ARRIVAL';
186 $sort_on[1] = 'ARRIVAL';
188 if ($sent_folder == $mailbox) {
192 if (!empty($sort_on[$sort])) {
193 $query = "SORT ($sort_on[$sort]) ".strtoupper($default_charset).' ALL';
194 $sort_test = sqimap_run_command ($imap_stream, $query, true, $response, $message, $uid_support);
196 if (isset($sort_test[0])) {
197 for ($i=0,$iCnt=count($sort_test);$i<$iCnt;++
$i) {
198 if (preg_match("/^\* SORT (.+)$/", $sort_test[$i], $regs)) {
199 $server_sort_array = preg_split("/ /", trim($regs[1]));
204 if ($sort == 0 ||
$sort == 2 ||
$sort == 4) {
205 $server_sort_array = array_reverse($server_sort_array);
207 if (!preg_match("/OK/", $response)) {
208 $server_sort_array = 'no';
210 sqsession_register($server_sort_array, 'server_sort_array');
211 return $server_sort_array;
215 * Get sort order from server if server does not have the SORT extension
216 * and return it as array for mailbox_display.
218 * @param resource $imap_stream
219 * @param array $mbxresponse response from a sqimap_mailbox_select
220 * @return array $php_sort_array
222 function sqimap_get_php_sort_order ($imap_stream, $mbxresponse) {
225 if (sqsession_is_registered('php_sort_array')) {
226 sqsession_unregister('php_sort_array');
229 $php_sort_array = array();
232 if (isset($mbxresponse['UIDNEXT']) && $mbxresponse['UIDNEXT']) {
233 $uidnext = $mbxresponse['UIDNEXT']-1;
237 $query = "SEARCH UID 1:$uidnext";
238 $uids = sqimap_run_command ($imap_stream, $query, true, $response, $message, true);
239 if (isset($uids[0])) {
240 $php_sort_array = array();
241 // EIMS workaround. EIMS returns the result as multiple untagged SEARCH responses
242 foreach($uids as $line) {
243 if (preg_match("/^\* SEARCH (.+)$/", $line, $regs)) {
244 $php_sort_array +
= preg_split("/ /", trim($regs[1]));
248 if (!preg_match("/OK/", $response)) {
249 $php_sort_array = 'no';
252 $qty = $mbxresponse['EXISTS'];
253 $php_sort_array = range(1, $qty);
255 sqsession_register($php_sort_array, 'php_sort_array');
256 return $php_sort_array;
261 * Returns an indent array for printMessageinfo()
262 * This represents the amount of indent needed (value),
263 * for this message number (key)
265 function get_parent_level ($imap_stream) {
266 global $sort_by_ref, $default_charset, $thread_new;
271 /* loop through the threads and take unwanted characters out
272 of the thread string then chop it up
274 for ($i=0;$i<count($thread_new);$i++
) {
275 $thread_new[$i] = preg_replace("/\s\(/", "(", $thread_new[$i]);
276 $thread_new[$i] = preg_replace("/(\d+)/", "$1|", $thread_new[$i]);
277 $thread_new[$i] = preg_split("/\|/", $thread_new[$i], -1, PREG_SPLIT_NO_EMPTY
);
279 $indent_array = array();
281 $thread_new = array();
283 /* looping through the parts of one message thread */
285 for ($i=0;$i<count($thread_new);$i++
) {
286 /* first grab the parent, it does not indent */
288 if (isset($thread_new[$i][0])) {
289 if (preg_match("/(\d+)/", $thread_new[$i][0], $regs)) {
293 $indent_array[$parent] = 0;
295 /* now the children, checking each thread portion for
296 ),(, and space, adjusting the level and space values
297 to get the indent level
304 for ($k=1;$k<(count($thread_new[$i]))-1;$k++
) {
305 $chars = count_chars($thread_new[$i][$k], 1);
306 if (isset($chars['40'])) { /* testing for ( */
307 $level = $level +
$chars['40'];
309 if (isset($chars['41'])) { /* testing for ) */
310 $level = $level - $chars['41'];
312 /* if we were faking lets stop, this portion
313 of the thread is over
315 if ($level == $cutoff) {
319 if (isset($chars['32'])) { /* testing for space */
320 if (!isset($spaces[$level])) {
323 $spaces[$level] = $spaces[$level] +
$chars['32'];
325 for ($x=0;$x<=$level;$x++
) {
326 if (isset($spaces[$x])) {
327 $spaces_total = $spaces_total +
$spaces[$x];
330 $indent = $level +
$spaces_total;
331 /* must have run into a message that broke the thread
332 so we are adjusting for that portion
335 $indent = $indent +
1;
337 if (preg_match("/(\d+)/", $thread_new[$i][$k], $regs)) {
340 /* the thread must be broken if $indent == 0
341 so indent the message once and start faking it
348 /* dont need abs but if indent was negative
351 $indent_array[$child] = abs($indent);
355 return $indent_array;
360 * Returns an array with each element as a string representing one
361 * message-thread as returned by the IMAP server.
363 function get_thread_sort ($imap_stream) {
364 global $thread_new, $sort_by_ref, $default_charset, $server_sort_array, $uid_support;
365 if (sqsession_is_registered('thread_new')) {
366 sqsession_unregister('thread_new');
368 if (sqsession_is_registered('server_sort_array')) {
369 sqsession_unregister('server_sort_array');
371 $thread_temp = array ();
372 if ($sort_by_ref == 1) {
373 $sort_type = 'REFERENCES';
376 $sort_type = 'ORDEREDSUBJECT';
378 $query = "THREAD $sort_type ".strtoupper($default_charset)." ALL";
379 $thread_test = sqimap_run_command ($imap_stream, $query, true, $response, $message, $uid_support);
380 if (isset($thread_test[0])) {
381 for ($i=0,$iCnt=count($thread_test);$i<$iCnt;++
$i) {
382 if (preg_match("/^\* THREAD (.+)$/", $thread_test[$i], $regs)) {
383 $thread_list = trim($regs[1]);
391 if (!preg_match("/OK/", $response)) {
392 $server_sort_array = 'no';
393 return $server_sort_array;
395 if (isset($thread_list)) {
396 $thread_temp = preg_split("//", $thread_list, -1, PREG_SPLIT_NO_EMPTY
);
398 $char_count = count($thread_temp);
400 $thread_new = array();
403 for ($i=0;$i<$char_count;$i++
) {
404 if ($thread_temp[$i] != ')' && $thread_temp[$i] != '(') {
405 $thread_new[$k] = $thread_new[$k] . $thread_temp[$i];
407 elseif ($thread_temp[$i] == '(') {
408 $thread_new[$k] .= $thread_temp[$i];
411 elseif ($thread_temp[$i] == ')') {
413 $thread_new[$k] .= $thread_temp[$i];
414 $counter = $counter - 1;
417 $thread_new[$k] .= $thread_temp[$i];
419 $thread_new[$k] = "";
420 $counter = $counter - 1;
424 sqsession_register($thread_new, 'thread_new');
425 $thread_new = array_reverse($thread_new);
426 $thread_list = implode(" ", $thread_new);
427 $thread_list = str_replace("(", " ", $thread_list);
428 $thread_list = str_replace(")", " ", $thread_list);
429 $thread_list = preg_split("/\s/", $thread_list, -1, PREG_SPLIT_NO_EMPTY
);
430 $server_sort_array = $thread_list;
431 sqsession_register($server_sort_array, 'server_sort_array');
436 function elapsedTime($start) {
437 $stop = gettimeofday();
438 $timepassed = 1000000 * ($stop['sec'] - $start['sec']) +
$stop['usec'] - $start['usec'];
442 // only used in sqimap_get_small_header_list
443 function parseString($read,&$i) {
449 $iPos = strpos($read,'"',$iPos);
451 if ($iPos && $read{$iPos -1} != '\\') {
452 $s = substr($read,$i,($iPos-$i));
457 if ($iPos > strlen($read)) {
461 } else if ($char == '{') {
464 $iPos = strpos($read,'}',$i);
466 $lit_cnt = substr($read, $i, $iPos - $i);
467 $i +
= strlen($lit_cnt) +
3; /* skip } + \r + \n */
468 /* Now read the literal */
469 $s = ($lit_cnt ?
substr($read,$i,$lit_cnt): '');
471 /* temp bugfix (SM 1.5 will have a working clean version)
472 too much work to implement that version right now */
474 } else { /* should never happen */
475 $i +
= 3; /* } + \r + \n */
485 // only used in sqimap_get_small_header_list
486 function parseArray($read,&$i) {
487 $i = strpos($read,'(',$i);
488 $i_pos = strpos($read,')',$i);
489 $s = substr($read,$i+
1,$i_pos - $i -1);
490 $a = explode(' ',$s);
499 function sqimap_get_small_header_list ($imap_stream, $msg_list, $show_num=false) {
500 global $squirrelmail_language, $color, $data_dir, $username, $imap_server_type;
501 global $uid_support, $allow_server_sort;
502 /* Get the small headers for each message in $msg_list */
503 $maxmsg = sizeof($msg_list);
504 if ($show_num != '999999') {
505 $msgs_str = sqimap_message_list_squisher($msg_list);
510 $read_list = array();
513 * We need to return the data in the same order as the caller supplied
514 * in $msg_list, but IMAP servers are free to return responses in
515 * whatever order they wish... So we need to re-sort manually
517 for ($i = 0; $i < sizeof($msg_list); $i++
) {
518 $messages["$msg_list[$i]"] = array();
521 $internaldate = getPref($data_dir, $username, 'internal_date_sort');
523 $query = "FETCH $msgs_str (FLAGS UID RFC822.SIZE INTERNALDATE BODY.PEEK[HEADER.FIELDS (Date To Cc From Subject X-Priority Content-Type)])";
525 $query = "FETCH $msgs_str (FLAGS UID RFC822.SIZE BODY.PEEK[HEADER.FIELDS (Date To Cc From Subject X-Priority Content-Type)])";
527 $read_list = sqimap_run_command_list ($imap_stream, $query, true, $response, $message, $uid_support);
530 foreach ($read_list as $r) {
531 $subject = _("(no subject)");
532 $from = _("Unknown sender");
535 $cc = $to = $date = $type[0] = $type[1] = $inrepto = '';
536 $flag_seen = $flag_answered = $flag_deleted = $flag_flagged = false;
538 $read = implode('',$r);
541 * #id<space>FETCH<space>(
544 /* extract the message id */
545 $i_space = strpos($read,' ',2);
546 $id = substr($read,2,$i_space-2);
547 $fetch = substr($read,$i_space+
1,5);
548 if (!is_numeric($id) && $fetch !== 'FETCH') {
549 set_up_language($squirrelmail_language);
550 echo '<br><b><font color=$color[2]>' .
551 _("ERROR : Could not complete request.") .
553 _("Unknown response from IMAP server: ") . ' 1.' .
554 htmlspecialchars($read) . "</font><br>\n";
557 $i = strpos($read,'(',$i_space+
5);
558 $read = substr($read,$i+
1);
559 $i_len = strlen($read);
561 while ($i < $i_len && $i !== false) {
563 $read = trim(substr($read,$i));
564 $i_len = strlen($read);
565 $i = strpos($read,' ');
566 $arg = substr($read,0,$i);
571 $i_pos = strpos($read,' ',$i);
573 $i_pos = strpos($read,')',$i);
576 $unique_id = substr($read,$i,$i_pos-$i);
583 $flags = parseArray($read,$i);
584 if (!$flags) break 3;
585 foreach ($flags as $flag) {
586 $flag = strtolower($flag);
589 case '\\seen': $flag_seen = true; break;
590 case '\\answered': $flag_answered = true; break;
591 case '\\deleted': $flag_deleted = true; break;
592 case '\\flagged': $flag_flagged = true; break;
598 $i_pos = strpos($read,' ',$i);
600 $i_pos = strpos($read,')',$i);
603 $size = substr($read,$i,$i_pos-$i);
611 $date = parseString($read,$i);
612 //if ($tmpdate === false) break 3;
613 //$tmpdate = str_replace(' ',' ',$tmpdate);
614 //$tmpdate = explode(' ',$tmpdate);
615 //$date = str_replace('-',' ',$tmpdate[0]) . " " .
616 // $tmpdate[1] . ' ' . $tmpdate[2];
618 case 'BODY.PEEK[HEADER.FIELDS':
619 case 'BODY[HEADER.FIELDS':
620 $i = strpos($read,'{',$i);
621 $header = parseString($read,$i);
622 if ($header === false) break 3;
623 /* First we unfold the header */
624 $hdr = trim(str_replace(array("\r\n\t", "\r\n "),array('', ''), $header));
625 /* Now we can make a new header array with */
626 /* each element representing a headerline */
627 $hdr = explode("\r\n" , $hdr);
628 foreach ($hdr as $line) {
629 $pos = strpos($line, ':');
631 $field = strtolower(substr($line, 0, $pos));
632 if (!strstr($field,' ')) { /* valid field */
633 $value = trim(substr($line, $pos+
1));
636 case 'to': $to = $value; break;
637 case 'cc': $cc = $value; break;
638 case 'from': $from = $value; break;
639 case 'date': $date = $value; break;
640 case 'x-priority': $priority = $value; break;
643 if ($subject == "") {
644 $subject = _("(no subject)");
649 if ($pos = strpos($type, ";")) {
650 $type = substr($type, 0, $pos);
652 $type = explode("/", $type);
653 if(!is_array($type)) {
656 if (!isset($type[1])) {
672 $date = str_replace(' ', ' ', $date);
673 $tmpdate = explode(' ', trim($date));
675 $tmpdate = $date = array('', '', '', '', '', '');
679 $messages[$msgi]['ID'] = $unique_id;
682 $messages[$msgi]['ID'] = $id;
684 $messages[$msgi]['TIME_STAMP'] = getTimeStamp($tmpdate);
685 $messages[$msgi]['DATE_STRING'] = getDateString($messages[$msgi]['TIME_STAMP']);
686 $messages[$msgi]['FROM'] = $from; //parseAddress($from);
687 $messages[$msgi]['SUBJECT'] = $subject;
688 // if (handleAsSent($mailbox)) {
689 $messages[$msgi]['TO'] = $to; //parseAddress($to);
691 $messages[$msgi]['PRIORITY'] = $priority;
692 $messages[$msgi]['CC'] = $cc; //parseAddress($cc);
693 $messages[$msgi]['SIZE'] = $size;
694 $messages[$msgi]['TYPE0'] = $type[0];
695 $messages[$msgi]['FLAG_DELETED'] = $flag_deleted;
696 $messages[$msgi]['FLAG_ANSWERED'] = $flag_answered;
697 $messages[$msgi]['FLAG_SEEN'] = $flag_seen;
698 $messages[$msgi]['FLAG_FLAGGED'] = $flag_flagged;
700 /* non server sort stuff */
701 if (!$allow_server_sort) {
702 $from = parseAddress($from);
704 $from = decodeHeader($from[0][1]);
708 $messages[$msgi]['FROM-SORT'] = $from;
709 $subject_sort = strtolower(decodeHeader($subject));
710 if (preg_match("/^(vedr|sv|re|aw):\s*(.*)$/si", $subject_sort, $matches)){
711 $messages[$msgi]['SUBJECT-SORT'] = $matches[2];
713 $messages[$msgi]['SUBJECT-SORT'] = $subject_sort;
718 array_reverse($messages);
719 $new_messages = array();
720 foreach ($messages as $i =>$message) {
721 $new_messages[] = $message;
723 return $new_messages;
727 * Returns a message array with all the information about a message.
728 * See the documentation folder for more information about this array.
730 function sqimap_get_message ($imap_stream, $id, $mailbox) {
734 $read = sqimap_run_command ($imap_stream, "FETCH $id (FLAGS BODYSTRUCTURE)", true, $response, $message, $uid_support);
736 if (preg_match('/.+FLAGS\s\((.*)\)\s/AUi',$read[0],$regs)) {
737 if (trim($regs[1])) {
738 $flags = preg_split('/ /', $regs[1],-1,'PREG_SPLIT_NI_EMPTY');
742 /* the message was not found, maybe the mailbox was modified? */
743 global $sort, $startMessage, $color;
745 $errmessage = _("The server couldn't find the message you requested.") .
746 '<p>'._("Most probably your message list was out of date and the message has been moved away or deleted (perhaps by another program accessing the same mailbox).");
747 /* this will include a link back to the message list */
748 error_message($errmessage, $mailbox, $sort, $startMessage, $color);
751 $bodystructure = implode('',$read);
752 $msg = mime_structure($bodystructure,$flags);
753 $read = sqimap_run_command ($imap_stream, "FETCH $id BODY[HEADER]", true, $response, $message, $uid_support);
754 $rfc822_header = new Rfc822Header();
755 $rfc822_header->parseHeader($read);
756 $msg->rfc822_header
= $rfc822_header;