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