imap_messages.php 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504
  1. <?php
  2. /**
  3. ** imap_messages.php
  4. **
  5. ** This implements functions that manipulate messages
  6. **
  7. ** $Id$
  8. **/
  9. if (defined ('imap_messages_php'))
  10. return;
  11. define ('imap_messages_php', true);
  12. /******************************************************************************
  13. ** Copies specified messages to specified folder
  14. ******************************************************************************/
  15. function sqimap_messages_copy ($imap_stream, $start, $end, $mailbox) {
  16. fputs ($imap_stream, sqimap_session_id() . " COPY $start:$end \"$mailbox\"\r\n");
  17. $read = sqimap_read_data ($imap_stream, sqimap_session_id(), true, $response, $message);
  18. }
  19. /******************************************************************************
  20. ** Deletes specified messages and moves them to trash if possible
  21. ******************************************************************************/
  22. function sqimap_messages_delete ($imap_stream, $start, $end, $mailbox) {
  23. global $move_to_trash, $trash_folder, $auto_expunge;
  24. if (($move_to_trash == true) && (sqimap_mailbox_exists($imap_stream, $trash_folder) && ($mailbox != $trash_folder))) {
  25. sqimap_messages_copy ($imap_stream, $start, $end, $trash_folder);
  26. sqimap_messages_flag ($imap_stream, $start, $end, "Deleted");
  27. } else {
  28. sqimap_messages_flag ($imap_stream, $start, $end, "Deleted");
  29. }
  30. }
  31. /******************************************************************************
  32. ** Sets the specified messages with specified flag
  33. ******************************************************************************/
  34. function sqimap_messages_flag ($imap_stream, $start, $end, $flag) {
  35. fputs ($imap_stream, sqimap_session_id() . " STORE $start:$end +FLAGS (\\$flag)\r\n");
  36. $read = sqimap_read_data ($imap_stream, sqimap_session_id(), true, $response, $message);
  37. }
  38. /******************************************************************************
  39. ** Remove specified flag from specified messages
  40. ******************************************************************************/
  41. function sqimap_messages_remove_flag ($imap_stream, $start, $end, $flag) {
  42. fputs ($imap_stream, sqimap_session_id() . " STORE $start:$end -FLAGS (\\$flag)\r\n");
  43. $read = sqimap_read_data ($imap_stream, sqimap_session_id(), true, $response, $message);
  44. }
  45. /******************************************************************************
  46. ** Returns some general header information -- FROM, DATE, and SUBJECT
  47. ******************************************************************************/
  48. class small_header {
  49. var $from = '', $subject = '', $date = '', $to = '',
  50. $priority = 0, $message_id = 0, $cc = '';
  51. }
  52. function sqimap_get_small_header ($imap_stream, $id, $sent) {
  53. $res = sqimap_get_small_header_list($imap_stream, array($id), $sent);
  54. return $res[0];
  55. }
  56. // Sort the message list and crunch to be as small as possible
  57. // (overflow could happen, so make it small if possible)
  58. function sqimap_message_list_squisher($messages_array) {
  59. if( !is_array( $messages_array ) ) return;
  60. sort($messages_array, SORT_NUMERIC);
  61. $msgs_str = '';
  62. while ($messages_array) {
  63. $start = array_shift($messages_array);
  64. $end = $start;
  65. while (isset($messages_array[0]) && $messages_array[0] == $end + 1)
  66. $end = array_shift($messages_array);
  67. if ($msgs_str != '')
  68. $msgs_str .= ',';
  69. $msgs_str .= $start;
  70. if ($start != $end)
  71. $msgs_str .= ':' . $end;
  72. }
  73. return $msgs_str;
  74. }
  75. function sqimap_get_small_header_list ($imap_stream, $msg_list, $issent) {
  76. global $squirrelmail_language, $color;
  77. /* Get the small headers for each message in $msg_list */
  78. $sid = sqimap_session_id();
  79. $maxmsg = sizeof($msg_list);
  80. $msgs_str = sqimap_message_list_squisher($msg_list);
  81. $results = array();
  82. $read_list = array();
  83. $sizes_list = array();
  84. /**
  85. * We need to return the data in the same order as the caller supplied
  86. * in $msg_list, but IMAP servers are free to return responses in
  87. * whatever order they wish... So we need to re-sort manually
  88. */
  89. for ($i = 0; $i < sizeof($msg_list); $i++) {
  90. $id2index[$msg_list[$i]] = $i;
  91. }
  92. $query = "$sid FETCH $msgs_str BODY.PEEK[HEADER.FIELDS (Date To From Cc Subject Message-Id X-Priority Content-Type)]\r\n";
  93. fputs ($imap_stream, $query);
  94. $readin_list = sqimap_read_data_list($imap_stream, $sid, true, $response, $message);
  95. foreach ($readin_list as $r) {
  96. if (!eregi("^\\* ([0-9]+) FETCH", $r[0], $regs)) {
  97. set_up_language($squirrelmail_language);
  98. echo '<br><b><font color=$color[2]>' .
  99. _("ERROR : Could not complete request.") .
  100. '</b><br>' .
  101. _("Unknown response from IMAP server: ") . ' 1.' .
  102. $r[0] . "</font><br>\n";
  103. // exit;
  104. } else if (! isset($id2index[$regs[1]]) || !count($id2index[$regs[1]])) {
  105. set_up_language($squirrelmail_language);
  106. echo '<br><b><font color=$color[2]>' .
  107. _("ERROR : Could not complete request.") .
  108. '</b><br>' .
  109. _("Unknown message number in reply from server: ") .
  110. $regs[1] . "</font><br>\n";
  111. // exit;
  112. } else {
  113. $read_list[$id2index[$regs[1]]] = $r;
  114. }
  115. }
  116. arsort($read_list);
  117. $query = "$sid FETCH $msgs_str RFC822.SIZE\r\n";
  118. fputs ($imap_stream, $query);
  119. $sizesin_list = sqimap_read_data_list($imap_stream, $sid, true, $response, $message);
  120. foreach ($sizesin_list as $r) {
  121. if (!eregi("^\\* ([0-9]+) FETCH", $r[0], $regs)) {
  122. set_up_language($squirrelmail_language);
  123. echo "<br><b><font color=$color[2]>\n";
  124. echo _("ERROR : Could not complete request.");
  125. echo "</b><br>\n";
  126. echo _("Unknown response from IMAP server: ") . ' 2.';
  127. echo $r[0] . "</font><br>\n";
  128. exit;
  129. }
  130. if (!count($id2index[$regs[1]])) {
  131. set_up_language($squirrelmail_language);
  132. echo "<br><b><font color=$color[2]>\n";
  133. echo _("ERROR : Could not complete request.");
  134. echo "</b><br>\n";
  135. echo _("Unknown messagenumber in reply from server: ");
  136. echo $regs[1] . "</font><br>\n";
  137. exit;
  138. }
  139. $sizes_list[$id2index[$regs[1]]] = $r;
  140. }
  141. arsort($sizes_list);
  142. for ($msgi = 0; $msgi < $maxmsg; $msgi++) {
  143. $subject = _("(no subject)");
  144. $from = _("Unknown Sender");
  145. $priority = 0;
  146. $messageid = "<>";
  147. $cc = "";
  148. $to = "";
  149. $date = "";
  150. $type[0] = "";
  151. $type[1] = "";
  152. $read = $read_list[$msgi];
  153. for ($i = 0; $i < count($read); $i++) {
  154. if (eregi ("^to:(.*)$", $read[$i], $regs)) {
  155. //$to = sqimap_find_displayable_name(substr($read[$i], 3));
  156. $to = $regs[1];
  157. } else if (eregi ("^from:(.*)$", $read[$i], $regs)) {
  158. //$from = sqimap_find_displayable_name(substr($read[$i], 5));
  159. $from = $regs[1];
  160. } else if (eregi ("^x-priority:(.*)$", $read[$i], $regs)) {
  161. $priority = trim($regs[1]);
  162. } else if (eregi ("^message-id:(.*)$", $read[$i], $regs)) {
  163. $messageid = trim($regs[1]);
  164. } else if (eregi ("^cc:(.*)$", $read[$i], $regs)) {
  165. $cc = $regs[1];
  166. } else if (eregi ("^date:(.*)$", $read[$i], $regs)) {
  167. $date = $regs[1];
  168. } else if (eregi ("^subject:(.*)$", $read[$i], $regs)) {
  169. $subject = htmlspecialchars(trim($regs[1]));
  170. if ($subject == "")
  171. $subject = _("(no subject)");
  172. } else if (eregi ("^content-type:(.*)$", $read[$i], $regs)) {
  173. $type = strtolower(trim($regs[1]));
  174. if ($pos = strpos($type, ";"))
  175. $type = substr($type, 0, $pos);
  176. $type = explode("/", $type);
  177. if (! isset($type[1]))
  178. $type[1] = '';
  179. }
  180. }
  181. if (trim($date) == "") {
  182. fputs($imap_stream, "$sid FETCH $msg_list[$msgi] INTERNALDATE\r\n");
  183. $readdate = sqimap_read_data($imap_stream, $sid, true, $response, $message);
  184. if (eregi(".*INTERNALDATE \"(.*)\".*", $readdate[0], $regs)) {
  185. $date_list = explode(" ", trim($regs[1]));
  186. $date_list[0] = str_replace("-", " ", $date_list[0]);
  187. $date = implode(" ", $date_list);
  188. }
  189. }
  190. eregi("([0-9]+)[^0-9]*$", $sizes_list[$msgi][0], $regs);
  191. $size = $regs[1];
  192. $header = new small_header;
  193. if ($issent == true) {
  194. $header->from = (trim($to) != '' ? $to : '(' ._("No To Address") . ')');
  195. } else {
  196. $header->from = $from;
  197. }
  198. $header->date = $date;
  199. $header->subject = $subject;
  200. $header->to = $to;
  201. $header->priority = $priority;
  202. $header->message_id = $messageid;
  203. $header->cc = $cc;
  204. $header->size = $size;
  205. $header->type0 = $type[0];
  206. $header->type1 = $type[1];
  207. $result[] = $header;
  208. }
  209. return $result;
  210. }
  211. /******************************************************************************
  212. ** Returns the flags for the specified messages
  213. ******************************************************************************/
  214. function sqimap_get_flags ($imap_stream, $i) {
  215. fputs ($imap_stream, sqimap_session_id() . " FETCH $i:$i FLAGS\r\n");
  216. $read = sqimap_read_data ($imap_stream, sqimap_session_id(), true, $response, $message);
  217. if (ereg("FLAGS(.*)", $read[0], $regs))
  218. return explode(" ", trim(ereg_replace('[\\(\\)\\\\]', '', $regs[1])));
  219. return Array('None');
  220. }
  221. function sqimap_get_flags_list ($imap_stream, $msg_list) {
  222. $msgs_str = sqimap_message_list_squisher($msg_list);
  223. for ($i = 0; $i < sizeof($msg_list); $i++) {
  224. $id2index[$msg_list[$i]] = $i;
  225. }
  226. fputs ($imap_stream, sqimap_session_id() . " FETCH $msgs_str FLAGS\r\n");
  227. $result_list = sqimap_read_data_list ($imap_stream, sqimap_session_id(), true, $response, $message);
  228. $result_flags = array();
  229. for ($i = 0; $i < sizeof($result_list); $i++) {
  230. if (eregi("^\\* ([0-9]+).*FETCH.*FLAGS(.*)", $result_list[$i][0], $regs)
  231. && isset($id2index[$regs[1]]) && count($id2index[$regs[1]])) {
  232. $result_flags[$id2index[$regs[1]]] = explode(" ", trim(ereg_replace('[\\(\\)\\\\]', '', $regs[2])));
  233. } else {
  234. set_up_language($squirrelmail_language);
  235. echo "<br><b><font color=$color[2]>\n";
  236. echo _("ERROR : Could not complete request.");
  237. echo "</b><br>\n";
  238. echo _("Unknown response from IMAP server: ");
  239. echo $result_list[$i][0] . "</font><br>\n";
  240. exit;
  241. }
  242. }
  243. arsort($result_flags);
  244. return $result_flags;
  245. }
  246. /******************************************************************************
  247. ** Returns a message array with all the information about a message. See
  248. ** the documentation folder for more information about this array.
  249. ******************************************************************************/
  250. function sqimap_get_message ($imap_stream, $id, $mailbox) {
  251. $header = sqimap_get_message_header($imap_stream, $id, $mailbox);
  252. return sqimap_get_message_body($imap_stream, $header);
  253. }
  254. /******************************************************************************
  255. ** Wrapper function that reformats the header information.
  256. ******************************************************************************/
  257. function sqimap_get_message_header ($imap_stream, $id, $mailbox) {
  258. fputs ($imap_stream, sqimap_session_id() . " FETCH $id:$id BODY[HEADER]\r\n");
  259. $read = sqimap_read_data ($imap_stream, sqimap_session_id(), true, $response, $message);
  260. $header = sqimap_get_header($imap_stream, $read);
  261. $header->id = $id;
  262. $header->mailbox = $mailbox;
  263. return $header;
  264. }
  265. /******************************************************************************
  266. ** Wrapper function that returns entity headers for use by decodeMime
  267. ******************************************************************************/
  268. /*
  269. function sqimap_get_entity_header ($imap_stream, &$read, &$type0, &$type1, &$bound, &$encoding, &$charset, &$filename) {
  270. $header = sqimap_get_header($imap_stream, $read);
  271. $type0 = $header["TYPE0"];
  272. $type1 = $header["TYPE1"];
  273. $bound = $header["BOUNDARY"];
  274. $encoding = $header["ENCODING"];
  275. $charset = $header["CHARSET"];
  276. $filename = $header["FILENAME"];
  277. }
  278. */
  279. /******************************************************************************
  280. ** Queries the IMAP server and gets all header information.
  281. ******************************************************************************/
  282. function sqimap_get_header ($imap_stream, $read) {
  283. global $where, $what;
  284. $hdr = new msg_header();
  285. $i = 0;
  286. // Set up some defaults
  287. $hdr->type0 = "text";
  288. $hdr->type1 = "plain";
  289. $hdr->charset = "us-ascii";
  290. while ($i < count($read)) {
  291. if (substr($read[$i], 0, 17) == "MIME-Version: 1.0") {
  292. $hdr->mime = true;
  293. $i++;
  294. }
  295. /** ENCODING TYPE **/
  296. else if (substr(strtolower($read[$i]), 0, 26) == "content-transfer-encoding:") {
  297. $hdr->encoding = strtolower(trim(substr($read[$i], 26)));
  298. $i++;
  299. }
  300. /** CONTENT-TYPE **/
  301. else if (strtolower(substr($read[$i], 0, 13)) == "content-type:") {
  302. $cont = strtolower(trim(substr($read[$i], 13)));
  303. if (strpos($cont, ";"))
  304. $cont = substr($cont, 0, strpos($cont, ";"));
  305. if (strpos($cont, "/")) {
  306. $hdr->type0 = substr($cont, 0, strpos($cont, "/"));
  307. $hdr->type1 = substr($cont, strpos($cont, "/")+1);
  308. } else {
  309. $hdr->type0 = $cont;
  310. }
  311. $line = $read[$i];
  312. $i++;
  313. while ( (substr(substr($read[$i], 0, strpos($read[$i], " ")), -1) != ":") && (trim($read[$i]) != "") && (trim($read[$i]) != ")")) {
  314. str_replace("\n", "", $line);
  315. str_replace("\n", "", $read[$i]);
  316. $line = "$line $read[$i]";
  317. $i++;
  318. }
  319. /** Detect the boundary of a multipart message **/
  320. if (eregi('boundary="([^"]+)"', $line, $regs)) {
  321. $hdr->boundary = $regs[1];
  322. }
  323. /** Detect the charset **/
  324. if (strpos(strtolower(trim($line)), "charset=")) {
  325. $pos = strpos($line, "charset=") + 8;
  326. $charset = trim($line);
  327. if (strpos($line, ";", $pos) > 0) {
  328. $charset = substr($charset, $pos, strpos($line, ";", $pos)-$pos);
  329. } else {
  330. $charset = substr($charset, $pos);
  331. }
  332. $charset = str_replace("\"", "", $charset);
  333. $hdr->charset = $charset;
  334. } else {
  335. $hdr->charset = "us-ascii";
  336. }
  337. }
  338. else if (strtolower(substr($read[$i], 0, 20)) == "content-disposition:") {
  339. /** Add better dontent-disposition support **/
  340. $line = $read[$i];
  341. $i++;
  342. while ( (substr(substr($read[$i], 0, strpos($read[$i], " ")), -1) != ":") && (trim($read[$i]) != "") && (trim($read[$i]) != ")")) {
  343. str_replace("\n", "", $line);
  344. str_replace("\n", "", $read[$i]);
  345. $line = "$line $read[$i]";
  346. $i++;
  347. }
  348. /** Detects filename if any **/
  349. if (strpos(strtolower(trim($line)), "filename=")) {
  350. $pos = strpos($line, "filename=") + 9;
  351. $name = trim($line);
  352. if (strpos($line, " ", $pos) > 0) {
  353. $name = substr($name, $pos, strpos($line, " ", $pos));
  354. } else {
  355. $name = substr($name, $pos);
  356. }
  357. $name = str_replace("\"", "", $name);
  358. $hdr->filename = $name;
  359. }
  360. }
  361. /** REPLY-TO **/
  362. else if (strtolower(substr($read[$i], 0, 9)) == "reply-to:") {
  363. $hdr->replyto = trim(substr($read[$i], 9, strlen($read[$i])));
  364. $i++;
  365. }
  366. /** FROM **/
  367. else if (strtolower(substr($read[$i], 0, 5)) == "from:") {
  368. $hdr->from = trim(substr($read[$i], 5, strlen($read[$i]) - 6));
  369. if (! isset($hdr->replyto) || $hdr->replyto == "")
  370. $hdr->replyto = $hdr->from;
  371. $i++;
  372. }
  373. /** DATE **/
  374. else if (strtolower(substr($read[$i], 0, 5)) == "date:") {
  375. $d = substr($read[$i], 5);
  376. $d = trim($d);
  377. $d = strtr($d, array(' ' => ' '));
  378. $d = explode(' ', $d);
  379. $hdr->date = getTimeStamp($d);
  380. $i++;
  381. }
  382. /** SUBJECT **/
  383. else if (strtolower(substr($read[$i], 0, 8)) == "subject:") {
  384. $hdr->subject = trim(substr($read[$i], 8, strlen($read[$i]) - 9));
  385. if (strlen(Chop($hdr->subject)) == 0)
  386. $hdr->subject = _("(no subject)");
  387. if ($where == "SUBJECT") {
  388. $hdr->subject = eregi_replace($what, "<b>\\0</b>", $hdr->subject);
  389. }
  390. $i++;
  391. }
  392. /** CC **/
  393. else if (strtolower(substr($read[$i], 0, 3)) == "cc:") {
  394. $pos = 0;
  395. $hdr->cc[$pos] = trim(substr($read[$i], 4));
  396. $i++;
  397. while (((substr($read[$i], 0, 1) == " ") || (substr($read[$i], 0, 1) == "\t")) && (trim($read[$i]) != "")){
  398. $pos++;
  399. $hdr->cc[$pos] = trim($read[$i]);
  400. $i++;
  401. }
  402. }
  403. /** TO **/
  404. else if (strtolower(substr($read[$i], 0, 3)) == "to:") {
  405. $pos = 0;
  406. $hdr->to[$pos] = trim(substr($read[$i], 4));
  407. $i++;
  408. while (((substr($read[$i], 0, 1) == " ") || (substr($read[$i], 0, 1) == "\t")) && (trim($read[$i]) != "")){
  409. $pos++;
  410. $hdr->to[$pos] = trim($read[$i]);
  411. $i++;
  412. }
  413. }
  414. /** MESSAGE ID **/
  415. else if (strtolower(substr($read[$i], 0, 11)) == "message-id:") {
  416. $hdr->message_id = trim(substr($read[$i], 11));
  417. $i++;
  418. }
  419. /** ERROR CORRECTION **/
  420. else if (substr($read[$i], 0, 1) == ")") {
  421. if (strlen(trim($hdr->subject)) == 0)
  422. $hdr->subject = _("(no subject)");
  423. if (strlen(trim($hdr->from)) == 0)
  424. $hdr->from = _("(unknown sender)");
  425. if (strlen(trim($hdr->date)) == 0)
  426. $hdr->date = time();
  427. $i++;
  428. }
  429. else {
  430. $i++;
  431. }
  432. }
  433. return $hdr;
  434. }
  435. /******************************************************************************
  436. ** Returns the body of a message.
  437. ******************************************************************************/
  438. function sqimap_get_message_body ($imap_stream, &$header) {
  439. $id = $header->id;
  440. return decodeMime($imap_stream, $header);
  441. }
  442. /******************************************************************************
  443. ** Returns an array with the body structure
  444. ******************************************************************************/
  445. ?>