functions/imap_messages.php

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