6 * Copyright (c) 1999-2002 The SquirrelMail Project Team
7 * Licensed under the GNU GPL. For full terms see the file COPYING.
9 * This implements functions that manipulate messages
14 /****************************************************************************
15 ** Copies specified messages to specified folder
16 ****************************************************************************/
17 function sqimap_messages_copy ($imap_stream, $start, $end, $mailbox) {
18 fputs ($imap_stream, sqimap_session_id() . " COPY $start:$end \"$mailbox\"\r\n");
19 $read = sqimap_read_data ($imap_stream, sqimap_session_id(), true, $response, $message);
22 /****************************************************************************
23 ** Deletes specified messages and moves them to trash if possible
24 ****************************************************************************/
25 function sqimap_messages_delete ($imap_stream, $start, $end, $mailbox) {
26 global $move_to_trash, $trash_folder, $auto_expunge;
28 if (($move_to_trash == true) && (sqimap_mailbox_exists($imap_stream, $trash_folder) && ($mailbox != $trash_folder))) {
29 sqimap_messages_copy ($imap_stream, $start, $end, $trash_folder);
30 sqimap_messages_flag ($imap_stream, $start, $end, "Deleted");
32 sqimap_messages_flag ($imap_stream, $start, $end, "Deleted");
36 /****************************************************************************
37 ** Sets the specified messages with specified flag
38 ****************************************************************************/
39 function sqimap_messages_flag ($imap_stream, $start, $end, $flag) {
40 fputs ($imap_stream, sqimap_session_id() . " STORE $start:$end +FLAGS (\\$flag)\r\n");
41 $read = sqimap_read_data ($imap_stream, sqimap_session_id(), true, $response, $message);
45 /****************************************************************************
46 ** Remove specified flag from specified messages
47 ****************************************************************************/
48 function sqimap_messages_remove_flag ($imap_stream, $start, $end, $flag) {
49 fputs ($imap_stream, sqimap_session_id() . " STORE $start:$end -FLAGS (\\$flag)\r\n");
50 $read = sqimap_read_data ($imap_stream, sqimap_session_id(), true, $response, $message);
54 /****************************************************************************
55 ** Returns some general header information -- FROM, DATE, and SUBJECT
56 ****************************************************************************/
58 var $from = '', $subject = '', $date = '', $to = '',
59 $priority = 0, $message_id = 0, $cc = '';
62 function sqimap_get_small_header ($imap_stream, $id, $sent) {
63 $res = sqimap_get_small_header_list($imap_stream, array($id), $sent);
67 /* Sort the message list and crunch to be as small as possible
68 * (overflow could happen, so make it small if possible)
70 function sqimap_message_list_squisher($messages_array) {
71 if( !is_array( $messages_array ) ) {
74 sort($messages_array, SORT_NUMERIC
);
76 while ($messages_array) {
77 $start = array_shift($messages_array);
79 while (isset($messages_array[0]) && $messages_array[0] == $end +
1) {
80 $end = array_shift($messages_array);
82 if ($msgs_str != '') {
87 $msgs_str .= ':' . $end;
94 function sqimap_get_small_header_list ($imap_stream, $msg_list, $issent) {
95 global $squirrelmail_language, $color;
97 /* Get the small headers for each message in $msg_list */
98 $sid = sqimap_session_id();
99 $maxmsg = sizeof($msg_list);
100 $msgs_str = sqimap_message_list_squisher($msg_list);
102 $read_list = array();
103 $sizes_list = array();
106 * We need to return the data in the same order as the caller supplied
107 * in $msg_list, but IMAP servers are free to return responses in
108 * whatever order they wish... So we need to re-sort manually
110 for ($i = 0; $i < sizeof($msg_list); $i++
) {
111 $id2index[$msg_list[$i]] = $i;
114 $query = "$sid FETCH $msgs_str BODY.PEEK[HEADER.FIELDS (Date To From Cc Subject Message-Id X-Priority Content-Type)]\r\n";
115 fputs ($imap_stream, $query);
116 $readin_list = sqimap_read_data_list($imap_stream, $sid, true, $response, $message);
118 foreach ($readin_list as $r) {
119 if (!eregi("^\\* ([0-9]+) FETCH", $r[0], $regs)) {
120 set_up_language($squirrelmail_language);
121 echo '<br><b><font color=$color[2]>' .
122 _("ERROR : Could not complete request.") .
124 _("Unknown response from IMAP server: ") . ' 1.' .
125 $r[0] . "</font><br>\n";
127 } else if (! isset($id2index[$regs[1]]) ||
!count($id2index[$regs[1]])) {
128 set_up_language($squirrelmail_language);
129 echo '<br><b><font color=$color[2]>' .
130 _("ERROR : Could not complete request.") .
132 _("Unknown message number in reply from server: ") .
133 $regs[1] . "</font><br>\n";
136 $read_list[$id2index[$regs[1]]] = $r;
141 $query = "$sid FETCH $msgs_str RFC822.SIZE\r\n";
142 fputs ($imap_stream, $query);
143 $sizesin_list = sqimap_read_data_list($imap_stream, $sid, true, $response, $message);
145 foreach ($sizesin_list as $r) {
146 if (!eregi("^\\* ([0-9]+) FETCH", $r[0], $regs)) {
147 set_up_language($squirrelmail_language);
148 echo "<br><b><font color=$color[2]>\n";
149 echo _("ERROR : Could not complete request.");
151 echo _("Unknown response from IMAP server: ") . ' 2.';
152 echo $r[0] . "</font><br>\n";
155 if (!count($id2index[$regs[1]])) {
156 set_up_language($squirrelmail_language);
157 echo "<br><b><font color=$color[2]>\n";
158 echo _("ERROR : Could not complete request.");
160 echo _("Unknown messagenumber in reply from server: ");
161 echo $regs[1] . "</font><br>\n";
164 $sizes_list[$id2index[$regs[1]]] = $r;
168 for ($msgi = 0; $msgi < $maxmsg; $msgi++
) {
169 $subject = _("(no subject)");
170 $from = _("Unknown Sender");
178 $read = $read_list[$msgi];
180 for ($i = 0; $i < count($read); $i++
) {
181 if (eregi ("^to:(.*)$", $read[$i], $regs)) {
182 /*$to = sqimap_find_displayable_name(substr($read[$i], 3));*/
184 } else if (eregi ("^from:(.*)$", $read[$i], $regs)) {
185 /*$from = sqimap_find_displayable_name(substr($read[$i], 5));*/
187 } else if (eregi ("^x-priority:(.*)$", $read[$i], $regs)) {
188 $priority = trim($regs[1]);
189 } else if (eregi ("^message-id:(.*)$", $read[$i], $regs)) {
190 $messageid = trim($regs[1]);
191 } else if (eregi ("^cc:(.*)$", $read[$i], $regs)) {
193 } else if (eregi ("^date:(.*)$", $read[$i], $regs)) {
195 } else if (eregi ("^subject:(.*)$", $read[$i], $regs)) {
196 $subject = htmlspecialchars(trim($regs[1]));
197 if ($subject == "") {
198 $subject = _("(no subject)");
200 } else if (eregi ("^content-type:(.*)$", $read[$i], $regs)) {
201 $type = strtolower(trim($regs[1]));
202 if ($pos = strpos($type, ";")) {
203 $type = substr($type, 0, $pos);
205 $type = explode("/", $type);
206 if (! isset($type[1])) {
211 if (trim($date) == "") {
212 fputs($imap_stream, "$sid FETCH $msg_list[$msgi] INTERNALDATE\r\n");
213 $readdate = sqimap_read_data($imap_stream, $sid, true, $response, $message);
214 if (eregi(".*INTERNALDATE \"(.*)\".*", $readdate[0], $regs)) {
215 $date_list = explode(" ", trim($regs[1]));
216 $date_list[0] = str_replace("-", " ", $date_list[0]);
217 $date = implode(" ", $date_list);
220 eregi("([0-9]+)[^0-9]*$", $sizes_list[$msgi][0], $regs);
223 $header = new small_header
;
224 if ($issent == true) {
225 $header->from
= (trim($to) != '' ?
$to : '(' ._("No To Address") . ')');
227 $header->from
= $from;
230 $header->date
= $date;
231 $header->subject
= $subject;
233 $header->priority
= $priority;
234 $header->message_id
= $messageid;
236 $header->size
= $size;
237 $header->type0
= $type[0];
238 $header->type1
= $type[1];
245 /****************************************************************************
246 ** Returns the flags for the specified messages
247 ****************************************************************************/
248 function sqimap_get_flags ($imap_stream, $i) {
249 fputs ($imap_stream, sqimap_session_id() . " FETCH $i:$i FLAGS\r\n");
250 $read = sqimap_read_data ($imap_stream, sqimap_session_id(), true, $response, $message);
251 if (ereg("FLAGS(.*)", $read[0], $regs)) {
252 return explode(" ", trim(ereg_replace('[\\(\\)\\\\]', '', $regs[1])));
254 return Array('None');
257 function sqimap_get_flags_list ($imap_stream, $msg_list) {
258 $msgs_str = sqimap_message_list_squisher($msg_list);
259 for ($i = 0; $i < sizeof($msg_list); $i++
) {
260 $id2index[$msg_list[$i]] = $i;
262 fputs ($imap_stream, sqimap_session_id() . " FETCH $msgs_str FLAGS\r\n");
263 $result_list = sqimap_read_data_list ($imap_stream, sqimap_session_id(), true, $response, $message);
264 $result_flags = array();
266 for ($i = 0; $i < sizeof($result_list); $i++
) {
267 if (eregi("^\\* ([0-9]+).*FETCH.*FLAGS(.*)", $result_list[$i][0], $regs)
268 && isset($id2index[$regs[1]]) && count($id2index[$regs[1]])) {
269 $result_flags[$id2index[$regs[1]]] = explode(" ", trim(ereg_replace('[\\(\\)\\\\]', '', $regs[2])));
271 set_up_language($squirrelmail_language);
272 echo "<br><b><font color=$color[2]>\n";
273 echo _("ERROR : Could not complete request.");
275 echo _("Unknown response from IMAP server: ");
276 echo $result_list[$i][0] . "</font><br>\n";
280 arsort($result_flags);
281 return $result_flags;
284 /****************************************************************************
285 ** Returns a message array with all the information about a message. See
286 ** the documentation folder for more information about this array.
287 ****************************************************************************/
288 function sqimap_get_message ($imap_stream, $id, $mailbox) {
289 $header = sqimap_get_message_header($imap_stream, $id, $mailbox);
290 return sqimap_get_message_body($imap_stream, $header);
293 /****************************************************************************
294 ** Wrapper function that reformats the header information.
295 ****************************************************************************/
296 function sqimap_get_message_header ($imap_stream, $id, $mailbox) {
297 fputs ($imap_stream, sqimap_session_id() . " FETCH $id:$id BODY[HEADER]\r\n");
298 $read = sqimap_read_data ($imap_stream, sqimap_session_id(), true, $response, $message);
300 $header = sqimap_get_header($imap_stream, $read);
302 $header->mailbox
= $mailbox;
307 /****************************************************************************
308 ** Wrapper function that returns entity headers for use by decodeMime
309 ****************************************************************************/
311 function sqimap_get_entity_header ($imap_stream, &$read, &$type0, &$type1, &$bound, &$encoding, &$charset, &$filename) {
312 $header = sqimap_get_header($imap_stream, $read);
313 $type0 = $header["TYPE0"];
314 $type1 = $header["TYPE1"];
315 $bound = $header["BOUNDARY"];
316 $encoding = $header["ENCODING"];
317 $charset = $header["CHARSET"];
318 $filename = $header["FILENAME"];
322 /****************************************************************************
323 ** Queries the IMAP server and gets all header information.
324 ****************************************************************************/
325 function sqimap_get_header ($imap_stream, $read) {
326 global $where, $what;
328 $hdr = new msg_header();
330 /* Set up some defaults */
331 $hdr->type0
= "text";
332 $hdr->type1
= "plain";
333 $hdr->charset
= "us-ascii";
335 while ($i < count($read)) {
336 if (substr($read[$i], 0, 17) == "MIME-Version: 1.0") {
341 /** ENCODING TYPE **/
342 else if (substr(strtolower($read[$i]), 0, 26) == "content-transfer-encoding:") {
343 $hdr->encoding
= strtolower(trim(substr($read[$i], 26)));
348 else if (strtolower(substr($read[$i], 0, 13)) == "content-type:") {
349 $cont = strtolower(trim(substr($read[$i], 13)));
350 if (strpos($cont, ";")) {
351 $cont = substr($cont, 0, strpos($cont, ";"));
355 if (strpos($cont, "/")) {
356 $hdr->type0
= substr($cont, 0, strpos($cont, "/"));
357 $hdr->type1
= substr($cont, strpos($cont, "/")+
1);
365 while ( (substr(substr($read[$i], 0, strpos($read[$i], " ")), -1) != ":") && (trim($read[$i]) != "") && (trim($read[$i]) != ")")) {
366 str_replace("\n", "", $line);
367 str_replace("\n", "", $read[$i]);
368 $line = "$line $read[$i]";
372 /** Detect the boundary of a multipart message **/
373 if (eregi('boundary="([^"]+)"', $line, $regs)) {
374 $hdr->boundary
= $regs[1];
377 /** Detect the charset **/
378 if (strpos(strtolower(trim($line)), "charset=")) {
379 $pos = strpos($line, "charset=") +
8;
380 $charset = trim($line);
381 if (strpos($line, ";", $pos) > 0) {
382 $charset = substr($charset, $pos, strpos($line, ";", $pos)-$pos);
384 $charset = substr($charset, $pos);
386 $charset = str_replace("\"", "", $charset);
387 $hdr->charset
= $charset;
389 $hdr->charset
= "us-ascii";
393 else if (strtolower(substr($read[$i], 0, 20)) == "content-disposition:") {
394 /** Add better dontent-disposition support **/
398 while ( (substr(substr($read[$i], 0, strpos($read[$i], " ")), -1) != ":") && (trim($read[$i]) != "") && (trim($read[$i]) != ")")) {
399 str_replace("\n", "", $line);
400 str_replace("\n", "", $read[$i]);
401 $line = "$line $read[$i]";
405 /** Detects filename if any **/
406 if (strpos(strtolower(trim($line)), "filename=")) {
407 $pos = strpos($line, "filename=") +
9;
409 if (strpos($line, " ", $pos) > 0) {
410 $name = substr($name, $pos, strpos($line, " ", $pos));
412 $name = substr($name, $pos);
414 $name = str_replace("\"", "", $name);
415 $hdr->filename
= $name;
420 else if (strtolower(substr($read[$i], 0, 9)) == "reply-to:") {
421 $hdr->replyto
= trim(substr($read[$i], 9, strlen($read[$i])));
426 else if (strtolower(substr($read[$i], 0, 5)) == "from:") {
427 $hdr->from
= trim(substr($read[$i], 5, strlen($read[$i]) - 6));
428 if (! isset($hdr->replyto
) ||
$hdr->replyto
== "") {
429 $hdr->replyto
= $hdr->from
;
434 else if (strtolower(substr($read[$i], 0, 5)) == "date:") {
435 $d = substr($read[$i], 5);
437 $d = strtr($d, array(' ' => ' '));
438 $d = explode(' ', $d);
439 $hdr->date
= getTimeStamp($d);
443 else if (strtolower(substr($read[$i], 0, 8)) == "subject:") {
444 $hdr->subject
= trim(substr($read[$i], 8, strlen($read[$i]) - 9));
445 if (strlen(Chop($hdr->subject
)) == 0) {
446 $hdr->subject
= _("(no subject)");
450 if ($where == 'SUBJECT') {
451 $hdr->subject = $what;
452 // $hdr->subject = eregi_replace($what, "<b>\\0</b>", $hdr->subject);
459 else if (strtolower(substr($read[$i], 0, 3)) == "cc:") {
461 $hdr->cc
[$pos] = trim(substr($read[$i], 4));
463 while (((substr($read[$i], 0, 1) == " ") ||
(substr($read[$i], 0, 1) == "\t")) && (trim($read[$i]) != "")){
465 $hdr->cc
[$pos] = trim($read[$i]);
470 else if (strtolower(substr($read[$i], 0, 4)) == "bcc:") {
472 $hdr->bcc
[$pos] = trim(substr($read[$i], 5));
474 while (((substr($read[$i], 0, 1) == " ") ||
(substr($read[$i], 0, 1) == "\t")) && (trim($read[$i]) != "")){
476 $hdr->bcc
[$pos] = trim($read[$i]);
481 else if (strtolower(substr($read[$i], 0, 3)) == "to:") {
483 $hdr->to
[$pos] = trim(substr($read[$i], 4));
485 while (((substr($read[$i], 0, 1) == " ") ||
(substr($read[$i], 0, 1) == "\t")) && (trim($read[$i]) != "")){
487 $hdr->to
[$pos] = trim($read[$i]);
492 else if (strtolower(substr($read[$i], 0, 11)) == "message-id:") {
493 $hdr->message_id
= trim(substr($read[$i], 11));
498 /** ERROR CORRECTION **/
499 else if (substr($read[$i], 0, 1) == ")") {
500 if (strlen(trim($hdr->subject
)) == 0) {
501 $hdr->subject
= _("(no subject)");
503 if (strlen(trim($hdr->from
)) == 0) {
504 $hdr->from
= _("(unknown sender)");
506 if (strlen(trim($hdr->date
)) == 0) {
512 else if (strtolower(substr($read[$i], 0, 11)) == "x-priority:") {
513 $hdr->priority
= trim(substr($read[$i], 11));
524 /****************************************************************************
525 ** Returns the body of a message.
526 ****************************************************************************/
527 function sqimap_get_message_body ($imap_stream, &$header) {
529 return decodeMime($imap_stream, $header);
533 /****************************************************************************
534 ** Returns an array with the body structure
535 ****************************************************************************/