-<?
- /**
- ** imap_messages.php
- **
- ** This implements functions that manipulate messages
- **/
-
- /******************************************************************************
- ** Copies specified messages to specified folder
- ******************************************************************************/
- function sqimap_messages_copy ($imap_stream, $start, $end, $mailbox) {
- fputs ($imap_stream, "a001 COPY $start:$end \"$mailbox\"\r\n");
- $read = sqimap_read_data ($imap_stream, "a001", 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))) {
- 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, "a001 STORE $start:$end +FLAGS (\\$flag)\r\n");
- $read = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
- }
-
- /******************************************************************************
- ** Returns some general header information -- FROM, DATE, and SUBJECT
- ******************************************************************************/
- function sqimap_get_small_header ($imap_stream, $id, &$from, &$subject, &$date) {
- fputs ($imap_stream, "a001 FETCH $id:$id BODY[HEADER.FIELDS (From Subject Date)]\r\n");
- $read = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
-
- for ($i = 0; $i < count($read); $i++) {
- if (strtolower(substr($read[$i], 0, 5)) == "from:") {
- $from = sqimap_find_displayable_name(substr($read[$i], 5));
- } else if (strtolower(substr($read[$i], 0, 5)) == "date:") {
- $date = substr($read[$i], 5);
- } else if (strtolower(substr($read[$i], 0, 8)) == "subject:") {
- $subject = htmlspecialchars(substr($read[$i], 8));
- if (strlen(trim($subject)) == 0)
- $subject = _("(no subject)");
- }
- }
- }
-
- /******************************************************************************
- ** Returns the flags for the specified messages
- ******************************************************************************/
- function sqimap_get_flags ($imap_stream, $start, $end) {
- fputs ($imap_stream, "a001 FETCH $start:$end FLAGS\r\n");
- $read = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
- $i = 0;
- while ($i < count($read)) {
- if (strpos($read[$i], "FLAGS")) {
- $tmp = ereg_replace("\(", "", $read[$i]);
- $tmp = ereg_replace("\)", "", $tmp);
- $tmp = str_replace("\\", "", $tmp);
- $tmp = substr($tmp, strpos($tmp, "FLAGS")+6, strlen($tmp));
- $tmp = trim($tmp);
- $flags[$i] = explode(" ", $tmp);
- } else {
- $flags[$i][0] = "None";
- }
- $i++;
- }
- return $flags;
- }
-
- /******************************************************************************
- ** Returns a message array with all the information about a message. See
- ** the documentation folder for more information about this array.
- ******************************************************************************/
- function sqimap_get_message ($imap_stream, $id, $mailbox) {
- $message["INFO"]["ID"] = $id;
- $message["INFO"]["MAILBOX"] = $mailbox;
- $message["HEADER"] = sqimap_get_message_header($imap_stream, $id);
- $message["ENTITIES"] = sqimap_get_message_body($imap_stream, $message["HEADER"]["BOUNDARY"], $id, $message["HEADER"]["TYPE0"], $message["HEADER"]["TYPE1"], $message["HEADER"]["ENCODING"], $message["HEADER"]["CHARSET"]);
- return $message;
- }
-
- /******************************************************************************
- ** Wrapper function that reformats the header information.
- ******************************************************************************/
- function sqimap_get_message_header ($imap_stream, $id) {
- fputs ($imap_stream, "a001 FETCH $id:$id BODY[HEADER]\r\n");
- $read = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
-
- return sqimap_get_header($imap_stream, $read);
- }
-
- /******************************************************************************
- ** 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"];
- }
-
- /******************************************************************************
- ** Queries the IMAP server and gets all header information.
- ******************************************************************************/
- function sqimap_get_header ($imap_stream, $read) {
- $i = 0;
- // Set up some defaults
- $header["TYPE0"] = "text";
- $header["TYPE1"] = "plain";
- $header["CHARSET"] = "us-ascii";
-
- while ($i < count($read)) {
- if (substr($read[$i], 0, 17) == "MIME-Version: 1.0") {
- $header["MIME"] = true;
- $i++;
- }
-
- /** ENCODING TYPE **/
- else if (substr(strtolower($read[$i]), 0, 26) == "content-transfer-encoding:") {
- $header["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, ";"));
-
-
- if (strpos($cont, "/")) {
- $header["TYPE0"] = substr($cont, 0, strpos($cont, "/"));
- $header["TYPE1"] = substr($cont, strpos($cont, "/")+1);
- } else {
- $header["TYPE0"] = $cont;
+<?php
+
+/**
+ * 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
+ * @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;
+ }
+}
+
+
+/**
+ * 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;
+ }
+}
+
+
+/**
+ * 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;
+ }
+}
+
+
+/**
+ * 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]));