2 * pop3.c -- POP3 protocol methods
4 * Copyright 1998 by Eric S. Raymond.
5 * For license terms, see the file COPYING in this directory.
13 #if defined(HAVE_UNISTD_H)
16 #if defined(STDC_HEADERS)
20 #include "fetchmail.h"
26 #endif /* OPIE_ENABLE */
28 #ifndef strstr /* glibc-2.1 declares this as a macro */
29 extern char *strstr(const char *, const char *); /* needed on sysV68 R3V7.1. */
36 #endif /* SDPS_ENABLE */
39 static char lastok[POPBUFSIZE+1];
40 #endif /* OPIE_ENABLE */
42 /* these variables are shared between the CAPA probe and the authenticator */
44 flag has_gssapi = FALSE;
45 #endif /* defined(GSSAPI) */
46 #if defined(KERBEROS_V4) || defined(KERBEROS_V5)
47 flag has_kerberos = FALSE;
48 #endif /* defined(KERBEROS_V4) || defined(KERBEROS_V5) */
49 flag has_cram = FALSE;
52 #endif /* OPIE_ENABLE */
55 #endif /* SSL_ENABLE */
60 static tSmbNtlmAuthRequest request;
61 static tSmbNtlmAuthChallenge challenge;
62 static tSmbNtlmAuthResponse response;
65 * NTLM support by Grant Edwards.
67 * Handle MS-Exchange NTLM authentication method. This is the same
68 * as the NTLM auth used by Samba for SMB related services. We just
69 * encode the packets in base64 instead of sending them out via a
72 * Much source (ntlm.h, smb*.c smb*.h) was borrowed from Samba.
75 static int do_pop3_ntlm(int sock, struct query *ctl)
80 gen_send(sock, "AUTH MSN");
82 if ((result = gen_recv(sock, msgbuf, sizeof msgbuf)))
88 buildSmbNtlmAuthRequest(&request,ctl->remotename,NULL);
90 if (outlevel >= O_DEBUG)
91 dumpSmbNtlmAuthRequest(stdout, &request);
93 memset(msgbuf,0,sizeof msgbuf);
94 to64frombits (msgbuf, (unsigned char*)&request, SmbLength(&request));
96 if (outlevel >= O_MONITOR)
97 report(stdout, "POP3> %s\n", msgbuf);
99 strcat(msgbuf,"\r\n");
100 SockWrite (sock, msgbuf, strlen (msgbuf));
102 if ((gen_recv(sock, msgbuf, sizeof msgbuf)))
105 len = from64tobits ((unsigned char*)&challenge, msgbuf, sizeof(msgbuf));
107 if (outlevel >= O_DEBUG)
108 dumpSmbNtlmAuthChallenge(stdout, &challenge);
110 buildSmbNtlmAuthResponse(&challenge, &response,ctl->remotename,ctl->password);
112 if (outlevel >= O_DEBUG)
113 dumpSmbNtlmAuthResponse(stdout, &response);
115 memset(msgbuf,0,sizeof msgbuf);
116 to64frombits (msgbuf, (unsigned char*)&response, SmbLength(&response));
118 if (outlevel >= O_MONITOR)
119 report(stdout, "POP3> %s\n", msgbuf);
121 strcat(msgbuf,"\r\n");
122 SockWrite (sock, msgbuf, strlen (msgbuf));
124 if ((result = gen_recv (sock, msgbuf, sizeof msgbuf)))
127 if (strstr (msgbuf, "OK"))
135 #define DOTLINE(s) (s[0] == '.' && (s[1]=='\r'||s[1]=='\n'||s[1]=='\0'))
137 static int pop3_ok (int sock, char *argbuf)
138 /* parse command response */
141 char buf [POPBUFSIZE+1];
144 if ((ok = gen_recv(sock, buf, sizeof(buf))) == 0)
146 if (*bufp == '+' || *bufp == '-')
151 while (isalpha((unsigned char)*bufp))
157 if (strcmp(buf,"+OK") == 0)
160 strcpy(lastok, bufp);
161 #endif /* OPIE_ENABLE */
164 else if (strncmp(buf,"-ERR", 4) == 0)
166 if (stage == STAGE_FETCH)
168 else if (stage > STAGE_GETAUTH)
171 * We're checking for "lock busy", "unable to lock",
172 * "already locked", "wait a few minutes" etc. here.
173 * This indicates that we have to wait for the server to
174 * unwedge itself before we can poll again.
176 * PS_LOCKBUSY check empirically verified with two recent
177 * versions of the Berkeley popper; QPOP (version 2.2) and
178 * QUALCOMM Pop server derived from UCB (version 2.1.4-R3)
179 * These are caught by the case-indifferent "lock" check.
180 * The "wait" catches "mail storage services unavailable,
181 * wait a few minutes and try again" on the InterMail server.
183 * If these aren't picked up on correctly, fetchmail will
184 * think there is an authentication failure and wedge the
185 * connection in order to prevent futile polls.
189 else if (strstr(bufp,"lock")
190 || strstr(bufp,"Lock")
191 || strstr(bufp,"LOCK")
192 || strstr(bufp,"wait")
193 /* these are blessed by RFC 2449 */
194 || strstr(bufp,"[IN-USE]")||strstr(bufp,"[LOGIN-DELAY]"))
196 else if ((strstr(bufp,"Service")
197 || strstr(bufp,"service"))
198 && (strstr(bufp,"unavailable")))
203 * We always want to pass the user lock-busy messages, because
204 * they're red flags. Other stuff (like AUTH failures on non-
205 * RFC1734 servers) only if we're debugging.
207 if (*bufp && (ok == PS_LOCKBUSY || outlevel >= O_MONITOR))
208 report(stderr, "%s\n", bufp);
222 static int capa_probe(int sock)
223 /* probe the capabilities of the remote server */
229 #endif /* defined(GSSAPI) */
230 #if defined(KERBEROS_V4) || defined(KERBEROS_V5)
231 has_kerberos = FALSE;
232 #endif /* defined(KERBEROS_V4) || defined(KERBEROS_V5) */
236 #endif /* OPIE_ENABLE */
238 ok = gen_transact(sock, "CAPA");
239 if (ok == PS_SUCCESS)
243 /* determine what authentication methods we have available */
244 while ((ok = gen_recv(sock, buffer, sizeof(buffer))) == 0)
249 if (strstr(buffer, "STLS"))
251 #endif /* SSL_ENABLE */
253 if (strstr(buffer, "GSSAPI"))
255 #endif /* defined(GSSAPI) */
256 #if defined(KERBEROS_V4)
257 if (strstr(buffer, "KERBEROS_V4"))
259 #endif /* defined(KERBEROS_V4) */
261 if (strstr(buffer, "X-OTP"))
263 #endif /* OPIE_ENABLE */
264 if (strstr(buffer, "CRAM-MD5"))
271 static int pop3_getauth(int sock, struct query *ctl, char *greeting)
272 /* apply for connection authorization */
279 #endif /* OPIE_ENABLE */
281 flag did_stls = FALSE;
282 #endif /* SSL_ENABLE */
286 #endif /* defined(GSSAPI) */
287 #if defined(KERBEROS_V4) || defined(KERBEROS_V5)
288 has_kerberos = FALSE;
289 #endif /* defined(KERBEROS_V4) || defined(KERBEROS_V5) */
293 #endif /* OPIE_ENABLE */
296 #endif /* SSL_ENABLE */
298 if (ctl->server.authenticate == A_SSH) {
304 * This needs to catch both demon.co.uk and demon.net.
305 * If we see either, and we're in multidrop mode, try to use
306 * the SDPS *ENV extension.
308 if (!(ctl->server.sdps) && MULTIDROP(ctl) && strstr(greeting, "demon."))
309 ctl->server.sdps = TRUE;
310 #endif /* SDPS_ENABLE */
312 /* MSN servers require the use of NTLM (MSN) authentication */
313 if (!strcasecmp(ctl->server.pollname, "pop3.email.msn.com") ||
314 ctl->server.authenticate == A_NTLM)
316 if (!do_pop3_ntlm(sock, ctl))
327 switch (ctl->server.protocol) {
330 /* CompuServe POP3 Servers as of 990730 want AUTH first for RPA */
331 if (strstr(ctl->remotename, "@compuserve.com"))
333 /* AUTH command should return a list of available mechanisms */
334 if (gen_transact(sock, "AUTH") == 0)
337 flag has_rpa = FALSE;
339 while ((ok = gen_recv(sock, buffer, sizeof(buffer))) == 0)
343 if (strncasecmp(buffer, "rpa", 3) == 0)
346 if (has_rpa && !POP3_auth_rpa(ctl->remotename,
347 ctl->password, sock))
353 #endif /* RPA_ENABLE */
356 * CAPA command may return a list including available
357 * authentication mechanisms. if it doesn't, no harm done, we
358 * just fall back to a plain login. Note that this code
359 * latches the server's authentication type, so that in daemon mode
360 * the CAPA check only needs to be done once at start of run.
362 * If CAPA fails, then force the authentication method to PASSORD
363 * and repoll immediately.
365 * These authentication methods are blessed by RFC1734,
366 * describing the POP3 AUTHentication command.
368 if ((ctl->use_ssl != FLAG_FALSE) ||
369 (ctl->server.authenticate == A_ANY) ||
370 (ctl->server.authenticate == A_GSSAPI) ||
371 (ctl->server.authenticate == A_KERBEROS_V4) ||
372 (ctl->server.authenticate == A_OTP) ||
373 (ctl->server.authenticate == A_CRAM_MD5))
375 if ((ok = capa_probe(sock)) != PS_SUCCESS)
376 /* we are in STAGE_GETAUTH! */
377 if (ok == PS_AUTHFAIL ||
378 /* Some servers directly close the socket. However, if we
379 * have already authenticated before, then a previous CAPA
380 * must have succeeded. In that case, treat this as a
381 * genuine socket error and do not change the auth method.
383 (ok == PS_SOCKET && !ctl->wehaveauthed))
385 ctl->server.authenticate = A_PASSWORD;
386 /* repoll immediately */
395 && (!ctl->sslproto || !strcmp(ctl->sslproto,"tls1")))
399 realhost = ctl->server.via ? ctl->server.via : ctl->server.pollname;
400 ok = gen_transact(sock, "STLS");
402 /* We use "tls1" instead of ctl->sslproto, as we want STLS,
403 * not other SSL protocols
405 if (ok == PS_SUCCESS &&
406 SSLOpen(sock,ctl->sslcert,ctl->sslkey,"tls1",ctl->sslcertck, ctl->sslcertpath,ctl->sslfingerprint,realhost,ctl->server.pollname) == -1)
408 if (!ctl->sslproto && !ctl->wehaveauthed)
410 ctl->sslproto = xstrdup("");
411 /* repoll immediately */
415 GT_("SSL connection failed.\n"));
421 * RFC 2595 says this:
423 * "Once TLS has been started, the client MUST discard cached
424 * information about server capabilities and SHOULD re-issue the
425 * CAPABILITY command. This is necessary to protect against
426 * man-in-the-middle attacks which alter the capabilities list prior
427 * to STARTTLS. The server MAY advertise different capabilities
432 #endif /* SSL_ENABLE */
435 * OK, we have an authentication type now.
437 #if defined(KERBEROS_V4)
439 * Servers doing KPOP have to go through a dummy login sequence
440 * rather than doing SASL.
444 ctl->server.service && (strcmp(ctl->server.service, KPOP_PORT)!=0)
445 #else /* INET6_ENABLE */
446 ctl->server.port != KPOP_PORT
447 #endif /* INET6_ENABLE */
448 && (ctl->server.authenticate == A_KERBEROS_V4
449 || ctl->server.authenticate == A_KERBEROS_V5
450 || ctl->server.authenticate == A_ANY))
452 ok = do_rfc1731(sock, "AUTH", ctl->server.truename);
453 if (ok == PS_SUCCESS || ctl->server.authenticate != A_ANY)
456 #endif /* defined(KERBEROS_V4) || defined(KERBEROS_V5) */
460 (ctl->server.authenticate == A_GSSAPI ||
461 ctl->server.authenticate == A_ANY))
463 ok = do_gssauth(sock,"AUTH","pop",ctl->server.truename,ctl->remotename);
464 if (ok == PS_SUCCESS || ctl->server.authenticate != A_ANY)
467 #endif /* defined(GSSAPI) */
471 (ctl->server.authenticate == A_OTP ||
472 ctl->server.authenticate == A_ANY))
474 ok = do_otp(sock, "AUTH", ctl);
475 if (ok == PS_SUCCESS || ctl->server.authenticate != A_ANY)
478 #endif /* OPIE_ENABLE */
480 if (ctl->server.authenticate == A_CRAM_MD5 ||
481 (has_cram && ctl->server.authenticate == A_ANY))
483 ok = do_cram_md5(sock, "AUTH", ctl, NULL);
484 if (ok == PS_SUCCESS || ctl->server.authenticate != A_ANY)
488 /* ordinary validation, no one-time password or RPA */
489 gen_transact(sock, "USER %s", ctl->remotename);
492 /* see RFC1938: A One-Time Password System */
493 if (challenge = strstr(lastok, "otp-")) {
494 char response[OPIE_RESPONSE_MAX+1];
497 i = opiegenerator(challenge, !strcmp(ctl->password, "opie") ? "" : ctl->password, response);
498 if ((i == -2) && !run.poll_interval) {
499 char secret[OPIE_SECRET_MAX+1];
500 fprintf(stderr, GT_("Secret pass phrase: "));
501 if (opiereadpass(secret, sizeof(secret), 0))
502 i = opiegenerator(challenge, secret, response);
503 memset(secret, 0, sizeof(secret));
511 ok = gen_transact(sock, "PASS %s", response);
514 #endif /* OPIE_ENABLE */
516 strcpy(shroud, ctl->password);
517 ok = gen_transact(sock, "PASS %s", ctl->password);
520 /* this is for servers which claim to support TLS, but actually
522 if (did_stls && ok == PS_SOCKET && !ctl->sslproto && !ctl->wehaveauthed)
524 ctl->sslproto = xstrdup("");
525 /* repoll immediately */
532 /* build MD5 digest from greeting timestamp + password */
533 /* find start of timestamp */
534 for (start = greeting; *start != 0 && *start != '<'; start++)
538 GT_("Required APOP timestamp not found in greeting\n"));
542 /* find end of timestamp */
543 for (end = start; *end != 0 && *end != '>'; end++)
545 if (*end == 0 || end == start + 1) {
547 GT_("Timestamp syntax error in greeting\n"));
553 /* copy timestamp and password into digestion buffer */
554 xalloca(msg, char *, (end-start+1) + strlen(ctl->password) + 1);
556 strcat(msg,ctl->password);
558 strcpy(ctl->digest, MD5Digest((unsigned char *)msg));
560 ok = gen_transact(sock, "APOP %s %s", ctl->remotename, ctl->digest);
564 if ((ok = gen_transact(sock,"USER %s", ctl->remotename)) == 0)
565 ok = gen_transact(sock, "RPOP %s", ctl->password);
569 report(stderr, GT_("Undefined protocol request in POP3_auth\n"));
575 /* maybe we detected a lock-busy condition? */
576 if (ok == PS_LOCKBUSY)
577 report(stderr, GT_("lock busy! Is another session active?\n"));
583 * Empirical experience shows some server/OS combinations
584 * may need a brief pause even after any lockfiles on the
585 * server are released, to give the server time to finish
586 * copying back very large mailfolders from the temp-file...
587 * this is only ever an issue with extremely large mailboxes.
589 sleep(3); /* to be _really_ safe, probably need sleep(5)! */
591 /* we're peek-capable if use of TOP is enabled */
592 peek_capable = !(ctl->fetchall || ctl->keep);
598 static int pop3_gettopid( int sock, int num , char *id)
602 char buf [POPBUFSIZE+1];
603 sprintf( buf, "TOP %d 1", num );
604 if ((ok = gen_transact(sock, buf )) != 0)
607 while ((ok = gen_recv(sock, buf, sizeof(buf))) == 0)
611 if ( ! got_it && ! strncasecmp("Message-Id:", buf, 11 )) {
613 /* prevent stack overflows */
615 sscanf( buf+12, "%s", id);
621 static int pop3_getuidl( int sock, int num , char *id)
624 char buf [POPBUFSIZE+1];
625 gen_send(sock, "UIDL %d", num);
626 if ((ok = pop3_ok(sock, buf)) != 0)
628 if (sscanf(buf, "%d %s", &num, id) != 2)
633 static int pop3_fastuidl( int sock, struct query *ctl, unsigned int count, int *newp)
636 unsigned int first_nr, last_nr, try_nr;
641 while (first_nr < last_nr - 1)
645 try_nr = (first_nr + last_nr) / 2;
646 if( (ok = pop3_getuidl( sock, try_nr, id )) != 0 )
648 if ((new = str_in_list(&ctl->oldsaved, id, FALSE)))
650 flag mark = new->val.status.mark;
651 if (mark == UID_DELETED || mark == UID_EXPUNGED)
653 if (outlevel >= O_VERBOSE)
654 report(stderr, GT_("id=%s (num=%d) was deleted, but is still present!\n"), id, try_nr);
655 /* just mark it as seen now! */
656 new->val.status.mark = mark = UID_SEEN;
659 /* narrow the search region! */
660 if (mark == UID_UNSEEN)
662 if (outlevel >= O_DEBUG)
663 report(stdout, GT_("%u is unseen\n"), try_nr);
669 /* save the number */
670 new->val.status.num = try_nr;
674 if (outlevel >= O_DEBUG)
675 report(stdout, GT_("%u is unseen\n"), try_nr);
679 new = save_str(&ctl->oldsaved, id, UID_UNSEEN);
680 new->val.status.num = try_nr;
683 if (outlevel >= O_DEBUG && last_nr <= count)
684 report(stdout, GT_("%u is first unseen\n"), last_nr);
687 *newp = count - first_nr;
692 static int pop3_slowuidl( int sock, struct query *ctl, int *countp, int *newp)
694 /* This approach tries to get the message headers from the
695 * remote hosts and compares the message-id to the already known
697 * + if the first message containes a new id, all messages on
698 * the server will be new
699 * + if the first is known, try to estimate the last known message
700 * on the server and check. If this works you know the total number
701 * of messages to get.
702 * + Otherwise run a binary search to determine the last known message
704 int ok, nolinear = 0;
705 int first_nr, list_len, try_id, try_nr, add_id;
709 if( (ok = pop3_gettopid( sock, 1, id )) != 0 )
712 if( ( first_nr = str_nr_in_list(&ctl->oldsaved, id) ) == -1 ) {
713 /* the first message is unknown -> all messages are new */
718 /* check where we expect the latest known message */
719 list_len = count_list( &ctl->oldsaved );
720 try_id = list_len - first_nr; /* -1 + 1 */
722 if( try_id <= *countp ) {
723 if( (ok = pop3_gettopid( sock, try_id, id )) != 0 )
726 try_nr = str_nr_last_in_list(&ctl->oldsaved, id);
731 if( try_nr != list_len -1 ) {
732 /* some messages inbetween have been deleted... */
736 for( add_id = 1<<30; add_id > try_id-1; add_id >>= 1 )
738 for( ; add_id; add_id >>= 1 ) {
740 if( try_id - add_id <= 1 ) {
747 if( (ok = pop3_gettopid( sock, try_id, id )) != 0 )
749 try_nr = str_nr_in_list(&ctl->oldsaved, id);
756 GT_("Messages inserted into list on server. Cannot handle this.\n"));
761 /* the first try_id messages are known -> copy them to the newsaved list */
762 for( num = first_nr; num < list_len; num++ )
764 struct idlist *new = save_str(&ctl->newsaved,
765 str_from_nr_list(&ctl->oldsaved, num),
767 new->val.status.num = num - first_nr + 1;
771 free_str_list(&ctl->oldsaved);
776 *newp = *countp - try_id;
780 static int pop3_getrange(int sock,
783 int *countp, int *newp, int *bytes)
784 /* get range of messages to be fetched */
787 char buf [POPBUFSIZE+1];
789 /* Ensure that the new list is properly empty */
790 ctl->newsaved = (struct idlist *)NULL;
793 /* Alain Knaff suggests this, but it's not RFC standard */
795 if ((ok = gen_transact(sock, "MBOX %s", folder)))
799 /* get the total message count */
800 gen_send(sock, "STAT");
801 ok = pop3_ok(sock, buf);
803 sscanf(buf,"%d %d", countp, bytes);
808 * Newer, RFC-1725-conformant POP servers may not have the LAST command.
809 * We work as hard as possible to hide this ugliness, but it makes
810 * counting new messages intrinsically quadratic in the worst case.
814 if (*countp > 0 && !ctl->fetchall)
819 /* should we do fast uidl this time? */
820 fastuidl = ctl->fastuidl;
821 if (*countp > 7 && /* linear search is better if there are few mails! */
822 !ctl->flush && /* with flush, it is safer to disable fastuidl */
823 NUM_NONZERO (fastuidl))
828 dofastuidl = ctl->fastuidlcount != 0;
833 if (!ctl->server.uidl) {
834 gen_send(sock, "LAST");
835 ok = pop3_ok(sock, buf);
840 if (sscanf(buf, "%d", &last) == 0)
842 report(stderr, GT_("protocol error\n"));
845 *newp = (*countp - last);
850 return(pop3_fastuidl( sock, ctl, *countp, newp));
851 /* grab the mailbox's UID list */
852 if ((ok = gen_transact(sock, "UIDL")) != 0)
854 /* don't worry, yet! do it the slow way */
855 if((ok = pop3_slowuidl( sock, ctl, countp, newp))!=0)
857 report(stderr, GT_("protocol error while fetching UIDLs\n"));
866 while ((ok = gen_recv(sock, buf, sizeof(buf))) == 0)
870 else if (sscanf(buf, "%d %s", &num, id) == 2)
872 struct idlist *old, *new;
874 new = save_str(&ctl->newsaved, id, UID_UNSEEN);
875 new->val.status.num = num;
877 if ((old = str_in_list(&ctl->oldsaved, id, FALSE)))
879 flag mark = old->val.status.mark;
880 if (mark == UID_DELETED || mark == UID_EXPUNGED)
882 if (outlevel >= O_VERBOSE)
883 report(stderr, GT_("id=%s (num=%d) was deleted, but is still present!\n"), id, num);
884 /* just mark it as seen now! */
885 old->val.status.mark = mark = UID_SEEN;
887 new->val.status.mark = mark;
888 if (mark == UID_UNSEEN)
891 if (outlevel >= O_DEBUG)
892 report(stdout, GT_("%u is unseen\n"), num);
898 if (outlevel >= O_DEBUG)
899 report(stdout, GT_("%u is unseen\n"), num);
900 /* add it to oldsaved also! In case, we do not
901 * swap the lists (say, due to socket error),
902 * the same mail will not be downloaded again.
904 old = save_str(&ctl->oldsaved, id, UID_UNSEEN);
905 old->val.status.num = num;
916 static int pop3_getpartialsizes(int sock, int first, int last, int *sizes)
917 /* capture the size of message #first */
920 char buf [POPBUFSIZE+1];
921 unsigned int num, size;
923 for (i = first; i <= last; i++) {
924 gen_send(sock, "LIST %d", i);
925 if ((ok = pop3_ok(sock, buf)) != 0)
927 if (sscanf(buf, "%u %u", &num, &size) == 2) {
929 sizes[i - first] = size;
931 /* warn about possible attempt to induce buffer overrun
933 * we expect server reply message number and requested
934 * message number to match */
935 report(stderr, "Warning: ignoring bogus data for message sizes returned by server.\n");
941 static int pop3_getsizes(int sock, int count, int *sizes)
942 /* capture the sizes of all messages */
946 if ((ok = gen_transact(sock, "LIST")) != 0)
950 char buf [POPBUFSIZE+1];
952 while ((ok = gen_recv(sock, buf, sizeof(buf))) == 0)
954 unsigned int num, size;
958 else if (sscanf(buf, "%u %u", &num, &size) == 2) {
959 if (num > 0 && num <= count)
960 sizes[num - 1] = size;
962 /* warn about possible attempt to induce buffer overrun */
963 report(stderr, "Warning: ignoring bogus data for message sizes returned by server.\n");
971 static int pop3_is_old(int sock, struct query *ctl, int num)
972 /* is the given message old? */
976 return (num <= last);
984 /* in fast uidl, we manipulate the old list only! */
986 if ((new = id_find(&ctl->oldsaved, num)))
988 /* we already have the id! */
989 return(new->val.status.mark != UID_UNSEEN);
992 /* get the uidl first! */
993 if (pop3_getuidl(sock, num, id) != PS_SUCCESS)
996 if ((new = str_in_list(&ctl->oldsaved, id, FALSE))) {
997 /* we already have the id! */
998 new->val.status.num = num;
999 return(new->val.status.mark != UID_UNSEEN);
1003 new = save_str(&ctl->oldsaved, id, UID_UNSEEN);
1004 new->val.status.num = num;
1008 return ((new = id_find(&ctl->newsaved, num)) != NULL &&
1009 new->val.status.mark != UID_UNSEEN);
1014 * We could use this to fetch headers only as we do for IMAP. The trouble
1015 * is that there's no way to fetch the body only. So the following RETR
1016 * would have to re-fetch the header. Enough messages have longer headers
1017 * than bodies to make this a net loss.
1019 static int pop_fetch_headers(int sock, struct query *ctl,int number,int *lenp)
1020 /* request headers of nth message */
1023 char buf[POPBUFSIZE+1];
1025 gen_send(sock, "TOP %d 0", number);
1026 if ((ok = pop3_ok(sock, buf)) != 0)
1029 *lenp = -1; /* we got sizes from the LIST response */
1035 static int pop3_fetch(int sock, struct query *ctl, int number, int *lenp)
1036 /* request nth message */
1039 char buf[POPBUFSIZE+1];
1043 * See http://www.demon.net/services/mail/sdps-tech.html
1044 * for a description of what we're parsing here.
1046 if (ctl->server.sdps)
1050 sdps_envfrom = (char *)NULL;
1051 sdps_envto = (char *)NULL;
1052 gen_send(sock, "*ENV %d", number);
1054 if (gen_recv(sock, buf, sizeof(buf)))
1059 switch (linecount) {
1061 /* No need to wrap envelope from address */
1062 sdps_envfrom = xmalloc(strlen(buf)+1);
1063 strcpy(sdps_envfrom,buf);
1066 /* Wrap address with To: <> so nxtaddr() likes it */
1067 sdps_envto = xmalloc(strlen(buf)+7);
1068 sprintf(sdps_envto,"To: <%s>",buf);
1072 (!(buf[0] == '.' && (buf[1] == '\r' || buf[1] == '\n' || buf[1] == '\0')));
1074 #endif /* SDPS_ENABLE */
1077 * Though the POP RFCs don't document this fact, on almost every
1078 * POP3 server I know of messages are marked "seen" only at the
1079 * time the OK response to a RETR is issued.
1081 * This means we can use TOP to fetch the message without setting its
1082 * seen flag. This is good! It means that if the protocol exchange
1083 * craps out during the message, it will still be marked `unseen' on
1084 * the server. (Exception: in early 1999 SpryNet's POP3 servers were
1085 * reported to mark messages seen on a TOP fetch.)
1087 * However...*don't* do this if we're using keep to suppress deletion!
1088 * In that case, marking the seen flag is the only way to prevent the
1089 * message from being re-fetched on subsequent runs.
1091 * Also use RETR if fetchall is on. This gives us a workaround
1092 * for servers like usa.net's that bungle TOP. It's pretty
1093 * harmless because fetchall guarantees that any message dropped
1094 * by an interrupted RETR will be picked up on the next poll of the
1097 * We take advantage here of the fact that, according to all the
1098 * POP RFCs, "if the number of lines requested by the POP3 client
1099 * is greater than than the number of lines in the body, then the
1100 * POP3 server sends the entire message.").
1102 * The line count passed (99999999) is the maximum value CompuServe will
1103 * accept; it's much lower than the natural value 2147483646 (the maximum
1104 * twos-complement signed 32-bit integer minus 1) */
1105 if (ctl->keep || ctl->fetchall)
1106 gen_send(sock, "RETR %d", number);
1108 gen_send(sock, "TOP %d 99999999", number);
1109 if ((ok = pop3_ok(sock, buf)) != 0)
1112 *lenp = -1; /* we got sizes from the LIST response */
1117 static void mark_uid_seen(struct query *ctl, int number)
1118 /* Tell the UID code we've seen this. */
1122 if ((sdp = id_find(&ctl->newsaved, number)))
1123 sdp->val.status.mark = UID_SEEN;
1124 /* mark it as seen in oldsaved also! In case, we do not swap the lists
1125 * (say, due to socket error), the same mail will not be downloaded
1128 if ((sdp = id_find(&ctl->oldsaved, number)))
1129 sdp->val.status.mark = UID_SEEN;
1132 static int pop3_delete(int sock, struct query *ctl, int number)
1133 /* delete a given message */
1136 mark_uid_seen(ctl, number);
1137 /* actually, mark for deletion -- doesn't happen until QUIT time */
1138 ok = gen_transact(sock, "DELE %d", number);
1139 if (ok != PS_SUCCESS)
1141 delete_str(dofastuidl ? &ctl->oldsaved : &ctl->newsaved, number);
1145 static int pop3_mark_seen(int sock, struct query *ctl, int number)
1146 /* mark a given message as seen */
1148 mark_uid_seen(ctl, number);
1152 static int pop3_logout(int sock, struct query *ctl)
1153 /* send logout command */
1159 * We used to do this in case the server marks messages deleted when seen.
1160 * (Yes, this has been reported, in the MercuryP/NLM server.
1161 * It's even legal under RFC 1939 (section 8) as a site policy.)
1162 * It interacted badly with UIDL, though. Thomas Zajic wrote:
1163 * "Running 'fetchmail -F -v' and checking the logs, I found out
1164 * that fetchmail did in fact flush my mailbox properly, but sent
1165 * a RSET just before sending QUIT to log off. This caused the
1166 * POP3 server to undo/forget about the previous DELEs, resetting
1167 * my mailbox to its original (ie. unflushed) state. The
1168 * ~/.fetchids file did get flushed though, so the next time
1169 * fetchmail was run it saw all the old messages as new ones ..."
1172 gen_transact(sock, "RSET");
1173 #endif /* __UNUSED__ */
1175 ok = gen_transact(sock, "QUIT");
1182 static const struct method pop3 =
1184 "POP3", /* Post Office Protocol v3 */
1186 "pop3", /* standard POP3 port */
1187 "pop3s", /* ssl POP3 port */
1188 #else /* INET6_ENABLE */
1189 110, /* standard POP3 port */
1190 995, /* ssl POP3 port */
1191 #endif /* INET6_ENABLE */
1192 FALSE, /* this is not a tagged protocol */
1193 TRUE, /* this uses a message delimiter */
1194 pop3_ok, /* parse command response */
1195 pop3_getauth, /* get authorization */
1196 pop3_getrange, /* query range of messages */
1197 pop3_getsizes, /* we can get a list of sizes */
1198 pop3_getpartialsizes, /* we can get the size of 1 mail */
1199 pop3_is_old, /* how do we tell a message is old? */
1200 pop3_fetch, /* request given message */
1201 NULL, /* no way to fetch body alone */
1202 NULL, /* no message trailer */
1203 pop3_delete, /* how to delete a message */
1204 pop3_mark_seen, /* how to mark a message as seen */
1205 pop3_logout, /* log out, we're done */
1206 FALSE, /* no, we can't re-poll */
1209 int doPOP3 (struct query *ctl)
1210 /* retrieve messages using POP3 */
1213 if (ctl->mailboxes->id) {
1214 fprintf(stderr,GT_("Option --remote is not supported with POP3\n"));
1218 peek_capable = !ctl->fetchall;
1219 return(do_protocol(ctl, &pop3));
1221 #endif /* POP3_ENABLE */
1223 /* pop3.c ends here */