* 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$
+ * @package squirrelmail
*/
-/* NOTE: quite some functions in this file are not used anymore. */
-
-/* Copies specified messages to specified folder */
-/* obsolete */
+/**
+ * Copies specified messages to specified folder
+ * @param int $imap_stream The resource ID for the IMAP connection
+ * @param string $start Beginning of range to copy
+ * @param string $end End of the range to copy
+ * @param string $mailbox Which box to copy to
+ * @deprecated This function is obsolete and should not be used
+ */
function sqimap_messages_copy ($imap_stream, $start, $end, $mailbox) {
global $uid_support;
$read = sqimap_run_command ($imap_stream, "COPY $start:$end " . sqimap_encode_mailbox_name($mailbox), true, $response, $message, $uid_support);
/**
* copy a range 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 void
*/
function sqimap_msgs_list_copy ($imap_stream, $id, $mailbox) {
global $uid_support;
/**
* move a range 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) {
global $uid_support;
}
-/* Deletes specified messages and moves them to trash if possible */
-/* obsolete */
+/**
+ * Deletes specified messages and moves them to trash if possible
+ * @deprecated This function is obsolete and should no longer be used
+ * @param int $imap_steam The resource ID for the IMAP connection
+ * @param string $start Start of range
+ * @param string $end End of range
+ * @param string $mailbox Mailbox messages are being deleted from
+ * @return void
+ */
function sqimap_messages_delete ($imap_stream, $start, $end, $mailbox) {
global $move_to_trash, $trash_folder, $auto_expunge, $uid_support;
}
-/* Sets the specified messages with specified flag */
+/**
+ * Sets the specified messages with specified flag
+ */
function sqimap_messages_flag ($imap_stream, $start, $end, $flag, $handle_errors) {
global $uid_support;
$read = sqimap_run_command ($imap_stream, "STORE $start:$end +FLAGS (\\$flag)", $handle_errors, $response, $message, $uid_support);
}
-/* Remove specified flag from specified messages */
-function sqimap_messages_remove_flag ($imap_stream, $start, $end, $flag, $handle_errors) {
- global $uid_support;
- $read = sqimap_run_command ($imap_stream, "STORE $start:$end -FLAGS (\\$flag)", $handle_errors, $response, $message, $uid_support);
-}
-
function sqimap_toggle_flag($imap_stream, $id, $flag, $set, $handle_errors) {
global $uid_support;
$msgs_id = sqimap_message_list_squisher($id);
$read = sqimap_run_command ($imap_stream, "STORE $msgs_id ".$set_string."FLAGS ($flag)", $handle_errors, $response, $message, $uid_support);
}
-// obsolete?
+/** @deprecated */
function sqimap_get_small_header ($imap_stream, $id, $sent) {
$res = sqimap_get_small_header_list($imap_stream, $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)
*/
return $msgs_str;
}
-/* returns the references header lines */
-function get_reference_header ($imap_stream, $message) {
- global $uid_support;
- $responses = array ();
- $results = array();
- $references = "";
- $responses = sqimap_run_command_list ($imap_stream, "FETCH $message BODY[HEADER.FIELDS (References)]", true, $response, $message, $uid_support);
- if (!eregi("^\\* ([0-9]+) FETCH", $responses[0][0], $regs)) {
- $responses = array ();
- }
- return $responses;
-}
-
-
-/* get sort order from server and
- * return it as the $id array for
- * mailbox_display
+/**
+ * Get sort order from server and return it as the $id array for mailbox_display.
*/
-
function sqimap_get_sort_order ($imap_stream, $sort, $mbxresponse) {
global $default_charset, $thread_sort_messages,
$internal_date_sort, $server_sort_array,
return $server_sort_array;
}
-
+/**
+ * Get sort order from server if server does not have the SORT extension
+ * and return it as array for mailbox_display.
+ *
+ * @param resource $imap_stream
+ * @param array $mbxresponse response from a sqimap_mailbox_select
+ * @return array $php_sort_array
+ */
function sqimap_get_php_sort_order ($imap_stream, $mbxresponse) {
global $uid_support;
$query = "SEARCH UID 1:$uidnext";
$uids = sqimap_run_command ($imap_stream, $query, true, $response, $message, true);
if (isset($uids[0])) {
- if (preg_match("/^\* SEARCH (.+)$/", $uids[0], $regs)) {
- $php_sort_array = preg_split("/ /", trim($regs[1]));
+ $php_sort_array = array();
+ // EIMS workaround. EIMS returns the result as multiple untagged SEARCH responses
+ foreach($uids as $line) {
+ if (preg_match("/^\* SEARCH (.+)$/", $line, $regs)) {
+ $php_sort_array += preg_split("/ /", trim($regs[1]));
+ }
}
}
if (!preg_match("/OK/", $response)) {
}
-/* returns an indent array for printMessageinfo()
- this represents the amount of indent needed (value)
- for this message number (key)
-*/
-
+/**
+ * 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;
+ $parent = '';
+ $child = '';
+ $cutoff = 0;
/* loop through the threads and take unwanted characters out
of the thread string then chop it up
}
-/* 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.
+ */
function get_thread_sort ($imap_stream) {
global $thread_new, $sort_by_ref, $default_charset, $server_sort_array, $uid_support;
if (sqsession_is_registered('thread_new')) {
return $new_messages;
}
-// obsolete?
-function sqimap_get_headerfield($imap_stream, $field) {
- global $uid_support;
- $sid = sqimap_session_id(false);
-
- $results = array();
- $read_list = array();
-
- $query = "FETCH 1:* (UID BODY.PEEK[HEADER.FIELDS ($field)])";
- $readin_list = sqimap_run_command_list ($imap_stream, $query, true, $response, $message, $uid_support);
- $i = 0;
-
- foreach ($readin_list as $r) {
- $r = implode('',$r);
- /* first we unfold the header */
- $r = str_replace(array("\r\n\t","\r\n\s"),array('',''),$r);
- /*
- * now we can make a new header array with each element representing
- * a headerline
- */
- $r = explode("\r\n" , $r);
- if (!$uid_support) {
- 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 {
- $id = $regs[1];
- }
- } else {
- if (!preg_match("/^\\*\s+([0-9]+)\s+FETCH.*UID\s+([0-9]+)\s+/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 {
- $id = $regs[2];
- }
- }
- $field = $r[1];
- $field = substr($field,strlen($field)+2);
- $result[] = array($id,$field);
- }
- return $result;
-}
-
-
-
-
-
-/*
+/**
* Returns a message array with all the information about a message.
* See the documentation folder for more information about this array.
*/
return $msg;
}
-/* Wrapper function that reformats the header information. */
-// obsolete?
-function sqimap_get_message_header ($imap_stream, $id, $mailbox) {
- global $uid_support;
- $read = sqimap_run_command ($imap_stream, "FETCH $id BODY[HEADER]", true, $response, $message, $uid_support);
- $header = sqimap_get_header($imap_stream, $read);
- $header->id = $id;
- $header->mailbox = $mailbox;
- return $header;
-}
-
-/* Wrapper function that reformats the entity header information. */
-// obsolete?
-function sqimap_get_ent_header ($imap_stream, $id, $mailbox, $ent) {
- global $uid_support;
- $read = sqimap_run_command ($imap_stream, "FETCH $id BODY[$ent.HEADER]", true, $response, $message, $uid_support);
- $header = sqimap_get_header($imap_stream, $read);
- $header->id = $id;
- $header->mailbox = $mailbox;
- return $header;
-}
-
-/* function to get the mime headers */
-// obsolete?
-function sqimap_get_mime_ent_header ($imap_stream, $id, $mailbox, $ent) {
- global $uid_support;
- $read = sqimap_run_command ($imap_stream, "FETCH $id:$id BODY[$ent.MIME]", true, $response, $message, $uid_support);
- $header = sqimap_get_header($imap_stream, $read);
- $header->id = $id;
- $header->mailbox = $mailbox;
- return $header;
-}
-
?>
projects / squirrelmail.git / blobdiff