c10439c834a59643f59bc13a1d7006f4a663a03e
[squirrelmail.git] / functions / imap_messages.php
1 <?php
2
3 /**
4 * imap_messages.php
5 *
6 * This implements functions that manipulate messages
7 * NOTE: Quite a few functions in this file are obsolete
8 *
9 * @copyright &copy; 1999-2007 The SquirrelMail Project Team
10 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
11 * @version $Id$
12 * @package squirrelmail
13 * @subpackage imap
14 */
15
16
17 /**
18 * Copy a set of messages ($id) to another mailbox ($mailbox)
19 * @param int $imap_stream The resource ID for the IMAP socket
20 * @param string $id The list of messages to copy
21 * @param string $mailbox The destination to copy to
22 * @param bool $handle_errors Show error messages in case of a NO, BAD or BYE response
23 * @return bool If the copy completed without errors
24 */
25 function sqimap_msgs_list_copy($imap_stream, $id, $mailbox, $handle_errors = true) {
26 $msgs_id = sqimap_message_list_squisher($id);
27 $read = sqimap_run_command ($imap_stream, "COPY $msgs_id " . sqimap_encode_mailbox_name($mailbox), $handle_errors, $response, $message, TRUE);
28 if ($response == 'OK') {
29 return true;
30 } else {
31 return false;
32 }
33 }
34
35
36 /**
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
41 * @param bool $handle_errors Show error messages in case of a NO, BAD or BYE response
42 * @param string $source_mailbox (since 1.5.1) name of source mailbox. It is used to
43 * validate that target mailbox != source mailbox.
44 * @return bool If the move completed without errors
45 */
46 function sqimap_msgs_list_move($imap_stream, $id, $mailbox, $handle_errors = true, $source_mailbox = false) {
47 if ($source_mailbox!==false && $source_mailbox==$mailbox) {
48 return false;
49 }
50 $msgs_id = sqimap_message_list_squisher($id);
51 if (sqimap_msgs_list_copy ($imap_stream, $id, $mailbox, $handle_errors)) {
52 return sqimap_toggle_flag($imap_stream, $id, '\\Deleted', true, true);
53 } else {
54 return false;
55 }
56 }
57
58
59 /**
60 * Deletes a message and move it to trash or expunge the mailbox
61 * @param resource imap connection
62 * @param string $mailbox mailbox, used for checking if it concerns the trash_folder
63 * @param array $id list with uid's
64 * @param bool $bypass_trash (since 1.5.0) skip copy to trash
65 * @return array $aMessageList array with messages containing the new flags and UID @see parseFetch
66 * @since 1.4.0
67 */
68 function sqimap_msgs_list_delete($imap_stream, $mailbox, $id, $bypass_trash=false) {
69 // FIX ME, remove globals by introducing an associative array with properties
70 // as 4th argument as replacement for the bypass_trash var
71 global $move_to_trash, $trash_folder;
72 if (($move_to_trash == true) && ($bypass_trash != true) &&
73 (sqimap_mailbox_exists($imap_stream, $trash_folder) && ($mailbox != $trash_folder)) ) {
74 /**
75 * turn off internal error handling (fourth argument = false) and
76 * ignore copy to trash errors (allows to delete messages when overquota)
77 */
78 sqimap_msgs_list_copy ($imap_stream, $id, $trash_folder, false);
79 }
80 return sqimap_toggle_flag($imap_stream, $id, '\\Deleted', true, true);
81 }
82
83
84 /**
85 * Set a flag on the provided uid list
86 * @param resource imap connection
87 * @param array $id list with uid's
88 * @param string $flag Flags to set/unset flags can be i.e.'\Seen', '\Answered', '\Seen \Answered'
89 * @param bool $set add (true) or remove (false) the provided flag
90 * @param bool $handle_errors Show error messages in case of a NO, BAD or BYE response
91 * @return array $aMessageList array with messages containing the new flags and UID @see parseFetch
92 */
93 function sqimap_toggle_flag($imap_stream, $id, $flag, $set, $handle_errors) {
94 $msgs_id = sqimap_message_list_squisher($id);
95 $set_string = ($set ? '+' : '-');
96
97 for ($i=0; $i<sizeof($id); $i++) {
98 $aMessageList["$id[$i]"] = array();
99 }
100
101 $aResponse = sqimap_run_command_list($imap_stream, "STORE $msgs_id ".$set_string."FLAGS ($flag)", $handle_errors, $response, $message, TRUE);
102
103 // parse the fetch response
104 $parseFetchResults=parseFetch($aResponse,$aMessageList);
105
106 // some broken IMAP servers do not return UID elements on UID STORE
107 // if this is the case, then we need to do a UID FETCH
108 $testkey=$id[0];
109 if (!isset($parseFetchResults[$testkey]['UID'])) {
110 $aResponse = sqimap_run_command_list($imap_stream, "FETCH $msgs_id (FLAGS)", $handle_errors, $response, $message, TRUE);
111 $parseFetchResults = parseFetch($aResponse,$aMessageList);
112 }
113
114 return ($parseFetchResults);
115 }
116
117
118 /**
119 * Sort the message list and crunch to be as small as possible
120 * (overflow could happen, so make it small if possible)
121 * @param array $aUid array with uid's
122 * @return string $s message set string
123 */
124 function sqimap_message_list_squisher($aUid) {
125 if( !is_array( $aUid ) ) {
126 return $aUid;
127 }
128 sort($aUid, SORT_NUMERIC);
129
130 if (count($aUid)) {
131 $s = '';
132 for ($i=0,$iCnt=count($aUid);$i<$iCnt;++$i) {
133 $iStart = $aUid[$i];
134 $iEnd = $iStart;
135 while ($i<($iCnt-1) && $aUid[$i+1] == $iEnd +1) {
136 $iEnd = $aUid[$i+1];
137 ++$i;
138 }
139 if ($s) {
140 $s .= ',';
141 }
142 $s .= $iStart;
143 if ($iStart != $iEnd) {
144 $s .= ':' . $iEnd;
145 }
146 }
147 }
148 return $s;
149 }
150
151
152 /**
153 * Retrieves an array with a sorted uid list. Sorting is done on the imap server
154 * @link http://www.ietf.org/internet-drafts/draft-ietf-imapext-sort-17.txt
155 * @param resource $imap_stream IMAP socket connection
156 * @param string $sSortField Field to sort on
157 * @param bool $reverse Reverse order search
158 * @return array $id sorted uid list
159 */
160 function sqimap_get_sort_order($imap_stream, $sSortField, $reverse, $search='ALL') {
161 global $default_charset;
162
163 if ($sSortField) {
164 if ($reverse) {
165 $sSortField = 'REVERSE '.$sSortField;
166 }
167 $query = "SORT ($sSortField) ".strtoupper($default_charset)." $search";
168 // FIX ME sqimap_run_command should return the parsed data accessible by $aDATA['SORT']
169 // use sqimap_run_command_list in case of unsollicited responses. If we don't we could loose the SORT response
170 $aData = sqimap_run_command_list ($imap_stream, $query, false, $response, $message, TRUE);
171 /* fallback to default charset */
172 if ($response == 'NO') {
173 if (strpos($message,'BADCHARSET') !== false ||
174 strpos($message,'character') !== false) {
175 sqm_trigger_imap_error('SQM_IMAP_BADCHARSET',$query, $response, $message);
176 $query = "SORT ($sSortField) US-ASCII $search";
177 $aData = sqimap_run_command_list ($imap_stream, $query, true, $response, $message, TRUE);
178 } else {
179 sqm_trigger_imap_error('SQM_IMAP_ERROR',$query, $response, $message);
180 }
181 } else if ($response == 'BAD') {
182 sqm_trigger_imap_error('SQM_IMAP_NO_SORT',$query, $response, $message);
183 }
184 }
185
186 if ($response == 'OK') {
187 return parseUidList($aData,'SORT');
188 } else {
189 return false;
190 }
191 }
192
193
194 /**
195 * Parses a UID list returned on a SORT or SEARCH request
196 * @param array $aData imap response (retrieved from sqimap_run_command_list)
197 * @param string $sCommand issued imap command (SEARCH or SORT)
198 * @return array $aUid uid list
199 */
200 function parseUidList($aData,$sCommand) {
201 $aUid = array();
202 if (isset($aData) && count($aData)) {
203 for ($i=0,$iCnt=count($aData);$i<$iCnt;++$i) {
204 for ($j=0,$jCnt=count($aData[$i]);$j<$jCnt;++$j) {
205 if (preg_match("/^\* $sCommand (.+)$/", $aData[$i][$j], $aMatch)) {
206 $aUid += explode(' ', trim($aMatch[1]));
207 }
208 }
209 }
210 }
211 return array_unique($aUid);
212 }
213
214 /**
215 * Retrieves an array with a sorted uid list. Sorting is done by SquirrelMail
216 *
217 * @param resource $imap_stream IMAP socket connection
218 * @param string $sSortField Field to sort on
219 * @param bool $reverse Reverse order search
220 * @param array $aUid limit the search to the provided array with uid's default sqimap_get_small_headers uses 1:*
221 * @return array $aUid sorted uid list
222 */
223 function get_squirrel_sort($imap_stream, $sSortField, $reverse = false, $aUid = NULL) {
224 if ($sSortField != 'RFC822.SIZE' && $sSortField != 'INTERNALDATE') {
225 $msgs = sqimap_get_small_header_list($imap_stream, $aUid,
226 array($sSortField), array());
227 } else {
228 $msgs = sqimap_get_small_header_list($imap_stream, $aUid,
229 array(), array($sSortField));
230 }
231 $aUid = array();
232 $walk = false;
233 switch ($sSortField) {
234 // natcasesort section
235 case 'FROM':
236 case 'TO':
237 case 'CC':
238 if(!$walk) {
239 array_walk($msgs, create_function('&$v,&$k,$f',
240 '$v[$f] = (isset($v[$f])) ? $v[$f] : "";
241 $addr = reset(parseRFC822Address($v[$f],1));
242 $sPersonal = (isset($addr[SQM_ADDR_PERSONAL]) && $addr[SQM_ADDR_PERSONAL]) ?
243 $addr[SQM_ADDR_PERSONAL] : "";
244 $sEmail = ($addr[SQM_ADDR_HOST]) ?
245 $addr[SQM_ADDR_MAILBOX] . "@".$addr[SQM_ADDR_HOST] :
246 $addr[SQM_ADDR_HOST];
247 $v[$f] = ($sPersonal) ? decodeHeader($sPersonal):$sEmail;'),$sSortField);
248 $walk = true;
249 }
250 // nobreak
251 case 'SUBJECT':
252 if(!$walk) {
253 array_walk($msgs, create_function('&$v,&$k,$f',
254 '$v[$f] = (isset($v[$f])) ? $v[$f] : "";
255 $v[$f] = strtolower(decodeHeader(trim($v[$f])));
256 $v[$f] = (preg_match("/^(vedr|sv|re|aw|\[\w\]):\s*(.*)$/si", $v[$f], $matches)) ?
257 $matches[2] : $v[$f];'),$sSortField);
258 $walk = true;
259 }
260 foreach ($msgs as $item) {
261 $aUid[$item['UID']] = $item[$sSortField];
262 }
263 natcasesort($aUid);
264 $aUid = array_keys($aUid);
265 if ($reverse) {
266 $aUid = array_reverse($aUid);
267 }
268 break;
269 // \natcasesort section
270 // sort_numeric section
271 case 'DATE':
272 case 'INTERNALDATE':
273 if(!$walk) {
274 array_walk($msgs, create_function('&$v,$k,$f',
275 '$v[$f] = (isset($v[$f])) ? $v[$f] : "";
276 $v[$f] = getTimeStamp(explode(" ",$v[$f]));'),$sSortField);
277 $walk = true;
278 }
279 // nobreak;
280 case 'RFC822.SIZE':
281 if(!$walk) {
282 // redefine $sSortField to maintain the same namespace between
283 // server-side sorting and SquirrelMail sorting
284 $sSortField = 'SIZE';
285 }
286 foreach ($msgs as $item) {
287 $aUid[$item['UID']] = (isset($item[$sSortField])) ? $item[$sSortField] : 0;
288 }
289 if ($reverse) {
290 arsort($aUid,SORT_NUMERIC);
291 } else {
292 asort($aUid, SORT_NUMERIC);
293 }
294 $aUid = array_keys($aUid);
295 break;
296 // \sort_numeric section
297 case 'UID':
298 $aUid = array_reverse($msgs);
299 break;
300 }
301 return $aUid;
302 }
303
304 /**
305 * Returns an array with each element as a string representing one
306 * message-thread as returned by the IMAP server.
307 * @param resource $imap_stream IMAP socket connection
308 * @param string $search optional search string
309 * @return array
310 * @link http://www.ietf.org/internet-drafts/draft-ietf-imapext-sort-13.txt
311 */
312 function get_thread_sort($imap_stream, $search='ALL') {
313 global $sort_by_ref, $default_charset;
314
315 if ($sort_by_ref == 1) {
316 $sort_type = 'REFERENCES';
317 } else {
318 $sort_type = 'ORDEREDSUBJECT';
319 }
320 $query = "THREAD $sort_type ".strtoupper($default_charset)." $search";
321
322 // TODO use sqimap_run_command_list as we do in get_server_sort()
323 $sRead = sqimap_run_command ($imap_stream, $query, false, $response, $message, TRUE);
324
325 /* fallback to default charset */
326 if ($response == 'NO') {
327 if (strpos($message,'BADCHARSET') !== false ||
328 strpos($message,'character') !== false) {
329 sqm_trigger_imap_error('SQM_IMAP_BADCHARSET',$query, $response, $message);
330 $query = "THREAD $sort_type US-ASCII $search";
331 $sRead = sqimap_run_command ($imap_stream, $query, true, $response, $message, TRUE);
332 } else {
333 sqm_trigger_imap_error('SQM_IMAP_ERROR',$query, $response, $message);
334 }
335 } elseif ($response == 'BAD') {
336 sqm_trigger_imap_error('SQM_IMAP_NO_THREAD',$query, $response, $message);
337 }
338 $sThreadResponse = '';
339 if (isset($sRead[0])) {
340 for ($i=0,$iCnt=count($sRead);$i<$iCnt;++$i) {
341 if (preg_match("/^\* THREAD (.+)$/", $sRead[$i], $aMatch)) {
342 $sThreadResponse = trim($aMatch[1]);
343 break;
344 }
345 }
346 }
347 unset($sRead);
348
349 if ($response !== 'OK') {
350 return false;
351 }
352
353 /* Example response
354 * S: * THREAD (2)(3 6 (4 23)(44 7 96))
355 * -- 2
356 *
357 * -- 3
358 * \-- 6
359 * |-- 4
360 * | \-- 23
361 * |
362 * \-- 44
363 * \-- 7
364 * \-- 96
365 */
366 /*
367 * Notes for future work:
368 * indent_array should contain: indent_level, parent and flags,
369 * sibling nodes ..
370 * To achieve that we need to define the following flags:
371 * 0: hasnochildren
372 * 1: haschildren
373 * 2: is first
374 * 4: is last
375 * a node has sibling nodes if it's not the last node
376 * a node has no sibling nodes if it's the last node
377 * By using binary comparations we can store the flag in one var
378 *
379 * example:
380 * -1 par = 0, level = 0, flag = 1 + 2 + 4 = 7 (haschildren, isfirst, islast)
381 * \-2 par = 1, level = 1, flag = 0 + 2 = 2 (hasnochildren, isfirst)
382 * |-3 par = 1, level = 1, flag = 1 + 4 = 5 (haschildren, islast)
383 * \-4 par = 3, level = 2, flag = 1 + 2 + 4 = 7 (haschildren, isfirst, islast)
384 * \-5 par = 4, level = 3, flag = 0 + 2 + 4 = 6 (hasnochildren, isfirst, islast)
385 */
386
387 $j = 0;
388 $k = 0;
389 $l = 0;
390 $aUidThread = array();
391 $aIndent = array();
392 $aUidSubThread = array();
393 $aDepthStack = array();
394 $sUid = '';
395
396 if ($sThreadResponse) {
397 for ($i=0,$iCnt = strlen($sThreadResponse);$i<$iCnt;++$i) {
398 $cChar = $sThreadResponse{$i};
399 switch ($cChar) {
400 case '(': // new sub thread
401 // correction for a subthread of a thread with no parents in thread
402 if (!count($aUidSubThread) && $j > 0) {
403 --$l;
404 }
405 $aDepthStack[$j] = $l;
406 ++$j;
407 break;
408 case ')': // close sub thread
409 if($sUid !== '') {
410 $aUidSubThread[] = $sUid;
411 $aIndent[$sUid] = $j + $l - 1;
412 ++$l;
413 $sUid = '';
414 }
415 --$j;
416 if ($j === 0) {
417 // show message that starts the thread first.
418 $aUidSubThread = array_reverse($aUidSubThread);
419 // do not use array_merge because it's extremely slow and is causing timeouts
420 foreach ($aUidSubThread as $iUid) {
421 $aUidThread[] = $iUid;
422 }
423 $aUidSubThread = array();
424 $l = 0;
425 $aDepthStack = array();
426 } else {
427 $l = $aDepthStack[$j];
428 }
429 break;
430 case ' ': // new child
431 if ($sUid !== '') {
432 $aUidSubThread[] = $sUid;
433 $aIndent[$sUid] = $j + $l - 1;
434 ++$l;
435 $sUid = '';
436 }
437 break;
438 default: // part of UID
439 $sUid .= $cChar;
440 break;
441 }
442 }
443 }
444 unset($sThreadResponse);
445 // show newest threads first
446 $aUidThread = array_reverse($aUidThread);
447 return array($aUidThread,$aIndent);
448 }
449
450
451 function elapsedTime($start) {
452 $stop = gettimeofday();
453 $timepassed = 1000000 * ($stop['sec'] - $start['sec']) + $stop['usec'] - $start['usec'];
454 return $timepassed;
455 }
456
457 /**
458 * Parses a string in an imap response. String starts with " or { which means it
459 * can handle double quoted strings and literal strings
460 *
461 * @param string $read imap response
462 * @param integer $i (reference) offset in string
463 * @return string $s parsed string without the double quotes or literal count
464 */
465 function parseString($read,&$i) {
466 $char = $read{$i};
467 $s = '';
468 if ($char == '"') {
469 $iPos = ++$i;
470 while (true) {
471 $iPos = strpos($read,'"',$iPos);
472 if (!$iPos) break;
473 if ($iPos && $read{$iPos -1} != '\\') {
474 $s = substr($read,$i,($iPos-$i));
475 $i = $iPos;
476 break;
477 }
478 $iPos++;
479 if ($iPos > strlen($read)) {
480 break;
481 }
482 }
483 } else if ($char == '{') {
484 $lit_cnt = '';
485 ++$i;
486 $iPos = strpos($read,'}',$i);
487 if ($iPos) {
488 $lit_cnt = substr($read, $i, $iPos - $i);
489 $i += strlen($lit_cnt) + 3; /* skip } + \r + \n */
490 /* Now read the literal */
491 $s = ($lit_cnt ? substr($read,$i,$lit_cnt): '');
492 $i += $lit_cnt;
493 /* temp bugfix (SM 1.5 will have a working clean version)
494 too much work to implement that version right now */
495 --$i;
496 } else { /* should never happen */
497 $i += 3; /* } + \r + \n */
498 $s = '';
499 }
500 } else {
501 return false;
502 }
503 ++$i;
504 return $s;
505 }
506
507
508 /**
509 * Parses a string containing an array from an imap response. String starts with ( and end with )
510 *
511 * @param string $read imap response
512 * @param integer $i (reference) offset in string
513 * @return array $a
514 */
515 function parseArray($read,&$i) {
516 $i = strpos($read,'(',$i);
517 $i_pos = strpos($read,')',$i);
518 $s = substr($read,$i+1,$i_pos - $i -1);
519 $a = explode(' ',$s);
520 if ($i_pos) {
521 $i = $i_pos+1;
522 return $a;
523 } else {
524 return false;
525 }
526 }
527
528
529 /**
530 * Retrieves a list with headers, flags, size or internaldate from the imap server
531 *
532 * WARNING: function is not portable between SquirrelMail 1.2.x, 1.4.x and 1.5.x.
533 * Output format, third argument and $msg_list array format requirements differ.
534 * @param stream $imap_stream imap connection
535 * @param array $msg_list array with id's to create a msgs set from
536 * @param array $aHeaderFields (since 1.5.0) requested header fields
537 * @param array $aFetchItems (since 1.5.0) requested other fetch items like FLAGS, RFC822.SIZE
538 * @return array $aMessages associative array with messages. Key is the UID, value is an associative array
539 * @since 1.1.3
540 */
541 function sqimap_get_small_header_list($imap_stream, $msg_list,
542 $aHeaderFields = array('Date', 'To', 'Cc', 'From', 'Subject', 'X-Priority', 'Content-Type'),
543 $aFetchItems = array('FLAGS', 'RFC822.SIZE', 'INTERNALDATE')) {
544
545 $aMessageList = array();
546
547 /**
548 * Catch other priority headers as well
549 */
550 if (in_array('X-Priority',$aHeaderFields,true)) {
551 $aHeaderFields[] = 'Importance';
552 $aHeaderFields[] = 'Priority';
553 }
554
555 $bUidFetch = ! in_array('UID', $aFetchItems, true);
556
557 /* Get the small headers for each message in $msg_list */
558 if ($msg_list !== NULL) {
559 $msgs_str = sqimap_message_list_squisher($msg_list);
560 /*
561 * We need to return the data in the same order as the caller supplied
562 * in $msg_list, but IMAP servers are free to return responses in
563 * whatever order they wish... So we need to re-sort manually
564 */
565 if ($bUidFetch) {
566 for ($i = 0; $i < sizeof($msg_list); $i++) {
567 $aMessageList["$msg_list[$i]"] = array();
568 }
569 }
570 } else {
571 $msgs_str = '1:*';
572 }
573
574 /*
575 * Create the query
576 */
577
578 $sFetchItems = '';
579 $query = "FETCH $msgs_str (";
580 if (count($aFetchItems)) {
581 $sFetchItems = implode(' ',$aFetchItems);
582 }
583 if (count($aHeaderFields)) {
584 $sHeaderFields = implode(' ',$aHeaderFields);
585 $sFetchItems .= ' BODY.PEEK[HEADER.FIELDS ('.$sHeaderFields.')]';
586 }
587 $query .= trim($sFetchItems) . ')';
588 $aResponse = sqimap_run_command_list ($imap_stream, $query, true, $response, $message, $bUidFetch);
589 $aMessages = parseFetch($aResponse,$aMessageList);
590 array_reverse($aMessages);
591 return $aMessages;
592 }
593
594
595 /**
596 * Parses a fetch response, currently it can hande FLAGS, HEADERS, RFC822.SIZE, INTERNALDATE and UID
597 * @param array $aResponse Imap response
598 * @param array $aMessageList Placeholder array for results. The keys of the
599 * placeholder array should be the UID so we can reconstruct the order.
600 * @return array $aMessageList associative array with messages. Key is the UID, value is an associative array
601 * @author Marc Groot Koerkamp
602 */
603 function parseFetch(&$aResponse,$aMessageList = array()) {
604 for ($j=0,$iCnt=count($aResponse);$j<$iCnt;++$j) {
605 $aMsg = array();
606
607 $read = implode('',$aResponse[$j]);
608 // free up memmory
609 unset($aResponse[$j]); /* unset does not reindex the array. the for loop is safe */
610 /*
611 * #id<space>FETCH<space>(
612 */
613
614 /* extract the message id */
615 $i_space = strpos($read,' ',2);/* position 2ed <space> */
616 $id = substr($read,2/* skip "*<space>" */,$i_space -2);
617 $aMsg['ID'] = $id;
618 $fetch = substr($read,$i_space+1,5);
619 if (!is_numeric($id) && $fetch !== 'FETCH') {
620 $aMsg['ERROR'] = $read; // htmlspecialchars should be done just before display. this is backend code
621 break;
622 }
623 $i = strpos($read,'(',$i_space+5);
624 $read = substr($read,$i+1);
625 $i_len = strlen($read);
626 $i = 0;
627 while ($i < $i_len && $i !== false) {
628 /* get argument */
629 $read = trim(substr($read,$i));
630 $i_len = strlen($read);
631 $i = strpos($read,' ');
632 $arg = substr($read,0,$i);
633 ++$i;
634 /*
635 * use allcaps for imap items and lowcaps for headers as key for the $aMsg array
636 */
637 switch ($arg)
638 {
639 case 'UID':
640 $i_pos = strpos($read,' ',$i);
641 if (!$i_pos) {
642 $i_pos = strpos($read,')',$i);
643 }
644 if ($i_pos) {
645 $unique_id = substr($read,$i,$i_pos-$i);
646 $i = $i_pos+1;
647 } else {
648 break 3;
649 }
650 break;
651 case 'FLAGS':
652 $flags = parseArray($read,$i);
653 if (!$flags) break 3;
654 $aFlags = array();
655 foreach ($flags as $flag) {
656 $flag = strtolower($flag);
657 $aFlags[$flag] = true;
658 }
659 $aMsg['FLAGS'] = $aFlags;
660 break;
661 case 'RFC822.SIZE':
662 $i_pos = strpos($read,' ',$i);
663 if (!$i_pos) {
664 $i_pos = strpos($read,')',$i);
665 }
666 if ($i_pos) {
667 $aMsg['SIZE'] = substr($read,$i,$i_pos-$i);
668 $i = $i_pos+1;
669 } else {
670 break 3;
671 }
672 break;
673 case 'ENVELOPE':
674 // sqimap_parse_address($read,$i,$aMsg);
675 break; // to be implemented, moving imap code out of the Message class
676 case 'BODYSTRUCTURE':
677 break; // to be implemented, moving imap code out of the Message class
678 case 'INTERNALDATE':
679 $aMsg['INTERNALDATE'] = trim(str_replace(' ', ' ',parseString($read,$i)));
680 break;
681 case 'BODY.PEEK[HEADER.FIELDS':
682 case 'BODY[HEADER.FIELDS':
683 $i = strpos($read,'{',$i); // header is always returned as literal because it contain \n characters
684 $header = parseString($read,$i);
685 if ($header === false) break 2;
686 /* First we replace all \r\n by \n, and unfold the header */
687 $hdr = trim(str_replace(array("\r\n", "\n\t", "\n "),array("\n", ' ', ' '), $header));
688 /* Now we can make a new header array with
689 each element representing a headerline */
690 $aHdr = explode("\n" , $hdr);
691 $aReceived = array();
692 foreach ($aHdr as $line) {
693 $pos = strpos($line, ':');
694 if ($pos > 0) {
695 $field = strtolower(substr($line, 0, $pos));
696 if (!strstr($field,' ')) { /* valid field */
697 $value = trim(substr($line, $pos+1));
698 switch($field) {
699 case 'date':
700 $aMsg['date'] = trim(str_replace(' ', ' ', $value));
701 break;
702 case 'x-priority': $aMsg['x-priority'] = ($value) ? (int) $value{0} : 3; break;
703 case 'priority':
704 case 'importance':
705 // duplicate code with Rfc822Header.cls:parsePriority()
706 if (!isset($aMsg['x-priority'])) {
707 $aPrio = preg_split('/\s/',trim($value));
708 $sPrio = strtolower(array_shift($aPrio));
709 if (is_numeric($sPrio)) {
710 $iPrio = (int) $sPrio;
711 } elseif ( $sPrio == 'non-urgent' || $sPrio == 'low' ) {
712 $iPrio = 3;
713 } elseif ( $sPrio == 'urgent' || $sPrio == 'high' ) {
714 $iPrio = 1;
715 } else {
716 // default is normal priority
717 $iPrio = 3;
718 }
719 $aMsg['x-priority'] = $iPrio;
720 }
721 break;
722 case 'content-type':
723 $type = $value;
724 if ($pos = strpos($type, ";")) {
725 $type = substr($type, 0, $pos);
726 }
727 $type = explode("/", $type);
728 if(!is_array($type) || count($type) < 2) {
729 $aMsg['content-type'] = array('text','plain');
730 } else {
731 $aMsg['content-type'] = array(strtolower($type[0]),strtolower($type[1]));
732 }
733 break;
734 case 'received':
735 $aMsg['received'][] = $value;
736 break;
737 default:
738 $aMsg[$field] = $value;
739 break;
740 }
741 }
742 }
743 }
744 break;
745 default:
746 ++$i;
747 break;
748 }
749 }
750 if (!empty($unique_id)) {
751 $msgi = "$unique_id";
752 $aMsg['UID'] = $unique_id;
753 } else {
754 $msgi = '';
755 }
756 $aMessageList[$msgi] = $aMsg;
757 $aResponse[$j] = NULL;
758 }
759 return $aMessageList;
760 }
761
762 /**
763 * Work in process
764 * @private
765 * @author Marc Groot Koerkamp
766 */
767 function sqimap_parse_envelope($read, &$i, &$msg) {
768 $arg_no = 0;
769 $arg_a = array();
770 ++$i;
771 for ($cnt = strlen($read); ($i < $cnt) && ($read{$i} != ')'); ++$i) {
772 $char = strtoupper($read{$i});
773 switch ($char) {
774 case '{':
775 case '"':
776 $arg_a[] = parseString($read,$i);
777 ++$arg_no;
778 break;
779 case 'N':
780 /* probably NIL argument */
781 if (strtoupper(substr($read, $i, 3)) == 'NIL') {
782 $arg_a[] = '';
783 ++$arg_no;
784 $i += 2;
785 }
786 break;
787 case '(':
788 /* Address structure (with group support)
789 * Note: Group support is useless on SMTP connections
790 * because the protocol doesn't support it
791 */
792 $addr_a = array();
793 $group = '';
794 $a=0;
795 for (; $i < $cnt && $read{$i} != ')'; ++$i) {
796 if ($read{$i} == '(') {
797 $addr = sqimap_parse_address($read, $i);
798 if (($addr[3] == '') && ($addr[2] != '')) {
799 /* start of group */
800 $group = $addr[2];
801 $group_addr = $addr;
802 $j = $a;
803 } else if ($group && ($addr[3] == '') && ($addr[2] == '')) {
804 /* end group */
805 if ($a == ($j+1)) { /* no group members */
806 $group_addr[4] = $group;
807 $group_addr[2] = '';
808 $group_addr[0] = "$group: Undisclosed recipients;";
809 $addr_a[] = $group_addr;
810 $group ='';
811 }
812 } else {
813 $addr[4] = $group;
814 $addr_a[] = $addr;
815 }
816 ++$a;
817 }
818 }
819 $arg_a[] = $addr_a;
820 break;
821 default: break;
822 }
823 }
824
825 if (count($arg_a) > 9) {
826 $d = strtr($arg_a[0], array(' ' => ' '));
827 $d = explode(' ', $d);
828 if (!$arg_a[1]) $arg_a[1] = '';
829 $msg['DATE'] = $d; /* argument 1: date */
830 $msg['SUBJECT'] = $arg_a[1]; /* argument 2: subject */
831 $msg['FROM'] = is_array($arg_a[2]) ? $arg_a[2][0] : ''; /* argument 3: from */
832 $msg['SENDER'] = is_array($arg_a[3]) ? $arg_a[3][0] : ''; /* argument 4: sender */
833 $msg['REPLY-TO'] = is_array($arg_a[4]) ? $arg_a[4][0] : ''; /* argument 5: reply-to */
834 $msg['TO'] = $arg_a[5]; /* argument 6: to */
835 $msg['CC'] = $arg_a[6]; /* argument 7: cc */
836 $msg['BCC'] = $arg_a[7]; /* argument 8: bcc */
837 $msg['IN-REPLY-TO'] = $arg_a[8]; /* argument 9: in-reply-to */
838 $msg['MESSAGE-ID'] = $arg_a[9]; /* argument 10: message-id */
839 }
840 }
841
842
843 /**
844 * Work in process
845 * @private
846 * @author Marc Groot Koerkamp
847 */
848 function sqimap_parse_address($read, &$i) {
849 $arg_a = array();
850 for (; $read{$i} != ')'; ++$i) {
851 $char = strtoupper($read{$i});
852 switch ($char) {
853 case '{':
854 case '"': $arg_a[] = parseString($read,$i); break;
855 case 'n':
856 case 'N':
857 if (strtoupper(substr($read, $i, 3)) == 'NIL') {
858 $arg_a[] = '';
859 $i += 2;
860 }
861 break;
862 default: break;
863 }
864 }
865
866 if (count($arg_a) == 4) {
867 return $arg_a;
868
869 // $adr = new AddressStructure();
870 // $adr->personal = $arg_a[0];
871 // $adr->adl = $arg_a[1];
872 // $adr->mailbox = $arg_a[2];
873 // $adr->host = $arg_a[3];
874 } else {
875 $adr = '';
876 }
877 return $adr;
878 }
879
880
881 /**
882 * Returns a message array with all the information about a message.
883 * See the documentation folder for more information about this array.
884 *
885 * @param resource $imap_stream imap connection
886 * @param integer $id uid of the message
887 * @param string $mailbox used for error handling, can be removed because we should return an error code and generate the message elsewhere
888 * @param int $hide Indicates whether or not to hide any errors: 0 = don't hide, 1 = hide (just exit), 2 = hide (return FALSE), 3 = hide (return error string) (OPTIONAL; default don't hide)
889 * @return mixed Message object or FALSE/error string if error occurred and $hide is set to 2/3
890 */
891 function sqimap_get_message($imap_stream, $id, $mailbox, $hide=0) {
892 // typecast to int to prohibit 1:* msgs sets
893 $id = (int) $id;
894 $flags = array();
895 $read = sqimap_run_command($imap_stream, "FETCH $id (FLAGS BODYSTRUCTURE)", true, $response, $message, TRUE);
896 if ($read) {
897 if (preg_match('/.+FLAGS\s\((.*)\)\s/AUi',$read[0],$regs)) {
898 if (trim($regs[1])) {
899 $flags = preg_split('/ /', $regs[1],-1,PREG_SPLIT_NO_EMPTY);
900 }
901 }
902 } else {
903
904 if ($hide == 1) exit;
905 if ($hide == 2) return FALSE;
906
907 /* the message was not found, maybe the mailbox was modified? */
908 global $sort, $startMessage;
909
910 $errmessage = _("The server couldn't find the message you requested.");
911
912 if ($hide == 3) return $errmessage;
913
914 $errmessage .= '<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).");
915
916 /* this will include a link back to the message list */
917 error_message($errmessage, $mailbox, $sort, (int) $startMessage);
918 exit;
919 }
920 $bodystructure = implode('',$read);
921 $msg = mime_structure($bodystructure,$flags);
922 $read = sqimap_run_command($imap_stream, "FETCH $id BODY[HEADER]", true, $response, $message, TRUE);
923 $rfc822_header = new Rfc822Header();
924 $rfc822_header->parseHeader($read);
925 $msg->rfc822_header = $rfc822_header;
926
927 parse_message_entities($msg, $id, $imap_stream);
928 return $msg;
929 }
930
931
932 /**
933 * Recursively parse embedded messages (if any) in the given
934 * message, building correct rfc822 headers for each one
935 *
936 * @param object $msg The message object to scan for attached messages
937 * NOTE: this is passed by reference! Changes made
938 * within will affect the caller's copy of $msg!
939 * @param int $id The top-level message UID on the IMAP server, even
940 * if the $msg being passed in is only an attached entity
941 * thereof.
942 * @param resource $imap_stream A live connection to the IMAP server.
943 *
944 * @return void
945 *
946 * @since 1.5.2
947 *
948 */
949 function parse_message_entities(&$msg, $id, $imap_stream) {
950 global $uid_support;
951 if (!empty($msg->entities)) foreach ($msg->entities as $i => $entity) {
952 if (is_object($entity) && get_class($entity) == 'Message') {
953 if (!empty($entity->rfc822_header)) {
954 $read = sqimap_run_command($imap_stream, "FETCH $id BODY[". $entity->entity_id .".HEADER]", true, $response, $message, $uid_support);
955 $rfc822_header = new Rfc822Header();
956 $rfc822_header->parseHeader($read);
957 $msg->entities[$i]->rfc822_header = $rfc822_header;
958 }
959 parse_message_entities($msg->entities[$i], $id, $imap_stream);
960 }
961 }
962 }