updated changelog, fixed a few minor bugs
[squirrelmail.git] / functions / imap_messages.php
CommitLineData
59177427 1<?php
052e0c26 2 /**
3 ** imap_messages.php
4 **
5 ** This implements functions that manipulate messages
6 **/
7
8beafbbc 8 if (!$mime_php) include "../functions/mime.php";
9
052e0c26 10 /******************************************************************************
11 ** Copies specified messages to specified folder
12 ******************************************************************************/
13 function sqimap_messages_copy ($imap_stream, $start, $end, $mailbox) {
14 fputs ($imap_stream, "a001 COPY $start:$end \"$mailbox\"\r\n");
15 $read = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
16 }
17
18 /******************************************************************************
19 ** Deletes specified messages and moves them to trash if possible
20 ******************************************************************************/
21 function sqimap_messages_delete ($imap_stream, $start, $end, $mailbox) {
22 global $move_to_trash, $trash_folder, $auto_expunge;
23
24 if (($move_to_trash == true) && (sqimap_mailbox_exists($imap_stream, $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 /******************************************************************************
33 ** Sets the specified messages with specified flag
34 ******************************************************************************/
35 function sqimap_messages_flag ($imap_stream, $start, $end, $flag) {
36 fputs ($imap_stream, "a001 STORE $start:$end +FLAGS (\\$flag)\r\n");
37 $read = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
052e0c26 38 }
39
40 /******************************************************************************
41 ** Returns some general header information -- FROM, DATE, and SUBJECT
42 ******************************************************************************/
60994e13 43 class small_header {
44 var $from, $subject, $date, $to, $priority, $message_id;
45 }
15a9cd31 46
4bbba0d8 47 function sqimap_get_small_header ($imap_stream, $id, $sent) {
60994e13 48 fputs ($imap_stream, "a001 FETCH $id BODY.PEEK[HEADER.FIELDS (Date To From Subject Message-Id X-Priority)]\r\n");
052e0c26 49 $read = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
50
51 $subject = _("(no subject)");
52 $from = _("Unknown Sender");
266fe275 53 $priority = "0";
60994e13 54 $messageid = "<>";
55
56 $g = 0;
052e0c26 57 for ($i = 0; $i < count($read); $i++) {
3e69e88b 58 if (eregi ("^to:", $read[$i])) {
c36ed9cf 59 //$to = sqimap_find_displayable_name(substr($read[$i], 3));
60 $to = substr($read[$i], 3);
61 } else if (eregi ("^from:", $read[$i])) {
62 //$from = sqimap_find_displayable_name(substr($read[$i], 5));
63 $from = substr($read[$i], 5);
64 } else if (eregi ("^x-priority:", $read[$i])) {
266fe275 65 $priority = trim(substr($read[$i], 11));
c36ed9cf 66 } else if (eregi ("^message-id:", $read[$i])) {
60994e13 67 $messageid = trim(substr($read[$i], 11));
c36ed9cf 68 } else if (eregi ("^date:", $read[$i])) {
4bbba0d8 69 $date = substr($read[$i], 5);
70 } else if (eregi ("^subject:", $read[$i])) {
71 $subject = htmlspecialchars(eregi_replace ("^subject: ", "", $read[$i]));
34688939 72 if (trim($subject) == "")
4bbba0d8 73 $subject = _("(no subject)");
74 }
60994e13 75 }
4bbba0d8 76
60994e13 77 $header = new small_header;
3e69e88b 78 if ($sent == true)
79 $header->from = $to;
80 else
60994e13 81 $header->from = $from;
82
83 $header->date = $date;
84 $header->subject = $subject;
3e69e88b 85 $header->to = $to;
266fe275 86 $header->priority = $priority;
60994e13 87 $header->message_id = $messageid;
88
89 return $header;
052e0c26 90 }
91
92 /******************************************************************************
93 ** Returns the flags for the specified messages
94 ******************************************************************************/
95 function sqimap_get_flags ($imap_stream, $i) {
96 fputs ($imap_stream, "a001 FETCH $i:$i FLAGS\r\n");
97 $read = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
98 if (strpos($read[0], "FLAGS")) {
99 $tmp = ereg_replace("\(", "", $read[0]);
100 $tmp = ereg_replace("\)", "", $tmp);
101 $tmp = str_replace("\\", "", $tmp);
102 $tmp = substr($tmp, strpos($tmp, "FLAGS")+6, strlen($tmp));
103 $tmp = trim($tmp);
104 $flags = explode(" ", $tmp);
105 } else {
106 $flags[0] = "None";
107 }
108 return $flags;
109 }
110
111 /******************************************************************************
112 ** Returns a message array with all the information about a message. See
113 ** the documentation folder for more information about this array.
114 ******************************************************************************/
115 function sqimap_get_message ($imap_stream, $id, $mailbox) {
8beafbbc 116
117 $header = sqimap_get_message_header($imap_stream, $id, $mailbox);
118 $msg = sqimap_get_message_body($imap_stream, &$header);
119 return $msg;
052e0c26 120 }
121
122 /******************************************************************************
123 ** Wrapper function that reformats the header information.
124 ******************************************************************************/
8beafbbc 125 function sqimap_get_message_header ($imap_stream, $id, $mailbox) {
052e0c26 126 fputs ($imap_stream, "a001 FETCH $id:$id BODY[HEADER]\r\n");
127 $read = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
128
8beafbbc 129 $header = sqimap_get_header($imap_stream, $read);
130 $header->id = $id;
131 $header->mailbox = $mailbox;
132
133 return $header;
052e0c26 134 }
135
136 /******************************************************************************
137 ** Wrapper function that returns entity headers for use by decodeMime
138 ******************************************************************************/
8beafbbc 139 /*
052e0c26 140 function sqimap_get_entity_header ($imap_stream, &$read, &$type0, &$type1, &$bound, &$encoding, &$charset, &$filename) {
141 $header = sqimap_get_header($imap_stream, $read);
142 $type0 = $header["TYPE0"];
143 $type1 = $header["TYPE1"];
144 $bound = $header["BOUNDARY"];
145 $encoding = $header["ENCODING"];
146 $charset = $header["CHARSET"];
147 $filename = $header["FILENAME"];
148 }
8beafbbc 149 */
052e0c26 150
151 /******************************************************************************
152 ** Queries the IMAP server and gets all header information.
153 ******************************************************************************/
154 function sqimap_get_header ($imap_stream, $read) {
8beafbbc 155 $hdr = new msg_header();
052e0c26 156 $i = 0;
157 // Set up some defaults
8beafbbc 158 $hdr->type0 = "text";
159 $hdr->type1 = "plain";
160 $hdr->charset = "us-ascii";
052e0c26 161
162 while ($i < count($read)) {
163 if (substr($read[$i], 0, 17) == "MIME-Version: 1.0") {
8beafbbc 164 $hdr->mime = true;
052e0c26 165 $i++;
166 }
167
168 /** ENCODING TYPE **/
169 else if (substr(strtolower($read[$i]), 0, 26) == "content-transfer-encoding:") {
8beafbbc 170 $hdr->encoding = strtolower(trim(substr($read[$i], 26)));
052e0c26 171 $i++;
172 }
173
174 /** CONTENT-TYPE **/
175 else if (strtolower(substr($read[$i], 0, 13)) == "content-type:") {
176 $cont = strtolower(trim(substr($read[$i], 13)));
177 if (strpos($cont, ";"))
178 $cont = substr($cont, 0, strpos($cont, ";"));
179
180
181 if (strpos($cont, "/")) {
8beafbbc 182 $hdr->type0 = substr($cont, 0, strpos($cont, "/"));
183 $hdr->type1 = substr($cont, strpos($cont, "/")+1);
052e0c26 184 } else {
8beafbbc 185 $hdr->type0 = $cont;
052e0c26 186 }
187
188
189 $line = $read[$i];
190 $i++;
191 while ( (substr(substr($read[$i], 0, strpos($read[$i], " ")), -1) != ":") && (trim($read[$i]) != "") && (trim($read[$i]) != ")")) {
192 str_replace("\n", "", $line);
193 str_replace("\n", "", $read[$i]);
194 $line = "$line $read[$i]";
195 $i++;
196 }
197
198 /** Detect the boundary of a multipart message **/
199 if (eregi("boundary=\"([^\"]+)\"", $line, $regs)) {
8beafbbc 200 $hdr->boundary = $regs[1];
052e0c26 201 }
202
203 /** Detect the charset **/
204 if (strpos(strtolower(trim($line)), "charset=")) {
205 $pos = strpos($line, "charset=") + 8;
206 $charset = trim($line);
207 if (strpos($line, " ", $pos) > 0) {
208 $charset = substr($charset, $pos, strpos($line, " ", $pos));
209 } else {
210 $charset = substr($charset, $pos);
211 }
212 $charset = str_replace("\"", "", $charset);
8beafbbc 213 $hdr->charset = $charset;
052e0c26 214 } else {
8beafbbc 215 $hdr->charset = "us-ascii";
052e0c26 216 }
217
218 }
219
220 else if (strtolower(substr($read[$i], 0, 20)) == "content-disposition:") {
221 /** Add better dontent-disposition support **/
222
223 $line = $read[$i];
224 $i++;
225 while ( (substr(substr($read[$i], 0, strpos($read[$i], " ")), -1) != ":") && (trim($read[$i]) != "") && (trim($read[$i]) != ")")) {
226 str_replace("\n", "", $line);
227 str_replace("\n", "", $read[$i]);
228 $line = "$line $read[$i]";
229 $i++;
230 }
231
232 /** Detects filename if any **/
233 if (strpos(strtolower(trim($line)), "filename=")) {
234 $pos = strpos($line, "filename=") + 9;
235 $name = trim($line);
236 if (strpos($line, " ", $pos) > 0) {
237 $name = substr($name, $pos, strpos($line, " ", $pos));
238 } else {
239 $name = substr($name, $pos);
240 }
241 $name = str_replace("\"", "", $name);
8beafbbc 242 $hdr->filename = $name;
052e0c26 243 }
244 }
245
246 /** REPLY-TO **/
247 else if (strtolower(substr($read[$i], 0, 9)) == "reply-to:") {
8beafbbc 248 $hdr->replyto = trim(substr($read[$i], 9, strlen($read[$i])));
052e0c26 249 $i++;
250 }
251
252 /** FROM **/
253 else if (strtolower(substr($read[$i], 0, 5)) == "from:") {
8beafbbc 254 $hdr->from = trim(substr($read[$i], 5, strlen($read[$i]) - 6));
255 if ($hdr->replyto == "")
256 $hdr->replyto = $hdr->from;
052e0c26 257 $i++;
258 }
259 /** DATE **/
260 else if (strtolower(substr($read[$i], 0, 5)) == "date:") {
261 $d = substr($read[$i], 5);
262 $d = trim($d);
263 $d = ereg_replace(" ", " ", $d);
264 $d = explode(" ", $d);
8beafbbc 265 $hdr->date = getTimeStamp($d);
052e0c26 266 $i++;
267 }
268 /** SUBJECT **/
269 else if (strtolower(substr($read[$i], 0, 8)) == "subject:") {
8beafbbc 270 $hdr->subject = trim(substr($read[$i], 8, strlen($read[$i]) - 9));
271 if (strlen(Chop($hdr->subject)) == 0)
272 $hdr->subject = _("(no subject)");
052e0c26 273 $i++;
274 }
275 /** CC **/
276 else if (strtolower(substr($read[$i], 0, 3)) == "cc:") {
277 $pos = 0;
8beafbbc 278 $hdr->cc[$pos] = trim(substr($read[$i], 4));
052e0c26 279 $i++;
11728a4d 280 while (((substr($read[$i], 0, 1) == " ") || (substr($read[$i], 0, 1) == "\t")) && (trim($read[$i]) != "")){
052e0c26 281 $pos++;
8beafbbc 282 $hdr->cc[$pos] = trim($read[$i]);
052e0c26 283 $i++;
284 }
285 }
286 /** TO **/
287 else if (strtolower(substr($read[$i], 0, 3)) == "to:") {
288 $pos = 0;
8beafbbc 289 $hdr->to[$pos] = trim(substr($read[$i], 4));
052e0c26 290 $i++;
11728a4d 291 while (((substr($read[$i], 0, 1) == " ") || (substr($read[$i], 0, 1) == "\t")) && (trim($read[$i]) != "")){
052e0c26 292 $pos++;
8beafbbc 293 $hdr->to[$pos] = trim($read[$i]);
052e0c26 294 $i++;
295 }
296 }
297 /** MESSAGE ID **/
298 else if (strtolower(substr($read[$i], 0, 11)) == "message-id:") {
8beafbbc 299 $hdr->message_id = trim(substr($read[$i], 11));
052e0c26 300 $i++;
301 }
302
303
304 /** ERROR CORRECTION **/
305 else if (substr($read[$i], 0, 1) == ")") {
8beafbbc 306 if (strlen(trim($hdr->subject)) == 0)
307 $hdr->subject = _("(no subject)");
052e0c26 308
8beafbbc 309 if (strlen(trim($hdr->from)) == 0)
310 $hdr->from = _("(unknown sender)");
052e0c26 311
8beafbbc 312 if (strlen(trim($hdr->date)) == 0)
313 $hdr->date = time();
052e0c26 314 $i++;
315 }
316 else {
317 $i++;
318 }
319 }
8beafbbc 320 return $hdr;
052e0c26 321 }
322
323
324 /******************************************************************************
325 ** Returns the body of a message.
326 ******************************************************************************/
8beafbbc 327 function sqimap_get_message_body ($imap_stream, &$header) {
328 $id = $header->id;
329 //fputs ($imap_stream, "a001 FETCH $id:$id BODY[TEXT]\r\n");
330 //$read = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
052e0c26 331
332 $i = 0;
333 $j = 0;
334 while ($i < count($read)-1) {
335 if ( ($i != 0) ) {
8beafbbc 336 $body[$j] = $read[$i];
052e0c26 337 $j++;
338 }
339 $i++;
340 }
8beafbbc 341 return decodeMime($body, &$header);
052e0c26 342 }
8beafbbc 343
344
345 /******************************************************************************
346 ** Returns an array with the body structure
347 ******************************************************************************/
052e0c26 348?>