de96678592661fd5836e610c212b5124d0f78021
6 * Copyright (c) 1999-2004 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
19 * Copy a set of messages ($id) to another mailbox ($mailbox)
20 * @param int $imap_stream The resource ID for the IMAP socket
21 * @param string $id The list of messages to copy
22 * @param string $mailbox The destination to copy to
25 function sqimap_msgs_list_copy($imap_stream, $id, $mailbox) {
26 $msgs_id = sqimap_message_list_squisher($id);
27 $read = sqimap_run_command ($imap_stream, "COPY $msgs_id " . sqimap_encode_mailbox_name($mailbox), true, $response, $message, TRUE);
28 if ($response == 'OK') {
37 * Move a set of messages ($id) to another mailbox. Deletes the originals.
38 * @param int $imap_stream The resource ID for the IMAP socket
39 * @param string $id The list of messages to move
40 * @param string $mailbox The destination to move to
43 function sqimap_msgs_list_move($imap_stream, $id, $mailbox) {
44 $msgs_id = sqimap_message_list_squisher($id);
45 if (sqimap_msgs_list_copy ($imap_stream, $id, $mailbox)) {
46 return sqimap_toggle_flag($imap_stream, $id, '\\Deleted', true, true);
54 * Deletes a message and move it to trash or expunge the mailbox
55 * @param resource imap connection
56 * @param string $mailbox mailbox, used for checking if it concerns the trash_folder
57 * @param array $id list with uid's
58 * @param bool $bypass_trash skip copy to trash
59 * @return array $aMessageList array with messages containing the new flags and UID @see parseFetch
61 function sqimap_msgs_list_delete($imap_stream, $mailbox, $id, $bypass_trash=false) {
62 // FIX ME, remove globals by introducing an associative array with properties
63 // as 4th argument as replacement for the bypass_trash var
64 global $move_to_trash, $trash_folder;
66 if (($move_to_trash == true) && ($bypass_trash != true) &&
67 (sqimap_mailbox_exists($imap_stream, $trash_folder) && ($mailbox != $trash_folder)) ) {
68 $bRes = sqimap_msgs_list_copy ($imap_stream, $id, $trash_folder);
71 return sqimap_toggle_flag($imap_stream, $id, '\\Deleted', true, true);
79 * Set a flag on the provided uid list
80 * @param resource imap connection
81 * @param array $id list with uid's
82 * @param string $flag Flags to set/unset flags can be i.e.'\Seen', '\Answered', '\Seen \Answered'
83 * @param bool $set add (true) or remove (false) the provided flag
84 * @param bool $handle_errors Show error messages in case of a NO, BAD or BYE response
85 * @return array $aMessageList array with messages containing the new flags and UID @see parseFetch
87 function sqimap_toggle_flag($imap_stream, $id, $flag, $set, $handle_errors) {
88 $msgs_id = sqimap_message_list_squisher($id);
89 $set_string = ($set ?
'+' : '-');
90 $aResponse = sqimap_run_command_list($imap_stream, "STORE $msgs_id ".$set_string."FLAGS ($flag)", $handle_errors, $response, $message, TRUE);
91 // parse the fetch response
92 return parseFetch($aResponse);
97 * Sort the message list and crunch to be as small as possible
98 * (overflow could happen, so make it small if possible)
100 function sqimap_message_list_squisher($messages_array) {
101 if( !is_array( $messages_array ) ) {
102 return $messages_array;
105 sort($messages_array, SORT_NUMERIC
);
107 while ($messages_array) {
108 $start = array_shift($messages_array);
110 while (isset($messages_array[0]) && $messages_array[0] == $end +
1) {
111 $end = array_shift($messages_array);
113 if ($msgs_str != '') {
117 if ($start != $end) {
118 $msgs_str .= ':' . $end;
126 * Retrieves an array with a sorted uid list. Sorting is done on the imap server
127 * @link http://www.ietf.org/internet-drafts/draft-ietf-imapext-sort-17.txt
128 * @param resource $imap_stream IMAP socket connection
129 * @param string $sSortField Field to sort on
130 * @param bool $reverse Reverse order search
131 * @return array $id sorted uid list
133 function sqimap_get_sort_order($imap_stream, $sSortField, $reverse, $search='ALL') {
134 global $default_charset;
138 $sSortField = 'REVERSE '.$sSortField;
140 $query = "SORT ($sSortField) ".strtoupper($default_charset)." $search";
141 // FIX ME sqimap_run_command should return the parsed data accessible by $aDATA['SORT']
142 $aData = sqimap_run_command ($imap_stream, $query, false, $response, $message, TRUE);
143 /* fallback to default charset */
144 if ($response == 'NO' && strpos($message,'[BADCHARSET]') !== false) {
145 $query = "SORT ($sSortField) US-ASCII $search";
146 $aData = sqimap_run_command ($imap_stream, $query, true, $response, $message, TRUE);
150 if ($response == 'OK') {
151 return parseUidList($aData,'SORT');
159 * Parses a UID list returned on a SORT or SEARCH request
160 * @param array $aData imap response
161 * @param string $sCommand issued imap command (SEARCH or SORT)
162 * @return array $aUid uid list
164 function parseUidList($aData,$sCommand) {
166 if (isset($aData) && count($aData)) {
167 for ($i=0,$iCnt=count($aData);$i<$iCnt;++
$i) {
168 if (preg_match("/^\* $sCommand (.+)$/", $aData[$i], $aMatch)) {
169 $aUid +
= preg_split("/ /", trim($aMatch[1]));
173 return array_unique($aUid);
177 * Retrieves an array with a sorted uid list. Sorting is done by SquirrelMail
179 * @param resource $imap_stream IMAP socket connection
180 * @param string $sSortField Field to sort on
181 * @param bool $reverse Reverse order search
182 * @param array $aUid limit the search to the provided array with uid's default sqimap_get_small_headers uses 1:*
183 * @return array $aUid sorted uid list
185 function get_squirrel_sort($imap_stream, $sSortField, $reverse = false, $aUid = NULL) {
186 if ($sSortField != 'RFC822.SIZE' && $sSortField != 'INTERNALDATE') {
187 $msgs = sqimap_get_small_header_list($imap_stream, $aUid,
188 array($sSortField), array());
190 $msgs = sqimap_get_small_header_list($imap_stream, $aUid,
191 array(), array($sSortField));
195 switch ($sSortField) {
196 // natcasesort section
201 array_walk($msgs, create_function('&$v,&$k,$f',
202 '$v[$f] = (isset($v[$f])) ? $v[$f] : "";
203 $addr = reset(parseRFC822Address($v[$f],1));
204 $sPersonal = (isset($addr[SQM_ADDR_PERSONAL]) && $addr[SQM_ADDR_PERSONAL]) ?
205 $addr[SQM_ADDR_PERSONAL] : "";
206 $sEmail = ($addr[SQM_ADDR_HOST]) ?
207 $addr[SQM_ADDR_HOST] . "@".$addr[SQM_ADDR_HOST] :
208 $addr[SQM_ADDR_HOST];
209 $v[$f] = ($sPersonal) ? decodeHeader($sPersonal):$sEmail;'),$sSortField);
215 array_walk($msgs, create_function('&$v,&$k,$f',
216 '$v[$f] = (isset($v[$f])) ? $v[$f] : "";
217 $v[$f] = strtolower(decodeHeader(trim($v[$f])));
218 $v[$f] = (preg_match("/^(vedr|sv|re|aw|\[\w\]):\s*(.*)$/si", $v[$f], $matches)) ?
219 $matches[2] : $v[$f];'),$sSortField);
222 foreach ($msgs as $item) {
223 $aUid[$item['UID']] = $item[$sSortField];
226 $aUid = array_keys($aUid);
228 $aUid = array_reverse($aUid);
231 // \natcasesort section
232 // sort_numeric section
236 array_walk($msgs, create_function('&$v,$k,$f',
237 '$v[$f] = (isset($v[$f])) ? $v[$f] : "";
238 $v[$f] = getTimeStamp(explode(" ",$v[$f]));'),$sSortField);
244 // redefine $sSortField to maintain the same namespace between
245 // server-side sorting and squirrelmail sorting
246 $sSortField = 'SIZE';
248 foreach ($msgs as $item) {
249 $aUid[$item['UID']] = (isset($item[$sSortField])) ?
$item[$sSortField] : 0;
252 arsort($aUid,SORT_NUMERIC
);
254 asort($aUid, SORT_NUMERIC
);
256 $aUid = array_keys($aUid);
258 // \sort_numeric section
260 $aUid = array_reverse($msgs);
268 * Returns an indent array for printMessageinfo()
269 * This represents the amount of indent needed (value),
270 * for this message number (key)
274 * Notes for future work:
275 * indent_array should contain: indent_level, parent and flags,
277 * To achieve that we need to define the following flags:
282 * a node has sibling nodes if it's not the last node
283 * a node has no sibling nodes if it's the last node
284 * By using binary comparations we can store the flag in one var
287 * -1 par = 0, level = 0, flag = 1 + 2 + 4 = 7 (haschildren, isfirst, islast)
288 * \-2 par = 1, level = 1, flag = 0 + 2 = 2 (hasnochildren, isfirst)
289 * |-3 par = 1, level = 1, flag = 1 + 4 = 5 (haschildren, islast)
290 * \-4 par = 3, level = 2, flag = 1 + 2 + 4 = 7 (haschildren, isfirst, islast)
291 * \-5 par = 4, level = 3, flag = 0 + 2 + 4 = 6 (hasnochildren, isfirst, islast)
293 function get_parent_level($thread_new) {
299 * loop through the threads and take unwanted characters out
300 * of the thread string then chop it up
302 for ($i=0;$i<count($thread_new);$i++
) {
303 $thread_new[$i] = preg_replace("/\s\(/", "(", $thread_new[$i]);
304 $thread_new[$i] = preg_replace("/(\d+)/", "$1|", $thread_new[$i]);
305 $thread_new[$i] = preg_split("/\|/", $thread_new[$i], -1, PREG_SPLIT_NO_EMPTY
);
307 $indent_array = array();
309 $thread_new = array();
311 /* looping through the parts of one message thread */
313 for ($i=0;$i<count($thread_new);$i++
) {
314 /* first grab the parent, it does not indent */
316 if (isset($thread_new[$i][0])) {
317 if (preg_match("/(\d+)/", $thread_new[$i][0], $regs)) {
321 $indent_array[$parent] = 0;
324 * now the children, checking each thread portion for
325 * ),(, and space, adjusting the level and space values
326 * to get the indent level
333 for ($k=1,$iCnt=count($thread_new[$i])-1;$k<$iCnt;++
$k) {
334 $chars = count_chars($thread_new[$i][$k], 1);
335 if (isset($chars['40'])) { /* testing for ( */
336 $level +
= $chars['40'];
338 if (isset($chars['41'])) { /* testing for ) */
339 $level -= $chars['41'];
341 /* if we were faking lets stop, this portion
342 * of the thread is over
344 if ($level == $cutoff) {
348 if (isset($chars['32'])) { /* testing for space */
349 if (!isset($spaces[$level])) {
352 $spaces[$level] +
= $chars['32'];
354 for ($x=0;$x<=$level;$x++
) {
355 if (isset($spaces[$x])) {
356 $spaces_total +
= $spaces[$x];
359 $indent = $level +
$spaces_total;
360 /* must have run into a message that broke the thread
361 * so we are adjusting for that portion
364 $indent = $indent +
1;
366 if (preg_match("/(\d+)/", $thread_new[$i][$k], $regs)) {
369 /* the thread must be broken if $indent == 0
370 * so indent the message once and start faking it
377 /* dont need abs but if indent was negative
380 $indent_array[$child] = ($indent < 0) ?
0 : $indent;
384 return $indent_array;
389 * Returns an array with each element as a string representing one
390 * message-thread as returned by the IMAP server.
391 * @link http://www.ietf.org/internet-drafts/draft-ietf-imapext-sort-13.txt
393 function get_thread_sort($imap_stream, $search='ALL') {
394 global $thread_new, $sort_by_ref, $default_charset, $server_sort_array, $indent_array;
396 $thread_temp = array ();
397 if ($sort_by_ref == 1) {
398 $sort_type = 'REFERENCES';
400 $sort_type = 'ORDEREDSUBJECT';
402 $query = "THREAD $sort_type ".strtoupper($default_charset)." $search";
404 $thread_test = sqimap_run_command ($imap_stream, $query, false, $response, $message, TRUE);
405 /* fallback to default charset */
406 if ($response == 'NO' && strpos($message,'[BADCHARSET]') !== false) {
407 $query = "THREAD $sort_type US-ASCII $search";
408 $thread_test = sqimap_run_command ($imap_stream, $query, true, $response, $message, TRUE);
410 if (isset($thread_test[0])) {
411 for ($i=0,$iCnt=count($thread_test);$i<$iCnt;++
$i) {
412 if (preg_match("/^\* THREAD (.+)$/", $thread_test[$i], $regs)) {
413 $thread_list = trim($regs[1]);
420 if (!preg_match("/OK/", $response)) {
421 $server_sort_array = 'no';
422 return $server_sort_array;
424 if (isset($thread_list)) {
425 $thread_temp = preg_split("//", $thread_list, -1, PREG_SPLIT_NO_EMPTY
);
429 $thread_new = array();
433 * parse the thread response into separate threads
438 * [2] => (1599 759 959 37)
440 * [4] => ((933)(1891))
441 * [5] => (1030 (1497)(845)(1637))
443 for ($i=0,$iCnt=count($thread_temp);$i<$iCnt;$i++
) {
444 if ($thread_temp[$i] != ')' && $thread_temp[$i] != '(') {
445 $thread_new[$k] = $thread_new[$k] . $thread_temp[$i];
446 } elseif ($thread_temp[$i] == '(') {
447 $thread_new[$k] .= $thread_temp[$i];
449 } elseif ($thread_temp[$i] == ')') {
451 $thread_new[$k] .= $thread_temp[$i];
452 $counter = $counter - 1;
454 $thread_new[$k] .= $thread_temp[$i];
456 $thread_new[$k] = "";
457 $counter = $counter - 1;
462 $thread_new = array_reverse($thread_new);
463 /* place the threads after each other in one string */
464 $thread_list = implode(" ", $thread_new);
465 $thread_list = str_replace("(", " ", $thread_list);
466 $thread_list = str_replace(")", " ", $thread_list);
467 $thread_list = preg_split("/\s/", $thread_list, -1, PREG_SPLIT_NO_EMPTY
);
468 $server_sort_array = $thread_list;
470 $indent_array = get_parent_level ($thread_new);
471 return array($thread_list,$indent_array);
475 function elapsedTime($start) {
476 $stop = gettimeofday();
477 $timepassed = 1000000 * ($stop['sec'] - $start['sec']) +
$stop['usec'] - $start['usec'];
483 * Parses a string in an imap response. String starts with " or { which means it
484 * can handle double quoted strings and literal strings
486 * @param string $read imap response
487 * @param integer $i (reference) offset in string
488 * @return string $s parsed string without the double quotes or literal count
490 function parseString($read,&$i) {
496 $iPos = strpos($read,'"',$iPos);
498 if ($iPos && $read{$iPos -1} != '\\') {
499 $s = substr($read,$i,($iPos-$i));
504 if ($iPos > strlen($read)) {
508 } else if ($char == '{') {
511 $iPos = strpos($read,'}',$i);
513 $lit_cnt = substr($read, $i, $iPos - $i);
514 $i +
= strlen($lit_cnt) +
3; /* skip } + \r + \n */
515 /* Now read the literal */
516 $s = ($lit_cnt ?
substr($read,$i,$lit_cnt): '');
518 /* temp bugfix (SM 1.5 will have a working clean version)
519 too much work to implement that version right now */
521 } else { /* should never happen */
522 $i +
= 3; /* } + \r + \n */
534 * Parses a string containing an array from an imap response. String starts with ( and end with )
536 * @param string $read imap response
537 * @param integer $i (reference) offset in string
540 function parseArray($read,&$i) {
541 $i = strpos($read,'(',$i);
542 $i_pos = strpos($read,')',$i);
543 $s = substr($read,$i+
1,$i_pos - $i -1);
544 $a = explode(' ',$s);
555 * Retrieves a list with headers, flags, size or internaldate from the imap server
556 * @param resource $imap_stream imap connection
557 * @param array $msg_list array with id's to create a msgs set from
558 * @param array $aHeaderFields requested header fields
559 * @param array $aFetchItems requested other fetch items like FLAGS, RFC822.SIZE
560 * @return array $aMessages associative array with messages. Key is the UID, value is an associative array
562 function sqimap_get_small_header_list($imap_stream, $msg_list,
563 $aHeaderFields = array('Date', 'To', 'Cc', 'From', 'Subject', 'X-Priority', 'Content-Type'),
564 $aFetchItems = array('FLAGS', 'RFC822.SIZE', 'INTERNALDATE')) {
566 $aMessageList = array();
568 $bUidFetch = ! in_array('UID', $aFetchItems, true);
570 /* Get the small headers for each message in $msg_list */
571 if ($msg_list !== NULL) {
572 $msgs_str = sqimap_message_list_squisher($msg_list);
574 * We need to return the data in the same order as the caller supplied
575 * in $msg_list, but IMAP servers are free to return responses in
576 * whatever order they wish... So we need to re-sort manually
579 for ($i = 0; $i < sizeof($msg_list); $i++
) {
580 $aMessageList["$msg_list[$i]"] = array();
592 $query = "FETCH $msgs_str (";
593 if (count($aFetchItems)) {
594 $sFetchItems = implode(' ',$aFetchItems);
596 if (count($aHeaderFields)) {
597 $sHeaderFields = implode(' ',$aHeaderFields);
598 $sFetchItems .= ' BODY.PEEK[HEADER.FIELDS ('.$sHeaderFields.')]';
600 $query .= trim($sFetchItems) . ')';
601 $aResponse = sqimap_run_command_list ($imap_stream, $query, true, $response, $message, $bUidFetch);
602 $aMessages = parseFetch($aResponse,$aMessageList);
603 array_reverse($aMessages);
609 * Parses a fetch response, currently it can hande FLAGS, HEADERS, RFC822.SIZE, INTERNALDATE and UID
610 * @param array $aResponse Imap response
611 * @param array $aMessageList Placeholder array for results. The keys of the
612 * placeholder array should be the UID so we can reconstruct the order.
613 * @return array $aMessageList associative array with messages. Key is the UID, value is an associative array
614 * @author Marc Groot Koerkamp
616 function parseFetch($aResponse,$aMessageList = array()) {
617 foreach ($aResponse as $r) {
619 // use unset because we do isset below
620 $read = implode('',$r);
623 * #id<space>FETCH<space>(
626 /* extract the message id */
627 $i_space = strpos($read,' ',2);
628 $id = substr($read,2,$i_space-2);
630 $fetch = substr($read,$i_space+
1,5);
631 if (!is_numeric($id) && $fetch !== 'FETCH') {
632 $msg['ERROR'] = $read; // htmlspecialchars should be done just before display. this is backend code
635 $i = strpos($read,'(',$i_space+
5);
636 $read = substr($read,$i+
1);
637 $i_len = strlen($read);
639 while ($i < $i_len && $i !== false) {
641 $read = trim(substr($read,$i));
642 $i_len = strlen($read);
643 $i = strpos($read,' ');
644 $arg = substr($read,0,$i);
649 $i_pos = strpos($read,' ',$i);
651 $i_pos = strpos($read,')',$i);
654 $unique_id = substr($read,$i,$i_pos-$i);
661 $flags = parseArray($read,$i);
662 if (!$flags) break 3;
664 foreach ($flags as $flag) {
665 $flag = strtolower($flag);
666 $aFlags[$flag] = true;
668 $msg['FLAGS'] = $aFlags;
671 $i_pos = strpos($read,' ',$i);
673 $i_pos = strpos($read,')',$i);
676 $msg['SIZE'] = substr($read,$i,$i_pos-$i);
684 break; // to be implemented, moving imap code out of the nessages class
685 sqimap_parse_address($read,$i,$msg);
686 break; // to be implemented, moving imap code out of the nessages class
687 case 'BODYSTRUCTURE':
690 $msg['INTERNALDATE'] = str_replace(' ', ' ',parseString($read,$i));
692 case 'BODY.PEEK[HEADER.FIELDS':
693 case 'BODY[HEADER.FIELDS':
694 $i = strpos($read,'{',$i);
695 $header = parseString($read,$i);
696 if ($header === false) break 2;
697 /* First we replace all \r\n by \n, and unfold the header */
698 $hdr = trim(str_replace(array("\r\n", "\n\t", "\n "),array("\n", ' ', ' '), $header));
699 /* Now we can make a new header array with */
700 /* each element representing a headerline */
701 $hdr = explode("\n" , $hdr);
702 $aReceived = array();
703 foreach ($hdr as $line) {
704 $pos = strpos($line, ':');
706 $field = strtolower(substr($line, 0, $pos));
707 if (!strstr($field,' ')) { /* valid field */
708 $value = trim(substr($line, $pos+
1));
711 case 'to': $msg['TO'] = $value; break;
712 case 'cc': $msg['CC'] = $value; break;
713 case 'from': $msg['FROM'] = $value; break;
715 $msg['DATE'] = str_replace(' ', ' ', $value);
717 case 'x-priority': $msg['PRIORITY'] = $value; break;
718 case 'subject': $msg['SUBJECT'] = $value; break;
721 if ($pos = strpos($type, ";")) {
722 $type = substr($type, 0, $pos);
724 $type = explode("/", $type);
725 if(!is_array($type) ||
count($type) < 2) {
726 $msg['TYPE0'] = 'text';
727 $msg['TYPE1'] = 'plain';
729 $msg['TYPE0'] = strtolower($type[0]);
730 $msg['TYPE1'] = strtolower($type[1]);
734 $aReceived[] = $value;
741 if (count($aReceived)) {
742 $msg['RECEIVED'] = $aReceived;
751 $msg['UID'] = $unique_id;
753 $aMessageList[$msgi] = $msg;
756 return $aMessageList;
763 * @author Marc Groot Koerkamp
765 function sqimap_parse_envelope($read, &$i, &$msg) {
769 for ($cnt = strlen($read); ($i < $cnt) && ($read{$i} != ')'); ++
$i) {
770 $char = strtoupper($read{$i});
774 $arg_a[] = parseString($read,$i);
778 /* probably NIL argument */
779 if (strtoupper(substr($read, $i, 3)) == 'NIL') {
786 /* Address structure (with group support)
787 * Note: Group support is useless on SMTP connections
788 * because the protocol doesn't support it
793 for (; $i < $cnt && $read{$i} != ')'; ++
$i) {
794 if ($read{$i} == '(') {
795 $addr = sqimap_parse_address($read, $i);
796 if (($addr[3] == '') && ($addr[2] != '')) {
801 } else if ($group && ($addr[3] == '') && ($addr[2] == '')) {
803 if ($a == ($j+
1)) { /* no group members */
804 $group_addr[4] = $group;
806 $group_addr[0] = "$group: Undisclosed recipients;";
807 $addr_a[] = $group_addr;
823 if (count($arg_a) > 9) {
824 $d = strtr($arg_a[0], array(' ' => ' '));
825 $d = explode(' ', $d);
826 if (!$arg_a[1]) $arg_a[1] = '';
827 $msg['DATE'] = $d; /* argument 1: date */
828 $msg['SUBJECT'] = $arg_a[1]; /* argument 2: subject */
829 $msg['FROM'] = is_array($arg_a[2]) ?
$arg_a[2][0] : ''; /* argument 3: from */
830 $msg['SENDER'] = is_array($arg_a[3]) ?
$arg_a[3][0] : ''; /* argument 4: sender */
831 $msg['REPLY-TO'] = is_array($arg_a[4]) ?
$arg_a[4][0] : ''; /* argument 5: reply-to */
832 $msg['TO'] = $arg_a[5]; /* argument 6: to */
833 $msg['CC'] = $arg_a[6]; /* argument 7: cc */
834 $msg['BCC'] = $arg_a[7]; /* argument 8: bcc */
835 $msg['IN-REPLY-TO'] = $arg_a[8]; /* argument 9: in-reply-to */
836 $msg['MESSAGE-ID'] = $arg_a[9]; /* argument 10: message-id */
844 * @author Marc Groot Koerkamp
846 function sqimap_parse_address($read, &$i) {
848 for (; $read{$i} != ')'; ++
$i) {
849 $char = strtoupper($read{$i});
852 case '"': $arg_a[] = parseString($read,$i); break;
855 if (strtoupper(substr($read, $i, 3)) == 'NIL') {
864 if (count($arg_a) == 4) {
867 // $adr = new AddressStructure();
868 // $adr->personal = $arg_a[0];
869 // $adr->adl = $arg_a[1];
870 // $adr->mailbox = $arg_a[2];
871 // $adr->host = $arg_a[3];
880 * Returns a message array with all the information about a message.
881 * See the documentation folder for more information about this array.
883 * @param resource $imap_stream imap connection
884 * @param integer $id uid of the message
885 * @param string $mailbox used for error handling, can be removed because we should return an error code and generate the message elsewhere
886 * @return Message Message object
888 function sqimap_get_message($imap_stream, $id, $mailbox) {
889 // typecast to int to prohibit 1:* msgs sets
892 $read = sqimap_run_command($imap_stream, "FETCH $id (FLAGS BODYSTRUCTURE)", true, $response, $message, TRUE);
894 if (preg_match('/.+FLAGS\s\((.*)\)\s/AUi',$read[0],$regs)) {
895 if (trim($regs[1])) {
896 $flags = preg_split('/ /', $regs[1],-1,'PREG_SPLIT_NI_EMPTY');
900 /* the message was not found, maybe the mailbox was modified? */
901 global $sort, $startMessage, $color;
903 $errmessage = _("The server couldn't find the message you requested.") .
904 '<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).");
905 /* this will include a link back to the message list */
906 error_message($errmessage, $mailbox, $sort, (int) $startMessage, $color);
909 $bodystructure = implode('',$read);
910 $msg = mime_structure($bodystructure,$flags);
911 $read = sqimap_run_command($imap_stream, "FETCH $id BODY[HEADER]", true, $response, $message, TRUE);
912 $rfc822_header = new Rfc822Header();
913 $rfc822_header->parseHeader($read);
914 $msg->rfc822_header
= $rfc822_header;
920 * Deprecated !!!!!!! DO NOT USE THIS, use sqimap_msgs_list_copy instead
922 function sqimap_messages_copy($imap_stream, $start, $end, $mailbox) {
923 $read = sqimap_run_command ($imap_stream, "COPY $start:$end " . sqimap_encode_mailbox_name($mailbox), true, $response, $message, TRUE);
928 * Deprecated !!!!!!! DO NOT USE THIS, use sqimap_msgs_list_delete instead
930 function sqimap_messages_delete($imap_stream, $start, $end, $mailbox, $bypass_trash=false) {
931 global $move_to_trash, $trash_folder;
933 if (($move_to_trash == true) && ($bypass_trash != true) &&
934 (sqimap_mailbox_exists($imap_stream, $trash_folder) && ($mailbox != $trash_folder))) {
935 sqimap_messages_copy ($imap_stream, $start, $end, $trash_folder);
937 sqimap_messages_flag ($imap_stream, $start, $end, "Deleted", true);
942 * Deprecated !!!!!!! DO NOT USE THIS, use sqimap_toggle_flag instead
943 * Set a flag on the provided uid list
944 * @param resource imap connection
946 function sqimap_messages_flag($imap_stream, $start, $end, $flag, $handle_errors) {
947 $read = sqimap_run_command ($imap_stream, "STORE $start:$end +FLAGS (\\$flag)", $handle_errors, $response, $message, TRUE);
954 function sqimap_get_small_header($imap_stream, $id, $sent) {
955 $res = sqimap_get_small_header_list($imap_stream, $id, $sent);