056abb2f670fb11f33f391414c6e3272daa8052c
[squirrelmail.git] / functions / mailbox.php
1 <?
2 /**
3 ** mailbox.php
4 **
5 ** This contains functions that request information about a mailbox. Including
6 ** reading and parsing headers, getting folder information, etc.
7 **
8 **/
9
10 function selectMailbox($imapConnection, $mailbox, &$numberOfMessages) {
11 // select mailbox
12 fputs($imapConnection, "mailboxSelect SELECT \"$mailbox\"\n");
13 $data = imapReadData($imapConnection, "mailboxSelect");
14 for ($i = 0; $i < count($data); $i++) {
15 if (substr(Chop($data[$i]), -6) == "EXISTS") {
16 $array = explode(" ", $data[$i]);
17 $numberOfMessages = $array[1];
18 }
19 }
20 }
21
22 function unseenMessages($imapConnection, &$numUnseen) {
23 fputs($imapConnection, "1 SEARCH UNSEEN NOT DELETED\n");
24 $read = fgets($imapConnection, 1024);
25 $unseen = false;
26
27 if (strlen($read) > 10) {
28 $unseen = true;
29 $ary = explode(" ", $read);
30 $numUnseen = count($ary) - 2;
31 }
32 else {
33 $unseen = false;
34 $numUnseen = 0;
35 }
36
37 $read = fgets($imapConnection, 1024);
38 return $unseen;
39 }
40
41 /** This function sends a request to the IMAP server for headers, 50 at a time
42 ** until $end is reached. I originally had it do them all at one time, but found
43 ** it slightly faster to do it this way.
44 **
45 ** Originally we had getMessageHeaders get the headers for one message at a time.
46 ** Doing it in bunches gave us a speed increase from 9 seconds (for a box of 800
47 ** messages) to about 3.5 seconds.
48 **/
49 function getMessageHeaders($imapConnection, $start, $end, &$from, &$subject, &$date) {
50 $rel_start = $start;
51 if (($start > $end) || ($start < 1)) {
52 echo "Error in message header fetching. Start message: $start, End message: $end<BR>";
53 exit;
54 }
55
56 $pos = 0;
57 while ($rel_start <= $end) {
58 if ($end - $rel_start > 50) {
59 $rel_end = $rel_start + 49;
60 } else {
61 $rel_end = $end;
62 }
63 fputs($imapConnection, "messageFetch FETCH $rel_start:$rel_end RFC822.HEADER.LINES (From Subject Date)\n");
64 $read = fgets($imapConnection, 1024);
65
66 while ((substr($read, 0, 15) != "messageFetch OK") && (substr($read, 0, 16) != "messageFetch BAD")) {
67
68 if (substr($read, 0, 5) == "From:") {
69 $read = encodeEmailAddr("$read");
70 $from[$pos] = substr($read, 5, strlen($read) - 6);
71 }
72 else if (substr($read, 0, 5) == "Date:") {
73 $read = ereg_replace("<", "&lt;", $read);
74 $read = ereg_replace(">", "&gt;", $read);
75 $date[$pos] = substr($read, 5, strlen($read) - 6);
76 }
77 else if (substr($read, 0, 8) == "Subject:") {
78 $read = ereg_replace("<", "&lt;", $read);
79 $read = ereg_replace(">", "&gt;", $read);
80 $subject[$pos] = substr($read, 8, strlen($read) - 9);
81 if (strlen(Chop($subject[$pos])) == 0)
82 $subject[$pos] = "(no subject)";
83 }
84 else if (substr($read, 0, 1) == ")") {
85 if ($subject[$pos] == "")
86 $subject[$pos] = "(no subject)";
87 else if ($from[$pos] == "")
88 $from[$pos] = "(unknown sender)";
89 else if ($date[$pos] == "")
90 $from[$pos] = gettimeofday();
91
92 $pos++;
93 }
94
95 $read = fgets($imapConnection, 1024);
96 }
97 $rel_start = $rel_start + 50;
98 }
99 }
100
101 function encodeEmailAddr($string) {
102 $string = ereg_replace("<", "EMAILSTART--", $string);
103 $string = ereg_replace(">", "--EMAILEND", $string);
104 return $string;
105 }
106
107 function setMessageFlag($imapConnection, $i, $q, $flag) {
108 fputs($imapConnection, "messageStore STORE $i:$q +FLAGS (\\$flag)\n");
109 }
110
111 /** This function gets the flags for message $j. It does only one message at a
112 ** time, rather than doing groups of messages (like getMessageHeaders does).
113 ** I found it one or two seconds quicker (on a box of 800 messages) to do it
114 ** individually. I'm not sure why it happens like that, but that's what my
115 ** testing found. Perhaps later I will be proven wrong and this will change.
116 **/
117 function getMessageFlags($imapConnection, $j, &$flags) {
118 /** * 2 FETCH (FLAGS (\Answered \Seen)) */
119 fputs($imapConnection, "messageFetch FETCH $j:$j FLAGS\n");
120 $read = fgets($imapConnection, 1024);
121 $count = 0;
122 while ((substr($read, 0, 15) != "messageFetch OK") && (substr($read, 0, 16) != "messageFetch BAD")) {
123 if (strpos($read, "FLAGS")) {
124 $read = ereg_replace("\(", "", $read);
125 $read = ereg_replace("\)", "", $read);
126 $read = substr($read, strpos($read, "FLAGS")+6, strlen($read));
127 $read = trim($read);
128 $flags = explode(" ", $read);;
129 $s = 0;
130 while ($s < count($flags)) {
131 $flags[$s] = substr($flags[$s], 1, strlen($flags[$s]));
132 $s++;
133 }
134 } else {
135 $flags[0] = "None";
136 }
137 $count++;
138 $read = fgets($imapConnection, 1024);
139 }
140 }
141
142 function decodeEmailAddr($sender) {
143 $emailAddr = getEmailAddr($sender);
144 if (strpos($emailAddr, "EMAILSTART--")) {
145
146 $emailAddr = ereg_replace("EMAILSTART--", "", $emailAddr);
147 $emailAddr = ereg_replace("--EMAILEND", "", $emailAddr);
148 } else {
149 $emailAddr = $emailAddr;
150 }
151 return $emailAddr;
152 }
153
154 function getEmailAddr($sender) {
155 if (strpos($sender, "EMAILSTART--") == false)
156 return "$sender";
157
158 $emailStart = strpos($sender, "EMAILSTART--") + 12;
159 $emailAddr = substr($sender, $emailStart, strlen($sender));
160 $emailAddr = substr($emailAddr, 0, strpos($emailAddr, "--EMAILEND"));
161
162 return $emailAddr;
163 }
164
165 function getSender($sender) {
166 if (strpos($sender, "EMAILSTART--") == false)
167 return "$sender";
168
169 $first = substr($sender, 0, strpos($sender, "EMAILSTART--"));
170 $second = substr($sender, strpos($sender, "--EMAILEND") +10, strlen($sender));
171 return "$first $second";
172 }
173
174 function getSenderName($sender) {
175 $name = getSender($sender);
176 $emailAddr = getEmailAddr($sender);
177 $emailStart = strpos($emailAddr, "EMAILSTART--");
178 $emailEnd = strpos($emailAddr, "--EMAILEND") - 10;
179
180 if (($emailAddr == "") && ($name == "")) {
181 $from = $sender;
182 }
183 else if ((strstr($name, "?") != false) || (strstr($name, "$") != false) || (strstr($name, "%") != false)){
184 $emailAddr = ereg_replace("EMAILSTART--", "", $emailAddr);
185 $emailAddr = ereg_replace("--EMAILEND", "", $emailAddr);
186 $from = $emailAddr;
187 }
188 else if (strlen($name) > 0) {
189 $from = $name;
190 }
191 else if (strlen($emailAddr > 0)) {
192 $emailAddr = ereg_replace("EMAILSTART--", "", $emailAddr);
193 $emailAddr = ereg_replace("--EMAILEND", "", $emailAddr);
194 $from = $emailAddr;
195 }
196
197 $from = trim($from);
198
199 // strip out any quotes if they exist
200 if ((strlen($from) > 0) && ($from[0] == "\"") && ($from[strlen($from) - 1] == "\""))
201 $from = substr($from, 1, strlen($from) - 2);
202
203 return $from;
204 }
205
206 /** returns "true" if the copy was completed successfully.
207 ** returns "false" with an error message if unsuccessful.
208 **/
209 function copyMessages($imapConnection, $from_id, $to_id, $folder) {
210 fputs($imapConnection, "mailboxStore COPY $from_id:$to_id \"$folder\"\n");
211 $read = fgets($imapConnection, 1024);
212 while ((substr($read, 0, 15) != "mailboxStore OK") && (substr($read, 0, 15) != "mailboxStore NO")) {
213 $read = fgets($imapConnection, 1024);
214 }
215
216 if (substr($read, 0, 15) == "mailboxStore NO") {
217 return false;
218 } else if (substr($read, 0, 15) == "mailboxStore OK") {
219 return true;
220 }
221
222 echo "UNKNOWN ERROR copying messages $from_id to $to_id to folder $folder.<BR>";
223 return false;
224 }
225
226 /** expunges a mailbox **/
227 function expungeBox($imapConnection, $mailbox) {
228 selectMailbox($imapConnection, $mailbox, $num);
229 fputs($imapConnection, "1 EXPUNGE\n");
230 }
231
232 function getFolderNameMinusINBOX($mailbox, $del) {
233 $inbox = "INBOX" . $del;
234 if (substr($mailbox, 0, strlen($inbox)) == $inbox)
235 $box = substr($mailbox, strlen($inbox), strlen($mailbox));
236 else
237 $box = $mailbox;
238
239 return $box;
240 }
241
242 /** This function gets all the information about a message. Including Header and body **/
243 function fetchMessage($imapConnection, $id) {
244 $message["HEADER"] = fetchHeader($imapConnection, $id);
245 $message["ENTITIES"] = fetchBody($imapConnection, $message["HEADER"]["BOUNDARY"], $id, $message["HEADER"]["TYPE0"], $message["HEADER"]["TYPE1"]);
246
247 return $message;
248 }
249
250 function fetchHeader($imapConnection, $id) {
251 fputs($imapConnection, "messageFetch FETCH $id:$id RFC822.HEADER\n");
252 $read = fgets($imapConnection, 1024);
253
254 /** defaults... if the don't get overwritten, it will display text **/
255 $header["TYPE0"] = "text";
256 $header["TYPE1"] = "plain";
257 $header["ENCODING"] = "us-ascii";
258 while ((substr($read, 0, 15) != "messageFetch OK") && (substr($read, 0, 16) != "messageFetch BAD")) {
259 /** MIME-VERSION **/
260 if (substr($read, 0, 17) == "MIME-Version: 1.0") {
261 $header["MIME"] = true;
262 $read = fgets($imapConnection, 1024);
263 }
264
265 /** ENCODING TYPE **/
266 else if (substr($read[$i], 0, 26) == "Content-Transfer-Encoding:") {
267 $header["ENCODING"] = strtolower(trim(substr($read[$i], 26)));
268 }
269
270 /** CONTENT-TYPE **/
271 else if (substr($read, 0, 13) == "Content-Type:") {
272 $cont = strtolower(trim(substr($read, 13)));
273 if (strpos($cont, ";"))
274 $cont = substr($cont, 0, strpos($cont, ";"));
275
276 if (strpos($cont, "/")) {
277 $header["TYPE0"] = substr($cont, 0, strpos($cont, "/"));
278 $header["TYPE1"] = substr($cont, strpos($cont, "/")+1);
279 } else {
280 $header["TYPE0"] = $cont;
281 }
282
283 $line = $read;
284 $read = fgets($imapConnection, 1024);
285 while ( (substr(substr($read, 0, strpos($read, " ")), -1) != ":") && (trim($read) != "") && (trim($read) != ")")) {
286 str_replace("\n", "", $line);
287 str_replace("\n", "", $read);
288 $line = "$line $read";
289 $read = fgets($imapConnection, 1024);
290 }
291
292 /** Detect the boundary of a multipart message **/
293 if (strpos(strtolower(trim($line)), "boundary=")) {
294 $pos = strpos($line, "boundary=") + 9;
295 $bound = trim($line);
296 if (strpos($line, " ", $pos) > 0) {
297 $bound = substr($bound, $pos, strpos($line, " ", $pos));
298 } else {
299 $bound = substr($bound, $pos);
300 }
301 $bound = str_replace("\"", "", $bound);
302 $header["BOUNDARY"] = $bound;
303 }
304
305 /** Detect the charset **/
306 if (strpos(strtolower(trim($line)), "charset=")) {
307 $pos = strpos($line, "charset=") + 8;
308 $charset = trim($line);
309 if (strpos($line, " ", $pos) > 0) {
310 $charset = substr($charset, $pos, strpos($line, " ", $pos));
311 } else {
312 $charset = substr($charset, $pos);
313 }
314 $charset = str_replace("\"", "", $charset);
315 $header["CHARSET"] = $charset;
316 } else {
317 $header["CHARSET"] = "us-ascii";
318 }
319
320 /** Detects filename if any **/
321 if (strpos(strtolower(trim($line)), "name=")) {
322 $pos = strpos($line, "name=") + 5;
323 $name = trim($line);
324 if (strpos($line, " ", $pos) > 0) {
325 $name = substr($name, $pos, strpos($line, " ", $pos));
326 } else {
327 $name = substr($name, $pos);
328 }
329 $name = str_replace("\"", "", $name);
330 $header["FILENAME"] = $name;
331 }
332 }
333
334 /** REPLY-TO **/
335 else if (strtolower(substr($read, 0, 9)) == "reply-to:") {
336 $header["REPLYTO"] = trim(substr($read, 9, strlen($read)));
337 $read = fgets($imapConnection, 1024);
338 }
339
340 /** FROM **/
341 else if (strtolower(substr($read, 0, 5)) == "from:") {
342 $header["FROM"] = trim(substr($read, 5, strlen($read) - 6));
343 if ($header["REPLYTO"] == "")
344 $header["REPLYTO"] = $header["FROM"];
345 $read = fgets($imapConnection, 1024);
346 }
347 /** DATE **/
348 else if (strtolower(substr($read, 0, 5)) == "date:") {
349 $d = substr($read, 5, strlen($read) - 6);
350 $d = trim($d);
351 $d = ereg_replace(" ", " ", $d);
352 $d = explode(" ", $d);
353 $header["DATE"] = getTimeStamp($d);
354 $read = fgets($imapConnection, 1024);
355 }
356 /** SUBJECT **/
357 else if (strtolower(substr($read, 0, 8)) == "subject:") {
358 $header["SUBJECT"] = trim(substr($read, 8, strlen($read) - 9));
359 if (strlen(Chop($header["SUBJECT"])) == 0)
360 $header["SUBJECT"] = "(no subject)";
361 $read = fgets($imapConnection, 1024);
362 }
363 /** CC **/
364 else if (strtolower(substr($read, 0, 3)) == "cc:") {
365 $pos = 0;
366 $header["CC"][$pos] = trim(substr($read, 4));
367 $read = fgets($imapConnection, 1024);
368 while ((substr($read, 0, 1) == " ") && (trim($read) != "")) {
369 $pos++;
370 $header["CC"][$pos] = trim($read);
371 $read = fgets($imapConnection, 1024);
372 }
373 }
374 /** TO **/
375 else if (strtolower(substr($read, 0, 3)) == "to:") {
376 $pos = 0;
377 $header["TO"][$pos] = trim(substr($read, 4));
378 $read = fgets($imapConnection, 1024);
379 while ((substr($read, 0, 1) == " ") && (trim($read) != "")){
380 $pos++;
381 $header["TO"][$pos] = trim($read);
382 $read = fgets($imapConnection, 1024);
383 }
384 }
385
386 /** ERROR CORRECTION **/
387 else if (substr($read, 0, 1) == ")") {
388 if ($header["SUBJECT"] == "")
389 $header["SUBJECT"] = "(no subject)";
390
391 if ($header["FROM"] == "")
392 $header["FROM"] = "(unknown sender)";
393
394 if ($header["DATE"] == "")
395 $header["DATE"] = time();
396 $read = fgets($imapConnection, 1024);
397 }
398 else {
399 $read = fgets($imapConnection, 1024);
400 }
401 }
402 return $header;
403 }
404
405 function fetchBody($imapConnection, $bound, $id, $type0, $type1) {
406 /** This first part reads in the full body of the message **/
407 fputs($imapConnection, "messageFetch FETCH $id:$id BODY[TEXT]\n");
408 $read = fgets($imapConnection, 1024);
409
410 $count = 0;
411 while ((substr($read, 0, 15) != "messageFetch OK") && (substr($read, 0, 16) != "messageFetch BAD")) {
412 $body[$count] = $read;
413 $count++;
414
415 $read = fgets($imapConnection, 1024);
416 }
417
418 /** this deletes the first line, and the last two (imap stuff we ignore) **/
419 $i = 0;
420 $j = 0;
421 while ($i < count($body)) {
422 if ( ($i != 0) && ($i != count($body) - 1) && ($i != count($body)) ) {
423 $bodytmp[$j] = $body[$i];
424 $j++;
425 }
426 $i++;
427 }
428 $body = $bodytmp;
429
430 /** Now, lets work out the MIME stuff **/
431 /** (needs mime.php included) **/
432 return decodeMime($body, $bound, $type0, $type1);
433 }
434
435 function fetchEntityHeader($imapConnection, &$read, &$type0, &$type1, &$bound, &$encoding, &$charset, &$filename) {
436 /** defaults... if the don't get overwritten, it will display text **/
437 $type0 = "text";
438 $type1 = "plain";
439 $encoding = "us-ascii";
440 $i = 0;
441 while (trim($read[$i]) != "") {
442 if (substr($read[$i], 0, 26) == "Content-Transfer-Encoding:") {
443 $encoding = strtolower(trim(substr($read[$i], 26)));
444
445 } else if (substr($read[$i], 0, 13) == "Content-Type:") {
446 $cont = strtolower(trim(substr($read[$i], 13)));
447 if (strpos($cont, ";"))
448 $cont = substr($cont, 0, strpos($cont, ";"));
449
450 if (strpos($cont, "/")) {
451 $type0 = substr($cont, 0, strpos($cont, "/"));
452 $type1 = substr($cont, strpos($cont, "/")+1);
453 } else {
454 $type0 = $cont;
455 }
456
457 $read[$i] = trim($read[$i]);
458 $line = $read[$i];
459 $i++;
460 while ( (substr(substr($read[$i], 0, strpos($read[$i], " ")), -1) != ":") && (trim($read[$i]) != "") && (trim($read[$i]) != ")")) {
461 str_replace("\n", "", $line);
462 str_replace("\n", "", $read[$i]);
463 $line = "$line $read[$i]";
464 $i++;
465 $read[$i] = trim($read[$i]);
466 }
467
468 /** Detect the boundary of a multipart message **/
469 if (strpos(strtolower(trim($line)), "boundary=")) {
470 $pos = strpos($line, "boundary=") + 9;
471 $bound = trim($line);
472 if (strpos($line, " ", $pos) > 0) {
473 $bound = substr($bound, $pos, strpos($line, " ", $pos));
474 } else {
475 $bound = substr($bound, $pos);
476 }
477 $bound = str_replace("\"", "", $bound);
478 }
479
480 /** Detect the charset **/
481 if (strpos(strtolower(trim($line)), "charset=")) {
482 $pos = strpos($line, "charset=") + 8;
483 $charset = trim($line);
484 if (strpos($line, " ", $pos) > 0) {
485 $charset = substr($charset, $pos, strpos($line, " ", $pos));
486 } else {
487 $charset = substr($charset, $pos);
488 }
489 $charset = str_replace("\"", "", $charset);
490 }
491
492 /** Detects filename if any **/
493 if (strpos(strtolower(trim($line)), "name=")) {
494 $pos = strpos($line, "name=") + 5;
495 $name = trim($line);
496 if (strpos($line, " ", $pos) > 0) {
497 $name = substr($name, $pos, strpos($line, " ", $pos));
498 } else {
499 $name = substr($name, $pos);
500 }
501 $name = str_replace("\"", "", $name);
502 $filename = $name;
503 }
504 }
505 $i++;
506 }
507
508 /** remove the header from the entity **/
509 $i = 0;
510 while (trim($read[$i]) != "") {
511 $i++;
512 }
513 $i++;
514
515 for ($p = 0; $i < count($read); $p++) {
516 $entity[$p] = $read[$i];
517 $i++;
518 }
519
520 $read = $entity;
521 }
522
523 function parsePlainTextMessage($line) {
524 $line = "^^$line";
525
526 if ((strpos(strtolower($line), "<!") == false) &&
527 (strpos(strtolower($line), "<html>") == false) &&
528 (strpos(strtolower($line), "</html>") == false)) {
529 $line = str_replace("<", "&lt;", $line);
530 $line = str_replace(">", "&gt;", $line);
531 }
532
533 $wrap_at = 86; // Make this configurable int the config file some time
534 if (strlen($line) - 2 >= $wrap_at) // -2 because of the ^^ at the beginning
535 $line = wordWrap($line, $wrap_at);
536
537 $line = str_replace(" ", "&nbsp;", $line);
538 $line = str_replace("\t", "&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;", $line);
539 $line = str_replace("\n", "", $line);
540
541 /** if >> or > are found at the beginning of a line, I'll assume that was
542 replied text, so make it different colors **/
543 if (strpos(trim(str_replace("&nbsp;", "", $line)), "&gt;&gt;") == 2) {
544 $line = substr($line, 2, strlen($line));
545 $line = "<TT><FONT COLOR=FF0000>$line</FONT></TT><BR>\n";
546 } else if (strpos(trim(str_replace("&nbsp;", "", $line)), "&gt;") == 2) {
547 $line = substr($line, 2, strlen($line));
548 $line = "<TT><FONT COLOR=800000>$line</FONT></TT><BR>\n";
549 } else {
550 $line = substr($line, 2, strlen($line));
551 $line = "<TT><FONT COLOR=000000>$line</FONT></TT><BR>\n";
552 }
553
554 /** This translates "http://" into a link. It could be made better to accept
555 "www" and "mailto" also. That should probably be added later. **/
556 if (strpos(strtolower($line), "http://") != false) {
557 $line = ereg_replace("<BR>", "", $line);
558 $start = strpos(strtolower($line), "http://");
559 $link = substr($line, $start, strlen($line));
560
561 if (strpos($link, " ")) {
562 $end = strpos($link, " ")-1;
563 }
564 else if (strpos($link, "&nbsp;")) {
565 $end = strpos($link, "&nbsp;")-1;
566 }
567 else if (strpos($link, "<")) {
568 $end = strpos($link, "<");
569 }
570 else if (strpos($link, ">")) {
571 $end = strpos($link, ">");
572 }
573 else if (strpos($link, "(")) {
574 $end = strpos($link, "(")-1;
575 }
576 else if (strpos($link, ")")) {
577 $end = strpos($link, ")")-1;
578 }
579 else if (strpos($link, "{")) {
580 $end = strpos($link, "{")-1;
581 }
582 else if (strpos($link, "}")) {
583 $end = strpos($link, "}")-1;
584 }
585 else
586 $end = strlen($link);
587
588 $link = substr($line, $start, $end);
589 $end = $end + $start;
590 $before = substr($line, 0, $start);
591 $after = substr($line, $end, strlen($line));
592
593 $line = "$before<A HREF=\"$link\" TARGET=_top>$link</A>$after<BR>";
594 }
595
596 return $line;
597 }
598 ?>