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 $sort_test = array();
143 $sSortField = 'REVERSE '.$sSortField;
145 $query = "SORT ($sSortField) ".strtoupper($default_charset)." $search";
146 // FIX ME sqimap_run_command should return the parsed data accessible by $aDATA['SORT']
147 $aData = sqimap_run_command ($imap_stream, $query, false, $response, $message, TRUE);
148 /* fallback to default charset */
149 if ($response == 'NO' && strpos($message,'[BADCHARSET]') !== false) {
150 $query = "SORT ($sSortField) US-ASCII $search";
151 $aData = sqimap_run_command ($imap_stream, $query, true, $response, $message, TRUE);
155 if ($response == 'OK') {
156 return parseUidList($aData,'SORT');
164 * Parses a UID list returned on a SORT or SEARCH request
165 * @param array $aData imap response
166 * @param string $sCommand issued imap command (SEARCH or SORT)
167 * @return array $aUid uid list
169 function parseUidList($aData,$sCommand) {
171 if (isset($aData) && count($aData)) {
172 for ($i=0,$iCnt=count($aData);$i<$iCnt;++
$i) {
173 if (preg_match("/^\* $sCommand (.+)$/", $aData[$i], $aMatch)) {
174 $aUid +
= preg_split("/ /", trim($aMatch[1]));
178 return array_unique($aUid);
182 * Retrieves an array with a sorted uid list. Sorting is done by SquirrelMail
184 * @param resource $imap_stream IMAP socket connection
185 * @param string $sSortField Field to sort on
186 * @param bool $reverse Reverse order search
187 * @param array $aUid limit the search to the provided array with uid's default sqimap_get_small_headers uses 1:*
188 * @return array $aUid sorted uid list
190 function get_squirrel_sort($imap_stream, $sSortField, $reverse = false, $aUid = NULL) {
191 if ($sSortField != 'RFC822.SIZE' && $sSortField != 'INTERNALDATE') {
192 $msgs = sqimap_get_small_header_list($imap_stream, $aUid,
193 array($sSortField), array());
195 $msgs = sqimap_get_small_header_list($imap_stream, $aUid,
196 array(), array($sSortField));
200 switch ($sSortField) {
201 // natcasesort section
206 array_walk($msgs, create_function('&$v,&$k,$f',
207 '$v[$f] = (isset($v[$f])) ? $v[$f] : "";
208 $addr = reset(parseRFC822Address($v[$f],1));
209 $sPersonal = (isset($addr[SQM_ADDR_PERSONAL]) && $addr[SQM_ADDR_PERSONAL]) ?
210 $addr[SQM_ADDR_PERSONAL] : "";
211 $sEmail = ($addr[SQM_ADDR_HOST]) ?
212 $addr[SQM_ADDR_HOST] . "@".$addr[SQM_ADDR_HOST] :
213 $addr[SQM_ADDR_HOST];
214 $v[$f] = ($sPersonal) ? decodeHeader($sPersonal):$sEmail;'),$sSortField);
220 array_walk($msgs, create_function('&$v,&$k,$f',
221 '$v[$f] = (isset($v[$f])) ? $v[$f] : "";
222 $v[$f] = strtolower(decodeHeader(trim($v[$f])));
223 $v[$f] = (preg_match("/^(vedr|sv|re|aw|\[\w\]):\s*(.*)$/si", $v[$f], $matches)) ?
224 $matches[2] : $v[$f];'),$sSortField);
227 foreach ($msgs as $item) {
228 $aUid[$item['UID']] = $item[$sSortField];
231 $aUid = array_keys($aUid);
233 $aUid = array_reverse($aUid);
236 // \natcasesort section
237 // sort_numeric section
241 array_walk($msgs, create_function('&$v,$k,$f',
242 '$v[$f] = (isset($v[$f])) ? $v[$f] : "";
243 $v[$f] = getTimeStamp(explode(" ",$v[$f]));'),$sSortField);
249 // redefine $sSortField to maintain the same namespace between
250 // server-side sorting and squirrelmail sorting
251 $sSortField = 'SIZE';
253 foreach ($msgs as $item) {
254 $aUid[$item['UID']] = (isset($item[$sSortField])) ?
$item[$sSortField] : 0;
257 arsort($aUid,SORT_NUMERIC
);
259 asort($aUid, SORT_NUMERIC
);
261 $aUid = array_keys($aUid);
263 // \sort_numeric section
265 $aUid = array_reverse($msgs);
273 * Returns an indent array for printMessageinfo()
274 * This represents the amount of indent needed (value),
275 * for this message number (key)
279 * Notes for future work:
280 * indent_array should contain: indent_level, parent and flags,
282 * To achieve that we need to define the following flags:
287 * a node has sibling nodes if it's not the last node
288 * a node has no sibling nodes if it's the last node
289 * By using binary comparations we can store the flag in one var
292 * -1 par = 0, level = 0, flag = 1 + 2 + 4 = 7 (haschildren, isfirst, islast)
293 * \-2 par = 1, level = 1, flag = 0 + 2 = 2 (hasnochildren, isfirst)
294 * |-3 par = 1, level = 1, flag = 1 + 4 = 5 (haschildren, islast)
295 * \-4 par = 3, level = 2, flag = 1 + 2 + 4 = 7 (haschildren, isfirst, islast)
296 * \-5 par = 4, level = 3, flag = 0 + 2 + 4 = 6 (hasnochildren, isfirst, islast)
298 function get_parent_level($thread_new) {
304 * loop through the threads and take unwanted characters out
305 * of the thread string then chop it up
307 for ($i=0;$i<count($thread_new);$i++
) {
308 $thread_new[$i] = preg_replace("/\s\(/", "(", $thread_new[$i]);
309 $thread_new[$i] = preg_replace("/(\d+)/", "$1|", $thread_new[$i]);
310 $thread_new[$i] = preg_split("/\|/", $thread_new[$i], -1, PREG_SPLIT_NO_EMPTY
);
312 $indent_array = array();
314 $thread_new = array();
316 /* looping through the parts of one message thread */
318 for ($i=0;$i<count($thread_new);$i++
) {
319 /* first grab the parent, it does not indent */
321 if (isset($thread_new[$i][0])) {
322 if (preg_match("/(\d+)/", $thread_new[$i][0], $regs)) {
326 $indent_array[$parent] = 0;
329 * now the children, checking each thread portion for
330 * ),(, and space, adjusting the level and space values
331 * to get the indent level
338 for ($k=1,$iCnt=count($thread_new[$i])-1;$k<$iCnt;++
$k) {
339 $chars = count_chars($thread_new[$i][$k], 1);
340 if (isset($chars['40'])) { /* testing for ( */
341 $level +
= $chars['40'];
343 if (isset($chars['41'])) { /* testing for ) */
344 $level -= $chars['41'];
346 /* if we were faking lets stop, this portion
347 * of the thread is over
349 if ($level == $cutoff) {
353 if (isset($chars['32'])) { /* testing for space */
354 if (!isset($spaces[$level])) {
357 $spaces[$level] +
= $chars['32'];
359 for ($x=0;$x<=$level;$x++
) {
360 if (isset($spaces[$x])) {
361 $spaces_total +
= $spaces[$x];
364 $indent = $level +
$spaces_total;
365 /* must have run into a message that broke the thread
366 * so we are adjusting for that portion
369 $indent = $indent +
1;
371 if (preg_match("/(\d+)/", $thread_new[$i][$k], $regs)) {
374 /* the thread must be broken if $indent == 0
375 * so indent the message once and start faking it
382 /* dont need abs but if indent was negative
385 $indent_array[$child] = ($indent < 0) ?
0 : $indent;
389 return $indent_array;
394 * Returns an array with each element as a string representing one
395 * message-thread as returned by the IMAP server.
396 * @link http://www.ietf.org/internet-drafts/draft-ietf-imapext-sort-13.txt
398 function get_thread_sort($imap_stream, $search='ALL') {
399 global $thread_new, $sort_by_ref, $default_charset, $server_sort_array, $indent_array;
401 $thread_temp = array ();
402 if ($sort_by_ref == 1) {
403 $sort_type = 'REFERENCES';
405 $sort_type = 'ORDEREDSUBJECT';
407 $query = "THREAD $sort_type ".strtoupper($default_charset)." $search";
409 $thread_test = sqimap_run_command ($imap_stream, $query, false, $response, $message, TRUE);
410 /* fallback to default charset */
411 if ($response == 'NO' && strpos($message,'[BADCHARSET]') !== false) {
412 $query = "THREAD $sort_type US-ASCII $search";
413 $thread_test = sqimap_run_command ($imap_stream, $query, true, $response, $message, TRUE);
415 if (isset($thread_test[0])) {
416 for ($i=0,$iCnt=count($thread_test);$i<$iCnt;++
$i) {
417 if (preg_match("/^\* THREAD (.+)$/", $thread_test[$i], $regs)) {
418 $thread_list = trim($regs[1]);
425 if (!preg_match("/OK/", $response)) {
426 $server_sort_array = 'no';
427 return $server_sort_array;
429 if (isset($thread_list)) {
430 $thread_temp = preg_split("//", $thread_list, -1, PREG_SPLIT_NO_EMPTY
);
433 $char_count = count($thread_temp);
435 $thread_new = array();
439 * parse the thread response into separate threads
444 * [2] => (1599 759 959 37)
446 * [4] => ((933)(1891))
447 * [5] => (1030 (1497)(845)(1637))
449 for ($i=0,$iCnt=count($thread_temp);$i<$iCnt;$i++
) {
450 if ($thread_temp[$i] != ')' && $thread_temp[$i] != '(') {
451 $thread_new[$k] = $thread_new[$k] . $thread_temp[$i];
452 } elseif ($thread_temp[$i] == '(') {
453 $thread_new[$k] .= $thread_temp[$i];
455 } elseif ($thread_temp[$i] == ')') {
457 $thread_new[$k] .= $thread_temp[$i];
458 $counter = $counter - 1;
460 $thread_new[$k] .= $thread_temp[$i];
462 $thread_new[$k] = "";
463 $counter = $counter - 1;
468 $thread_new = array_reverse($thread_new);
469 /* place the threads after each other in one string */
470 $thread_list = implode(" ", $thread_new);
471 $thread_list = str_replace("(", " ", $thread_list);
472 $thread_list = str_replace(")", " ", $thread_list);
473 $thread_list = preg_split("/\s/", $thread_list, -1, PREG_SPLIT_NO_EMPTY
);
474 $server_sort_array = $thread_list;
476 $indent_array = get_parent_level ($thread_new);
477 return array($thread_list,$indent_array);
481 function elapsedTime($start) {
482 $stop = gettimeofday();
483 $timepassed = 1000000 * ($stop['sec'] - $start['sec']) +
$stop['usec'] - $start['usec'];
489 * Parses a string in an imap response. String starts with " or { which means it
490 * can handle double quoted strings and literal strings
492 * @param string $read imap response
493 * @param integer $i (reference) offset in string
494 * @return string $s parsed string without the double quotes or literal count
496 function parseString($read,&$i) {
502 $iPos = strpos($read,'"',$iPos);
504 if ($iPos && $read{$iPos -1} != '\\') {
505 $s = substr($read,$i,($iPos-$i));
510 if ($iPos > strlen($read)) {
514 } else if ($char == '{') {
517 $iPos = strpos($read,'}',$i);
519 $lit_cnt = substr($read, $i, $iPos - $i);
520 $i +
= strlen($lit_cnt) +
3; /* skip } + \r + \n */
521 /* Now read the literal */
522 $s = ($lit_cnt ?
substr($read,$i,$lit_cnt): '');
524 /* temp bugfix (SM 1.5 will have a working clean version)
525 too much work to implement that version right now */
527 } else { /* should never happen */
528 $i +
= 3; /* } + \r + \n */
540 * Parses a string containing an array from an imap response. String starts with ( and end with )
542 * @param string $read imap response
543 * @param integer $i (reference) offset in string
546 function parseArray($read,&$i) {
547 $i = strpos($read,'(',$i);
548 $i_pos = strpos($read,')',$i);
549 $s = substr($read,$i+
1,$i_pos - $i -1);
550 $a = explode(' ',$s);
561 * Retrieves a list with headers, flags, size or internaldate from the imap server
562 * @param resource $imap_stream imap connection
563 * @param array $msg_list array with id's to create a msgs set from
564 * @param array $aHeaderFields requested header fields
565 * @param array $aFetchItems requested other fetch items like FLAGS, RFC822.SIZE
566 * @return array $aMessages associative array with messages. Key is the UID, value is an associative array
568 function sqimap_get_small_header_list($imap_stream, $msg_list,
569 $aHeaderFields = array('Date', 'To', 'Cc', 'From', 'Subject', 'X-Priority', 'Content-Type'),
570 $aFetchItems = array('FLAGS', 'RFC822.SIZE', 'INTERNALDATE')) {
572 $aMessageList = array();
573 $read_list = array();
575 $bUidFetch = ! in_array('UID', $aFetchItems, true);
577 /* Get the small headers for each message in $msg_list */
578 if ($msg_list !== NULL) {
579 $msgs_str = sqimap_message_list_squisher($msg_list);
581 * We need to return the data in the same order as the caller supplied
582 * in $msg_list, but IMAP servers are free to return responses in
583 * whatever order they wish... So we need to re-sort manually
586 for ($i = 0; $i < sizeof($msg_list); $i++
) {
587 $aMessageList["$msg_list[$i]"] = array();
600 $query = "FETCH $msgs_str (";
601 if (count($aFetchItems)) {
602 $sFetchItems = implode(' ',$aFetchItems);
604 if (count($aHeaderFields)) {
605 $sHeaderFields = implode(' ',$aHeaderFields);
606 $sFetchItems .= ' BODY.PEEK[HEADER.FIELDS ('.$sHeaderFields.')]';
608 $query .= trim($sFetchItems) . ')';
609 $aResponse = sqimap_run_command_list ($imap_stream, $query, true, $response, $message, $bUidFetch);
610 $aMessages = parseFetch($aResponse,$aMessageList);
611 array_reverse($aMessages);
617 * Parses a fetch response, currently it can hande FLAGS, HEADERS, RFC822.SIZE, INTERNALDATE and UID
618 * @param array $aResponse Imap response
619 * @param array $aMessageList Placeholder array for results. The keys of the
620 * placeholder array should be the UID so we can reconstruct the order.
621 * @return array $aMessageList associative array with messages. Key is the UID, value is an associative array
622 * @author Marc Groot Koerkamp
624 function parseFetch($aResponse,$aMessageList = array()) {
625 foreach ($aResponse as $r) {
627 // use unset because we do isset below
628 $read = implode('',$r);
631 * #id<space>FETCH<space>(
634 /* extract the message id */
635 $i_space = strpos($read,' ',2);
636 $id = substr($read,2,$i_space-2);
638 $fetch = substr($read,$i_space+
1,5);
639 if (!is_numeric($id) && $fetch !== 'FETCH') {
640 $msg['ERROR'] = $read; // htmlspecialchars should be done just before display. this is backend code
643 $i = strpos($read,'(',$i_space+
5);
644 $read = substr($read,$i+
1);
645 $i_len = strlen($read);
647 while ($i < $i_len && $i !== false) {
649 $read = trim(substr($read,$i));
650 $i_len = strlen($read);
651 $i = strpos($read,' ');
652 $arg = substr($read,0,$i);
657 $i_pos = strpos($read,' ',$i);
659 $i_pos = strpos($read,')',$i);
662 $unique_id = substr($read,$i,$i_pos-$i);
669 $flags = parseArray($read,$i);
670 if (!$flags) break 3;
672 foreach ($flags as $flag) {
673 $flag = strtolower($flag);
674 $aFlags[$flag] = true;
676 $msg['FLAGS'] = $aFlags;
679 $i_pos = strpos($read,' ',$i);
681 $i_pos = strpos($read,')',$i);
684 $msg['SIZE'] = substr($read,$i,$i_pos-$i);
692 break; // to be implemented, moving imap code out of the nessages class
693 sqimap_parse_address($read,$i,$msg);
694 break; // to be implemented, moving imap code out of the nessages class
695 case 'BODYSTRUCTURE':
698 $msg['INTERNALDATE'] = str_replace(' ', ' ',parseString($read,$i));
700 case 'BODY.PEEK[HEADER.FIELDS':
701 case 'BODY[HEADER.FIELDS':
702 $i = strpos($read,'{',$i);
703 $header = parseString($read,$i);
704 if ($header === false) break 2;
705 /* First we replace all \r\n by \n, and unfold the header */
706 $hdr = trim(str_replace(array("\r\n", "\n\t", "\n "),array("\n", ' ', ' '), $header));
707 /* Now we can make a new header array with */
708 /* each element representing a headerline */
709 $hdr = explode("\n" , $hdr);
710 $aReceived = array();
711 foreach ($hdr as $line) {
712 $pos = strpos($line, ':');
714 $field = strtolower(substr($line, 0, $pos));
715 if (!strstr($field,' ')) { /* valid field */
716 $value = trim(substr($line, $pos+
1));
719 case 'to': $msg['TO'] = $value; break;
720 case 'cc': $msg['CC'] = $value; break;
721 case 'from': $msg['FROM'] = $value; break;
723 $msg['DATE'] = str_replace(' ', ' ', $value);
725 case 'x-priority': $msg['PRIORITY'] = $value; break;
726 case 'subject': $msg['SUBJECT'] = $value; break;
729 if ($pos = strpos($type, ";")) {
730 $type = substr($type, 0, $pos);
732 $type = explode("/", $type);
733 if(!is_array($type) ||
count($type) < 2) {
734 $msg['TYPE0'] = 'text';
735 $msg['TYPE1'] = 'plain';
737 $msg['TYPE0'] = strtolower($type[0]);
738 $msg['TYPE1'] = strtolower($type[1]);
742 $aReceived[] = $value;
749 if (count($aReceived)) {
750 $msg['RECEIVED'] = $aReceived;
759 $msg['UID'] = $unique_id;
761 $aMessageList[$msgi] = $msg;
764 return $aMessageList;
771 * @author Marc Groot Koerkamp
773 function sqimap_parse_envelope($read, &$i, &$msg) {
777 for ($cnt = strlen($read); ($i < $cnt) && ($read{$i} != ')'); ++
$i) {
778 $char = strtoupper($read{$i});
782 $arg_a[] = parseString($read,$i);
786 /* probably NIL argument */
787 if (strtoupper(substr($read, $i, 3)) == 'NIL') {
794 /* Address structure (with group support)
795 * Note: Group support is useless on SMTP connections
796 * because the protocol doesn't support it
801 for (; $i < $cnt && $read{$i} != ')'; ++
$i) {
802 if ($read{$i} == '(') {
803 $addr = sqimap_parse_address($read, $i);
804 if (($addr[3] == '') && ($addr[2] != '')) {
809 } else if ($group && ($addr[3] == '') && ($addr[2] == '')) {
811 if ($a == ($j+
1)) { /* no group members */
812 $group_addr[4] = $group;
814 $group_addr[0] = "$group: Undisclosed recipients;";
815 $addr_a[] = $group_addr;
831 if (count($arg_a) > 9) {
832 $d = strtr($arg_a[0], array(' ' => ' '));
833 $d = explode(' ', $d);
834 if (!$arg_a[1]) $arg_a[1] = '';
835 $msg['DATE'] = $d; /* argument 1: date */
836 $msg['SUBJECT'] = $arg_a[1]; /* argument 2: subject */
837 $msg['FROM'] = is_array($arg_a[2]) ?
$arg_a[2][0] : ''; /* argument 3: from */
838 $msg['SENDER'] = is_array($arg_a[3]) ?
$arg_a[3][0] : ''; /* argument 4: sender */
839 $msg['REPLY-TO'] = is_array($arg_a[4]) ?
$arg_a[4][0] : ''; /* argument 5: reply-to */
840 $msg['TO'] = $arg_a[5]; /* argument 6: to */
841 $msg['CC'] = $arg_a[6]; /* argument 7: cc */
842 $msg['BCC'] = $arg_a[7]; /* argument 8: bcc */
843 $msg['IN-REPLY-TO'] = $arg_a[8]; /* argument 9: in-reply-to */
844 $msg['MESSAGE-ID'] = $arg_a[9]; /* argument 10: message-id */
852 * @author Marc Groot Koerkamp
854 function sqimap_parse_address($read, &$i) {
856 for (; $read{$i} != ')'; ++
$i) {
857 $char = strtoupper($read{$i});
860 case '"': $arg_a[] = parseString($read,$i); break;
863 if (strtoupper(substr($read, $i, 3)) == 'NIL') {
872 if (count($arg_a) == 4) {
875 // $adr = new AddressStructure();
876 // $adr->personal = $arg_a[0];
877 // $adr->adl = $arg_a[1];
878 // $adr->mailbox = $arg_a[2];
879 // $adr->host = $arg_a[3];
888 * Returns a message array with all the information about a message.
889 * See the documentation folder for more information about this array.
891 * @param resource $imap_stream imap connection
892 * @param integer $id uid of the message
893 * @param string $mailbox used for error handling, can be removed because we should return an error code and generate the message elsewhere
894 * @return Message Message object
896 function sqimap_get_message($imap_stream, $id, $mailbox) {
897 // typecast to int to prohibit 1:* msgs sets
900 $read = sqimap_run_command($imap_stream, "FETCH $id (FLAGS BODYSTRUCTURE)", true, $response, $message, TRUE);
902 if (preg_match('/.+FLAGS\s\((.*)\)\s/AUi',$read[0],$regs)) {
903 if (trim($regs[1])) {
904 $flags = preg_split('/ /', $regs[1],-1,'PREG_SPLIT_NI_EMPTY');
908 /* the message was not found, maybe the mailbox was modified? */
909 global $sort, $startMessage, $color;
911 $errmessage = _("The server couldn't find the message you requested.") .
912 '<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).");
913 /* this will include a link back to the message list */
914 error_message($errmessage, $mailbox, $sort, (int) $startMessage, $color);
917 $bodystructure = implode('',$read);
918 $msg = mime_structure($bodystructure,$flags);
919 $read = sqimap_run_command($imap_stream, "FETCH $id BODY[HEADER]", true, $response, $message, TRUE);
920 $rfc822_header = new Rfc822Header();
921 $rfc822_header->parseHeader($read);
922 $msg->rfc822_header
= $rfc822_header;
928 * Deprecated !!!!!!! DO NOT USE THIS, use sqimap_msgs_list_copy instead
930 function sqimap_messages_copy($imap_stream, $start, $end, $mailbox) {
931 $read = sqimap_run_command ($imap_stream, "COPY $start:$end " . sqimap_encode_mailbox_name($mailbox), true, $response, $message, TRUE);
936 * Deprecated !!!!!!! DO NOT USE THIS, use sqimap_msgs_list_delete instead
938 function sqimap_messages_delete($imap_stream, $start, $end, $mailbox, $bypass_trash=false) {
939 global $move_to_trash, $trash_folder, $auto_expunge;
941 if (($move_to_trash == true) && ($bypass_trash != true) &&
942 (sqimap_mailbox_exists($imap_stream, $trash_folder) && ($mailbox != $trash_folder))) {
943 sqimap_messages_copy ($imap_stream, $start, $end, $trash_folder);
945 sqimap_messages_flag ($imap_stream, $start, $end, "Deleted", true);
950 * Deprecated !!!!!!! DO NOT USE THIS, use sqimap_toggle_flag instead
951 * Set a flag on the provided uid list
952 * @param resource imap connection
954 function sqimap_messages_flag($imap_stream, $start, $end, $flag, $handle_errors) {
955 $read = sqimap_run_command ($imap_stream, "STORE $start:$end +FLAGS (\\$flag)", $handle_errors, $response, $message, TRUE);
962 function sqimap_get_small_header($imap_stream, $id, $sent) {
963 $res = sqimap_get_small_header_list($imap_stream, $id, $sent);