- /**
- ** imap_messages.php
- **
- ** This implements functions that manipulate messages
- **
- ** $Id$
- **/
-
- if (defined ('imap_messages_php'))
- return;
- define ('imap_messages_php', true);
-
- /******************************************************************************
- ** Copies specified messages to specified folder
- ******************************************************************************/
- function sqimap_messages_copy ($imap_stream, $start, $end, $mailbox) {
- fputs ($imap_stream, sqimap_session_id() . " COPY $start:$end \"$mailbox\"\r\n");
- $read = sqimap_read_data ($imap_stream, sqimap_session_id(), true, $response, $message);
- }
-
- /******************************************************************************
- ** 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);
- sqimap_messages_flag ($imap_stream, $start, $end, "Deleted");
- } else {
- sqimap_messages_flag ($imap_stream, $start, $end, "Deleted");
- }
- }
-
- /******************************************************************************
- ** Sets the specified messages with specified flag
- ******************************************************************************/
- function sqimap_messages_flag ($imap_stream, $start, $end, $flag) {
- fputs ($imap_stream, sqimap_session_id() . " STORE $start:$end +FLAGS (\\$flag)\r\n");
- $read = sqimap_read_data ($imap_stream, sqimap_session_id(), true, $response, $message);
- }
-
-
- /******************************************************************************
- ** Remove specified flag from specified messages
- ******************************************************************************/
- function sqimap_messages_remove_flag ($imap_stream, $start, $end, $flag) {
- fputs ($imap_stream, sqimap_session_id() . " STORE $start:$end -FLAGS (\\$flag)\r\n");
- $read = sqimap_read_data ($imap_stream, sqimap_session_id(), true, $response, $message);
- }
-
-
- /******************************************************************************
- ** 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];
- }
-
- // 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;
- sort($messages_array, SORT_NUMERIC);
- $msgs_str = '';
- while ($messages_array) {
- $start = array_shift($messages_array);
- $end = $start;
- while (isset($messages_array[0]) && $messages_array[0] == $end + 1)
- $end = array_shift($messages_array);
- if ($msgs_str != '')
- $msgs_str .= ',';
- $msgs_str .= $start;
- if ($start != $end)
- $msgs_str .= ':' . $end;
- }
-
- return $msgs_str;
- }
-
- function sqimap_get_small_header_list ($imap_stream, $msg_list, $issent) {
- global $squirrelmail_language, $color;
-
- /* Get the small headers for each message in $msg_list */
-
- $maxmsg = sizeof($msg_list);
- $msgs_str = sqimap_message_list_squisher($msg_list);
- $results = array();
- $read_list = array();
- $sizes_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;
- }
-
-
- $query = sqimap_session_id() . " FETCH $msgs_str BODY.PEEK[HEADER.FIELDS (Date To From Cc Subject Message-Id X-Priority Content-Type)]\r\n";
- fputs ($imap_stream, $query);
- $readin_list = sqimap_read_data_list($imap_stream, sqimap_session_id(), true, $response, $message);
-
-
- foreach ($readin_list as $r) {
- if (!eregi("^\\* ([0-9]+) FETCH", $r[0], $regs)) {
- set_up_language($squirrelmail_language);
- echo "<br><b><font color=$color[2]>\n";
- echo _("ERROR : Could not complete request.");
- echo "</b><br>\n";
- echo _("Unknown response from IMAP server: ");
- echo $r[0] . "</font><br>\n";
- exit;
- }
- if (! isset($id2index[$regs[1]]) || !count($id2index[$regs[1]])) {
- set_up_language($squirrelmail_language);
- echo "<br><b><font color=$color[2]>\n";
- echo _("ERROR : Could not complete request.");
- echo "</b><br>\n";
- echo _("Unknown message number in reply from server: ");
- echo $regs[1] . "</font><br>\n";
- exit;
- }
- $read_list[$id2index[$regs[1]]] = $r;
- }
- arsort($read_list);
-
- $query = sqimap_session_id() . " FETCH $msgs_str RFC822.SIZE\r\n";
- fputs ($imap_stream, $query);
- $sizesin_list = sqimap_read_data_list($imap_stream, sqimap_session_id(), true, $response, $message);
-
- foreach ($sizesin_list as $r) {
- if (!eregi("^\\* ([0-9]+) FETCH", $r[0], $regs)) {
- set_up_language($squirrelmail_language);
- echo "<br><b><font color=$color[2]>\n";
- echo _("ERROR : Could not complete request.");
- echo "</b><br>\n";
- echo _("Unknown response from IMAP server: ");
- echo $r[0] . "</font><br>\n";
- exit;
- }
- if (!count($id2index[$regs[1]])) {
- set_up_language($squirrelmail_language);
- echo "<br><b><font color=$color[2]>\n";
- echo _("ERROR : Could not complete request.");
- echo "</b><br>\n";
- echo _("Unknown messagenumber in reply from server: ");
- echo $regs[1] . "</font><br>\n";
- exit;
- }
- $sizes_list[$id2index[$regs[1]]] = $r;
- }
- arsort($sizes_list);
-
- for ($msgi = 0; $msgi < $maxmsg; $msgi++) {
- $subject = _("(no subject)");
- $from = _("Unknown Sender");
- $priority = 0;
- $messageid = "<>";
- $cc = "";
- $to = "";
- $date = "";
- $type[0] = "";
- $type[1] = "";
- $read = $read_list[$msgi];
-
- for ($i = 0; $i < count($read); $i++) {
- if (eregi ("^to:(.*)$", $read[$i], $regs)) {
- //$to = sqimap_find_displayable_name(substr($read[$i], 3));
- $to = $regs[1];
- } else if (eregi ("^from:(.*)$", $read[$i], $regs)) {
- //$from = sqimap_find_displayable_name(substr($read[$i], 5));
- $from = $regs[1];
- } else if (eregi ("^x-priority:(.*)$", $read[$i], $regs)) {
- $priority = trim($regs[1]);
- } else if (eregi ("^message-id:(.*)$", $read[$i], $regs)) {
- $messageid = trim($regs[1]);
- } else if (eregi ("^cc:(.*)$", $read[$i], $regs)) {
- $cc = $regs[1];
- } else if (eregi ("^date:(.*)$", $read[$i], $regs)) {
- $date = $regs[1];
- } else if (eregi ("^subject:(.*)$", $read[$i], $regs)) {
- $subject = htmlspecialchars(trim($regs[1]));
- if ($subject == "")
- $subject = _("(no subject)");
- } else if (eregi ("^content-type:(.*)$", $read[$i], $regs)) {
- $type = strtolower(trim($regs[1]));
- if ($pos = strpos($type, ";"))
- $type = substr($type, 0, $pos);
- $type = explode("/", $type);
- if (! isset($type[1]))
- $type[1] = '';
- }
-
- }
- if (trim($date) == "") {
- fputs($imap_stream, sqimap_session_id() . " FETCH $msg_list[$msgi] INTERNALDATE\r\n");
- $readdate = sqimap_read_data($imap_stream, sqimap_session_id(), true, $response, $message);
- if (eregi(".*INTERNALDATE \"(.*)\".*", $readdate[0], $regs)) {
- $date_list = explode(" ", trim($regs[1]));
- $date_list[0] = str_replace("-", " ", $date_list[0]);
- $date = implode(" ", $date_list);
+
+/**
+ * imap_messages.php
+ *
+ * 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
+ *
+ * @version $Id$
+ * @package squirrelmail
+ * @subpackage imap
+ */
+
+
+/**
+ * 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
+ * @return bool
+ */
+function sqimap_msgs_list_copy($imap_stream, $id, $mailbox) {
+ $msgs_id = sqimap_message_list_squisher($id);
+ $read = sqimap_run_command ($imap_stream, "COPY $msgs_id " . sqimap_encode_mailbox_name($mailbox), true, $response, $message, TRUE);
+ if ($response == 'OK') {
+ return true;
+ } else {
+ return false;
+ }
+}
+
+
+/**
+ * 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
+ * @return void
+ */
+function sqimap_msgs_list_move($imap_stream, $id, $mailbox) {
+ $msgs_id = sqimap_message_list_squisher($id);
+ if (sqimap_msgs_list_copy ($imap_stream, $id, $mailbox)) {
+ return sqimap_toggle_flag($imap_stream, $id, '\\Deleted', true, true);
+ } else {
+ return false;
+ }
+}
+
+
+/**
+ * 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 skip copy to trash
+ * @return array $aMessageList array with messages containing the new flags and UID @see parseFetch
+ */
+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;
+ }
+}
+
+
+/**
+ * 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 $messages_array;
+ }
+
+ sort($messages_array, SORT_NUMERIC);
+ $msgs_str = '';
+ while ($messages_array) {
+ $start = array_shift($messages_array);
+ $end = $start;
+ while (isset($messages_array[0]) && $messages_array[0] == $end + 1) {
+ $end = array_shift($messages_array);
+ }
+ if ($msgs_str != '') {
+ $msgs_str .= ',';
+ }
+ $msgs_str .= $start;
+ if ($start != $end) {
+ $msgs_str .= ':' . $end;
+ }
+ }
+ return $msgs_str;
+}
+
+
+/**
+ * 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;
+ }
+}
+
+
+/**
+ * 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 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]));