functions/imap_messages.php

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