]> Pileus Git - ~andy/fetchmail/blob - pop3.c
Sunil Shetye's latest cleanup patch.
[~andy/fetchmail] / pop3.c
1 /*
2  * pop3.c -- POP3 protocol methods
3  *
4  * Copyright 1998 by Eric S. Raymond.
5  * For license terms, see the file COPYING in this directory.
6  */
7
8 #include  "config.h"
9 #ifdef POP3_ENABLE
10 #include  <stdio.h>
11 #include  <string.h>
12 #include  <ctype.h>
13 #if defined(HAVE_UNISTD_H)
14 #include <unistd.h>
15 #endif
16 #if defined(STDC_HEADERS)
17 #include  <stdlib.h>
18 #endif
19  
20 #include  "fetchmail.h"
21 #include  "socket.h"
22 #include  "i18n.h"
23
24 #if OPIE_ENABLE
25 #include <opie.h>
26 #endif /* OPIE_ENABLE */
27
28 #ifndef strstr          /* glibc-2.1 declares this as a macro */
29 extern char *strstr();  /* needed on sysV68 R3V7.1. */
30 #endif /* strstr */
31
32 static int last;
33 #ifdef SDPS_ENABLE
34 char *sdps_envfrom;
35 char *sdps_envto;
36 #endif /* SDPS_ENABLE */
37
38 #if OPIE_ENABLE
39 static char lastok[POPBUFSIZE+1];
40 #endif /* OPIE_ENABLE */
41
42 #define DOTLINE(s)      (s[0] == '.' && (s[1]=='\r'||s[1]=='\n'||s[1]=='\0'))
43
44 static int pop3_ok (int sock, char *argbuf)
45 /* parse command response */
46 {
47     int ok;
48     char buf [POPBUFSIZE+1];
49     char *bufp;
50
51     if ((ok = gen_recv(sock, buf, sizeof(buf))) == 0)
52     {   bufp = buf;
53         if (*bufp == '+' || *bufp == '-')
54             bufp++;
55         else
56             return(PS_PROTOCOL);
57
58         while (isalpha(*bufp))
59             bufp++;
60
61         if (*bufp)
62           *(bufp++) = '\0';
63
64         if (strcmp(buf,"+OK") == 0)
65         {
66 #if OPIE_ENABLE
67             strcpy(lastok, bufp);
68 #endif /* OPIE_ENABLE */
69             ok = 0;
70         }
71         else if (strncmp(buf,"-ERR", 4) == 0)
72         {
73             if (stage == STAGE_FETCH)
74                 ok = PS_TRANSIENT;
75             else if (stage > STAGE_GETAUTH)
76                 ok = PS_PROTOCOL;
77             /*
78              * We're checking for "lock busy", "unable to lock", 
79              * "already locked", "wait a few minutes" etc. here. 
80              * This indicates that we have to wait for the server to
81              * unwedge itself before we can poll again.
82              *
83              * PS_LOCKBUSY check empirically verified with two recent
84              * versions of the Berkeley popper; QPOP (version 2.2)  and
85              * QUALCOMM Pop server derived from UCB (version 2.1.4-R3)
86              * These are caught by the case-indifferent "lock" check.
87              * The "wait" catches "mail storage services unavailable,
88              * wait a few minutes and try again" on the InterMail server.
89              *
90              * If these aren't picked up on correctly, fetchmail will 
91              * think there is an authentication failure and wedge the
92              * connection in order to prevent futile polls.
93              *
94              * Gad, what a kluge.
95              */
96             else if (strstr(bufp,"lock")
97                      || strstr(bufp,"Lock")
98                      || strstr(bufp,"LOCK")
99                      || strstr(bufp,"wait")
100                      /* these are blessed by RFC 2449 */
101                      || strstr(bufp,"[IN-USE]")||strstr(bufp,"[LOGIN-DELAY]"))
102                 ok = PS_LOCKBUSY;
103             else if ((strstr(bufp,"Service")
104                      || strstr(bufp,"service"))
105                          && (strstr(bufp,"unavailable")))
106                 ok = PS_SERVBUSY;
107             else
108                 ok = PS_AUTHFAIL;
109             /*
110              * We always want to pass the user lock-busy messages, because
111              * they're red flags.  Other stuff (like AUTH failures on non-
112              * RFC1734 servers) only if we're debugging.
113              */
114             if (*bufp && (ok == PS_LOCKBUSY || outlevel >= O_MONITOR))
115               report(stderr, "%s\n", bufp);
116         }
117         else
118             ok = PS_PROTOCOL;
119
120         if (argbuf != NULL)
121             strcpy(argbuf,bufp);
122     }
123
124     return(ok);
125 }
126
127 static int pop3_getauth(int sock, struct query *ctl, char *greeting)
128 /* apply for connection authorization */
129 {
130     int ok;
131     char *start,*end;
132     char *msg;
133 #if OPIE_ENABLE
134     char *challenge;
135 #endif /* OPIE_ENABLE */
136 #if defined(GSSAPI)
137     flag has_gssapi = FALSE;
138 #endif /* defined(GSSAPI) */
139 #if defined(KERBEROS_V4) || defined(KERBEROS_V5)
140     flag has_kerberos = FALSE;
141 #endif /* defined(KERBEROS_V4) || defined(KERBEROS_V5) */
142     flag has_cram = FALSE;
143 #ifdef OPIE_ENABLE
144     flag has_otp = FALSE;
145 #endif /* OPIE_ENABLE */
146 #ifdef SSL_ENABLE
147     flag has_ssl = FALSE;
148 #endif /* SSL_ENABLE */
149
150 #ifdef SDPS_ENABLE
151     /*
152      * This needs to catch both demon.co.uk and demon.net.
153      * If we see either, and we're in multidrop mode, try to use
154      * the SDPS *ENV extension.
155      */
156     if (!(ctl->server.sdps) && MULTIDROP(ctl) && strstr(greeting, "demon."))
157         ctl->server.sdps = TRUE;
158 #endif /* SDPS_ENABLE */
159
160     switch (ctl->server.protocol) {
161     case P_POP3:
162 #ifdef RPA_ENABLE
163         /* CompuServe POP3 Servers as of 990730 want AUTH first for RPA */
164         if (strstr(ctl->remotename, "@compuserve.com"))
165         {
166             /* AUTH command should return a list of available mechanisms */
167             if (gen_transact(sock, "AUTH") == 0)
168             {
169                 char buffer[10];
170                 flag has_rpa = FALSE;
171
172                 while ((ok = gen_recv(sock, buffer, sizeof(buffer))) == 0)
173                 {
174                     if (DOTLINE(buffer))
175                         break;
176                     if (strncasecmp(buffer, "rpa", 3) == 0)
177                         has_rpa = TRUE;
178                 }
179                 if (has_rpa && !POP3_auth_rpa(ctl->remotename, 
180                                               ctl->password, sock))
181                     return(PS_SUCCESS);
182             }
183
184             return(PS_AUTHFAIL);
185         }
186 #endif /* RPA_ENABLE */
187
188         /*
189          * CAPA command may return a list including available
190          * authentication mechanisms.  if it doesn't, no harm done, we
191          * just fall back to a plain login.  Note that this code 
192          * latches the server's authentication type, so that in daemon mode
193          * the CAPA check only needs to be done once at start of run.
194          *
195          * If CAPA fails, then force the authentication method to PASSORD
196          * and repoll immediately.
197          *
198          * These authentication methods are blessed by RFC1734,
199          * describing the POP3 AUTHentication command.
200          */
201         if (ctl->server.authenticate == A_ANY)
202         {
203             ok = gen_transact(sock, "CAPA");
204             if (ok == PS_SUCCESS)
205             {
206                 char buffer[64];
207
208                 /* determine what authentication methods we have available */
209                 while ((ok = gen_recv(sock, buffer, sizeof(buffer))) == 0)
210                 {
211                     if (DOTLINE(buffer))
212                         break;
213 #ifdef SSL_ENABLE
214                     if (strstr(buffer, "STLS"))
215                         has_ssl = TRUE;
216 #endif /* SSL_ENABLE */
217 #if defined(GSSAPI)
218                     if (strstr(buffer, "GSSAPI"))
219                         has_gssapi = TRUE;
220 #endif /* defined(GSSAPI) */
221 #if defined(KERBEROS_V4)
222                     if (strstr(buffer, "KERBEROS_V4"))
223                         has_kerberos = TRUE;
224 #endif /* defined(KERBEROS_V4)  */
225 #ifdef OPIE_ENABLE
226                     if (strstr(buffer, "X-OTP"))
227                         has_otp = TRUE;
228 #endif /* OPIE_ENABLE */
229                     if (strstr(buffer, "CRAM-MD5"))
230                         has_cram = TRUE;
231                 }
232             }
233             /* we are in STAGE_GETAUTH! */
234             else if (ok == PS_AUTHFAIL ||
235                 /* Some servers directly close the socket. However, if we
236                  * have already authenticated before, then a previous CAPA
237                  * must have succeeded. In that case, treat this as a
238                  * genuine socket error and do not change the auth method.
239                  */
240                 (ok == PS_SOCKET && !ctl->wehaveauthed))
241             {
242                 ctl->server.authenticate = A_PASSWORD;
243                 /* repoll immediately */
244                 ok = PS_REPOLL;
245                 break;
246             }
247         }
248
249 #ifdef SSL_ENABLE
250        if (has_ssl && !ctl->use_ssl &&
251 #if INET6_ENABLE
252            ctl->server.service && (strcmp(ctl->server.service, "pop3s"))
253 #else /* INET6_ENABLE */
254            ctl->server.port != 995
255 #endif /* INET6_ENABLE */
256            )
257        {
258            char *realhost;
259
260            realhost = ctl->server.via ? ctl->server.via : ctl->server.pollname;           gen_transact(sock, "STLS");
261            if (SSLOpen(sock,ctl->sslcert,ctl->sslkey,ctl->sslproto,ctl->sslcertck, ctl->sslcertpath,ctl->sslfingerprint,realhost,ctl->server.pollname) == -1)
262            {
263                report(stderr,
264                       GT_("SSL connection failed.\n"));
265                return(PS_AUTHFAIL);
266            }
267        }
268 #endif /* SSL_ENABLE */
269
270         /*
271          * OK, we have an authentication type now.
272          */
273 #if defined(KERBEROS_V4)
274         /* 
275          * Servers doing KPOP have to go through a dummy login sequence
276          * rather than doing SASL.
277          */
278         if (has_kerberos &&
279 #if INET6_ENABLE
280             ctl->server.service && (strcmp(ctl->server.service, KPOP_PORT)!=0)
281 #else /* INET6_ENABLE */
282             ctl->server.port != KPOP_PORT
283 #endif /* INET6_ENABLE */
284             && (ctl->server.authenticate == A_KERBEROS_V4
285              || ctl->server.authenticate == A_KERBEROS_V5
286              || ctl->server.authenticate == A_ANY))
287         {
288             ok = do_rfc1731(sock, "AUTH", ctl->server.truename);
289             if (ok == PS_SUCCESS || ctl->server.authenticate != A_ANY)
290                 break;
291         }
292 #endif /* defined(KERBEROS_V4) || defined(KERBEROS_V5) */
293
294 #if defined(GSSAPI)
295         if (has_gssapi &&
296             (ctl->server.authenticate == A_GSSAPI ||
297              ctl->server.authenticate == A_ANY))
298         {
299             ok = do_gssauth(sock,"AUTH",ctl->server.truename,ctl->remotename);
300             if (ok == PS_SUCCESS || ctl->server.authenticate != A_ANY)
301                 break;
302         }
303 #endif /* defined(GSSAPI) */
304
305 #ifdef OPIE_ENABLE
306         if (has_otp &&
307             (ctl->server.authenticate == A_OTP ||
308              ctl->server.authenticate == A_ANY))
309         {
310             ok = do_otp(sock, "AUTH", ctl);
311             if (ok == PS_SUCCESS || ctl->server.authenticate != A_ANY)
312                 break;
313         }
314 #endif /* OPIE_ENABLE */
315
316         if (has_cram &&
317             (ctl->server.authenticate == A_CRAM_MD5 ||
318              ctl->server.authenticate == A_ANY))
319         {
320             ok = do_cram_md5(sock, "AUTH", ctl, NULL);
321             if (ok == PS_SUCCESS || ctl->server.authenticate != A_ANY)
322                 break;
323         }
324
325         /* ordinary validation, no one-time password or RPA */ 
326         gen_transact(sock, "USER %s", ctl->remotename);
327         strcpy(shroud, ctl->password);
328         ok = gen_transact(sock, "PASS %s", ctl->password);
329         shroud[0] = '\0';
330         break;
331
332     case P_APOP:
333         /* build MD5 digest from greeting timestamp + password */
334         /* find start of timestamp */
335         for (start = greeting;  *start != 0 && *start != '<';  start++)
336             continue;
337         if (*start == 0) {
338             report(stderr,
339                    GT_("Required APOP timestamp not found in greeting\n"));
340             return(PS_AUTHFAIL);
341         }
342
343         /* find end of timestamp */
344         for (end = start;  *end != 0  && *end != '>';  end++)
345             continue;
346         if (*end == 0 || end == start + 1) {
347             report(stderr, 
348                    GT_("Timestamp syntax error in greeting\n"));
349             return(PS_AUTHFAIL);
350         }
351         else
352             *++end = '\0';
353
354         /* copy timestamp and password into digestion buffer */
355         xalloca(msg, char *, (end-start+1) + strlen(ctl->password) + 1);
356         strcpy(msg,start);
357         strcat(msg,ctl->password);
358
359         strcpy(ctl->digest, MD5Digest((unsigned char *)msg));
360
361         ok = gen_transact(sock, "APOP %s %s", ctl->remotename, ctl->digest);
362         break;
363
364     case P_RPOP:
365         if ((ok = gen_transact(sock,"USER %s", ctl->remotename)) == 0)
366             ok = gen_transact(sock, "RPOP %s", ctl->password);
367         break;
368
369     default:
370         report(stderr, GT_("Undefined protocol request in POP3_auth\n"));
371         ok = PS_ERROR;
372     }
373
374     if (ok != 0)
375     {
376         /* maybe we detected a lock-busy condition? */
377         if (ok == PS_LOCKBUSY)
378             report(stderr, GT_("lock busy!  Is another session active?\n")); 
379
380         return(ok);
381     }
382
383     /*
384      * Empirical experience shows some server/OS combinations
385      * may need a brief pause even after any lockfiles on the
386      * server are released, to give the server time to finish
387      * copying back very large mailfolders from the temp-file...
388      * this is only ever an issue with extremely large mailboxes.
389      */
390     sleep(3); /* to be _really_ safe, probably need sleep(5)! */
391
392     /* we're peek-capable if use of TOP is enabled */
393     peek_capable = !(ctl->fetchall || ctl->keep);
394
395     /* we're approved */
396     return(PS_SUCCESS);
397 }
398
399 static int pop3_gettopid( int sock, int num , char *id)
400 {
401     int ok;
402     int got_it;
403     char buf [POPBUFSIZE+1];
404     sprintf( buf, "TOP %d 1", num );
405     if ((ok = gen_transact(sock, buf )) != 0)
406        return ok; 
407     got_it = 0;
408     while ((ok = gen_recv(sock, buf, sizeof(buf))) == 0) 
409     {
410         if (DOTLINE(buf))
411             break;
412         if ( ! got_it && ! strncasecmp("Message-Id:", buf, 11 )) {
413             got_it = 1;
414             /* prevent stack overflows */
415             buf[IDLEN+12] = 0;
416             sscanf( buf+12, "%s", id);
417         }
418     }
419     return 0;
420 }
421
422 static int pop3_slowuidl( int sock,  struct query *ctl, int *countp, int *newp)
423 {
424     /* This approach tries to get the message headers from the
425      * remote hosts and compares the message-id to the already known
426      * ones:
427      *  + if the first message containes a new id, all messages on
428      *    the server will be new
429      *  + if the first is known, try to estimate the last known message
430      *    on the server and check. If this works you know the total number
431      *    of messages to get.
432      *  + Otherwise run a binary search to determine the last known message
433      */
434     int ok, nolinear = 0;
435     int first_nr, list_len, try_id, try_nr, add_id;
436     int num;
437     char id [IDLEN+1];
438     
439     if( (ok = pop3_gettopid( sock, 1, id )) != 0 )
440         return ok;
441     
442     if( ( first_nr = str_nr_in_list(&ctl->oldsaved, id) ) == -1 ) {
443         /* the first message is unknown -> all messages are new */
444         *newp = *countp;        
445         return 0;
446     }
447
448     /* check where we expect the latest known message */
449     list_len = count_list( &ctl->oldsaved );
450     try_id = list_len  - first_nr; /* -1 + 1 */
451     if( try_id > 1 ) {
452         if( try_id <= *countp ) {
453             if( (ok = pop3_gettopid( sock, try_id, id )) != 0 )
454                 return ok;
455     
456             try_nr = str_nr_last_in_list(&ctl->oldsaved, id);
457         } else {
458             try_id = *countp+1;
459             try_nr = -1;
460         }
461         if( try_nr != list_len -1 ) {
462             /* some messages inbetween have been deleted... */
463             if( try_nr == -1 ) {
464                 nolinear = 1;
465
466                 for( add_id = 1<<30; add_id > try_id-1; add_id >>= 1 )
467                     ;
468                 for( ; add_id; add_id >>= 1 ) {
469                     if( try_nr == -1 ) {
470                         if( try_id - add_id <= 1 ) {
471                             continue;
472                         }
473                         try_id -= add_id;
474                     } else 
475                         try_id += add_id;
476                     
477                     if( (ok = pop3_gettopid( sock, try_id, id )) != 0 )
478                         return ok;
479                     try_nr = str_nr_in_list(&ctl->oldsaved, id);
480                 }
481                 if( try_nr == -1 ) {
482                     try_id--;
483                 }
484             } else {
485                 report(stderr, 
486                        GT_("Messages inserted into list on server. Cannot handle this.\n"));
487                 return -1;
488             }
489         } 
490     }
491     /* the first try_id messages are known -> copy them to the newsaved list */
492     for( num = first_nr; num < list_len; num++ )
493     {
494         struct idlist   *new = save_str(&ctl->newsaved, 
495                                 str_from_nr_list(&ctl->oldsaved, num),
496                                 UID_UNSEEN);
497         new->val.status.num = num - first_nr + 1;
498     }
499
500     if( nolinear ) {
501         free_str_list(&ctl->oldsaved);
502         ctl->oldsaved = 0;
503         last = try_id;
504     }
505
506     *newp = *countp - try_id;
507     return 0;
508 }
509
510 static int pop3_getrange(int sock, 
511                          struct query *ctl,
512                          const char *folder,
513                          int *countp, int *newp, int *bytes)
514 /* get range of messages to be fetched */
515 {
516     int ok;
517     char buf [POPBUFSIZE+1];
518
519     /* Ensure that the new list is properly empty */
520     ctl->newsaved = (struct idlist *)NULL;
521
522 #ifdef MBOX
523     /* Alain Knaff suggests this, but it's not RFC standard */
524     if (folder)
525         if ((ok = gen_transact(sock, "MBOX %s", folder)))
526             return ok;
527 #endif /* MBOX */
528
529     /* get the total message count */
530     gen_send(sock, "STAT");
531     ok = pop3_ok(sock, buf);
532     if (ok == 0)
533         sscanf(buf,"%d %d", countp, bytes);
534     else
535         return(ok);
536
537     /*
538      * Newer, RFC-1725-conformant POP servers may not have the LAST command.
539      * We work as hard as possible to hide this ugliness, but it makes 
540      * counting new messages intrinsically quadratic in the worst case.
541      */
542     last = 0;
543     *newp = -1;
544     if (*countp > 0 && !ctl->fetchall)
545     {
546         char id [IDLEN+1];
547
548         if (!ctl->server.uidl) {
549             gen_send(sock, "LAST");
550             ok = pop3_ok(sock, buf);
551         } else
552             ok = 1;
553         if (ok == 0)
554         {
555             if (sscanf(buf, "%d", &last) == 0)
556             {
557                 report(stderr, GT_("protocol error\n"));
558                 return(PS_ERROR);
559             }
560             *newp = (*countp - last);
561         }
562         else
563         {
564             /* grab the mailbox's UID list */
565             if ((ok = gen_transact(sock, "UIDL")) != 0)
566             {
567                 /* don't worry, yet! do it the slow way */
568                 if((ok = pop3_slowuidl( sock, ctl, countp, newp))!=0)
569                 {
570                     report(stderr, GT_("protocol error while fetching UIDLs\n"));
571                     return(PS_ERROR);
572                 }
573             }
574             else
575             {
576                 int     num;
577
578                 *newp = 0;
579                 while ((ok = gen_recv(sock, buf, sizeof(buf))) == 0)
580                 {
581                     if (DOTLINE(buf))
582                         break;
583                     else if (sscanf(buf, "%d %s", &num, id) == 2)
584                     {
585                         struct idlist   *new;
586
587                         new = save_str(&ctl->newsaved, id, UID_UNSEEN);
588                         new->val.status.num = num;
589
590                         if (str_in_list(&ctl->oldsaved, id, FALSE)) {
591                             new->val.status.mark = UID_SEEN;
592                             str_set_mark(&ctl->oldsaved, id, UID_SEEN);
593                         }
594                         else
595                             (*newp)++;
596                     }
597                 }
598             }
599         }
600     }
601
602     return(PS_SUCCESS);
603 }
604
605 static int pop3_getsizes(int sock, int count, int *sizes)
606 /* capture the sizes of all messages */
607 {
608     int ok;
609
610     if ((ok = gen_transact(sock, "LIST")) != 0)
611         return(ok);
612     else
613     {
614         char buf [POPBUFSIZE+1];
615
616         while ((ok = gen_recv(sock, buf, sizeof(buf))) == 0)
617         {
618             unsigned int num, size;
619
620             if (DOTLINE(buf))
621                 break;
622             else if (sscanf(buf, "%u %u", &num, &size) == 2) {
623                 if (num > 0 && num <= count)
624                     sizes[num - 1] = size;
625                 else
626                     /* warn about possible attempt to induce buffer overrun */
627                     report(stderr, "Warning: ignoring bogus data for message sizes returned by server.\n");
628             }
629         }
630
631         return(ok);
632     }
633 }
634
635 static int pop3_is_old(int sock, struct query *ctl, int num)
636 /* is the given message old? */
637 {
638     if (!ctl->oldsaved)
639         return (num <= last);
640     else
641         return (str_in_list(&ctl->oldsaved,
642                             str_find(&ctl->newsaved, num), FALSE));
643 }
644
645 #ifdef UNUSED
646 /*
647  * We could use this to fetch headers only as we do for IMAP.  The trouble 
648  * is that there's no way to fetch the body only.  So the following RETR 
649  * would have to re-fetch the header.  Enough messages have longer headers
650  * than bodies to make this a net loss.
651  */
652 static int pop_fetch_headers(int sock, struct query *ctl,int number,int *lenp)
653 /* request headers of nth message */
654 {
655     int ok;
656     char buf[POPBUFSIZE+1];
657
658     gen_send(sock, "TOP %d 0", number);
659     if ((ok = pop3_ok(sock, buf)) != 0)
660         return(ok);
661
662     *lenp = -1;         /* we got sizes from the LIST response */
663
664     return(PS_SUCCESS);
665 }
666 #endif /* UNUSED */
667
668 static int pop3_fetch(int sock, struct query *ctl, int number, int *lenp)
669 /* request nth message */
670 {
671     int ok;
672     char buf[POPBUFSIZE+1];
673
674 #ifdef SDPS_ENABLE
675     /*
676      * See http://www.demon.net/services/mail/sdps-tech.html
677      * for a description of what we're parsing here.
678      */
679     if (ctl->server.sdps)
680     {
681         int     linecount = 0;
682
683         sdps_envfrom = (char *)NULL;
684         sdps_envto = (char *)NULL;
685         gen_send(sock, "*ENV %d", number);
686         do {
687             if (gen_recv(sock, buf, sizeof(buf)))
688             {
689                 break;
690             }
691             linecount++;
692             switch (linecount) {
693             case 4:
694                 /* No need to wrap envelope from address */
695                 sdps_envfrom = xmalloc(strlen(buf)+1);
696                 strcpy(sdps_envfrom,buf);
697                 break;
698             case 5:
699                 /* Wrap address with To: <> so nxtaddr() likes it */
700                 sdps_envto = xmalloc(strlen(buf)+7);
701                 sprintf(sdps_envto,"To: <%s>",buf);
702                 break;
703             }
704         } while
705             (!(buf[0] == '.' && (buf[1] == '\r' || buf[1] == '\n' || buf[1] == '\0')));
706     }
707 #endif /* SDPS_ENABLE */
708
709     /*
710      * Though the POP RFCs don't document this fact, on almost every
711      * POP3 server I know of messages are marked "seen" only at the
712      * time the OK response to a RETR is issued.
713      *
714      * This means we can use TOP to fetch the message without setting its
715      * seen flag.  This is good!  It means that if the protocol exchange
716      * craps out during the message, it will still be marked `unseen' on
717      * the server.  (Exception: in early 1999 SpryNet's POP3 servers were
718      * reported to mark messages seen on a TOP fetch.)
719      *
720      * However...*don't* do this if we're using keep to suppress deletion!
721      * In that case, marking the seen flag is the only way to prevent the
722      * message from being re-fetched on subsequent runs.
723      *
724      * Also use RETR if fetchall is on.  This gives us a workaround
725      * for servers like usa.net's that bungle TOP.  It's pretty
726      * harmless because fetchall guarantees that any message dropped
727      * by an interrupted RETR will be picked up on the next poll of the
728      * site.
729      *
730      * We take advantage here of the fact that, according to all the
731      * POP RFCs, "if the number of lines requested by the POP3 client
732      * is greater than than the number of lines in the body, then the
733      * POP3 server sends the entire message.").
734      *
735      * The line count passed (99999999) is the maximum value CompuServe will
736      * accept; it's much lower than the natural value 2147483646 (the maximum
737      * twos-complement signed 32-bit integer minus 1) */
738     if (ctl->keep || ctl->fetchall)
739         gen_send(sock, "RETR %d", number);
740     else
741         gen_send(sock, "TOP %d 99999999", number);
742     if ((ok = pop3_ok(sock, buf)) != 0)
743         return(ok);
744
745     *lenp = -1;         /* we got sizes from the LIST response */
746
747     return(PS_SUCCESS);
748 }
749
750 static int pop3_delete(int sock, struct query *ctl, int number)
751 /* delete a given message */
752 {
753     /* actually, mark for deletion -- doesn't happen until QUIT time */
754     return(gen_transact(sock, "DELE %d", number));
755 }
756
757 static int pop3_logout(int sock, struct query *ctl)
758 /* send logout command */
759 {
760     int ok;
761
762 #ifdef __UNUSED__
763     /*
764      * We used to do this in case the server marks messages deleted when seen.
765      * (Yes, this has been reported, in the MercuryP/NLM server.
766      * It's even legal under RFC 1939 (section 8) as a site policy.)
767      * It interacted badly with UIDL, though.  Thomas Zajic wrote:
768      * "Running 'fetchmail -F -v' and checking the logs, I found out
769      * that fetchmail did in fact flush my mailbox properly, but sent
770      * a RSET just before sending QUIT to log off.  This caused the
771      * POP3 server to undo/forget about the previous DELEs, resetting
772      * my mailbox to its original (ie.  unflushed) state. The
773      * ~/.fetchids file did get flushed though, so the next time
774      * fetchmail was run it saw all the old messages as new ones ..."
775      */
776      if (ctl->keep)
777         gen_transact(sock, "RSET");
778 #endif /* __UNUSED__ */
779
780     ok = gen_transact(sock, "QUIT");
781     if (!ok)
782         expunge_uids(ctl);
783
784     if (ctl->lastid)
785     {
786         free(ctl->lastid);
787         ctl->lastid = NULL;
788     }
789
790     return(ok);
791 }
792
793 const static struct method pop3 =
794 {
795     "POP3",             /* Post Office Protocol v3 */
796 #if INET6_ENABLE
797     "pop3",             /* standard POP3 port */
798     "pop3s",            /* ssl POP3 port */
799 #else /* INET6_ENABLE */
800     110,                /* standard POP3 port */
801     995,                /* ssl POP3 port */
802 #endif /* INET6_ENABLE */
803     FALSE,              /* this is not a tagged protocol */
804     TRUE,               /* this uses a message delimiter */
805     pop3_ok,            /* parse command response */
806     pop3_getauth,       /* get authorization */
807     pop3_getrange,      /* query range of messages */
808     pop3_getsizes,      /* we can get a list of sizes */
809     pop3_is_old,        /* how do we tell a message is old? */
810     pop3_fetch,         /* request given message */
811     NULL,               /* no way to fetch body alone */
812     NULL,               /* no message trailer */
813     pop3_delete,        /* how to delete a message */
814     pop3_logout,        /* log out, we're done */
815     FALSE,              /* no, we can't re-poll */
816 };
817
818 int doPOP3 (struct query *ctl)
819 /* retrieve messages using POP3 */
820 {
821 #ifndef MBOX
822     if (ctl->mailboxes->id) {
823         fprintf(stderr,GT_("Option --remote is not supported with POP3\n"));
824         return(PS_SYNTAX);
825     }
826 #endif /* MBOX */
827     peek_capable = !ctl->fetchall;
828     return(do_protocol(ctl, &pop3));
829 }
830 #endif /* POP3_ENABLE */
831
832 /* pop3.c ends here */