5 ** This implements functions that manipulate messages
10 if (defined ('imap_messages_php'))
12 define ('imap_messages_php', true);
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)
69 function sqimap_message_list_squisher($messages_array) {
70 if( !is_array( $messages_array ) ) return;
71 sort($messages_array, SORT_NUMERIC
);
73 while ($messages_array) {
74 $start = array_shift($messages_array);
76 while (isset($messages_array[0]) && $messages_array[0] == $end +
1)
77 $end = array_shift($messages_array);
82 $msgs_str .= ':' . $end;
88 function sqimap_get_small_header_list ($imap_stream, $msg_list, $issent) {
89 global $squirrelmail_language, $color;
91 /* Get the small headers for each message in $msg_list */
92 $sid = sqimap_session_id();
93 $maxmsg = sizeof($msg_list);
94 $msgs_str = sqimap_message_list_squisher($msg_list);
97 $sizes_list = array();
100 * We need to return the data in the same order as the caller supplied
101 * in $msg_list, but IMAP servers are free to return responses in
102 * whatever order they wish... So we need to re-sort manually
104 for ($i = 0; $i < sizeof($msg_list); $i++
) {
105 $id2index[$msg_list[$i]] = $i;
108 $query = "$sid FETCH $msgs_str BODY.PEEK[HEADER.FIELDS (Date To From Cc Subject Message-Id X-Priority Content-Type)]\r\n";
109 fputs ($imap_stream, $query);
110 $readin_list = sqimap_read_data_list($imap_stream, $sid, true, $response, $message);
112 foreach ($readin_list as $r) {
113 if (!eregi("^\\* ([0-9]+) FETCH", $r[0], $regs)) {
114 set_up_language($squirrelmail_language);
115 echo '<br><b><font color=$color[2]>' .
116 _("ERROR : Could not complete request.") .
118 _("Unknown response from IMAP server: ") . ' 1.' .
119 $r[0] . "</font><br>\n";
121 } else if (! isset($id2index[$regs[1]]) ||
!count($id2index[$regs[1]])) {
122 set_up_language($squirrelmail_language);
123 echo '<br><b><font color=$color[2]>' .
124 _("ERROR : Could not complete request.") .
126 _("Unknown message number in reply from server: ") .
127 $regs[1] . "</font><br>\n";
130 $read_list[$id2index[$regs[1]]] = $r;
135 $query = "$sid FETCH $msgs_str RFC822.SIZE\r\n";
136 fputs ($imap_stream, $query);
137 $sizesin_list = sqimap_read_data_list($imap_stream, $sid, true, $response, $message);
139 foreach ($sizesin_list as $r) {
140 if (!eregi("^\\* ([0-9]+) FETCH", $r[0], $regs)) {
141 set_up_language($squirrelmail_language);
142 echo "<br><b><font color=$color[2]>\n";
143 echo _("ERROR : Could not complete request.");
145 echo _("Unknown response from IMAP server: ") . ' 2.';
146 echo $r[0] . "</font><br>\n";
149 if (!count($id2index[$regs[1]])) {
150 set_up_language($squirrelmail_language);
151 echo "<br><b><font color=$color[2]>\n";
152 echo _("ERROR : Could not complete request.");
154 echo _("Unknown messagenumber in reply from server: ");
155 echo $regs[1] . "</font><br>\n";
158 $sizes_list[$id2index[$regs[1]]] = $r;
162 for ($msgi = 0; $msgi < $maxmsg; $msgi++
) {
163 $subject = _("(no subject)");
164 $from = _("Unknown Sender");
172 $read = $read_list[$msgi];
174 for ($i = 0; $i < count($read); $i++
) {
175 if (eregi ("^to:(.*)$", $read[$i], $regs)) {
176 //$to = sqimap_find_displayable_name(substr($read[$i], 3));
178 } else if (eregi ("^from:(.*)$", $read[$i], $regs)) {
179 //$from = sqimap_find_displayable_name(substr($read[$i], 5));
181 } else if (eregi ("^x-priority:(.*)$", $read[$i], $regs)) {
182 $priority = trim($regs[1]);
183 } else if (eregi ("^message-id:(.*)$", $read[$i], $regs)) {
184 $messageid = trim($regs[1]);
185 } else if (eregi ("^cc:(.*)$", $read[$i], $regs)) {
187 } else if (eregi ("^date:(.*)$", $read[$i], $regs)) {
189 } else if (eregi ("^subject:(.*)$", $read[$i], $regs)) {
190 $subject = htmlspecialchars(trim($regs[1]));
192 $subject = _("(no subject)");
193 } else if (eregi ("^content-type:(.*)$", $read[$i], $regs)) {
194 $type = strtolower(trim($regs[1]));
195 if ($pos = strpos($type, ";"))
196 $type = substr($type, 0, $pos);
197 $type = explode("/", $type);
198 if (! isset($type[1]))
203 if (trim($date) == "") {
204 fputs($imap_stream, "$sid FETCH $msg_list[$msgi] INTERNALDATE\r\n");
205 $readdate = sqimap_read_data($imap_stream, $sid, true, $response, $message);
206 if (eregi(".*INTERNALDATE \"(.*)\".*", $readdate[0], $regs)) {
207 $date_list = explode(" ", trim($regs[1]));
208 $date_list[0] = str_replace("-", " ", $date_list[0]);
209 $date = implode(" ", $date_list);
212 eregi("([0-9]+)[^0-9]*$", $sizes_list[$msgi][0], $regs);
215 $header = new small_header
;
216 if ($issent == true) {
217 $header->from
= (trim($to) != '' ?
$to : '(' ._("No To Address") . ')');
219 $header->from
= $from;
222 $header->date
= $date;
223 $header->subject
= $subject;
225 $header->priority
= $priority;
226 $header->message_id
= $messageid;
228 $header->size
= $size;
229 $header->type0
= $type[0];
230 $header->type1
= $type[1];
237 /******************************************************************************
238 ** Returns the flags for the specified messages
239 ******************************************************************************/
240 function sqimap_get_flags ($imap_stream, $i) {
241 fputs ($imap_stream, sqimap_session_id() . " FETCH $i:$i FLAGS\r\n");
242 $read = sqimap_read_data ($imap_stream, sqimap_session_id(), true, $response, $message);
243 if (ereg("FLAGS(.*)", $read[0], $regs))
244 return explode(" ", trim(ereg_replace('[\\(\\)\\\\]', '', $regs[1])));
245 return Array('None');
248 function sqimap_get_flags_list ($imap_stream, $msg_list) {
249 $msgs_str = sqimap_message_list_squisher($msg_list);
250 for ($i = 0; $i < sizeof($msg_list); $i++
) {
251 $id2index[$msg_list[$i]] = $i;
253 fputs ($imap_stream, sqimap_session_id() . " FETCH $msgs_str FLAGS\r\n");
254 $result_list = sqimap_read_data_list ($imap_stream, sqimap_session_id(), true, $response, $message);
255 $result_flags = array();
257 for ($i = 0; $i < sizeof($result_list); $i++
) {
258 if (eregi("^\\* ([0-9]+).*FETCH.*FLAGS(.*)", $result_list[$i][0], $regs)
259 && isset($id2index[$regs[1]]) && count($id2index[$regs[1]])) {
260 $result_flags[$id2index[$regs[1]]] = explode(" ", trim(ereg_replace('[\\(\\)\\\\]', '', $regs[2])));
262 set_up_language($squirrelmail_language);
263 echo "<br><b><font color=$color[2]>\n";
264 echo _("ERROR : Could not complete request.");
266 echo _("Unknown response from IMAP server: ");
267 echo $result_list[$i][0] . "</font><br>\n";
271 arsort($result_flags);
272 return $result_flags;
275 /******************************************************************************
276 ** Returns a message array with all the information about a message. See
277 ** the documentation folder for more information about this array.
278 ******************************************************************************/
279 function sqimap_get_message ($imap_stream, $id, $mailbox) {
280 $header = sqimap_get_message_header($imap_stream, $id, $mailbox);
281 return sqimap_get_message_body($imap_stream, $header);
284 /******************************************************************************
285 ** Wrapper function that reformats the header information.
286 ******************************************************************************/
287 function sqimap_get_message_header ($imap_stream, $id, $mailbox) {
288 fputs ($imap_stream, sqimap_session_id() . " FETCH $id:$id BODY[HEADER]\r\n");
289 $read = sqimap_read_data ($imap_stream, sqimap_session_id(), true, $response, $message);
291 $header = sqimap_get_header($imap_stream, $read);
293 $header->mailbox
= $mailbox;
298 /******************************************************************************
299 ** Wrapper function that returns entity headers for use by decodeMime
300 ******************************************************************************/
302 function sqimap_get_entity_header ($imap_stream, &$read, &$type0, &$type1, &$bound, &$encoding, &$charset, &$filename) {
303 $header = sqimap_get_header($imap_stream, $read);
304 $type0 = $header["TYPE0"];
305 $type1 = $header["TYPE1"];
306 $bound = $header["BOUNDARY"];
307 $encoding = $header["ENCODING"];
308 $charset = $header["CHARSET"];
309 $filename = $header["FILENAME"];
313 /******************************************************************************
314 ** Queries the IMAP server and gets all header information.
315 ******************************************************************************/
316 function sqimap_get_header ($imap_stream, $read) {
317 global $where, $what;
319 $hdr = new msg_header();
321 // Set up some defaults
322 $hdr->type0
= "text";
323 $hdr->type1
= "plain";
324 $hdr->charset
= "us-ascii";
326 while ($i < count($read)) {
327 if (substr($read[$i], 0, 17) == "MIME-Version: 1.0") {
332 /** ENCODING TYPE **/
333 else if (substr(strtolower($read[$i]), 0, 26) == "content-transfer-encoding:") {
334 $hdr->encoding
= strtolower(trim(substr($read[$i], 26)));
339 else if (strtolower(substr($read[$i], 0, 13)) == "content-type:") {
340 $cont = strtolower(trim(substr($read[$i], 13)));
341 if (strpos($cont, ";"))
342 $cont = substr($cont, 0, strpos($cont, ";"));
345 if (strpos($cont, "/")) {
346 $hdr->type0
= substr($cont, 0, strpos($cont, "/"));
347 $hdr->type1
= substr($cont, strpos($cont, "/")+
1);
355 while ( (substr(substr($read[$i], 0, strpos($read[$i], " ")), -1) != ":") && (trim($read[$i]) != "") && (trim($read[$i]) != ")")) {
356 str_replace("\n", "", $line);
357 str_replace("\n", "", $read[$i]);
358 $line = "$line $read[$i]";
362 /** Detect the boundary of a multipart message **/
363 if (eregi('boundary="([^"]+)"', $line, $regs)) {
364 $hdr->boundary
= $regs[1];
367 /** Detect the charset **/
368 if (strpos(strtolower(trim($line)), "charset=")) {
369 $pos = strpos($line, "charset=") +
8;
370 $charset = trim($line);
371 if (strpos($line, ";", $pos) > 0) {
372 $charset = substr($charset, $pos, strpos($line, ";", $pos)-$pos);
374 $charset = substr($charset, $pos);
376 $charset = str_replace("\"", "", $charset);
377 $hdr->charset
= $charset;
379 $hdr->charset
= "us-ascii";
384 else if (strtolower(substr($read[$i], 0, 20)) == "content-disposition:") {
385 /** Add better dontent-disposition support **/
389 while ( (substr(substr($read[$i], 0, strpos($read[$i], " ")), -1) != ":") && (trim($read[$i]) != "") && (trim($read[$i]) != ")")) {
390 str_replace("\n", "", $line);
391 str_replace("\n", "", $read[$i]);
392 $line = "$line $read[$i]";
396 /** Detects filename if any **/
397 if (strpos(strtolower(trim($line)), "filename=")) {
398 $pos = strpos($line, "filename=") +
9;
400 if (strpos($line, " ", $pos) > 0) {
401 $name = substr($name, $pos, strpos($line, " ", $pos));
403 $name = substr($name, $pos);
405 $name = str_replace("\"", "", $name);
406 $hdr->filename
= $name;
411 else if (strtolower(substr($read[$i], 0, 9)) == "reply-to:") {
412 $hdr->replyto
= trim(substr($read[$i], 9, strlen($read[$i])));
417 else if (strtolower(substr($read[$i], 0, 5)) == "from:") {
418 $hdr->from
= trim(substr($read[$i], 5, strlen($read[$i]) - 6));
419 if (! isset($hdr->replyto
) ||
$hdr->replyto
== "")
420 $hdr->replyto
= $hdr->from
;
424 else if (strtolower(substr($read[$i], 0, 5)) == "date:") {
425 $d = substr($read[$i], 5);
427 $d = strtr($d, array(' ' => ' '));
428 $d = explode(' ', $d);
429 $hdr->date
= getTimeStamp($d);
433 else if (strtolower(substr($read[$i], 0, 8)) == "subject:") {
434 $hdr->subject
= trim(substr($read[$i], 8, strlen($read[$i]) - 9));
435 if (strlen(Chop($hdr->subject
)) == 0)
436 $hdr->subject
= _("(no subject)");
438 if ($where == "SUBJECT") {
439 $hdr->subject
= eregi_replace($what, "<b>\\0</b>", $hdr->subject
);
444 else if (strtolower(substr($read[$i], 0, 3)) == "cc:") {
446 $hdr->cc
[$pos] = trim(substr($read[$i], 4));
448 while (((substr($read[$i], 0, 1) == " ") ||
(substr($read[$i], 0, 1) == "\t")) && (trim($read[$i]) != "")){
450 $hdr->cc
[$pos] = trim($read[$i]);
455 else if (strtolower(substr($read[$i], 0, 4)) == "bcc:") {
457 $hdr->bcc
[$pos] = trim(substr($read[$i], 5));
459 while (((substr($read[$i], 0, 1) == " ") ||
(substr($read[$i], 0, 1) == "\t")) && (trim($read[$i]) != "")){
461 $hdr->bcc
[$pos] = trim($read[$i]);
466 else if (strtolower(substr($read[$i], 0, 3)) == "to:") {
468 $hdr->to
[$pos] = trim(substr($read[$i], 4));
470 while (((substr($read[$i], 0, 1) == " ") ||
(substr($read[$i], 0, 1) == "\t")) && (trim($read[$i]) != "")){
472 $hdr->to
[$pos] = trim($read[$i]);
477 else if (strtolower(substr($read[$i], 0, 11)) == "message-id:") {
478 $hdr->message_id
= trim(substr($read[$i], 11));
483 /** ERROR CORRECTION **/
484 else if (substr($read[$i], 0, 1) == ")") {
485 if (strlen(trim($hdr->subject
)) == 0)
486 $hdr->subject
= _("(no subject)");
488 if (strlen(trim($hdr->from
)) == 0)
489 $hdr->from
= _("(unknown sender)");
491 if (strlen(trim($hdr->date
)) == 0)
503 /******************************************************************************
504 ** Returns the body of a message.
505 ******************************************************************************/
506 function sqimap_get_message_body ($imap_stream, &$header) {
508 return decodeMime($imap_stream, $header);
512 /******************************************************************************
513 ** Returns an array with the body structure
514 ******************************************************************************/