/**
* imap_messages.php
*
- * Copyright (c) 1999-2002 The SquirrelMail Project Team
+ * Copyright (c) 1999-2005 The SquirrelMail Project Team
* Licensed under the GNU GPL. For full terms see the file COPYING.
*
* This implements functions that manipulate messages
+ * NOTE: Quite a few functions in this file are obsolete
*
- * $Id$
+ * @version $Id$
+ * @package squirrelmail
+ * @subpackage imap
*/
-/* Copies specified messages to specified folder */
-function sqimap_messages_copy ($imap_stream, $start, $end, $mailbox) {
- $read = sqimap_run_command ($imap_stream, "COPY $start:$end \"$mailbox\"", true, $response, $message);
+
+/**
+ * Copy a set of messages ($id) to another mailbox ($mailbox)
+ * @param int $imap_stream The resource ID for the IMAP socket
+ * @param string $id The list of messages to copy
+ * @param string $mailbox The destination to copy to
+ * @param bool $handle_errors Show error messages in case of a NO, BAD or BYE response
+ * @return bool If the copy completed without errors
+ */
+function sqimap_msgs_list_copy($imap_stream, $id, $mailbox, $handle_errors = true) {
+ $msgs_id = sqimap_message_list_squisher($id);
+ $read = sqimap_run_command ($imap_stream, "COPY $msgs_id " . sqimap_encode_mailbox_name($mailbox), $handle_errors, $response, $message, TRUE);
+ if ($response == 'OK') {
+ return true;
+ } else {
+ return false;
+ }
}
-/* Deletes specified messages and moves them to trash if possible */
-function sqimap_messages_delete ($imap_stream, $start, $end, $mailbox) {
- global $move_to_trash, $trash_folder, $auto_expunge;
- if (($move_to_trash == true) && (sqimap_mailbox_exists($imap_stream, $trash_folder) && ($mailbox != $trash_folder))) {
- sqimap_messages_copy ($imap_stream, $start, $end, $trash_folder);
+/**
+ * Move a set of messages ($id) to another mailbox. Deletes the originals.
+ * @param int $imap_stream The resource ID for the IMAP socket
+ * @param string $id The list of messages to move
+ * @param string $mailbox The destination to move to
+ * @param bool $handle_errors Show error messages in case of a NO, BAD or BYE response
+ * @return bool If the move completed without errors
+ */
+function sqimap_msgs_list_move($imap_stream, $id, $mailbox, $handle_errors = true) {
+ $msgs_id = sqimap_message_list_squisher($id);
+ if (sqimap_msgs_list_copy ($imap_stream, $id, $mailbox, $handle_errors)) {
+ return sqimap_toggle_flag($imap_stream, $id, '\\Deleted', true, true);
+ } else {
+ return false;
}
- sqimap_messages_flag ($imap_stream, $start, $end, "Deleted");
}
-/* Sets the specified messages with specified flag */
-function sqimap_messages_flag ($imap_stream, $start, $end, $flag) {
- $read = sqimap_run_command ($imap_stream, "STORE $start:$end +FLAGS (\\$flag)", true, $response, $message);
-}
-/* Remove specified flag from specified messages */
-function sqimap_messages_remove_flag ($imap_stream, $start, $end, $flag) {
- $read = sqimap_run_command ($imap_stream, "STORE $start:$end -FLAGS (\\$flag)", true, $response, $message);
+/**
+ * Deletes a message and move it to trash or expunge the mailbox
+ * @param resource imap connection
+ * @param string $mailbox mailbox, used for checking if it concerns the trash_folder
+ * @param array $id list with uid's
+ * @param bool $bypass_trash (since 1.5.0) skip copy to trash
+ * @return array $aMessageList array with messages containing the new flags and UID @see parseFetch
+ * @since 1.4.0
+ */
+function sqimap_msgs_list_delete($imap_stream, $mailbox, $id, $bypass_trash=false) {
+ // FIX ME, remove globals by introducing an associative array with properties
+ // as 4th argument as replacement for the bypass_trash var
+ global $move_to_trash, $trash_folder;
+ $bRes = true;
+ if (($move_to_trash == true) && ($bypass_trash != true) &&
+ (sqimap_mailbox_exists($imap_stream, $trash_folder) && ($mailbox != $trash_folder)) ) {
+ $bRes = sqimap_msgs_list_copy ($imap_stream, $id, $trash_folder);
+ }
+ if ($bRes) {
+ return sqimap_toggle_flag($imap_stream, $id, '\\Deleted', true, true);
+ } else {
+ return false;
+ }
}
-/* Returns some general header information -- FROM, DATE, and SUBJECT */
-class small_header {
- var $from = '', $subject = '', $date = '', $to = '',
- $priority = 0, $message_id = 0, $cc = '';
-}
-function sqimap_get_small_header ($imap_stream, $id, $sent) {
- $res = sqimap_get_small_header_list($imap_stream, array($id), $sent);
- return $res[0];
+/**
+ * Set a flag on the provided uid list
+ * @param resource imap connection
+ * @param array $id list with uid's
+ * @param string $flag Flags to set/unset flags can be i.e.'\Seen', '\Answered', '\Seen \Answered'
+ * @param bool $set add (true) or remove (false) the provided flag
+ * @param bool $handle_errors Show error messages in case of a NO, BAD or BYE response
+ * @return array $aMessageList array with messages containing the new flags and UID @see parseFetch
+ */
+function sqimap_toggle_flag($imap_stream, $id, $flag, $set, $handle_errors) {
+ $msgs_id = sqimap_message_list_squisher($id);
+ $set_string = ($set ? '+' : '-');
+ $aResponse = sqimap_run_command_list($imap_stream, "STORE $msgs_id ".$set_string."FLAGS ($flag)", $handle_errors, $response, $message, TRUE);
+ // parse the fetch response
+ return parseFetch($aResponse);
}
-/*
+
+/**
* Sort the message list and crunch to be as small as possible
* (overflow could happen, so make it small if possible)
*/
function sqimap_message_list_squisher($messages_array) {
if( !is_array( $messages_array ) ) {
- return;
+ return $messages_array;
}
+
sort($messages_array, SORT_NUMERIC);
$msgs_str = '';
while ($messages_array) {
$msgs_str .= ':' . $end;
}
}
-
return $msgs_str;
}
-/* returns the references header lines */
-function get_reference_header ($imap_stream, $message) {
- $responses = array ();
- $sid = sqimap_session_id();
- $results = array();
- $references = "";
- $query = "$sid FETCH $message BODY[HEADER.FIELDS (References)]\r\n";
- fputs ($imap_stream, $query);
- $responses = sqimap_read_data_list($imap_stream, $sid, true, $responses, $message);
- if (!eregi("^\\* ([0-9]+) FETCH", $responses[0][0], $regs)) {
- $responses = array ();
- }
- return $responses;
+
+/**
+ * Retrieves an array with a sorted uid list. Sorting is done on the imap server
+ * @link http://www.ietf.org/internet-drafts/draft-ietf-imapext-sort-17.txt
+ * @param resource $imap_stream IMAP socket connection
+ * @param string $sSortField Field to sort on
+ * @param bool $reverse Reverse order search
+ * @return array $id sorted uid list
+ */
+function sqimap_get_sort_order($imap_stream, $sSortField, $reverse, $search='ALL') {
+ global $default_charset;
+
+ if ($sSortField) {
+ if ($reverse) {
+ $sSortField = 'REVERSE '.$sSortField;
+ }
+ $query = "SORT ($sSortField) ".strtoupper($default_charset)." $search";
+ // FIX ME sqimap_run_command should return the parsed data accessible by $aDATA['SORT']
+ $aData = sqimap_run_command ($imap_stream, $query, false, $response, $message, TRUE);
+ /* fallback to default charset */
+ if ($response == 'NO' && strpos($message,'[BADCHARSET]') !== false) {
+ $query = "SORT ($sSortField) US-ASCII $search";
+ $aData = sqimap_run_command ($imap_stream, $query, true, $response, $message, TRUE);
+ }
+ }
+
+ if ($response == 'OK') {
+ return parseUidList($aData,'SORT');
+ } else {
+ return false;
+ }
}
-/* get sort order from server and
- * return it as the $id array for
- * mailbox_display
+/**
+ * Parses a UID list returned on a SORT or SEARCH request
+ * @param array $aData imap response
+ * @param string $sCommand issued imap command (SEARCH or SORT)
+ * @return array $aUid uid list
*/
-
-function sqimap_get_sort_order ($imap_stream, $sort) {
- global $default_charset, $thread_sort_messages,
- $internal_date_sort, $server_sort_array,
- $sent_folder, $mailbox;
-
- if (session_is_registered('server_sort_array')) {
- session_unregister('server_sort_array');
- }
- if ($sort == 6) {
- $qty = sqimap_get_num_messages ($imap_stream, $mailbox);
- $server_sort_array = range(1, $qty);
- session_register('server_sort_array');
- return $server_sort_array;
- }
- $sid = sqimap_session_id();
- $sort_on = array();
- $reverse = 0;
- $server_sort_array = array();
- $sort_test = array();
- $sort_query = '';
- $sort_on = array (0=> 'DATE',
- 1=> 'DATE',
- 2=> 'FROM',
- 3=> 'FROM',
- 4=> 'SUBJECT',
- 5=> 'SUBJECT');
- if ($internal_date_sort == true) {
- $sort_on[0] = 'ARRIVAL';
- $sort_on[1] = 'ARRIVAL';
- }
- if ($sent_folder == $mailbox) {
- $sort_on[2] = 'TO';
- $sort_on[3] = 'TO';
- }
- if (!empty($sort_on[$sort])) {
- $sort_query = "$sid SORT ($sort_on[$sort]) ".strtoupper($default_charset)." ALL\r\n";
- fputs($imap_stream, $sort_query);
- $sort_test = sqimap_read_data($imap_stream, $sid, false, $response, $message);
- }
- if (isset($sort_test[0])) {
- if (preg_match("/^\* SORT (.+)$/", $sort_test[0], $regs)) {
- $server_sort_array = preg_split("/ /", trim($regs[1]));
+function parseUidList($aData,$sCommand) {
+ $aUid = array();
+ if (isset($aData) && count($aData)) {
+ for ($i=0,$iCnt=count($aData);$i<$iCnt;++$i) {
+ if (preg_match("/^\* $sCommand (.+)$/", $aData[$i], $aMatch)) {
+ $aUid += preg_split("/ /", trim($aMatch[1]));
+ }
}
}
- if ($sort == 0 || $sort == 2 || $sort == 4) {
- $server_sort_array = array_reverse($server_sort_array);
+ return array_unique($aUid);
+}
+
+/**
+ * Retrieves an array with a sorted uid list. Sorting is done by SquirrelMail
+ *
+ * @param resource $imap_stream IMAP socket connection
+ * @param string $sSortField Field to sort on
+ * @param bool $reverse Reverse order search
+ * @param array $aUid limit the search to the provided array with uid's default sqimap_get_small_headers uses 1:*
+ * @return array $aUid sorted uid list
+ */
+function get_squirrel_sort($imap_stream, $sSortField, $reverse = false, $aUid = NULL) {
+ if ($sSortField != 'RFC822.SIZE' && $sSortField != 'INTERNALDATE') {
+ $msgs = sqimap_get_small_header_list($imap_stream, $aUid,
+ array($sSortField), array());
+ } else {
+ $msgs = sqimap_get_small_header_list($imap_stream, $aUid,
+ array(), array($sSortField));
}
- if (!preg_match("/OK/", $response)) {
- $server_sort_array = 'no';
- }
- session_register('server_sort_array');
- return $server_sort_array;
+ $aUid = array();
+ $walk = false;
+ switch ($sSortField) {
+ // natcasesort section
+ case 'FROM':
+ case 'TO':
+ case 'CC':
+ if(!$walk) {
+ array_walk($msgs, create_function('&$v,&$k,$f',
+ '$v[$f] = (isset($v[$f])) ? $v[$f] : "";
+ $addr = reset(parseRFC822Address($v[$f],1));
+ $sPersonal = (isset($addr[SQM_ADDR_PERSONAL]) && $addr[SQM_ADDR_PERSONAL]) ?
+ $addr[SQM_ADDR_PERSONAL] : "";
+ $sEmail = ($addr[SQM_ADDR_HOST]) ?
+ $addr[SQM_ADDR_MAILBOX] . "@".$addr[SQM_ADDR_HOST] :
+ $addr[SQM_ADDR_HOST];
+ $v[$f] = ($sPersonal) ? decodeHeader($sPersonal):$sEmail;'),$sSortField);
+ $walk = true;
+ }
+ // nobreak
+ case 'SUBJECT':
+ if(!$walk) {
+ array_walk($msgs, create_function('&$v,&$k,$f',
+ '$v[$f] = (isset($v[$f])) ? $v[$f] : "";
+ $v[$f] = strtolower(decodeHeader(trim($v[$f])));
+ $v[$f] = (preg_match("/^(vedr|sv|re|aw|\[\w\]):\s*(.*)$/si", $v[$f], $matches)) ?
+ $matches[2] : $v[$f];'),$sSortField);
+ $walk = true;
+ }
+ foreach ($msgs as $item) {
+ $aUid[$item['UID']] = $item[$sSortField];
+ }
+ natcasesort($aUid);
+ $aUid = array_keys($aUid);
+ if ($reverse) {
+ $aUid = array_reverse($aUid);
+ }
+ break;
+ // \natcasesort section
+ // sort_numeric section
+ case 'DATE':
+ case 'INTERNALDATE':
+ if(!$walk) {
+ array_walk($msgs, create_function('&$v,$k,$f',
+ '$v[$f] = (isset($v[$f])) ? $v[$f] : "";
+ $v[$f] = getTimeStamp(explode(" ",$v[$f]));'),$sSortField);
+ $walk = true;
+ }
+ // nobreak;
+ case 'RFC822.SIZE':
+ if(!$walk) {
+ // redefine $sSortField to maintain the same namespace between
+ // server-side sorting and SquirrelMail sorting
+ $sSortField = 'SIZE';
+ }
+ foreach ($msgs as $item) {
+ $aUid[$item['UID']] = (isset($item[$sSortField])) ? $item[$sSortField] : 0;
+ }
+ if ($reverse) {
+ arsort($aUid,SORT_NUMERIC);
+ } else {
+ asort($aUid, SORT_NUMERIC);
+ }
+ $aUid = array_keys($aUid);
+ break;
+ // \sort_numeric section
+ case 'UID':
+ $aUid = array_reverse($msgs);
+ break;
+ }
+ return $aUid;
}
-
-/* returns an indent array for printMessageinfo()
- this represents the amount of indent needed (value)
- for this message number (key)
-*/
-
-function get_parent_level ($imap_stream) {
- global $sort_by_ref, $default_charset, $thread_new;
- $parent = "";
- $child = "";
- $cutoff = 0;
-
- /* loop through the threads and take unwanted characters out
- of the thread string then chop it up
+
+
+/**
+ * Returns an indent array for printMessageinfo()
+ * This represents the amount of indent needed (value),
+ * for this message number (key)
+ */
+
+/*
+ * Notes for future work:
+ * indent_array should contain: indent_level, parent and flags,
+ * sibling notes ..
+ * To achieve that we need to define the following flags:
+ * 0: hasnochildren
+ * 1: haschildren
+ * 2: is first
+ * 4: is last
+ * a node has sibling nodes if it's not the last node
+ * a node has no sibling nodes if it's the last node
+ * By using binary comparations we can store the flag in one var
+ *
+ * example:
+ * -1 par = 0, level = 0, flag = 1 + 2 + 4 = 7 (haschildren, isfirst, islast)
+ * \-2 par = 1, level = 1, flag = 0 + 2 = 2 (hasnochildren, isfirst)
+ * |-3 par = 1, level = 1, flag = 1 + 4 = 5 (haschildren, islast)
+ * \-4 par = 3, level = 2, flag = 1 + 2 + 4 = 7 (haschildren, isfirst, islast)
+ * \-5 par = 4, level = 3, flag = 0 + 2 + 4 = 6 (hasnochildren, isfirst, islast)
+ */
+function get_parent_level($thread_new) {
+ $parent = '';
+ $child = '';
+ $cutoff = 0;
+
+ /*
+ * loop through the threads and take unwanted characters out
+ * of the thread string then chop it up
*/
for ($i=0;$i<count($thread_new);$i++) {
$thread_new[$i] = preg_replace("/\s\(/", "(", $thread_new[$i]);
$thread_new[$i] = preg_replace("/(\d+)/", "$1|", $thread_new[$i]);
$thread_new[$i] = preg_split("/\|/", $thread_new[$i], -1, PREG_SPLIT_NO_EMPTY);
- }
+ }
$indent_array = array();
- if (!$thread_new) {
- $thread_new = array();
- }
+ if (!$thread_new) {
+ $thread_new = array();
+ }
/* looping through the parts of one message thread */
-
+
for ($i=0;$i<count($thread_new);$i++) {
- /* first grab the parent, it does not indent */
-
+ /* first grab the parent, it does not indent */
+
if (isset($thread_new[$i][0])) {
if (preg_match("/(\d+)/", $thread_new[$i][0], $regs)) {
$parent = $regs[1];
}
$indent_array[$parent] = 0;
- /* now the children, checking each thread portion for
- ),(, and space, adjusting the level and space values
- to get the indent level
- */
+ /*
+ * now the children, checking each thread portion for
+ * ),(, and space, adjusting the level and space values
+ * to get the indent level
+ */
$level = 0;
$spaces = array();
$spaces_total = 0;
$indent = 0;
$fake = FALSE;
- for ($k=1;$k<(count($thread_new[$i]))-1;$k++) {
+ for ($k=1,$iCnt=count($thread_new[$i])-1;$k<$iCnt;++$k) {
$chars = count_chars($thread_new[$i][$k], 1);
if (isset($chars['40'])) { /* testing for ( */
- $level = $level + $chars['40'];
+ $level += $chars['40'];
}
if (isset($chars['41'])) { /* testing for ) */
- $level = $level - $chars['41'];
+ $level -= $chars['41'];
$spaces[$level] = 0;
/* if we were faking lets stop, this portion
- of the thread is over
- */
+ * of the thread is over
+ */
if ($level == $cutoff) {
$fake = FALSE;
}
if (!isset($spaces[$level])) {
$spaces[$level] = 0;
}
- $spaces[$level] = $spaces[$level] + $chars['32'];
+ $spaces[$level] += $chars['32'];
}
for ($x=0;$x<=$level;$x++) {
if (isset($spaces[$x])) {
- $spaces_total = $spaces_total + $spaces[$x];
+ $spaces_total += $spaces[$x];
}
}
$indent = $level + $spaces_total;
/* must have run into a message that broke the thread
- so we are adjusting for that portion
- */
+ * so we are adjusting for that portion
+ */
if ($fake == TRUE) {
$indent = $indent +1;
}
$child = $regs[1];
}
/* the thread must be broken if $indent == 0
- so indent the message once and start faking it
- */
+ * so indent the message once and start faking it
+ */
if ($indent == 0) {
$indent = 1;
$fake = TRUE;
$cutoff = $level;
}
/* dont need abs but if indent was negative
- errors would occur
- */
- $indent_array[$child] = abs($indent);
+ * errors would occur
+ */
+ $indent_array[$child] = ($indent < 0) ? 0 : $indent;
$spaces_total = 0;
- }
+ }
}
return $indent_array;
}
-/* returns an array with each element as a string
- representing one message thread as returned by
- the IMAP server
-*/
+/**
+ * Returns an array with each element as a string representing one
+ * message-thread as returned by the IMAP server.
+ * @link http://www.ietf.org/internet-drafts/draft-ietf-imapext-sort-13.txt
+ */
+function get_thread_sort($imap_stream, $search='ALL') {
+ global $thread_new, $sort_by_ref, $default_charset, $server_sort_array, $indent_array;
-function get_thread_sort ($imap_stream) {
- global $thread_new, $sort_by_ref, $default_charset, $server_sort_array;
- if (session_is_registered('thread_new')) {
- session_unregister('thread_new');
- }
- if (session_is_registered('server_sort_array')) {
- session_unregister('server_srot_array');
- }
- $sid = sqimap_session_id();
$thread_temp = array ();
if ($sort_by_ref == 1) {
$sort_type = 'REFERENCES';
- }
- else {
+ } else {
$sort_type = 'ORDEREDSUBJECT';
}
- $thread_query = "$sid THREAD $sort_type ".strtoupper($default_charset)." ALL\r\n";
- fputs($imap_stream, $thread_query);
- $thread_test = sqimap_read_data($imap_stream, $sid, false, $response, $message);
+ $query = "THREAD $sort_type ".strtoupper($default_charset)." $search";
+
+ $thread_test = sqimap_run_command ($imap_stream, $query, false, $response, $message, TRUE);
+ /* fallback to default charset */
+ if ($response == 'NO' && strpos($message,'[BADCHARSET]') !== false) {
+ $query = "THREAD $sort_type US-ASCII $search";
+ $thread_test = sqimap_run_command ($imap_stream, $query, true, $response, $message, TRUE);
+ }
if (isset($thread_test[0])) {
- if (preg_match("/^\* THREAD (.+)$/", $thread_test[0], $regs)) {
- $thread_list = trim($regs[1]);
+ for ($i=0,$iCnt=count($thread_test);$i<$iCnt;++$i) {
+ if (preg_match("/^\* THREAD (.+)$/", $thread_test[$i], $regs)) {
+ $thread_list = trim($regs[1]);
+ break;
+ }
}
- }
- else {
- $thread_list = "";
+ } else {
+ $thread_list = "";
}
if (!preg_match("/OK/", $response)) {
- $server_sort_array = 'no';
- return $server_sort_array;
- }
+ $server_sort_array = 'no';
+ return $server_sort_array;
+ }
if (isset($thread_list)) {
$thread_temp = preg_split("//", $thread_list, -1, PREG_SPLIT_NO_EMPTY);
}
- $char_count = count($thread_temp);
+
$counter = 0;
$thread_new = array();
$k = 0;
$thread_new[0] = "";
- for ($i=0;$i<$char_count;$i++) {
- if ($thread_temp[$i] != ')' && $thread_temp[$i] != '(') {
- $thread_new[$k] = $thread_new[$k] . $thread_temp[$i];
- }
- elseif ($thread_temp[$i] == '(') {
- $thread_new[$k] .= $thread_temp[$i];
- $counter++;
- }
- elseif ($thread_temp[$i] == ')') {
- if ($counter > 1) {
- $thread_new[$k] .= $thread_temp[$i];
- $counter = $counter - 1;
- }
- else {
- $thread_new[$k] .= $thread_temp[$i];
- $k++;
- $thread_new[$k] = "";
- $counter = $counter - 1;
- }
+ /*
+ * parse the thread response into separate threads
+ *
+ * example:
+ * [0] => (540)
+ * [1] => (1386)
+ * [2] => (1599 759 959 37)
+ * [3] => (492 1787)
+ * [4] => ((933)(1891))
+ * [5] => (1030 (1497)(845)(1637))
+ */
+ for ($i=0,$iCnt=count($thread_temp);$i<$iCnt;$i++) {
+ if ($thread_temp[$i] != ')' && $thread_temp[$i] != '(') {
+ $thread_new[$k] = $thread_new[$k] . $thread_temp[$i];
+ } elseif ($thread_temp[$i] == '(') {
+ $thread_new[$k] .= $thread_temp[$i];
+ $counter++;
+ } elseif ($thread_temp[$i] == ')') {
+ if ($counter > 1) {
+ $thread_new[$k] .= $thread_temp[$i];
+ $counter = $counter - 1;
+ } else {
+ $thread_new[$k] .= $thread_temp[$i];
+ $k++;
+ $thread_new[$k] = "";
+ $counter = $counter - 1;
}
+ }
}
- session_register('thread_new');
+
$thread_new = array_reverse($thread_new);
+ /* place the threads after each other in one string */
$thread_list = implode(" ", $thread_new);
$thread_list = str_replace("(", " ", $thread_list);
$thread_list = str_replace(")", " ", $thread_list);
$thread_list = preg_split("/\s/", $thread_list, -1, PREG_SPLIT_NO_EMPTY);
$server_sort_array = $thread_list;
- session_register('server_sort_array');
- return $thread_list;
-}
-function elapsedTime($start) {
- $stop = gettimeofday();
- $timepassed = 1000000 * ($stop['sec'] - $start['sec']) + $stop['usec'] - $start['usec'];
- return $timepassed;
+ $indent_array = get_parent_level ($thread_new);
+ return array($thread_list,$indent_array);
}
-function sqimap_get_small_header_list ($imap_stream, $msg_list, $issent) {
- global $squirrelmail_language, $color, $data_dir, $username, $imap_server_type;
- $start = gettimeofday();
- /* Get the small headers for each message in $msg_list */
- $sid = sqimap_session_id();
- $maxmsg = sizeof($msg_list);
- $msgs_str = sqimap_message_list_squisher($msg_list);
- $results = array();
- $read_list = array();
- /*
- * We need to return the data in the same order as the caller supplied
- * in $msg_list, but IMAP servers are free to return responses in
- * whatever order they wish... So we need to re-sort manually
- */
- for ($i = 0; $i < sizeof($msg_list); $i++) {
- $id2index[$msg_list[$i]] = $i;
- }
-
- $internaldate = getPref($data_dir, $username, 'internal_date_sort');
- if ($internaldate) {
- $query = "$sid FETCH $msgs_str (FLAGS RFC822.SIZE INTERNALDATE BODY.PEEK[HEADER.FIELDS (Date To From Cc Subject X-Priority Content-Type)])\r\n";
- } else {
- $query = "$sid FETCH $msgs_str (FLAGS RFC822.SIZE BODY.PEEK[HEADER.FIELDS (Date To From Cc Subject X-Priority Content-Type)])\r\n";
- }
- fputs ($imap_stream, $query);
- $readin_list = sqimap_read_data_list($imap_stream, $sid, true, $response, $message);
-
- foreach ($readin_list as $r) {
- if (!preg_match("/^\\*\s+([0-9]+)\s+FETCH/iAU",$r[0], $regs)) {
- set_up_language($squirrelmail_language);
- echo '<br><b><font color=$color[2]>' .
- _("ERROR : Could not complete request.") .
- '</b><br>' .
- _("Unknown response from IMAP server: ") . ' 1.' .
- $r[0] . "</font><br>\n";
-
- } else if (! isset($id2index[$regs[1]]) || !count($id2index[$regs[1]])) {
- set_up_language($squirrelmail_language);
- echo '<br><b><font color=$color[2]>' .
- _("ERROR : Could not complete request.") .
- '</b><br>' .
- _("Unknown message number in reply from server: ") .
- $regs[1] . "</font><br>\n";
- } else {
- $read_list[$id2index[$regs[1]]] = $r;
- }
- }
- arsort($read_list);
-
- $patterns = array (
- "/^To:(.*)\$/AU",
- "/^From:(.*)\$/AU",
- "/^X-Priority:(.*)\$/AU",
- "/^Cc:(.*)\$/AU",
- "/^Date:(.*)\$/AU",
- "/^Subject:(.*)\$/AU",
- "/^Content-Type:(.*)\$/AU"
- );
- $regpattern = '';
-
- for ($msgi = 0; $msgi < $maxmsg; $msgi++) {
- $subject = _("(no subject)");
- $from = _("Unknown Sender");
- $priority = 0;
- $messageid = "<>";
- $cc = "";
- $to = "";
- $date = "";
- $type[0] = "";
- $type[1] = "";
- $inrepto = "";
- $flag_seen = false;
- $flag_answered = false;
- $flag_deleted = false;
- $flag_flagged = false;
- $read = $read_list[$msgi];
- $prevline = false;
-
- foreach ($read as $read_part) {
- //unfold multi-line headers
- while ($prevline && strspn($read_part, "\t ") > 0) {
- $read_part = substr($prevline, 0, -2) . ' ' . ltrim($read_part);
- }
- $prev_line = $read_part;
-
- if ($read_part{0} == '*') {
- if ($internaldate) {
- if (preg_match ("/^.+INTERNALDATE\s+\"(.+)\".+/iUA",$read_part, $reg)) {
- $tmpdate = trim($reg[1]);
- $tmpdate = str_replace(' ',' ',$tmpdate);
- $tmpdate = explode(' ',$tmpdate);
- $date = str_replace('-',' ',$tmpdate[0]) . " " .
- $tmpdate[1] . " " .
- $tmpdate[2];
- }
- }
- if (preg_match ("/^.+RFC822.SIZE\s+(\d+).+/iA",$read_part, $reg)) {
- $size = $reg[1];
- }
- if (preg_match("/^.+FLAGS\s+\((.*)\).+/iUA", $read_part, $regs)) {
- $flags = explode(' ',trim($regs[1]));
- foreach ($flags as $flag) {
- $flag = strtolower($flag);
- if ($flag == '\\seen') {
- $flag_seen = true;
- } else if ($flag == '\\answered') {
- $flag_answered = true;
- } else if ($flag == '\\deleted') {
- $flag_deleted = true;
- } else if ($flag == '\\flagged') {
- $flag_flagged = true;
- }
- }
- }
- } else {
- $firstchar = $read_part{0};
- if ($firstchar == 'T') {
- $regpattern = $patterns[0];
- $id = 1;
- } else if ($firstchar == 'F') {
- $regpattern = $patterns[1];
- $id = 2;
- } else if ($firstchar == 'X') {
- $regpattern = $patterns[2];
- $id = 3;
- } else if ($firstchar == 'C') {
- if (strtolower($read_part{1}) == 'c') {
- $regpattern = $patterns[3];
- $id = 4;
- } else if (strtolower($read_part{1}) == 'o') {
- $regpattern = $patterns[6];
- $id = 7;
- }
- } else if ($firstchar == 'D' && !$internaldate ) {
- $regpattern = $patterns[4];
- $id = 5;
- } else if ($firstchar == 'S') {
- $regpattern = $patterns[5];
- $id = 6;
- } else $regpattern = '';
-
- if ($regpattern) {
- if (preg_match ($regpattern, $read_part, $regs)) {
- switch ($id) {
- case 1:
- $to = $regs[1];
- break;
- case 2:
- $from = $regs[1];
- break;
- case 3:
- $priority = $regs[1];
- break;
- case 4:
- $cc = $regs[1];
- break;
- case 5:
- $date = $regs[1];
- break;
- case 6:
- $subject = htmlspecialchars(trim($regs[1]));
- if ($subject == "") {
- $subject = _("(no subject)");
- }
- break;
- case 7:
- $type = strtolower(trim($regs[1]));
- if ($pos = strpos($type, ";")) {
- $type = substr($type, 0, $pos);
- }
- $type = explode("/", $type);
- if (!isset($type[1])) {
- $type[1] = '';
- }
- break;
- default:
- break;
- }
- }
- }
- }
-
- }
- $header = new small_header;
- if ($issent) {
- $header->from = (trim($to) != '' ? $to : '(' ._("No To Address") . ')');
- } else {
- $header->from = $from;
- }
-
- $header->date = $date;
- $header->subject = $subject;
- $header->to = $to;
- $header->priority = $priority;
- $header->message_id = $messageid;
- $header->cc = $cc;
- $header->size = $size;
- $header->type0 = $type[0];
- $header->type1 = $type[1];
- $header->flag_seen = $flag_seen;
- $header->flag_answered = $flag_answered;
- $header->flag_deleted = $flag_deleted;
- $header->flag_flagged = $flag_flagged;
- $header->inrepto = $inrepto;
- $result[] = $header;
- }
-// echo 'processtime (us): ' . elapsedtime($start) .'<BR>';
- return $result;
+function elapsedTime($start) {
+ $stop = gettimeofday();
+ $timepassed = 1000000 * ($stop['sec'] - $start['sec']) + $stop['usec'] - $start['usec'];
+ return $timepassed;
}
-
-
-/* Returns the flags for the specified messages */
-function sqimap_get_flags ($imap_stream, $i) {
- $read = sqimap_run_command ($imap_stream, "FETCH $i:$i FLAGS", true, $response, $message);
- if (ereg('FLAGS(.*)', $read[0], $regs)) {
- return explode(' ', trim(ereg_replace('[\\(\\)\\\\]', '', $regs[1])));
+/**
+ * Normalise the different Priority headers into a uniform value,
+ * namely that of the X-Priority header (1, 3, 5). Supports:
+ * Prioirty, X-Priority, Importance.
+ * X-MS-Mail-Priority is not parsed because it always coincides
+ * with one of the other headers.
+ *
+ * FIXME: DUPLICATE CODE ALERT:
+ * NOTE: this is actually a duplicate from the function in
+ * class/mime/Rfc822Header.php.
+ * @todo obsolate function or use it instead of code block in parseFetch()
+ */
+function parsePriority($sValue) {
+ $aValue = split('/\w/',trim($sValue));
+ $value = strtolower(array_shift($aValue));
+ if ( is_numeric($value) ) {
+ return $value;
}
- return array('None');
-}
-
-function sqimap_get_flags_list ($imap_stream, $msg_list) {
- $msgs_str = sqimap_message_list_squisher($msg_list);
- for ($i = 0; $i < sizeof($msg_list); $i++) {
- $id2index[$msg_list[$i]] = $i;
+ if ( $value == 'urgent' || $value == 'high' ) {
+ return 1;
+ } elseif ( $value == 'non-urgent' || $value == 'low' ) {
+ return 5;
}
- $result_list = sqimap_run_command_list ($imap_stream, "FETCH $msgs_str FLAGS", true, $response, $message);
- $result_flags = array();
+ return 3;
+}
- for ($i = 0; $i < sizeof($result_list); $i++) {
- if (eregi('^\* ([0-9]+).*FETCH.*FLAGS(.*)', $result_list[$i][0], $regs)
- && isset($id2index[$regs[1]]) && count($id2index[$regs[1]])) {
- $result_flags[$id2index[$regs[1]]] = explode(" ", trim(ereg_replace('[\\(\\)\\\\]', '', $regs[2])));
- } else {
- set_up_language($squirrelmail_language);
- echo "<br><b><font color=$color[2]>\n" .
- _("ERROR : Could not complete request.") .
- "</b><br>\n" .
- _("Unknown response from IMAP server: ") .
- $result_list[$i][0] . "</font><br>\n";
- exit;
+/**
+ * Parses a string in an imap response. String starts with " or { which means it
+ * can handle double quoted strings and literal strings
+ *
+ * @param string $read imap response
+ * @param integer $i (reference) offset in string
+ * @return string $s parsed string without the double quotes or literal count
+ */
+function parseString($read,&$i) {
+ $char = $read{$i};
+ $s = '';
+ if ($char == '"') {
+ $iPos = ++$i;
+ while (true) {
+ $iPos = strpos($read,'"',$iPos);
+ if (!$iPos) break;
+ if ($iPos && $read{$iPos -1} != '\\') {
+ $s = substr($read,$i,($iPos-$i));
+ $i = $iPos;
+ break;
+ }
+ $iPos++;
+ if ($iPos > strlen($read)) {
+ break;
+ }
+ }
+ } else if ($char == '{') {
+ $lit_cnt = '';
+ ++$i;
+ $iPos = strpos($read,'}',$i);
+ if ($iPos) {
+ $lit_cnt = substr($read, $i, $iPos - $i);
+ $i += strlen($lit_cnt) + 3; /* skip } + \r + \n */
+ /* Now read the literal */
+ $s = ($lit_cnt ? substr($read,$i,$lit_cnt): '');
+ $i += $lit_cnt;
+ /* temp bugfix (SM 1.5 will have a working clean version)
+ too much work to implement that version right now */
+ --$i;
+ } else { /* should never happen */
+ $i += 3; /* } + \r + \n */
+ $s = '';
}
+ } else {
+ return false;
}
- arsort($result_flags);
- return $result_flags;
+ ++$i;
+ return $s;
}
-/*
- * Returns a message array with all the information about a message.
- * See the documentation folder for more information about this array.
+
+/**
+ * Parses a string containing an array from an imap response. String starts with ( and end with )
+ *
+ * @param string $read imap response
+ * @param integer $i (reference) offset in string
+ * @return array $a
*/
-function sqimap_get_message ($imap_stream, $id, $mailbox) {
- $header = sqimap_get_message_header($imap_stream, $id, $mailbox);
- return sqimap_get_message_body($imap_stream, $header);
+function parseArray($read,&$i) {
+ $i = strpos($read,'(',$i);
+ $i_pos = strpos($read,')',$i);
+ $s = substr($read,$i+1,$i_pos - $i -1);
+ $a = explode(' ',$s);
+ if ($i_pos) {
+ $i = $i_pos+1;
+ return $a;
+ } else {
+ return false;
+ }
}
-/* Wrapper function that reformats the header information. */
-function sqimap_get_message_header ($imap_stream, $id, $mailbox) {
- $read = sqimap_run_command ($imap_stream, "FETCH $id:$id BODY[HEADER]", true, $response, $message);
- $header = sqimap_get_header($imap_stream, $read);
- $header->id = $id;
- $header->mailbox = $mailbox;
- return $header;
-}
-/* Wrapper function that reformats the entity header information. */
-function sqimap_get_ent_header ($imap_stream, $id, $mailbox, $ent) {
- $read = sqimap_run_command ($imap_stream, "FETCH $id:$id BODY[$ent.HEADER]", true, $response, $message);
- $header = sqimap_get_header($imap_stream, $read);
- $header->id = $id;
- $header->mailbox = $mailbox;
- return $header;
-}
+/**
+ * Retrieves a list with headers, flags, size or internaldate from the imap server
+ *
+ * WARNING: function is not portable between SquirrelMail 1.2.x, 1.4.x and 1.5.x.
+ * Output format, third argument and $msg_list array format requirements differ.
+ * @param stream $imap_stream imap connection
+ * @param array $msg_list array with id's to create a msgs set from
+ * @param array $aHeaderFields (since 1.5.0) requested header fields
+ * @param array $aFetchItems (since 1.5.0) requested other fetch items like FLAGS, RFC822.SIZE
+ * @return array $aMessages associative array with messages. Key is the UID, value is an associative array
+ * @since 1.1.3
+ */
+function sqimap_get_small_header_list($imap_stream, $msg_list,
+ $aHeaderFields = array('Date', 'To', 'Cc', 'From', 'Subject', 'X-Priority', 'Content-Type'),
+ $aFetchItems = array('FLAGS', 'RFC822.SIZE', 'INTERNALDATE')) {
+ $aMessageList = array();
-/* Wrapper function that returns entity headers for use by decodeMime */
-/*
-function sqimap_get_entity_header ($imap_stream, &$read, &$type0, &$type1, &$bound, &$encoding, &$charset, &$filename) {
- $header = sqimap_get_header($imap_stream, $read);
- $type0 = $header["TYPE0"];
- $type1 = $header["TYPE1"];
- $bound = $header["BOUNDARY"];
- $encoding = $header["ENCODING"];
- $charset = $header["CHARSET"];
- $filename = $header["FILENAME"];
-}
+ /**
+ * Catch other priority headers as well
+ */
+ if (in_array('X-Priority',$aHeaderFields,true)) {
+ $aHeaderFields[] = 'Importance';
+ $aHeaderFields[] = 'Priority';
+ }
-/* function to get the mime headers */
-function sqimap_get_mime_ent_header ($imap_stream, $id, $mailbox, $ent) {
- $read = sqimap_run_command ($imap_stream, "FETCH $id:$id BODY[$ent.MIME]", true, $response, $message);
- $header = sqimap_get_header($imap_stream, $read);
- $header->id = $id;
- $header->mailbox = $mailbox;
- return $header;
-}
+ $bUidFetch = ! in_array('UID', $aFetchItems, true);
-*/
-/* Queries the IMAP server and gets all header information. */
-function sqimap_get_header ($imap_stream, $read) {
- global $where, $what;
-
- $hdr = new msg_header();
- $i = 0;
-
- /* Set up some defaults */
- $hdr->type0 = "text";
- $hdr->type1 = "plain";
- $hdr->charset = "us-ascii";
-
- $read_fold = array();
-
- while ($i < count($read)) {
- /* unfold multi-line headers */
- /* remember line for to, cc and bcc */
- $read_fold[] = $read[$i];
- $folded = false;
- while (($i + 1 < count($read)) && (strspn($read[$i + 1], "\t ") > 0) ) {
- if ($read[$i+1] != '') $read_fold[] = $read[$i+1];
- $read[$i + 1] = substr($read[$i], 0, -2) . ' ' . ltrim($read[$i+1]);
- array_splice($read, $i, 1);
- $folded = true;
- }
- if (!$folded) {
- $read_fold = array();
- }
-
- if (substr($read[$i], 0, 17) == "MIME-Version: 1.0") {
- $hdr->mime = true;
- $i++;
- }
- /* ENCODING TYPE */
- else if (substr(strtolower($read[$i]), 0, 26) == "content-transfer-encoding:") {
- $hdr->encoding = strtolower(trim(substr($read[$i], 26)));
- $i++;
- }
- /* CONTENT-TYPE */
- else if (strtolower(substr($read[$i], 0, 13)) == "content-type:") {
- $cont = strtolower(trim(substr($read[$i], 13)));
- if (strpos($cont, ";")) {
- $cont = substr($cont, 0, strpos($cont, ";"));
+ /* Get the small headers for each message in $msg_list */
+ if ($msg_list !== NULL) {
+ $msgs_str = sqimap_message_list_squisher($msg_list);
+ /*
+ * We need to return the data in the same order as the caller supplied
+ * in $msg_list, but IMAP servers are free to return responses in
+ * whatever order they wish... So we need to re-sort manually
+ */
+ if ($bUidFetch) {
+ for ($i = 0; $i < sizeof($msg_list); $i++) {
+ $aMessageList["$msg_list[$i]"] = array();
}
+ }
+ } else {
+ $msgs_str = '1:*';
+ }
- if (strpos($cont, "/")) {
- $hdr->type0 = substr($cont, 0, strpos($cont, "/"));
- $hdr->type1 = substr($cont, strpos($cont, "/")+1);
- } else {
- $hdr->type0 = $cont;
- }
+ /*
+ * Create the query
+ */
- $line = $read[$i];
- $i++;
- while ( (substr(substr($read[$i], 0, strpos($read[$i], " ")), -1) != ":") && (trim($read[$i]) != "") && (trim($read[$i]) != ")")) {
- str_replace("\n", "", $line);
- str_replace("\n", "", $read[$i]);
- $line = "$line $read[$i]";
- $i++;
- }
+ $sFetchItems = '';
+ $query = "FETCH $msgs_str (";
+ if (count($aFetchItems)) {
+ $sFetchItems = implode(' ',$aFetchItems);
+ }
+ if (count($aHeaderFields)) {
+ $sHeaderFields = implode(' ',$aHeaderFields);
+ $sFetchItems .= ' BODY.PEEK[HEADER.FIELDS ('.$sHeaderFields.')]';
+ }
+ $query .= trim($sFetchItems) . ')';
+ $aResponse = sqimap_run_command_list ($imap_stream, $query, true, $response, $message, $bUidFetch);
+ $aMessages = parseFetch($aResponse,$aMessageList);
+ array_reverse($aMessages);
+ return $aMessages;
+}
- /* Detect the boundary of a multipart message */
- if (eregi('boundary="([^"]+)"', $line, $regs)) {
- $hdr->boundary = $regs[1];
- }
- /* Detect the charset */
- if (strpos(strtolower(trim($line)), "charset=")) {
- $pos = strpos($line, "charset=") + 8;
- $charset = trim($line);
- if (strpos($line, ";", $pos) > 0) {
- $charset = substr($charset, $pos, strpos($line, ";", $pos)-$pos);
- } else {
- $charset = substr($charset, $pos);
+/**
+ * Parses a fetch response, currently it can hande FLAGS, HEADERS, RFC822.SIZE, INTERNALDATE and UID
+ * @param array $aResponse Imap response
+ * @param array $aMessageList Placeholder array for results. The keys of the
+ * placeholder array should be the UID so we can reconstruct the order.
+ * @return array $aMessageList associative array with messages. Key is the UID, value is an associative array
+ * @author Marc Groot Koerkamp
+ */
+function parseFetch($aResponse,$aMessageList = array()) {
+ for ($j=0,$iCnt=count($aResponse);$j<$iCnt;++$j) {
+ $aMsg = array();
+
+ $read = implode('',$aResponse[$j]);
+ // free up memmory
+ unset($aResponse[$j]); /* unset does not reindex the array. the for loop is safe */
+ /*
+ * #id<space>FETCH<space>(
+ */
+
+ /* extract the message id */
+ $i_space = strpos($read,' ',2);/* position 2ed <space> */
+ $id = substr($read,2/* skip "*<space>" */,$i_space -2);
+ $aMsg['ID'] = $id;
+ $fetch = substr($read,$i_space+1,5);
+ if (!is_numeric($id) && $fetch !== 'FETCH') {
+ $aMsg['ERROR'] = $read; // htmlspecialchars should be done just before display. this is backend code
+ break;
+ }
+ $i = strpos($read,'(',$i_space+5);
+ $read = substr($read,$i+1);
+ $i_len = strlen($read);
+ $i = 0;
+ while ($i < $i_len && $i !== false) {
+ /* get argument */
+ $read = trim(substr($read,$i));
+ $i_len = strlen($read);
+ $i = strpos($read,' ');
+ $arg = substr($read,0,$i);
+ ++$i;
+ /*
+ * use allcaps for imap items and lowcaps for headers as key for the $aMsg array
+ */
+ switch ($arg)
+ {
+ case 'UID':
+ $i_pos = strpos($read,' ',$i);
+ if (!$i_pos) {
+ $i_pos = strpos($read,')',$i);
}
- $charset = str_replace("\"", "", $charset);
- $hdr->charset = $charset;
- } else {
- $hdr->charset = "us-ascii";
- }
- /* Detect type in case of multipart/related */
- if (strpos(strtolower(trim($line)), "type=")) {
- $pos = strpos($line, "type=") + 6;
- $type = trim($line);
- if (strpos($line, ";", $pos) > 0) {
- $type = substr($type, $pos, strpos($line, ";", $pos)-$pos);
+ if ($i_pos) {
+ $unique_id = substr($read,$i,$i_pos-$i);
+ $i = $i_pos+1;
} else {
- $type = substr($type, $pos);
+ break 3;
}
- $hdr->type = $type;
- }
- }
- else if (strtolower(substr($read[$i], 0, 20)) == "content-disposition:") {
- /* Add better content-disposition support */
- $line = $read[$i];
- $i++;
- while ( (substr(substr($read[$i], 0, strpos($read[$i], " ")), -1) != ":") && (trim($read[$i]) != "") && (trim($read[$i]) != ")")) {
- str_replace("\n", "", $line);
- str_replace("\n", "", $read[$i]);
- $line = "$line $read[$i]";
- $i++;
- }
-
- /* Detects filename if any */
- if (strpos(strtolower(trim($line)), "filename=")) {
- $pos = strpos($line, "filename=") + 9;
- $name = trim($line);
- if (strpos($line, " ", $pos) > 0) {
- $name = substr($name, $pos, strpos($line, " ", $pos));
+ break;
+ case 'FLAGS':
+ $flags = parseArray($read,$i);
+ if (!$flags) break 3;
+ $aFlags = array();
+ foreach ($flags as $flag) {
+ $flag = strtolower($flag);
+ $aFlags[$flag] = true;
+ }
+ $aMsg['FLAGS'] = $aFlags;
+ break;
+ case 'RFC822.SIZE':
+ $i_pos = strpos($read,' ',$i);
+ if (!$i_pos) {
+ $i_pos = strpos($read,')',$i);
+ }
+ if ($i_pos) {
+ $aMsg['SIZE'] = substr($read,$i,$i_pos-$i);
+ $i = $i_pos+1;
} else {
- $name = substr($name, $pos);
+ break 3;
}
- $name = str_replace("\"", "", $name);
- $hdr->filename = $name;
- }
- }
- /* REPLY-TO */
- else if (strtolower(substr($read[$i], 0, 9)) == "reply-to:") {
- $hdr->replyto = trim(substr($read[$i], 9, strlen($read[$i])));
- $i++;
- }
- /* FROM */
- else if (strtolower(substr($read[$i], 0, 5)) == "from:") {
- $hdr->from = trim(substr($read[$i], 5, strlen($read[$i]) - 6));
- if (! isset($hdr->replyto) || $hdr->replyto == "") {
- $hdr->replyto = $hdr->from;
- }
- $i++;
- }
- /* DATE */
- else if (strtolower(substr($read[$i], 0, 5)) == "date:") {
- $d = substr($read[$i], 5);
- $d = trim($d);
- $d = strtr($d, array(' ' => ' '));
- $d = explode(' ', $d);
- $hdr->date = getTimeStamp($d);
- $i++;
- }
- /* SUBJECT */
- else if (strtolower(substr($read[$i], 0, 8)) == "subject:") {
- $hdr->subject = trim(substr($read[$i], 8, strlen($read[$i]) - 9));
- if (strlen(Chop($hdr->subject)) == 0) {
- $hdr->subject = _("(no subject)");
- }
- /*
- if ($where == 'SUBJECT') {
- $hdr->subject = $what;
- // $hdr->subject = eregi_replace($what, "<b>\\0</b>", $hdr->subject);
- }
- */
- $i++;
- }
- /* CC */
- else if (strtolower(substr($read[$i], 0, 3)) == "cc:") {
- $pos = 0;
- if (isset($read_fold[0])) {
- $hdr->cc[$pos] = trim(substr($read_fold[0], 4));
- $pos++;
- while ($pos < count($read_fold)) {
- $hdr->cc[$pos] = trim($read_fold[$pos]);
- $pos++;
- }
- } else {
- $hdr->cc[$pos] = trim(substr($read[$i], 4));
- }
- $i++;
- }
- /* BCC */
- else if (strtolower(substr($read[$i], 0, 4)) == "bcc:") {
- $pos = 0;
- if (isset($read_fold[0])) {
- $hdr->bcc[$pos] = trim(substr($read_fold[0], 5));
- $pos++;
- while ($pos < count($read_fold)) {
- $hdr->bcc[$pos] = trim($read_fold[$pos]);
- $pos++;
- }
- } else {
- $hdr->bcc[$pos] = trim(substr($read[$i], 5));
- }
- $i++;
- }
- /* TO */
- else if (strtolower(substr($read[$i], 0, 3)) == "to:") {
- $pos = 0;
- if (isset($read_fold[0])) {
- $hdr->to[$pos] = trim(substr($read_fold[0], 4));
- $pos++;
- while ($pos < count($read_fold)) {
- $hdr->to[$pos] = trim($read_fold[$pos]);
- $pos++;
- }
- } else {
- $hdr->to[$pos] = trim(substr($read[$i], 4));
- }
- $i++;
-
- }
- /* MESSAGE ID */
- else if (strtolower(substr($read[$i], 0, 11)) == "message-id:") {
- $hdr->message_id = trim(substr($read[$i], 11));
- $i++;
- }
- /* ERROR CORRECTION */
- else if (substr($read[$i], 0, 1) == ")") {
- if (strlen(trim($hdr->subject)) == 0) {
- $hdr->subject = _("(no subject)");
- }
- if (strlen(trim($hdr->from)) == 0) {
- $hdr->from = _("(unknown sender)");
- }
- if (strlen(trim($hdr->date)) == 0) {
- $hdr->date = time();
+ break;
+ case 'ENVELOPE':
+ // sqimap_parse_address($read,$i,$aMsg);
+ break; // to be implemented, moving imap code out of the Message class
+ case 'BODYSTRUCTURE':
+ break; // to be implemented, moving imap code out of the Message class
+ case 'INTERNALDATE':
+ $aMsg['INTERNALDATE'] = trim(str_replace(' ', ' ',parseString($read,$i)));
+ break;
+ case 'BODY.PEEK[HEADER.FIELDS':
+ case 'BODY[HEADER.FIELDS':
+ $i = strpos($read,'{',$i); // header is always returned as literal because it contain \n characters
+ $header = parseString($read,$i);
+ if ($header === false) break 2;
+ /* First we replace all \r\n by \n, and unfold the header */
+ $hdr = trim(str_replace(array("\r\n", "\n\t", "\n "),array("\n", ' ', ' '), $header));
+ /* Now we can make a new header array with
+ each element representing a headerline */
+ $aHdr = explode("\n" , $hdr);
+ $aReceived = array();
+ foreach ($aHdr as $line) {
+ $pos = strpos($line, ':');
+ if ($pos > 0) {
+ $field = strtolower(substr($line, 0, $pos));
+ if (!strstr($field,' ')) { /* valid field */
+ $value = trim(substr($line, $pos+1));
+ switch($field) {
+ case 'date':
+ $aMsg['date'] = trim(str_replace(' ', ' ', $value));
+ break;
+ case 'x-priority': $aMsg['x-priority'] = ($value) ? (int) $value{0} : 3; break;
+ case 'priority':
+ case 'importance':
+ if (!isset($aMsg['x-priority'])) {
+ $aPrio = split('/\w/',trim($value));
+ $sPrio = strtolower(array_shift($aPrio));
+ if (is_numeric($sPrio)) {
+ $iPrio = (int) $sPrio;
+ } elseif ( $sPrio == 'non-urgent' || $sPrio == 'low' ) {
+ $iPrio = 3;
+ } elseif ( $sPrio == 'urgent' || $sPrio == 'high' ) {
+ $iPrio = 1;
+ } else {
+ // default is normal priority
+ $iPrio = 3;
+ }
+ $aMsg['x-priority'] = $iPrio;
+ }
+ break;
+ case 'content-type':
+ $type = $value;
+ if ($pos = strpos($type, ";")) {
+ $type = substr($type, 0, $pos);
+ }
+ $type = explode("/", $type);
+ if(!is_array($type) || count($type) < 2) {
+ $aMsg['content-type'] = array('text','plain');
+ } else {
+ $aMsg['content-type'] = array(strtolower($type[0]),strtolower($type[1]));
+ }
+ break;
+ case 'received':
+ $aMsg['received'][] = $value;
+ break;
+ default:
+ $aMsg[$field] = $value;
+ break;
+ }
+ }
+ }
+ }
+ break;
+ default:
+ ++$i;
+ break;
}
- $i++;
}
- /* X-PRIORITY */
- else if (strtolower(substr($read[$i], 0, 11)) == "x-priority:") {
- $hdr->priority = trim(substr($read[$i], 11));
- $i++;
+ $msgi ="$unique_id";
+ $aMsg['UID'] = $unique_id;
+ $aMessageList[$msgi] = $aMsg;
+ }
+ return $aMessageList;
+}
+
+/**
+ * Work in process
+ * @private
+ * @author Marc Groot Koerkamp
+ */
+function sqimap_parse_envelope($read, &$i, &$msg) {
+ $arg_no = 0;
+ $arg_a = array();
+ ++$i;
+ for ($cnt = strlen($read); ($i < $cnt) && ($read{$i} != ')'); ++$i) {
+ $char = strtoupper($read{$i});
+ switch ($char) {
+ case '{':
+ case '"':
+ $arg_a[] = parseString($read,$i);
+ ++$arg_no;
+ break;
+ case 'N':
+ /* probably NIL argument */
+ if (strtoupper(substr($read, $i, 3)) == 'NIL') {
+ $arg_a[] = '';
+ ++$arg_no;
+ $i += 2;
+ }
+ break;
+ case '(':
+ /* Address structure (with group support)
+ * Note: Group support is useless on SMTP connections
+ * because the protocol doesn't support it
+ */
+ $addr_a = array();
+ $group = '';
+ $a=0;
+ for (; $i < $cnt && $read{$i} != ')'; ++$i) {
+ if ($read{$i} == '(') {
+ $addr = sqimap_parse_address($read, $i);
+ if (($addr[3] == '') && ($addr[2] != '')) {
+ /* start of group */
+ $group = $addr[2];
+ $group_addr = $addr;
+ $j = $a;
+ } else if ($group && ($addr[3] == '') && ($addr[2] == '')) {
+ /* end group */
+ if ($a == ($j+1)) { /* no group members */
+ $group_addr[4] = $group;
+ $group_addr[2] = '';
+ $group_addr[0] = "$group: Undisclosed recipients;";
+ $addr_a[] = $group_addr;
+ $group ='';
+ }
+ } else {
+ $addr[4] = $group;
+ $addr_a[] = $addr;
+ }
+ ++$a;
+ }
+ }
+ $arg_a[] = $addr_a;
+ break;
+ default: break;
}
- else {
- $i++;
+ }
+
+ if (count($arg_a) > 9) {
+ $d = strtr($arg_a[0], array(' ' => ' '));
+ $d = explode(' ', $d);
+ if (!$arg_a[1]) $arg_a[1] = '';
+ $msg['DATE'] = $d; /* argument 1: date */
+ $msg['SUBJECT'] = $arg_a[1]; /* argument 2: subject */
+ $msg['FROM'] = is_array($arg_a[2]) ? $arg_a[2][0] : ''; /* argument 3: from */
+ $msg['SENDER'] = is_array($arg_a[3]) ? $arg_a[3][0] : ''; /* argument 4: sender */
+ $msg['REPLY-TO'] = is_array($arg_a[4]) ? $arg_a[4][0] : ''; /* argument 5: reply-to */
+ $msg['TO'] = $arg_a[5]; /* argument 6: to */
+ $msg['CC'] = $arg_a[6]; /* argument 7: cc */
+ $msg['BCC'] = $arg_a[7]; /* argument 8: bcc */
+ $msg['IN-REPLY-TO'] = $arg_a[8]; /* argument 9: in-reply-to */
+ $msg['MESSAGE-ID'] = $arg_a[9]; /* argument 10: message-id */
+ }
+}
+
+
+/**
+ * Work in process
+ * @private
+ * @author Marc Groot Koerkamp
+ */
+function sqimap_parse_address($read, &$i) {
+ $arg_a = array();
+ for (; $read{$i} != ')'; ++$i) {
+ $char = strtoupper($read{$i});
+ switch ($char) {
+ case '{':
+ case '"': $arg_a[] = parseString($read,$i); break;
+ case 'n':
+ case 'N':
+ if (strtoupper(substr($read, $i, 3)) == 'NIL') {
+ $arg_a[] = '';
+ $i += 2;
+ }
+ break;
+ default: break;
}
- $read_fold=array();
- }
- return $hdr;
+ }
+
+ if (count($arg_a) == 4) {
+ return $arg_a;
+
+// $adr = new AddressStructure();
+// $adr->personal = $arg_a[0];
+// $adr->adl = $arg_a[1];
+// $adr->mailbox = $arg_a[2];
+// $adr->host = $arg_a[3];
+ } else {
+ $adr = '';
+ }
+ return $adr;
}
-/* Returns the body of a message. */
-function sqimap_get_message_body ($imap_stream, &$header) {
- $id = $header->id;
- return decodeMime($imap_stream, $header);
+
+/**
+ * Returns a message array with all the information about a message.
+ * See the documentation folder for more information about this array.
+ *
+ * @param resource $imap_stream imap connection
+ * @param integer $id uid of the message
+ * @param string $mailbox used for error handling, can be removed because we should return an error code and generate the message elsewhere
+ * @return Message Message object
+ */
+function sqimap_get_message($imap_stream, $id, $mailbox) {
+ // typecast to int to prohibit 1:* msgs sets
+ $id = (int) $id;
+ $flags = array();
+ $read = sqimap_run_command($imap_stream, "FETCH $id (FLAGS BODYSTRUCTURE)", true, $response, $message, TRUE);
+ if ($read) {
+ if (preg_match('/.+FLAGS\s\((.*)\)\s/AUi',$read[0],$regs)) {
+ if (trim($regs[1])) {
+ $flags = preg_split('/ /', $regs[1],-1,'PREG_SPLIT_NI_EMPTY');
+ }
+ }
+ } else {
+ /* the message was not found, maybe the mailbox was modified? */
+ global $sort, $startMessage, $color;
+
+ $errmessage = _("The server couldn't find the message you requested.") .
+ '<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).");
+ /* this will include a link back to the message list */
+ error_message($errmessage, $mailbox, $sort, (int) $startMessage, $color);
+ exit;
+ }
+ $bodystructure = implode('',$read);
+ $msg = mime_structure($bodystructure,$flags);
+ $read = sqimap_run_command($imap_stream, "FETCH $id BODY[HEADER]", true, $response, $message, TRUE);
+ $rfc822_header = new Rfc822Header();
+ $rfc822_header->parseHeader($read);
+ $msg->rfc822_header = $rfc822_header;
+ return $msg;
}
?>