18b89234fdcbefae11c24c8f0cacaf0220171760
6 * Copyright (c) 1999-2002 The SquirrelMail Project Team
7 * Licensed under the GNU GPL. For full terms see the file COPYING.
9 * This implements functions that manipulate messages
14 /* Copies specified messages to specified folder */
15 function sqimap_messages_copy ($imap_stream, $start, $end, $mailbox) {
16 $read = sqimap_run_command ($imap_stream, "COPY $start:$end \"$mailbox\"", true, $response, $message);
19 /* Deletes specified messages and moves them to trash if possible */
20 function sqimap_messages_delete ($imap_stream, $start, $end, $mailbox) {
21 global $move_to_trash, $trash_folder, $auto_expunge;
23 if (($move_to_trash == true) && (sqimap_mailbox_exists($imap_stream, $trash_folder) && ($mailbox != $trash_folder))) {
24 sqimap_messages_copy ($imap_stream, $start, $end, $trash_folder);
26 sqimap_messages_flag ($imap_stream, $start, $end, "Deleted");
29 /* Sets the specified messages with specified flag */
30 function sqimap_messages_flag ($imap_stream, $start, $end, $flag) {
31 $read = sqimap_run_command ($imap_stream, "STORE $start:$end +FLAGS (\\$flag)", true, $response, $message);
34 /* Remove specified flag from specified messages */
35 function sqimap_messages_remove_flag ($imap_stream, $start, $end, $flag) {
36 $read = sqimap_run_command ($imap_stream, "STORE $start:$end -FLAGS (\\$flag)", true, $response, $message);
39 /* Returns some general header information -- FROM, DATE, and SUBJECT */
41 var $from = '', $subject = '', $date = '', $to = '',
42 $priority = 0, $message_id = 0, $cc = '';
45 function sqimap_get_small_header ($imap_stream, $id, $sent) {
46 $res = sqimap_get_small_header_list($imap_stream, array($id), $sent);
51 * Sort the message list and crunch to be as small as possible
52 * (overflow could happen, so make it small if possible)
54 function sqimap_message_list_squisher($messages_array) {
55 if( !is_array( $messages_array ) ) {
58 sort($messages_array, SORT_NUMERIC
);
60 while ($messages_array) {
61 $start = array_shift($messages_array);
63 while (isset($messages_array[0]) && $messages_array[0] == $end +
1) {
64 $end = array_shift($messages_array);
66 if ($msgs_str != '') {
71 $msgs_str .= ':' . $end;
78 /* returns the references header lines */
79 function get_reference_header ($imap_stream, $message) {
80 $responses = array ();
81 $sid = sqimap_session_id();
84 $query = "$sid FETCH $message BODY.PEEK[HEADER.FIELDS (References)]\r\n";
85 fputs ($imap_stream, $query);
86 $responses = sqimap_read_data_list($imap_stream, $sid, true, $responses, $message);
87 if (!eregi("^\\* ([0-9]+) FETCH", $responses[0][0], $regs)) {
88 $responses = array ();
94 /* get sort order from server and
95 * return it as the $id array for
99 function sqimap_get_sort_order ($imap_stream, $sort) {
100 global $default_charset, $thread_sort_messages,
101 $internal_date_sort, $server_sort_array,
102 $sent_folder, $mailbox;
104 if (session_is_registered('server_sort_array')) {
105 session_unregister('server_sort_array');
107 $sid = sqimap_session_id();
110 $server_sort_array = array();
111 $sort_test = array();
113 $sort_on = array (0=> 'DATE',
120 if ($internal_date_sort == true) {
121 $sort_on[0] = 'ARRIVAL';
122 $sort_on[1] = 'ARRIVAL';
124 if ($sent_folder == $mailbox) {
128 if (!empty($sort_on[$sort])) {
129 $sort_query = "$sid SORT ($sort_on[$sort]) ".strtoupper($default_charset)." ALL\r\n";
130 fputs($imap_stream, $sort_query);
131 $sort_test = sqimap_read_data($imap_stream, $sid, true, $response, $message);
133 if (preg_match("/^\* SORT (.+)$/", $sort_test[0], $regs)) {
134 $server_sort_array = preg_split("/ /", trim($regs[1]));
136 if ($sort == 0 ||
$sort == 2 ||
$sort == 4) {
137 $server_sort_array = array_reverse($server_sort_array);
139 session_register('server_sort_array');
140 return $server_sort_array;
143 /* returns an indent array for printMessageinfo()
144 this represents the amount of indent needed (value)
145 for this message number (key)
148 function get_parent_level ($imap_stream) {
149 global $sort_by_ref, $default_charset, $thread_new;
152 for ($i=0;$i<count($thread_new);$i++
) {
153 $thread_new[$i] = preg_replace("/\s\(/", "(", $thread_new[$i]);
154 $thread_new[$i] = preg_replace("/(\d+)/", "$1|", $thread_new[$i]);
155 $thread_new[$i] = preg_split("/\|/", $thread_new[$i], -1, PREG_SPLIT_NO_EMPTY
);
157 $indent_array = array();
159 $thread_new = array();
161 for ($i=0;$i<count($thread_new);$i++
) {
162 if (isset($thread_new[$i][0])) {
163 if (preg_match("/(\d+)/", $thread_new[$i][0], $regs)) {
167 $indent_array[$parent] = 0;
172 for ($k=1;$k<(count($thread_new[$i]))-1;$k++
) {
173 $chars = count_chars($thread_new[$i][$k], 1);
174 if (isset($chars['40']) && isset($chars['41'])) {
177 if (isset($chars['40'])) { // (
178 $indent = $indent +
$chars[40];
182 if (isset($chars['41'])) { // )
183 if ($go == 'start') {
184 if (!isset($spaces[$l])) {
187 $indent = $indent - $spaces[$l];
188 $indent = $indent - $chars[41] ;
193 $indent = $indent - $chars[41];
196 if (isset($chars['32'])) { // space
197 $indent = $indent +
$chars[32];
198 if ($go == 'start') {
199 if (!isset($spaces[$l])) {
202 $spaces[$l] = $spaces[$l] +
$chars[32];
205 if (preg_match("/(\d+)/", $thread_new[$i][$k], $regs)) {
208 $indent_array[$child] = abs($indent);
211 return $indent_array;
215 /* returns an array with each element as a string
216 representing one message thread as returned by
220 function get_thread_sort ($imap_stream) {
221 global $thread_new, $sort_by_ref, $default_charset, $server_sort_array;
223 if (session_is_registered('thread_new')) {
224 session_unregister('thread_new');
226 if (session_is_registered('server_sort_array')) {
227 session_unregister('server_srot_array');
229 $sid = sqimap_session_id();
230 $thread_temp = array ();
231 if ($sort_by_ref == 1) {
232 $sort_type = 'REFERENCES';
235 $sort_type = 'ORDEREDSUBJECT';
237 $thread_query = "$sid THREAD $sort_type ".strtoupper($default_charset)." ALL\r\n";
238 fputs($imap_stream, $thread_query);
239 $thread_test = sqimap_read_data($imap_stream, $sid, true, $response, $message);
240 if (preg_match("/^\* THREAD (.+)$/", $thread_test[0], $regs)) {
241 $thread_list = trim($regs[1]);
246 $thread_temp = preg_split("//", $thread_list, -1, PREG_SPLIT_NO_EMPTY
);
247 $char_count = count($thread_temp);
249 $thread_new = array();
252 for ($i=0;$i<$char_count;$i++
) {
253 if ($thread_temp[$i] != ')' && $thread_temp[$i] != '(') {
254 $thread_new[$k] = $thread_new[$k] . $thread_temp[$i];
256 elseif ($thread_temp[$i] == '(') {
257 $thread_new[$k] .= $thread_temp[$i];
260 elseif ($thread_temp[$i] == ')') {
262 $thread_new[$k] .= $thread_temp[$i];
263 $counter = $counter - 1;
266 $thread_new[$k] .= $thread_temp[$i];
268 $thread_new[$k] = "";
269 $counter = $counter - 1;
273 session_register('$thread_new');
274 $thread_new = array_reverse($thread_new);
275 $thread_list = implode(" ", $thread_new);
276 $thread_list = str_replace("(", " ", $thread_list);
277 $thread_list = str_replace(")", " ", $thread_list);
278 $thread_list = preg_split("/\s/", $thread_list, -1, PREG_SPLIT_NO_EMPTY
);
279 $server_sort_array = $thread_list;
280 session_register('server_sort_array');
286 function sqimap_get_small_header_list ($imap_stream, $msg_list, $issent) {
287 global $squirrelmail_language, $color, $data_dir, $username;
289 /* Get the small headers for each message in $msg_list */
290 $sid = sqimap_session_id();
291 $maxmsg = sizeof($msg_list);
292 $msgs_str = sqimap_message_list_squisher($msg_list);
294 $read_list = array();
295 $sizes_list = array();
297 * We need to return the data in the same order as the caller supplied
298 * in $msg_list, but IMAP servers are free to return responses in
299 * whatever order they wish... So we need to re-sort manually
301 for ($i = 0; $i < sizeof($msg_list); $i++
) {
302 $id2index[$msg_list[$i]] = $i;
305 $query = "$sid FETCH $msgs_str BODY.PEEK[HEADER.FIELDS (Date To From Cc Subject Message-Id X-Priority Content-Type In-Reply-To)]\r\n";
306 fputs ($imap_stream, $query);
307 $readin_list = sqimap_read_data_list($imap_stream, $sid, true, $response, $message);
309 foreach ($readin_list as $r) {
310 if (!eregi("^\\* ([0-9]+) FETCH", $r[0], $regs)) {
311 set_up_language($squirrelmail_language);
312 echo '<br><b><font color=$color[2]>' .
313 _("ERROR : Could not complete request.") .
315 _("Unknown response from IMAP server: ") . ' 1.' .
316 $r[0] . "</font><br>\n";
317 } else if (! isset($id2index[$regs[1]]) ||
!count($id2index[$regs[1]])) {
318 set_up_language($squirrelmail_language);
319 echo '<br><b><font color=$color[2]>' .
320 _("ERROR : Could not complete request.") .
322 _("Unknown message number in reply from server: ") .
323 $regs[1] . "</font><br>\n";
325 $read_list[$id2index[$regs[1]]] = $r;
330 $query = "$sid FETCH $msgs_str RFC822.SIZE\r\n";
331 fputs ($imap_stream, $query);
332 $sizesin_list = sqimap_read_data_list($imap_stream, $sid, true, $response, $message);
334 foreach ($sizesin_list as $r) {
335 if (!eregi("^\\* ([0-9]+) FETCH", $r[0], $regs)) {
336 set_up_language($squirrelmail_language);
337 echo "<br><b><font color=$color[2]>\n";
338 echo _("ERROR : Could not complete request.");
340 echo _("Unknown response from IMAP server: ") . ' 2.';
341 echo $r[0] . "</font><br>\n";
344 if (!count($id2index[$regs[1]])) {
345 set_up_language($squirrelmail_language);
346 echo "<br><b><font color=$color[2]>\n";
347 echo _("ERROR : Could not complete request.");
349 echo _("Unknown messagenumber in reply from server: ");
350 echo $regs[1] . "</font><br>\n";
353 $sizes_list[$id2index[$regs[1]]] = $r;
357 for ($msgi = 0; $msgi < $maxmsg; $msgi++
) {
358 $subject = _("(no subject)");
359 $from = _("Unknown Sender");
368 $read = $read_list[$msgi];
371 foreach ($read as $read_part) {
372 //unfold multi-line headers
373 while ($prevline && strspn($read_part, "\t ") > 0) {
374 $read_part = substr($prevline, 0, -2) . ' ' . ltrim($read_part);
376 $prevline = $read_part;
377 if (eregi ("^to:(.*)$", $read_part, $regs)) {
379 } else if (eregi ("^from:(.*)$", $read_part, $regs)) {
381 } else if (eregi ("^x-priority:(.*)$", $read_part, $regs)) {
382 $priority = trim($regs[1]);
383 } else if (eregi ("^message-id:(.*)$", $read_part, $regs)) {
384 $messageid = trim($regs[1]);
385 } else if (eregi ("^cc:(.*)$", $read_part, $regs)) {
387 } else if (eregi ("^date:(.*)$", $read_part, $regs)) {
389 } else if (eregi ("^subject:(.*)$", $read_part, $regs)) {
390 $subject = htmlspecialchars(trim($regs[1]));
391 if ($subject == "") {
392 $subject = _("(no subject)");
394 } else if (eregi ("^content-type:(.*)$", $read_part, $regs)) {
395 $type = strtolower(trim($regs[1]));
396 if ($pos = strpos($type, ";")) {
397 $type = substr($type, 0, $pos);
399 $type = explode("/", $type);
400 if (!isset($type[1])) {
403 } else if (eregi ("^in-reply-to:(.*)$", $read_part, $regs)) {
404 $inrepto = trim($regs[1]);
407 $internaldate = getPref($data_dir, $username, 'internal_date_sort');
408 if (trim($date) == "" ||
$internaldate) {
409 fputs($imap_stream, "$sid FETCH $msg_list[$msgi] INTERNALDATE\r\n");
410 $readdate = sqimap_read_data($imap_stream, $sid, true, $response, $message);
411 if (eregi(".*INTERNALDATE \"(.*)\".*", $readdate[0], $regs)) {
412 $date_list = explode(' ', trim($regs[1]));
413 $date_list[0] = str_replace("-", ' ', $date_list[0]);
414 $date = implode(' ', $date_list);
417 eregi("([0-9]+)[^0-9]*$", $sizes_list[$msgi][0], $regs);
420 $header = new small_header
;
422 $header->from
= (trim($to) != '' ?
$to : '(' ._("No To Address") . ')');
424 $header->from
= $from;
427 $header->date
= $date;
428 $header->subject
= $subject;
430 $header->priority
= $priority;
431 $header->message_id
= $messageid;
433 $header->size
= $size;
434 $header->type0
= $type[0];
435 $header->type1
= $type[1];
436 $header->inrepto
= $inrepto;
442 /* Returns the flags for the specified messages */
443 function sqimap_get_flags ($imap_stream, $i) {
444 $read = sqimap_run_command ($imap_stream, "FETCH $i:$i FLAGS", true, $response, $message);
445 if (ereg('FLAGS(.*)', $read[0], $regs)) {
446 return explode(' ', trim(ereg_replace('[\\(\\)\\\\]', '', $regs[1])));
448 return array('None');
451 function sqimap_get_flags_list ($imap_stream, $msg_list) {
452 $msgs_str = sqimap_message_list_squisher($msg_list);
453 for ($i = 0; $i < sizeof($msg_list); $i++
) {
454 $id2index[$msg_list[$i]] = $i;
456 $result_list = sqimap_run_command_list ($imap_stream, "FETCH $msgs_str FLAGS", true, $response, $message);
457 $result_flags = array();
459 for ($i = 0; $i < sizeof($result_list); $i++
) {
460 if (eregi('^\* ([0-9]+).*FETCH.*FLAGS(.*)', $result_list[$i][0], $regs)
461 && isset($id2index[$regs[1]]) && count($id2index[$regs[1]])) {
462 $result_flags[$id2index[$regs[1]]] = explode(" ", trim(ereg_replace('[\\(\\)\\\\]', '', $regs[2])));
464 set_up_language($squirrelmail_language);
465 echo "<br><b><font color=$color[2]>\n" .
466 _("ERROR : Could not complete request.") .
468 _("Unknown response from IMAP server: ") .
469 $result_list[$i][0] . "</font><br>\n";
473 arsort($result_flags);
474 return $result_flags;
478 * Returns a message array with all the information about a message.
479 * See the documentation folder for more information about this array.
481 function sqimap_get_message ($imap_stream, $id, $mailbox) {
482 $header = sqimap_get_message_header($imap_stream, $id, $mailbox);
483 return sqimap_get_message_body($imap_stream, $header);
486 /* Wrapper function that reformats the header information. */
487 function sqimap_get_message_header ($imap_stream, $id, $mailbox) {
488 $read = sqimap_run_command ($imap_stream, "FETCH $id:$id BODY[HEADER]", true, $response, $message);
489 $header = sqimap_get_header($imap_stream, $read);
491 $header->mailbox
= $mailbox;
495 /* Wrapper function that reformats the entity header information. */
496 function sqimap_get_ent_header ($imap_stream, $id, $mailbox, $ent) {
497 $read = sqimap_run_command ($imap_stream, "FETCH $id:$id BODY[$ent.HEADER]", true, $response, $message);
498 $header = sqimap_get_header($imap_stream, $read);
500 $header->mailbox
= $mailbox;
505 /* Wrapper function that returns entity headers for use by decodeMime */
507 function sqimap_get_entity_header ($imap_stream, &$read, &$type0, &$type1, &$bound, &$encoding, &$charset, &$filename) {
508 $header = sqimap_get_header($imap_stream, $read);
509 $type0 = $header["TYPE0"];
510 $type1 = $header["TYPE1"];
511 $bound = $header["BOUNDARY"];
512 $encoding = $header["ENCODING"];
513 $charset = $header["CHARSET"];
514 $filename = $header["FILENAME"];
517 /* Queries the IMAP server and gets all header information. */
518 function sqimap_get_header ($imap_stream, $read) {
519 global $where, $what;
521 $hdr = new msg_header();
524 /* Set up some defaults */
525 $hdr->type0
= "text";
526 $hdr->type1
= "plain";
527 $hdr->charset
= "us-ascii";
529 while ($i < count($read)) {
530 //unfold multi-line headers
531 while ($i +
1 < count($read) && strspn($read[$i +
1], "\t ") > 0) {
532 $read[$i +
1] = substr($read[$i], 0, -2) . ' ' . ltrim($read[$i +
1]);
533 array_splice($read, $i, 1);
536 if (substr($read[$i], 0, 17) == "MIME-Version: 1.0") {
541 else if (substr(strtolower($read[$i]), 0, 26) == "content-transfer-encoding:") {
542 $hdr->encoding
= strtolower(trim(substr($read[$i], 26)));
546 else if (strtolower(substr($read[$i], 0, 13)) == "content-type:") {
547 $cont = strtolower(trim(substr($read[$i], 13)));
548 if (strpos($cont, ";")) {
549 $cont = substr($cont, 0, strpos($cont, ";"));
552 if (strpos($cont, "/")) {
553 $hdr->type0
= substr($cont, 0, strpos($cont, "/"));
554 $hdr->type1
= substr($cont, strpos($cont, "/")+
1);
561 while ( (substr(substr($read[$i], 0, strpos($read[$i], " ")), -1) != ":") && (trim($read[$i]) != "") && (trim($read[$i]) != ")")) {
562 str_replace("\n", "", $line);
563 str_replace("\n", "", $read[$i]);
564 $line = "$line $read[$i]";
568 /* Detect the boundary of a multipart message */
569 if (eregi('boundary="([^"]+)"', $line, $regs)) {
570 $hdr->boundary
= $regs[1];
573 /* Detect the charset */
574 if (strpos(strtolower(trim($line)), "charset=")) {
575 $pos = strpos($line, "charset=") +
8;
576 $charset = trim($line);
577 if (strpos($line, ";", $pos) > 0) {
578 $charset = substr($charset, $pos, strpos($line, ";", $pos)-$pos);
580 $charset = substr($charset, $pos);
582 $charset = str_replace("\"", "", $charset);
583 $hdr->charset
= $charset;
585 $hdr->charset
= "us-ascii";
588 else if (strtolower(substr($read[$i], 0, 20)) == "content-disposition:") {
589 /* Add better content-disposition support */
592 while ( (substr(substr($read[$i], 0, strpos($read[$i], " ")), -1) != ":") && (trim($read[$i]) != "") && (trim($read[$i]) != ")")) {
593 str_replace("\n", "", $line);
594 str_replace("\n", "", $read[$i]);
595 $line = "$line $read[$i]";
599 /* Detects filename if any */
600 if (strpos(strtolower(trim($line)), "filename=")) {
601 $pos = strpos($line, "filename=") +
9;
603 if (strpos($line, " ", $pos) > 0) {
604 $name = substr($name, $pos, strpos($line, " ", $pos));
606 $name = substr($name, $pos);
608 $name = str_replace("\"", "", $name);
609 $hdr->filename
= $name;
613 else if (strtolower(substr($read[$i], 0, 9)) == "reply-to:") {
614 $hdr->replyto
= trim(substr($read[$i], 9, strlen($read[$i])));
618 else if (strtolower(substr($read[$i], 0, 5)) == "from:") {
619 $hdr->from
= trim(substr($read[$i], 5, strlen($read[$i]) - 6));
620 if (! isset($hdr->replyto
) ||
$hdr->replyto
== "") {
621 $hdr->replyto
= $hdr->from
;
626 else if (strtolower(substr($read[$i], 0, 5)) == "date:") {
627 $d = substr($read[$i], 5);
629 $d = strtr($d, array(' ' => ' '));
630 $d = explode(' ', $d);
631 $hdr->date
= getTimeStamp($d);
635 else if (strtolower(substr($read[$i], 0, 8)) == "subject:") {
636 $hdr->subject
= trim(substr($read[$i], 8, strlen($read[$i]) - 9));
637 if (strlen(Chop($hdr->subject
)) == 0) {
638 $hdr->subject
= _("(no subject)");
641 if ($where == 'SUBJECT') {
642 $hdr->subject = $what;
643 // $hdr->subject = eregi_replace($what, "<b>\\0</b>", $hdr->subject);
649 else if (strtolower(substr($read[$i], 0, 3)) == "cc:") {
651 $hdr->cc
[$pos] = trim(substr($read[$i], 4));
653 while (((substr($read[$i], 0, 1) == " ") ||
(substr($read[$i], 0, 1) == "\t")) && (trim($read[$i]) != "")){
655 $hdr->cc
[$pos] = trim($read[$i]);
660 else if (strtolower(substr($read[$i], 0, 4)) == "bcc:") {
662 $hdr->bcc
[$pos] = trim(substr($read[$i], 5));
664 while (((substr($read[$i], 0, 1) == " ") ||
(substr($read[$i], 0, 1) == "\t")) && (trim($read[$i]) != "")){
666 $hdr->bcc
[$pos] = trim($read[$i]);
671 else if (strtolower(substr($read[$i], 0, 3)) == "to:") {
673 $hdr->to
[$pos] = trim(substr($read[$i], 4));
675 while (((substr($read[$i], 0, 1) == " ") ||
(substr($read[$i], 0, 1) == "\t")) && (trim($read[$i]) != "")){
677 $hdr->to
[$pos] = trim($read[$i]);
682 else if (strtolower(substr($read[$i], 0, 11)) == "message-id:") {
683 $hdr->message_id
= trim(substr($read[$i], 11));
686 /* ERROR CORRECTION */
687 else if (substr($read[$i], 0, 1) == ")") {
688 if (strlen(trim($hdr->subject
)) == 0) {
689 $hdr->subject
= _("(no subject)");
691 if (strlen(trim($hdr->from
)) == 0) {
692 $hdr->from
= _("(unknown sender)");
694 if (strlen(trim($hdr->date
)) == 0) {
700 else if (strtolower(substr($read[$i], 0, 11)) == "x-priority:") {
701 $hdr->priority
= trim(substr($read[$i], 11));
711 /* Returns the body of a message. */
712 function sqimap_get_message_body ($imap_stream, &$header) {
714 return decodeMime($imap_stream, $header);