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 void
  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  * move a set of messages ($id) to another mailbox. Deletes the originals.
  37  * @param int $imap_stream The resource ID for the IMAP socket
  38  * @param string $id The list of messages to move
  39  * @param string $mailbox The destination to move to
  40  * @return void
  41  */
  42 function sqimap_msgs_list_move ($imap_stream, $id, $mailbox) {
  43     $msgs_id = sqimap_message_list_squisher($id);
  44     if (sqimap_msgs_list_copy ($imap_stream, $id, $mailbox)) {
  45         return sqimap_toggle_flag($imap_stream, $id, '\\Deleted', true, true);
  46     } else {
  47         return false;
  48     }
  49 }
  50
  51
  52 /**
  53  * Deletes a message and move it to trash or expunge the mailbox
  54  * @param  resource imap connection
  55  * @param  string $mailbox mailbox, used for checking if it concerns the trash_folder
  56  * @param  array $id list with uid's
  57  * @param  bool   $bypass_trash skip copy to trash
  58  * @return array  $aMessageList array with messages containing the new flags and UID @see parseFetch
  59  */
  60 function sqimap_msgs_list_delete ($imap_stream, $mailbox, $id, $bypass_trash=false) {
  61     // FIX ME, remove globals by introducing an associative array with properties
  62     // as 4th argument as replacement for the bypass_trash var
  63     global $move_to_trash, $trash_folder;
  64     $bRes = true;
  65     if (($move_to_trash == true) && ($bypass_trash != true) &&
  66         (sqimap_mailbox_exists($imap_stream, $trash_folder) &&  ($mailbox != $trash_folder)) ) {
  67         $bRes = sqimap_msgs_list_copy ($imap_stream, $id, $trash_folder);
  68     }
  69     if ($bRes) {
  70         return sqimap_toggle_flag($imap_stream, $id, '\\Deleted', true, true);
  71     } else {
  72         return false;
  73     }
  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  * Sort the message list and crunch to be as small as possible
  97  * (overflow could happen, so make it small if possible)
  98  */
  99 function sqimap_message_list_squisher($messages_array) {
 100     if( !is_array( $messages_array ) ) {
 101         return $messages_array;
 102     }
 103
 104     sort($messages_array, SORT_NUMERIC);
 105     $msgs_str = '';
 106     while ($messages_array) {
 107         $start = array_shift($messages_array);
 108         $end = $start;
 109         while (isset($messages_array[0]) && $messages_array[0] == $end + 1) {
 110             $end = array_shift($messages_array);
 111         }
 112         if ($msgs_str != '') {
 113             $msgs_str .= ',';
 114         }
 115         $msgs_str .= $start;
 116         if ($start != $end) {
 117             $msgs_str .= ':' . $end;
 118         }
 119     }
 120     return $msgs_str;
 121 }
 122
 123 /**
 124 * Retrieves an array with a sorted uid list. Sorting is done on the imap server
 125 * @link http://www.ietf.org/internet-drafts/draft-ietf-imapext-sort-17.txt
 126 * @param resource $imap_stream IMAP socket connection
 127 * @param string $sSortField Field to sort on
 128 * @param bool $reverse Reverse order search
 129 * @return array $id sorted uid list
 130 */
 131 function sqimap_get_sort_order ($imap_stream, $sSortField, $reverse, $search='ALL') {
 132     global  $default_charset,
 133             $sent_folder;
 134
 135     $id = array();
 136     $sort_test = array();
 137     $sort_query = '';
 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_HOST] . "@".$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  * Returns an indent array for printMessageinfo()
 271  * This represents the amount of indent needed (value),
 272  * for this message number (key)
 273  */
 274
 275 /*
 276  * Notes for future work:
 277  * indent_array should contain: indent_level, parent and flags,
 278  * sibling notes ..
 279  * To achieve that we  need to define the following flags:
 280  * 0: hasnochildren
 281  * 1: haschildren
 282  * 2: is first
 283  * 4: is last
 284  * a node has sibling nodes if it's not the last node
 285  * a node has no sibling nodes if it's the last node
 286  * By using binary comparations we can store the flag in one var
 287  *
 288  * example:
 289  * -1      par = 0, level = 0, flag = 1 + 2 + 4 = 7 (haschildren,   isfirst, islast)
 290  *  \-2    par = 1, level = 1, flag = 0 + 2     = 2 (hasnochildren, isfirst)
 291  *  |-3    par = 1, level = 1, flag = 1 + 4     = 5 (haschildren,   islast)
 292  *   \-4   par = 3, level = 2, flag = 1 + 2 + 4 = 7 (haschildren,   isfirst, islast)
 293  *     \-5 par = 4, level = 3, flag = 0 + 2 + 4 = 6 (hasnochildren, isfirst, islast)
 294  */
 295 function get_parent_level ($thread_new) {
 296     $parent = '';
 297     $child  = '';
 298     $cutoff = 0;
 299
 300     /*
 301      * loop through the threads and take unwanted characters out
 302      * of the thread string then chop it up
 303      */
 304     for ($i=0;$i<count($thread_new);$i++) {
 305         $thread_new[$i] = preg_replace("/\s\(/", "(", $thread_new[$i]);
 306         $thread_new[$i] = preg_replace("/(\d+)/", "$1|", $thread_new[$i]);
 307         $thread_new[$i] = preg_split("/\|/", $thread_new[$i], -1, PREG_SPLIT_NO_EMPTY);
 308     }
 309     $indent_array = array();
 310     if (!$thread_new) {
 311         $thread_new = array();
 312     }
 313     /* looping through the parts of one message thread */
 314
 315     for ($i=0;$i<count($thread_new);$i++) {
 316         /* first grab the parent, it does not indent */
 317
 318         if (isset($thread_new[$i][0])) {
 319             if (preg_match("/(\d+)/", $thread_new[$i][0], $regs)) {
 320                 $parent = $regs[1];
 321             }
 322         }
 323         $indent_array[$parent] = 0;
 324
 325         /*
 326          * now the children, checking each thread portion for
 327          * ),(, and space, adjusting the level and space values
 328          * to get the indent level
 329          */
 330         $level = 0;
 331         $spaces = array();
 332         $spaces_total = 0;
 333         $indent = 0;
 334         $fake = FALSE;
 335         for ($k=1,$iCnt=count($thread_new[$i])-1;$k<$iCnt;++$k) {
 336             $chars = count_chars($thread_new[$i][$k], 1);
 337             if (isset($chars['40'])) {       /* testing for ( */
 338                 $level += $chars['40'];
 339             }
 340             if (isset($chars['41'])) {      /* testing for ) */
 341                 $level -= $chars['41'];
 342                 $spaces[$level] = 0;
 343                 /* if we were faking lets stop, this portion
 344                  * of the thread is over
 345                  */
 346                 if ($level == $cutoff) {
 347                     $fake = FALSE;
 348                 }
 349             }
 350             if (isset($chars['32'])) {      /* testing for space */
 351                 if (!isset($spaces[$level])) {
 352                     $spaces[$level] = 0;
 353                 }
 354                 $spaces[$level] += $chars['32'];
 355             }
 356             for ($x=0;$x<=$level;$x++) {
 357                 if (isset($spaces[$x])) {
 358                     $spaces_total += $spaces[$x];
 359                 }
 360             }
 361             $indent = $level + $spaces_total;
 362             /* must have run into a message that broke the thread
 363              * so we are adjusting for that portion
 364              */
 365             if ($fake == TRUE) {
 366                 $indent = $indent +1;
 367             }
 368             if (preg_match("/(\d+)/", $thread_new[$i][$k], $regs)) {
 369                 $child = $regs[1];
 370             }
 371             /* the thread must be broken if $indent == 0
 372              * so indent the message once and start faking it
 373              */
 374             if ($indent == 0) {
 375                 $indent = 1;
 376                 $fake = TRUE;
 377                 $cutoff = $level;
 378             }
 379             /* dont need abs but if indent was negative
 380              * errors would occur
 381              */
 382             $indent_array[$child] = ($indent < 0) ? 0 : $indent;
 383             $spaces_total = 0;
 384         }
 385     }
 386     return $indent_array;
 387 }
 388
 389
 390 /**
 391  * Returns an array with each element as a string representing one
 392  * message-thread as returned by the IMAP server.
 393  * @link http://www.ietf.org/internet-drafts/draft-ietf-imapext-sort-13.txt
 394  */
 395 function get_thread_sort ($imap_stream, $search='ALL') {
 396     global $thread_new, $sort_by_ref, $default_charset, $server_sort_array, $indent_array;
 397
 398     $thread_temp = array ();
 399     if ($sort_by_ref == 1) {
 400         $sort_type = 'REFERENCES';
 401     } else {
 402         $sort_type = 'ORDEREDSUBJECT';
 403     }
 404     $query = "THREAD $sort_type ".strtoupper($default_charset)." $search";
 405
 406     $thread_test = sqimap_run_command ($imap_stream, $query, false, $response, $message, TRUE);
 407     /* fallback to default charset */
 408     if ($response == 'NO' && strpos($message,'[BADCHARSET]') !== false) {
 409         $query = "THREAD $sort_type US-ASCII $search";
 410         $thread_test = sqimap_run_command ($imap_stream, $query, true, $response, $message, TRUE);
 411     }
 412     if (isset($thread_test[0])) {
 413         for ($i=0,$iCnt=count($thread_test);$i<$iCnt;++$i) {
 414             if (preg_match("/^\* THREAD (.+)$/", $thread_test[$i], $regs)) {
 415                 $thread_list = trim($regs[1]);
 416                 break;
 417             }
 418         }
 419     } else {
 420         $thread_list = "";
 421     }
 422     if (!preg_match("/OK/", $response)) {
 423         $server_sort_array = 'no';
 424         return $server_sort_array;
 425     }
 426     if (isset($thread_list)) {
 427         $thread_temp = preg_split("//", $thread_list, -1, PREG_SPLIT_NO_EMPTY);
 428     }
 429
 430     $char_count = count($thread_temp);
 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  * Parses a string in an imap response. String starts with " or { which means it
 486  * can handle double quoted strings and literal strings
 487  *
 488  * @param string $read imap response
 489  * @param integer $i (reference) offset in string
 490  * @return string $s parsed string without the double quotes or literal count
 491  */
 492 function parseString($read,&$i) {
 493     $char = $read{$i};
 494     $s = '';
 495     if ($char == '"') {
 496         $iPos = ++$i;
 497         while (true) {
 498             $iPos = strpos($read,'"',$iPos);
 499             if (!$iPos) break;
 500                 if ($iPos && $read{$iPos -1} != '\\') {
 501                     $s = substr($read,$i,($iPos-$i));
 502                     $i = $iPos;
 503                     break;
 504                 }
 505                 $iPos++;
 506                 if ($iPos > strlen($read)) {
 507                     break;
 508                 }
 509         }
 510     } else if ($char == '{') {
 511         $lit_cnt = '';
 512         ++$i;
 513         $iPos = strpos($read,'}',$i);
 514         if ($iPos) {
 515         $lit_cnt = substr($read, $i, $iPos - $i);
 516         $i += strlen($lit_cnt) + 3; /* skip } + \r + \n */
 517         /* Now read the literal */
 518         $s = ($lit_cnt ? substr($read,$i,$lit_cnt): '');
 519         $i += $lit_cnt;
 520         /* temp bugfix (SM 1.5 will have a working clean version)
 521             too much work to implement that version right now */
 522         --$i;
 523         } else { /* should never happen */
 524             $i += 3; /* } + \r + \n */
 525             $s = '';
 526         }
 527     } else {
 528         return false;
 529     }
 530     ++$i;
 531     return $s;
 532 }
 533
 534 /**
 535  * Parses a string containing an array from an imap response. String starts with ( and end with )
 536  *
 537  * @param string $read imap response
 538  * @param integer $i (reference) offset in string
 539  * @return array $a
 540  */
 541 function parseArray($read,&$i) {
 542     $i = strpos($read,'(',$i);
 543     $i_pos = strpos($read,')',$i);
 544     $s = substr($read,$i+1,$i_pos - $i -1);
 545     $a = explode(' ',$s);
 546     if ($i_pos) {
 547         $i = $i_pos+1;
 548         return $a;
 549     } else {
 550         return false;
 551     }
 552 }
 553 /**
 554  * Retrieves a list with headers, flags, size or internaldate from the imap server
 555  * @param resource $imap_stream imap connection
 556  * @param array    $msg_list array with id's to create a msgs set from
 557  * @param array    $aHeaderFields requested header fields
 558  * @param array    $aFetchItems   requested other fetch items like FLAGS, RFC822.SIZE
 559  * @return array   $aMessages associative array with messages. Key is the UID, value is an associative array
 560  */
 561 function sqimap_get_small_header_list ($imap_stream, $msg_list,
 562     $aHeaderFields = array('Date', 'To', 'Cc', 'From', 'Subject', 'X-Priority', 'Content-Type'),
 563     $aFetchItems = array('FLAGS', 'RFC822.SIZE', 'INTERNALDATE')) {
 564
 565     $aMessageList = array();
 566     $read_list = array();
 567
 568     $bUidFetch = ! in_array('UID', $aFetchItems, true);
 569
 570     /* Get the small headers for each message in $msg_list */
 571     if ($msg_list !== NULL) {
 572         $msgs_str = sqimap_message_list_squisher($msg_list);
 573         /*
 574         * We need to return the data in the same order as the caller supplied
 575         * in $msg_list, but IMAP servers are free to return responses in
 576         * whatever order they wish... So we need to re-sort manually
 577         */
 578         if ($bUidFetch) {
 579             for ($i = 0; $i < sizeof($msg_list); $i++) {
 580                 $aMessageList["$msg_list[$i]"] = array();
 581             }
 582         }
 583     } else {
 584         $msgs_str = '1:*';
 585         $aId = array();
 586     }
 587
 588     /*
 589      * Create the query
 590      */
 591
 592     $sFetchItems = '';
 593     $query = "FETCH $msgs_str (";
 594     if (count($aFetchItems)) {
 595         $sFetchItems = implode(' ',$aFetchItems);
 596     }
 597     if (count($aHeaderFields)) {
 598         $sHeaderFields = implode(' ',$aHeaderFields);
 599         $sFetchItems .= ' BODY.PEEK[HEADER.FIELDS ('.$sHeaderFields.')]';
 600     }
 601     $query .= trim($sFetchItems) . ')';
 602     $aResponse = sqimap_run_command_list ($imap_stream, $query, true, $response, $message, $bUidFetch);
 603     $aMessages = parseFetch($aResponse,$aMessageList);
 604     array_reverse($aMessages);
 605     return $aMessages;
 606 }
 607
 608 /**
 609  * Parses a fetch response, currently it can hande FLAGS, HEADERS, RFC822.SIZE, INTERNALDATE and UID
 610  * @param array    $aResponse Imap response
 611  * @param array    $aMessageList Placeholder array for results. The keys of the
 612  *                 placeholder array should be the UID so we can reconstruct the order.
 613  * @return array   $aMessageList associative array with messages. Key is the UID, value is an associative array
 614  * @author Marc Groot Koerkamp
 615  */
 616 function parseFetch($aResponse,$aMessageList = array()) {
 617     foreach ($aResponse as $r) {
 618         $msg = array();
 619         // use unset because we do isset below
 620         $read = implode('',$r);
 621
 622         /*
 623             * #id<space>FETCH<space>(
 624         */
 625
 626         /* extract the message id */
 627         $i_space = strpos($read,' ',2);
 628         $id = substr($read,2,$i_space-2);
 629         $msg['ID'] = $id;
 630         $fetch = substr($read,$i_space+1,5);
 631         if (!is_numeric($id) && $fetch !== 'FETCH') {
 632             $msg['ERROR'] = $read; // htmlspecialchars should be done just before display. this is backend code
 633             break;
 634         }
 635         $i = strpos($read,'(',$i_space+5);
 636         $read = substr($read,$i+1);
 637         $i_len = strlen($read);
 638         $i = 0;
 639         while ($i < $i_len && $i !== false) {
 640             /* get argument */
 641             $read = trim(substr($read,$i));
 642             $i_len = strlen($read);
 643             $i = strpos($read,' ');
 644             $arg = substr($read,0,$i);
 645             ++$i;
 646             switch ($arg)
 647             {
 648             case 'UID':
 649                 $i_pos = strpos($read,' ',$i);
 650                 if (!$i_pos) {
 651                     $i_pos = strpos($read,')',$i);
 652                 }
 653                 if ($i_pos) {
 654                     $unique_id = substr($read,$i,$i_pos-$i);
 655                     $i = $i_pos+1;
 656                 } else {
 657                     break 3;
 658                 }
 659                 break;
 660             case 'FLAGS':
 661                 $flags = parseArray($read,$i);
 662                 if (!$flags) break 3;
 663                 $aFlags = array();
 664                 foreach ($flags as $flag) {
 665                     $flag = strtolower($flag);
 666                     $aFlags[$flag] = true;
 667                 }
 668                 $msg['FLAGS'] = $aFlags;
 669                 break;
 670             case 'RFC822.SIZE':
 671                 $i_pos = strpos($read,' ',$i);
 672                 if (!$i_pos) {
 673                     $i_pos = strpos($read,')',$i);
 674                 }
 675                 if ($i_pos) {
 676                     $msg['SIZE'] = substr($read,$i,$i_pos-$i);
 677                     $i = $i_pos+1;
 678                 } else {
 679                     break 3;
 680                 }
 681
 682                 break;
 683             case 'ENVELOPE':
 684                 break; // to be implemented, moving imap code out of the nessages class
 685                 sqimap_parse_address($read,$i,$msg);
 686                 break; // to be implemented, moving imap code out of the nessages class
 687             case 'BODYSTRUCTURE':
 688                 break;
 689             case 'INTERNALDATE':
 690                 $msg['INTERNALDATE'] = str_replace('  ', ' ',parseString($read,$i));
 691                 break;
 692             case 'BODY.PEEK[HEADER.FIELDS':
 693             case 'BODY[HEADER.FIELDS':
 694                 $i = strpos($read,'{',$i);
 695                 $header = parseString($read,$i);
 696                 if ($header === false) break 2;
 697                 /* First we replace all \r\n by \n, and unfold the header */
 698                 $hdr = trim(str_replace(array("\r\n", "\n\t", "\n "),array("\n", ' ', ' '), $header));
 699                 /* Now we can make a new header array with */
 700                 /* each element representing a headerline  */
 701                 $hdr = explode("\n" , $hdr);
 702                 $aReceived = array();
 703                 foreach ($hdr as $line) {
 704                     $pos = strpos($line, ':');
 705                     if ($pos > 0) {
 706                         $field = strtolower(substr($line, 0, $pos));
 707                         if (!strstr($field,' ')) { /* valid field */
 708                             $value = trim(substr($line, $pos+1));
 709                             switch($field)
 710                             {
 711                             case 'to': $msg['TO'] = $value; break;
 712                             case 'cc': $msg['CC'] = $value; break;
 713                             case 'from': $msg['FROM'] = $value; break;
 714                             case 'date':
 715                                 $msg['DATE'] = str_replace('  ', ' ', $value);
 716                                 break;
 717                             case 'x-priority': $msg['PRIORITY'] = $value; break;
 718                             case 'subject': $msg['SUBJECT'] = $value; break;
 719                             case 'content-type':
 720                                 $type = $value;
 721                                 if ($pos = strpos($type, ";")) {
 722                                     $type = substr($type, 0, $pos);
 723                                 }
 724                                 $type = explode("/", $type);
 725                                 if(!is_array($type) || count($type) < 2) {
 726                                     $msg['TYPE0'] = 'text';
 727                                     $msg['TYPE1'] = 'plain';
 728                                 } else {
 729                                     $msg['TYPE0'] = strtolower($type[0]);
 730                                     $msg['TYPE1'] = strtolower($type[1]);
 731                                 }
 732                                 break;
 733                             case 'received':
 734                                 $aReceived[] = $value;
 735                                 break;
 736                             default: break;
 737                             }
 738                         }
 739                     }
 740                 }
 741                 if (count($aReceived)) {
 742                     $msg['RECEIVED'] = $aReceived;
 743                 }
 744                 break;
 745             default:
 746                 ++$i;
 747                 break;
 748             }
 749         }
 750         $msgi ="$unique_id";
 751         $msg['UID'] = $unique_id;
 752
 753         $aMessageList[$msgi] = $msg;
 754         ++$msgi;
 755     }
 756     return $aMessageList;
 757 }
 758
 759 /**
 760  * Work in process
 761  * @private
 762  * @author Marc Groot Koerkamp
 763  */
 764 function sqimap_parse_envelope($read, &$i, &$msg) {
 765     $arg_no = 0;
 766     $arg_a = array();
 767     ++$i;
 768     for ($cnt = strlen($read); ($i < $cnt) && ($read{$i} != ')'); ++$i) {
 769         $char = strtoupper($read{$i});
 770         switch ($char) {
 771             case '{':
 772             case '"':
 773                 $arg_a[] = parseString($read,$i);
 774                 ++$arg_no;
 775                 break;
 776             case 'N':
 777                 /* probably NIL argument */
 778                 if (strtoupper(substr($read, $i, 3)) == 'NIL') {
 779                     $arg_a[] = '';
 780                     ++$arg_no;
 781                     $i += 2;
 782                 }
 783                 break;
 784             case '(':
 785                 /* Address structure (with group support)
 786                 * Note: Group support is useless on SMTP connections
 787                 *       because the protocol doesn't support it
 788                 */
 789                 $addr_a = array();
 790                 $group = '';
 791                 $a=0;
 792                 for (; $i < $cnt && $read{$i} != ')'; ++$i) {
 793                     if ($read{$i} == '(') {
 794                         $addr = sqimap_parse_address($read, $i);
 795                         if (($addr[3] == '') && ($addr[2] != '')) {
 796                             /* start of group */
 797                             $group = $addr[2];
 798                             $group_addr = $addr;
 799                             $j = $a;
 800                         } else if ($group && ($addr[3] == '') && ($addr[2] == '')) {
 801                         /* end group */
 802                             if ($a == ($j+1)) { /* no group members */
 803                                 $group_addr[4] = $group;
 804                                 $group_addr[2] = '';
 805                                 $group_addr[0] = "$group: Undisclosed recipients;";
 806                                 $addr_a[] = $group_addr;
 807                                 $group ='';
 808                             }
 809                         } else {
 810                             $addr[4] = $group;
 811                             $addr_a[] = $addr;
 812                         }
 813                         ++$a;
 814                     }
 815                 }
 816                 $arg_a[] = $addr_a;
 817                 break;
 818             default: break;
 819         }
 820     }
 821
 822     if (count($arg_a) > 9) {
 823         $d = strtr($arg_a[0], array('  ' => ' '));
 824         $d = explode(' ', $d);
 825         if (!$arg_a[1]) $arg_1[1] = '';
 826         $msg['DATE'] = $d; /* argument 1: date */
 827         $msg['SUBJECT'] = $arg_a[1];     /* argument 2: subject */
 828         $msg['FROM'] = is_array($arg_a[2]) ? $arg_a[2][0] : '';     /* argument 3: from        */
 829         $msg['SENDER'] = is_array($arg_a[3]) ? $arg_a[3][0] : '';   /* argument 4: sender      */
 830         $msg['REPLY-TO'] = is_array($arg_a[4]) ? $arg_a[4][0] : '';  /* argument 5: reply-to    */
 831         $msg['TO'] = $arg_a[5];          /* argument 6: to          */
 832         $msg['CC'] = $arg_a[6];          /* argument 7: cc          */
 833         $msg['BCC'] = $arg_a[7];         /* argument 8: bcc         */
 834         $msg['IN-REPLY-TO'] = $arg_a[8];   /* argument 9: in-reply-to */
 835         $msg['MESSAGE-ID'] = $arg_a[9];  /* argument 10: message-id */
 836     }
 837 }
 838
 839 /**
 840  * Work in process
 841  * @private
 842  * @author Marc Groot Koerkamp
 843  */
 844 function sqimap_parse_address($read, &$i) {
 845     $arg_a = array();
 846     for (; $read{$i} != ')'; ++$i) {
 847         $char = strtoupper($read{$i});
 848         switch ($char) {
 849             case '{':
 850             case '"': $arg_a[] =  parseString($read,$i); break;
 851             case 'n':
 852             case 'N':
 853                 if (strtoupper(substr($read, $i, 3)) == 'NIL') {
 854                     $arg_a[] = '';
 855                     $i += 2;
 856                 }
 857                 break;
 858             default: break;
 859         }
 860     }
 861
 862     if (count($arg_a) == 4) {
 863         return $arg_a;
 864
 865 //        $adr = new AddressStructure();
 866 //        $adr->personal = $arg_a[0];
 867 //        $adr->adl = $arg_a[1];
 868 //        $adr->mailbox = $arg_a[2];
 869 //        $adr->host = $arg_a[3];
 870     } else {
 871         $adr = '';
 872     }
 873     return $adr;
 874 }
 875
 876 /**
 877  * Returns a message array with all the information about a message.
 878  * See the documentation folder for more information about this array.
 879  *
 880  * @param  resource $imap_stream imap connection
 881  * @param  integer  $id uid of the message
 882  * @param  string   $mailbox used for error handling, can be removed because we should return an error code and generate the message elsewhere
 883  * @return Message  Message object
 884  */
 885 function sqimap_get_message ($imap_stream, $id, $mailbox) {
 886     // typecast to int to prohibit 1:* msgs sets
 887     $id = (int) $id;
 888     $flags = array();
 889     $read = sqimap_run_command ($imap_stream, "FETCH $id (FLAGS BODYSTRUCTURE)", true, $response, $message, TRUE);
 890     if ($read) {
 891         if (preg_match('/.+FLAGS\s\((.*)\)\s/AUi',$read[0],$regs)) {
 892             if (trim($regs[1])) {
 893                 $flags = preg_split('/ /', $regs[1],-1,'PREG_SPLIT_NI_EMPTY');
 894             }
 895         }
 896     } else {
 897         /* the message was not found, maybe the mailbox was modified? */
 898         global $sort, $startMessage, $color;
 899
 900         $errmessage = _("The server couldn't find the message you requested.") .
 901             '<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).");
 902         /* this will include a link back to the message list */
 903         error_message($errmessage, $mailbox, $sort, (int) $startMessage, $color);
 904         exit;
 905     }
 906     $bodystructure = implode('',$read);
 907     $msg =  mime_structure($bodystructure,$flags);
 908     $read = sqimap_run_command ($imap_stream, "FETCH $id BODY[HEADER]", true, $response, $message, TRUE);
 909     $rfc822_header = new Rfc822Header();
 910     $rfc822_header->parseHeader($read);
 911     $msg->rfc822_header = $rfc822_header;
 912     return $msg;
 913 }
 914
 915 /**
 916 * Depricated !!!!!!! DO NOT USE THIS, use sqimap_msgs_list_copy instead
 917 */
 918 function sqimap_messages_copy ($imap_stream, $start, $end, $mailbox) {
 919     $read = sqimap_run_command ($imap_stream, "COPY $start:$end " . sqimap_encode_mailbox_name($mailbox), true, $response, $message, TRUE);
 920 }
 921
 922 /**
 923 * Depricated !!!!!!! DO NOT USE THIS, use sqimap_msgs_list_delete instead
 924 */
 925 function sqimap_messages_delete ($imap_stream, $start, $end, $mailbox, $bypass_trash=false) {
 926     global $move_to_trash, $trash_folder, $auto_expunge;
 927
 928     if (($move_to_trash == true) && ($bypass_trash != true) &&
 929         (sqimap_mailbox_exists($imap_stream, $trash_folder) && ($mailbox != $trash_folder))) {
 930         sqimap_messages_copy ($imap_stream, $start, $end, $trash_folder);
 931     }
 932     sqimap_messages_flag ($imap_stream, $start, $end, "Deleted", true);
 933 }
 934
 935 /**
 936 * Depricated !!!!!!! DO NOT USE THIS, use sqimap_toggle_flag instead
 937 * Set a flag on the provided uid list
 938 * @param  resource imap connection
 939 */
 940 function sqimap_messages_flag ($imap_stream, $start, $end, $flag, $handle_errors) {
 941     $read = sqimap_run_command ($imap_stream, "STORE $start:$end +FLAGS (\\$flag)", $handle_errors, $response, $message, TRUE);
 942 }
 943
 944 /** @deprecated */
 945 function sqimap_get_small_header ($imap_stream, $id, $sent) {
 946     $res = sqimap_get_small_header_list($imap_stream, $id, $sent);
 947     return $res[0];
 948 }
 949
 950 ?>