15e6162e |
1 | <?php |
d622d38a |
2 | |
d3c89357 |
3 | /** |
15e6162e |
4 | * mail_fetch/setup.php |
5 | * |
6 | * Copyright (c) 1999-2002 The SquirrelMail Project Team |
7 | * |
8 | * Copyright (c) 1999 CDI (cdi@thewebmasters.net) All Rights Reserved |
9 | * Modified by Philippe Mingo 2001 mingo@rotedic.com |
10 | * An RFC 1939 compliant wrapper class for the POP3 protocol. |
11 | * |
12 | * Licensed under the GNU GPL. For full terms see the file COPYING. |
13 | * |
14 | * pop3 class |
15 | * |
16 | * $Id$ |
17 | */ |
d622d38a |
18 | |
19 | class POP3 { |
d3c89357 |
20 | var $ERROR = ''; // Error string. |
d622d38a |
21 | |
22 | var $TIMEOUT = 60; // Default timeout before giving up on a |
23 | // network operation. |
24 | |
25 | var $COUNT = -1; // Mailbox msg count |
26 | |
27 | var $BUFFER = 512; // Socket buffer for socket fgets() calls. |
28 | // Per RFC 1939 the returned line a POP3 |
29 | // server can send is 512 bytes. |
30 | |
d3c89357 |
31 | var $FP = ''; // The connection to the server's |
d622d38a |
32 | // file descriptor |
33 | |
d3c89357 |
34 | var $MAILSERVER = ''; // Set this to hard code the server name |
d622d38a |
35 | |
ef610a28 |
36 | var $DEBUG = FALSE; // set to true to echo pop3 |
d622d38a |
37 | // commands and responses to error_log |
38 | // this WILL log passwords! |
39 | |
d3c89357 |
40 | var $BANNER = ''; // Holds the banner returned by the |
d622d38a |
41 | // pop server - used for apop() |
42 | |
14d288ff |
43 | var $ALLOWAPOP = FALSE; // Allow or disallow apop() |
d622d38a |
44 | // This must be set to true |
45 | // manually |
46 | |
d3c89357 |
47 | function POP3 ( $server = '', $timeout = '' ) { |
d622d38a |
48 | settype($this->BUFFER,"integer"); |
49 | if( !empty($server) ) { |
50 | // Do not allow programs to alter MAILSERVER |
51 | // if it is already specified. They can get around |
52 | // this if they -really- want to, so don't count on it. |
53 | if(empty($this->MAILSERVER)) |
54 | $this->MAILSERVER = $server; |
55 | } |
56 | if(!empty($timeout)) { |
57 | settype($timeout,"integer"); |
58 | $this->TIMEOUT = $timeout; |
59 | set_time_limit($timeout); |
60 | } |
61 | return true; |
62 | } |
63 | |
64 | function update_timer () { |
65 | set_time_limit($this->TIMEOUT); |
66 | return true; |
67 | } |
68 | |
69 | function connect ($server, $port = 110) { |
70 | // Opens a socket to the specified server. Unless overridden, |
71 | // port defaults to 110. Returns true on success, false on fail |
72 | |
73 | // If MAILSERVER is set, override $server with it's value |
74 | |
75 | if(!empty($this->MAILSERVER)) |
76 | $server = $this->MAILSERVER; |
77 | |
78 | if(empty($server)){ |
79 | $this->ERROR = _("POP3 connect:") . ' ' . _("No server specified"); |
80 | unset($this->FP); |
81 | return false; |
82 | } |
83 | |
84 | $fp = fsockopen("$server", $port, $errno, $errstr); |
85 | |
86 | if(!$fp) { |
87 | $this->ERROR = _("POP3 connect:") . ' ' . _("Error ") . "[$errno] [$errstr]"; |
88 | unset($this->FP); |
89 | return false; |
90 | } |
91 | |
92 | socket_set_blocking($fp,-1); |
93 | $this->update_timer(); |
94 | $reply = fgets($fp,$this->BUFFER); |
95 | $reply = $this->strip_clf($reply); |
96 | if($this->DEBUG) |
97 | error_log("POP3 SEND [connect: $server] GOT [$reply]",0); |
98 | if(!$this->is_ok($reply)) { |
99 | $this->ERROR = _("POP3 connect:") . ' ' . _("Error ") . "[$reply]"; |
100 | unset($this->FP); |
101 | return false; |
102 | } |
103 | $this->FP = $fp; |
104 | $this->BANNER = $this->parse_banner($reply); |
8c259d67 |
105 | return true; |
d622d38a |
106 | } |
107 | |
108 | function noop () { |
109 | |
110 | if(!isset($this->FP)) { |
111 | $this->ERROR = _("POP3 noop:") . ' ' . _("No connection to server"); |
112 | return false; |
113 | } else { |
114 | $cmd = "NOOP"; |
115 | $reply = $this->send_cmd( $cmd ); |
116 | return( $this->is_ok( $reply ) ); |
117 | } |
118 | } |
119 | |
120 | function user ($user = "") { |
121 | // Sends the USER command, returns true or false |
122 | |
123 | if( empty($user) ) { |
124 | $this->ERROR = _("POP3 user:") . ' ' . _("no login ID submitted"); |
125 | return false; |
126 | } elseif(!isset($this->FP)) { |
127 | $this->ERROR = _("POP3 user:") . ' ' . _("connection not established"); |
128 | return false; |
129 | } else { |
130 | $reply = $this->send_cmd("USER $user"); |
131 | if(!$this->is_ok($reply)) { |
132 | $this->ERROR = _("POP3 user:") . ' ' . _("Error ") . "[$reply]"; |
133 | return false; |
134 | } else |
135 | return true; |
136 | } |
137 | } |
138 | |
139 | function pass ($pass = "") { |
140 | // Sends the PASS command, returns # of msgs in mailbox, |
141 | // returns false (undef) on Auth failure |
142 | |
143 | if(empty($pass)) { |
144 | $this->ERROR = _("POP3 pass:") . ' ' . _("No password submitted"); |
145 | return false; |
146 | } elseif(!isset($this->FP)) { |
147 | $this->ERROR = _("POP3 pass:") . ' ' . _("connection not established"); |
148 | return false; |
149 | } else { |
150 | $reply = $this->send_cmd("PASS $pass"); |
151 | if(!$this->is_ok($reply)) { |
152 | $this->ERROR = _("POP3 pass:") . ' ' . _("authentication failed ") . "[$reply]"; |
153 | $this->quit(); |
154 | return false; |
155 | } else { |
156 | // Auth successful. |
157 | $count = $this->last("count"); |
158 | $this->COUNT = $count; |
8c259d67 |
159 | return $count; |
d622d38a |
160 | } |
161 | } |
162 | } |
163 | |
164 | function apop ($login,$pass) { |
165 | // Attempts an APOP login. If this fails, it'll |
166 | // try a standard login. YOUR SERVER MUST SUPPORT |
167 | // THE USE OF THE APOP COMMAND! |
168 | // (apop is optional per rfc1939) |
169 | |
170 | if(!isset($this->FP)) { |
171 | $this->ERROR = _("POP3 apop:") . ' ' . _("No connection to server"); |
172 | return false; |
173 | } elseif(!$this->ALLOWAPOP) { |
174 | $retVal = $this->login($login,$pass); |
175 | return $retVal; |
176 | } elseif(empty($login)) { |
177 | $this->ERROR = _("POP3 apop:") . ' ' . _("No login ID submitted"); |
178 | return false; |
179 | } elseif(empty($pass)) { |
180 | $this->ERROR = _("POP3 apop:") . ' ' . _("No password submitted"); |
181 | return false; |
182 | } else { |
183 | $banner = $this->BANNER; |
184 | if( (!$banner) or (empty($banner)) ) { |
185 | $this->ERROR = _("POP3 apop:") . ' ' . _("No server banner") . ' - ' . _("abort"); |
186 | $retVal = $this->login($login,$pass); |
187 | return $retVal; |
188 | } else { |
189 | $AuthString = $banner; |
190 | $AuthString .= $pass; |
191 | $APOPString = md5($AuthString); |
192 | $cmd = "APOP $login $APOPString"; |
193 | $reply = $this->send_cmd($cmd); |
194 | if(!$this->is_ok($reply)) { |
195 | $this->ERROR = _("POP3 apop:") . ' ' . _("apop authentication failed") . ' - ' . _("abort"); |
196 | $retVal = $this->login($login,$pass); |
197 | return $retVal; |
198 | } else { |
199 | // Auth successful. |
200 | $count = $this->last("count"); |
201 | $this->COUNT = $count; |
8c259d67 |
202 | return $count; |
d622d38a |
203 | } |
204 | } |
205 | } |
206 | } |
207 | |
208 | function login ($login = "", $pass = "") { |
209 | // Sends both user and pass. Returns # of msgs in mailbox or |
210 | // false on failure (or -1, if the error occurs while getting |
211 | // the number of messages.) |
212 | |
213 | if( !isset($this->FP) ) { |
214 | $this->ERROR = _("POP3 login:") . ' ' . _("No connection to server"); |
215 | return false; |
216 | } else { |
217 | $fp = $this->FP; |
218 | if( !$this->user( $login ) ) { |
219 | // Preserve the error generated by user() |
220 | return false; |
221 | } else { |
222 | $count = $this->pass($pass); |
223 | if( (!$count) || ($count == -1) ) { |
224 | // Preserve the error generated by last() and pass() |
225 | return false; |
226 | } else |
227 | return $count; |
228 | } |
229 | } |
230 | } |
231 | |
232 | function top ($msgNum, $numLines = "0") { |
233 | // Gets the header and first $numLines of the msg body |
234 | // returns data in an array with each returned line being |
235 | // an array element. If $numLines is empty, returns |
236 | // only the header information, and none of the body. |
237 | |
238 | if(!isset($this->FP)) { |
239 | $this->ERROR = _("POP3 top:") . ' ' . _("No connection to server"); |
240 | return false; |
241 | } |
242 | $this->update_timer(); |
243 | |
244 | $fp = $this->FP; |
245 | $buffer = $this->BUFFER; |
246 | $cmd = "TOP $msgNum $numLines"; |
247 | fwrite($fp, "TOP $msgNum $numLines\r\n"); |
248 | $reply = fgets($fp, $buffer); |
249 | $reply = $this->strip_clf($reply); |
250 | if($this->DEBUG) { |
251 | @error_log("POP3 SEND [$cmd] GOT [$reply]",0); |
252 | } |
253 | if(!$this->is_ok($reply)) |
254 | { |
255 | $this->ERROR = _("POP3 top:") . ' ' . _("Error ") . "[$reply]"; |
256 | return false; |
257 | } |
258 | |
259 | $count = 0; |
260 | $MsgArray = array(); |
261 | |
262 | $line = fgets($fp,$buffer); |
263 | while ( !ereg("^\.\r\n",$line)) |
264 | { |
265 | $MsgArray[$count] = $line; |
266 | $count++; |
267 | $line = fgets($fp,$buffer); |
268 | if(empty($line)) { break; } |
269 | } |
270 | |
271 | return $MsgArray; |
272 | } |
273 | |
274 | function pop_list ($msgNum = "") { |
275 | // If called with an argument, returns that msgs' size in octets |
276 | // No argument returns an associative array of undeleted |
277 | // msg numbers and their sizes in octets |
278 | |
279 | if(!isset($this->FP)) |
280 | { |
281 | $this->ERROR = _("POP3 pop_list:") . ' ' . _("No connection to server"); |
282 | return false; |
283 | } |
284 | $fp = $this->FP; |
285 | $Total = $this->COUNT; |
286 | if( (!$Total) or ($Total == -1) ) |
287 | { |
288 | return false; |
289 | } |
290 | if($Total == 0) |
291 | { |
292 | return array("0","0"); |
293 | // return -1; // mailbox empty |
294 | } |
295 | |
296 | $this->update_timer(); |
297 | |
298 | if(!empty($msgNum)) |
299 | { |
300 | $cmd = "LIST $msgNum"; |
301 | fwrite($fp,"$cmd\r\n"); |
302 | $reply = fgets($fp,$this->BUFFER); |
303 | $reply = $this->strip_clf($reply); |
304 | if($this->DEBUG) { |
305 | @error_log("POP3 SEND [$cmd] GOT [$reply]",0); |
306 | } |
307 | if(!$this->is_ok($reply)) |
308 | { |
309 | $this->ERROR = _("POP3 pop_list:") . ' ' . _("Error ") . "[$reply]"; |
310 | return false; |
311 | } |
312 | list($junk,$num,$size) = explode(" ",$reply); |
313 | return $size; |
314 | } |
315 | $cmd = "LIST"; |
316 | $reply = $this->send_cmd($cmd); |
317 | if(!$this->is_ok($reply)) |
318 | { |
319 | $reply = $this->strip_clf($reply); |
320 | $this->ERROR = _("POP3 pop_list:") . ' ' . _("Error ") . "[$reply]"; |
321 | return false; |
322 | } |
323 | $MsgArray = array(); |
324 | $MsgArray[0] = $Total; |
325 | for($msgC=1;$msgC <= $Total; $msgC++) |
326 | { |
327 | if($msgC > $Total) { break; } |
328 | $line = fgets($fp,$this->BUFFER); |
329 | $line = $this->strip_clf($line); |
330 | if(ereg("^\.",$line)) |
331 | { |
332 | $this->ERROR = _("POP3 pop_list:") . ' ' . _("Premature end of list"); |
333 | return false; |
334 | } |
335 | list($thisMsg,$msgSize) = explode(" ",$line); |
336 | settype($thisMsg,"integer"); |
337 | if($thisMsg != $msgC) |
338 | { |
339 | $MsgArray[$msgC] = "deleted"; |
340 | } |
341 | else |
342 | { |
343 | $MsgArray[$msgC] = $msgSize; |
344 | } |
345 | } |
346 | return $MsgArray; |
347 | } |
348 | |
349 | function get ($msgNum) { |
350 | // Retrieve the specified msg number. Returns an array |
351 | // where each line of the msg is an array element. |
352 | |
353 | if(!isset($this->FP)) |
354 | { |
355 | $this->ERROR = _("POP3 get:") . ' ' . _("No connection to server"); |
356 | return false; |
357 | } |
358 | |
359 | $this->update_timer(); |
360 | |
361 | $fp = $this->FP; |
362 | $buffer = $this->BUFFER; |
363 | $cmd = "RETR $msgNum"; |
364 | $reply = $this->send_cmd($cmd); |
365 | |
366 | if(!$this->is_ok($reply)) |
367 | { |
368 | $this->ERROR = _("POP3 get:") . ' ' . _("Error ") . "[$reply]"; |
369 | return false; |
370 | } |
371 | |
372 | $count = 0; |
373 | $MsgArray = array(); |
374 | |
375 | $line = fgets($fp,$buffer); |
376 | while ( !ereg("^\.\r\n",$line)) |
377 | { |
378 | $MsgArray[$count] = $line; |
379 | $count++; |
380 | $line = fgets($fp,$buffer); |
381 | if(empty($line)) { break; } |
382 | } |
383 | return $MsgArray; |
384 | } |
385 | |
386 | function last ( $type = "count" ) { |
387 | // Returns the highest msg number in the mailbox. |
388 | // returns -1 on error, 0+ on success, if type != count |
389 | // results in a popstat() call (2 element array returned) |
390 | |
391 | $last = -1; |
392 | if(!isset($this->FP)) |
393 | { |
394 | $this->ERROR = _("POP3 last:") . ' ' . _("No connection to server"); |
395 | return $last; |
396 | } |
397 | |
398 | $reply = $this->send_cmd("STAT"); |
399 | if(!$this->is_ok($reply)) |
400 | { |
401 | $this->ERROR = _("POP3 last:") . ' ' . _("Error ") . "[$reply]"; |
402 | return $last; |
403 | } |
404 | |
405 | $Vars = explode(" ",$reply); |
406 | $count = $Vars[1]; |
407 | $size = $Vars[2]; |
408 | settype($count,"integer"); |
409 | settype($size,"integer"); |
410 | if($type != "count") |
411 | { |
412 | return array($count,$size); |
413 | } |
414 | return $count; |
415 | } |
416 | |
417 | function reset () { |
418 | // Resets the status of the remote server. This includes |
419 | // resetting the status of ALL msgs to not be deleted. |
420 | // This method automatically closes the connection to the server. |
421 | |
422 | if(!isset($this->FP)) |
423 | { |
424 | $this->ERROR = _("POP3 reset:") . ' ' . _("No connection to server"); |
425 | return false; |
426 | } |
427 | $reply = $this->send_cmd("RSET"); |
428 | if(!$this->is_ok($reply)) |
429 | { |
430 | // The POP3 RSET command -never- gives a -ERR |
431 | // response - if it ever does, something truely |
432 | // wild is going on. |
433 | |
434 | $this->ERROR = _("POP3 reset:") . ' ' . _("Error ") . "[$reply]"; |
435 | @error_log("POP3 reset: ERROR [$reply]",0); |
436 | } |
437 | $this->quit(); |
438 | return true; |
439 | } |
440 | |
441 | function send_cmd ( $cmd = "" ) |
442 | { |
443 | // Sends a user defined command string to the |
444 | // POP server and returns the results. Useful for |
445 | // non-compliant or custom POP servers. |
446 | // Do NOT includ the \r\n as part of your command |
447 | // string - it will be appended automatically. |
448 | |
449 | // The return value is a standard fgets() call, which |
450 | // will read up to $this->BUFFER bytes of data, until it |
451 | // encounters a new line, or EOF, whichever happens first. |
452 | |
453 | // This method works best if $cmd responds with only |
454 | // one line of data. |
455 | |
456 | if(!isset($this->FP)) |
457 | { |
458 | $this->ERROR = _("POP3 send_cmd:") . ' ' . _("No connection to server"); |
459 | return false; |
460 | } |
461 | |
462 | if(empty($cmd)) |
463 | { |
464 | $this->ERROR = _("POP3 send_cmd:") . ' ' . _("Empty command string"); |
465 | return ""; |
466 | } |
467 | |
468 | $fp = $this->FP; |
469 | $buffer = $this->BUFFER; |
470 | $this->update_timer(); |
471 | fwrite($fp,"$cmd\r\n"); |
472 | $reply = fgets($fp,$buffer); |
473 | $reply = $this->strip_clf($reply); |
474 | if($this->DEBUG) { @error_log("POP3 SEND [$cmd] GOT [$reply]",0); } |
475 | return $reply; |
476 | } |
477 | |
478 | function quit() { |
479 | // Closes the connection to the POP3 server, deleting |
480 | // any msgs marked as deleted. |
481 | |
482 | if(!isset($this->FP)) |
483 | { |
484 | $this->ERROR = _("POP3 quit:") . ' ' . _("connection does not exist"); |
485 | return false; |
486 | } |
487 | $fp = $this->FP; |
488 | $cmd = "QUIT"; |
489 | fwrite($fp,"$cmd\r\n"); |
490 | $reply = fgets($fp,$this->BUFFER); |
491 | $reply = $this->strip_clf($reply); |
492 | if($this->DEBUG) { @error_log("POP3 SEND [$cmd] GOT [$reply]",0); } |
493 | fclose($fp); |
494 | unset($this->FP); |
495 | return true; |
496 | } |
497 | |
498 | function popstat () { |
499 | // Returns an array of 2 elements. The number of undeleted |
500 | // msgs in the mailbox, and the size of the mbox in octets. |
501 | |
502 | $PopArray = $this->last("array"); |
503 | |
504 | if($PopArray == -1) { return false; } |
505 | |
506 | if( (!$PopArray) or (empty($PopArray)) ) |
507 | { |
508 | return false; |
509 | } |
510 | return $PopArray; |
511 | } |
512 | |
513 | function uidl ($msgNum = "") |
514 | { |
515 | // Returns the UIDL of the msg specified. If called with |
516 | // no arguments, returns an associative array where each |
517 | // undeleted msg num is a key, and the msg's uidl is the element |
518 | // Array element 0 will contain the total number of msgs |
519 | |
520 | if(!isset($this->FP)) { |
521 | $this->ERROR = _("POP3 uidl:") . ' ' . _("No connection to server"); |
522 | return false; |
523 | } |
524 | |
525 | $fp = $this->FP; |
526 | $buffer = $this->BUFFER; |
527 | |
528 | if(!empty($msgNum)) { |
529 | $cmd = "UIDL $msgNum"; |
530 | $reply = $this->send_cmd($cmd); |
531 | if(!$this->is_ok($reply)) |
532 | { |
533 | $this->ERROR = _("POP3 uidl:") . ' ' . _("Error ") . "[$reply]"; |
534 | return false; |
535 | } |
536 | list ($ok,$num,$myUidl) = explode(" ",$reply); |
537 | return $myUidl; |
538 | } else { |
539 | $this->update_timer(); |
540 | |
541 | $UIDLArray = array(); |
542 | $Total = $this->COUNT; |
543 | $UIDLArray[0] = $Total; |
544 | |
545 | if ($Total < 1) |
546 | { |
547 | return $UIDLArray; |
548 | } |
549 | $cmd = "UIDL"; |
550 | fwrite($fp, "UIDL\r\n"); |
551 | $reply = fgets($fp, $buffer); |
552 | $reply = $this->strip_clf($reply); |
553 | if($this->DEBUG) { @error_log("POP3 SEND [$cmd] GOT [$reply]",0); } |
554 | if(!$this->is_ok($reply)) |
555 | { |
556 | $this->ERROR = _("POP3 uidl:") . ' ' . _("Error ") . "[$reply]"; |
557 | return false; |
558 | } |
559 | |
560 | $line = ""; |
561 | $count = 1; |
562 | $line = fgets($fp,$buffer); |
563 | while ( !ereg("^\.\r\n",$line)) { |
564 | if(ereg("^\.\r\n",$line)) { |
565 | break; |
566 | } |
567 | list ($msg,$msgUidl) = explode(" ",$line); |
568 | $msgUidl = $this->strip_clf($msgUidl); |
569 | if($count == $msg) { |
570 | $UIDLArray[$msg] = $msgUidl; |
571 | } |
572 | else |
573 | { |
d3c89357 |
574 | $UIDLArray[$count] = 'deleted'; |
d622d38a |
575 | } |
576 | $count++; |
577 | $line = fgets($fp,$buffer); |
578 | } |
579 | } |
580 | return $UIDLArray; |
581 | } |
582 | |
583 | function delete ($msgNum = "") { |
584 | // Flags a specified msg as deleted. The msg will not |
585 | // be deleted until a quit() method is called. |
586 | |
587 | if(!isset($this->FP)) |
588 | { |
589 | $this->ERROR = _("POP3 delete:") . ' ' . _("No connection to server"); |
590 | return false; |
591 | } |
592 | if(empty($msgNum)) |
593 | { |
594 | $this->ERROR = _("POP3 delete:") . ' ' . _("No msg number submitted"); |
595 | return false; |
596 | } |
597 | $reply = $this->send_cmd("DELE $msgNum"); |
598 | if(!$this->is_ok($reply)) |
599 | { |
600 | $this->ERROR = _("POP3 delete:") . ' ' . _("Command failed ") . "[$reply]"; |
601 | return false; |
602 | } |
603 | return true; |
604 | } |
605 | |
606 | // ********************************************************* |
607 | |
608 | // The following methods are internal to the class. |
609 | |
610 | function is_ok ($cmd = "") { |
611 | // Return true or false on +OK or -ERR |
612 | |
613 | if( empty($cmd) ) |
614 | return false; |
615 | else |
616 | return( ereg ("^\+OK", $cmd ) ); |
617 | } |
618 | |
619 | function strip_clf ($text = "") { |
620 | // Strips \r\n from server responses |
621 | |
622 | if(empty($text)) |
623 | return $text; |
624 | else { |
625 | $stripped = str_replace("\r",'',$text); |
626 | $stripped = str_replace("\n",'',$stripped); |
627 | return $stripped; |
628 | } |
629 | } |
630 | |
631 | function parse_banner ( $server_text ) { |
632 | $outside = true; |
633 | $banner = ""; |
634 | $length = strlen($server_text); |
635 | for($count =0; $count < $length; $count++) |
636 | { |
637 | $digit = substr($server_text,$count,1); |
638 | if(!empty($digit)) { |
639 | if( (!$outside) && ($digit != '<') && ($digit != '>') ) |
640 | { |
641 | $banner .= $digit; |
642 | } |
643 | if ($digit == '<') |
644 | { |
645 | $outside = false; |
646 | } |
647 | if($digit == '>') |
648 | { |
649 | $outside = true; |
650 | } |
651 | } |
652 | } |
653 | $banner = $this->strip_clf($banner); // Just in case |
654 | return "<$banner>"; |
655 | } |
656 | |
657 | } // End class |
658 | |
659 | ?> |