Pileus Git - ~andy/fetchmail/blob - imap.c

   1 /*
   2  * imap.c -- IMAP2bis/IMAP4 protocol methods
   3  *
   4  * Copyright 1997 by Eric S. Raymond
   5  * For license terms, see the file COPYING in this directory.
   6  */
   7
   8 #include  "config.h"
   9 #include  <stdio.h>
  10 #include  <string.h>
  11 #include  <strings.h>
  12 #include  <ctype.h>
  13 #if defined(STDC_HEADERS)
  14 #include  <stdlib.h>
  15 #include  <limits.h>
  16 #include  <errno.h>
  17 #endif
  18 #include  "fetchmail.h"
  19 #include  "socket.h"
  20
  21 #include  "i18n.h"
  22
  23 /* imap_version values */
  24 #define IMAP2           -1      /* IMAP2 or IMAP2BIS, RFC1176 */
  25 #define IMAP4           0       /* IMAP4 rev 0, RFC1730 */
  26 #define IMAP4rev1       1       /* IMAP4 rev 1, RFC2060 */
  27
  28 /* global variables: please reinitialize them explicitly for proper
  29  * working in daemon mode */
  30
  31 /* TODO: session variables to be initialized before server greeting */
  32 static int preauth = FALSE;
  33
  34 /* session variables initialized in capa_probe() or imap_getauth() */
  35 static char capabilities[MSGBUFSIZE+1];
  36 static int imap_version = IMAP4;
  37 static flag do_idle = FALSE, has_idle = FALSE;
  38 static int expunge_period = 1;
  39
  40 /* mailbox variables initialized in imap_getrange() */
  41 static int count = 0, oldcount = 0, recentcount = 0, unseen = 0, deletions = 0;
  42 static unsigned int startcount = 1;
  43 static int expunged = 0;
  44 static unsigned int *unseen_messages;
  45
  46 /* for "IMAP> EXPUNGE" */
  47 static int actual_deletions = 0;
  48
  49 /* for "IMAP> IDLE" */
  50 static int saved_timeout = 0, idle_timeout = 0;
  51 static time_t idle_start_time = 0;
  52
  53 static int imap_untagged_response(int sock, const char *buf)
  54 /* interpret untagged status responses */
  55 {
  56     /* For each individual check, use a BLANK before the word to avoid
  57      * confusion with the \Recent flag or similar */
  58     if (stage == STAGE_GETAUTH
  59             && !strncmp(buf, "* CAPABILITY", 12))
  60     {
  61         strlcpy(capabilities, buf + 12, sizeof(capabilities));
  62     }
  63     else if (stage == STAGE_GETAUTH
  64             && !strncmp(buf, "* PREAUTH", 9))
  65     {
  66         preauth = TRUE;
  67     }
  68     else if (stage != STAGE_LOGOUT
  69             && !strncmp(buf, "* BYE", 5))
  70     {
  71         /* log the unexpected bye from server as we expect the
  72          * connection to be cut-off after this */
  73         if (outlevel > O_SILENT)
  74             report(stderr, GT_("Received BYE response from IMAP server: %s"), buf + 5);
  75     }
  76     else if (strstr(buf, " EXISTS"))
  77     {
  78         char *t; unsigned long u;
  79         errno = 0;
  80         u = strtoul(buf+2, &t, 10);
  81         /*
  82          * Don't trust the message count passed by the server.
  83          * Without this check, it might be possible to do a
  84          * DNS-spoofing attack that would pass back a ridiculous
  85          * count, and allocate a malloc area that would overlap
  86          * a portion of the stack.
  87          */
  88         if (errno /* strtoul failed */
  89                 || t == buf+2 /* no valid data */
  90                 || u > (unsigned long)(INT_MAX/sizeof(int)) /* too large */)
  91         {
  92             report(stderr, GT_("bogus message count in \"%s\"!"), buf);
  93             return(PS_PROTOCOL);
  94         }
  95         count = u; /* safe as long as count <= INT_MAX - checked above */
  96
  97         if ((recentcount = count - oldcount) < 0)
  98             recentcount = 0;
  99
 100         /*
 101          * Nasty kluge to handle RFC2177 IDLE.  If we know we're idling
 102          * we can't wait for the tag matching the IDLE; we have to tell the
 103          * server the IDLE is finished by shipping back a DONE when we
 104          * see an EXISTS.  Only after that will a tagged response be
 105          * shipped.  The idling flag also gets cleared on a timeout.
 106          */
 107         if (stage == STAGE_IDLE)
 108         {
 109             /* If IDLE isn't supported, we were only sending NOOPs anyway. */
 110             if (has_idle)
 111             {
 112                 /* we do our own write and report here to disable tagging */
 113                 SockWrite(sock, "DONE\r\n", 6);
 114                 if (outlevel >= O_MONITOR)
 115                     report(stdout, "IMAP> DONE\n");
 116             }
 117
 118             mytimeout = saved_timeout;
 119             stage = STAGE_GETRANGE;
 120         }
 121     }
 122     /* we now compute recentcount as a difference between
 123      * new and old EXISTS, hence disable RECENT check */
 124 # if 0
 125     else if (strstr(buf, " RECENT"))
 126     {
 127         /* fixme: use strto[u]l and error checking */
 128         recentcount = atoi(buf+2);
 129     }
 130 # endif
 131     else if (strstr(buf, " EXPUNGE"))
 132     {
 133         unsigned long u; char *t;
 134         /* the response "* 10 EXPUNGE" means that the currently
 135          * tenth (i.e. only one) message has been deleted */
 136         errno = 0;
 137         u = strtoul(buf+2, &t, 10);
 138         if (errno /* conversion error */ || t == buf+2 /* no number found */) {
 139             report(stderr, GT_("bogus EXPUNGE count in \"%s\"!"), buf);
 140             return PS_PROTOCOL;
 141         }
 142         if (u > 0)
 143         {
 144             if (count > 0)
 145                 count--;
 146             if (oldcount > 0)
 147                 oldcount--;
 148             /* We do expect an EXISTS response immediately
 149              * after this, so this updation of recentcount is
 150              * just a precaution! */
 151             if ((recentcount = count - oldcount) < 0)
 152                 recentcount = 0;
 153             actual_deletions++;
 154         }
 155     }
 156     /*
 157      * The server may decide to make the mailbox read-only,
 158      * which causes fetchmail to go into a endless loop
 159      * fetching the same message over and over again.
 160      *
 161      * However, for check_only, we use EXAMINE which will
 162      * mark the mailbox read-only as per the RFC.
 163      *
 164      * This checks for the condition and aborts if
 165      * the mailbox is read-only.
 166      *
 167      * See RFC 2060 section 6.3.1 (SELECT).
 168      * See RFC 2060 section 6.3.2 (EXAMINE).
 169      */
 170     else if (stage == STAGE_GETRANGE
 171             && !check_only && strstr(buf, "[READ-ONLY]"))
 172     {
 173         return(PS_LOCKBUSY);
 174     }
 175     else
 176     {
 177         return(PS_UNTAGGED);
 178     }
 179     return(PS_SUCCESS);
 180 }
 181
 182 static int imap_response(int sock, char *argbuf, struct RecvSplit *rs)
 183 /* parse command response */
 184 {
 185     char buf[MSGBUFSIZE+1];
 186
 187     do {
 188         int     ok;
 189         char    *cp;
 190
 191         if (rs)
 192             ok = gen_recv_split(sock, buf, sizeof(buf), rs);
 193         else
 194             ok = gen_recv(sock, buf, sizeof(buf));
 195         if (ok != PS_SUCCESS)
 196             return(ok);
 197
 198         /* all tokens in responses are caseblind */
 199         for (cp = buf; *cp; cp++)
 200             if (islower((unsigned char)*cp))
 201                 *cp = toupper((unsigned char)*cp);
 202
 203         /* untagged responses start with "* " */
 204         if (buf[0] == '*' && buf[1] == ' ') {
 205             ok = imap_untagged_response(sock, buf);
 206             if (ok == PS_UNTAGGED)
 207             {
 208                 if (argbuf && stage != STAGE_IDLE && tag[0] != '\0')
 209                 {
 210                     /* if there is an unmatched response, pass it back to
 211                      * the calling function for further analysis. The
 212                      * calling function should call imap_response() again
 213                      * to read the remaining response */
 214                     strcpy(argbuf, buf);
 215                     return(ok);
 216                 }
 217             }
 218             else if (ok != PS_SUCCESS)
 219                 return(ok);
 220         }
 221
 222         if (stage == STAGE_IDLE)
 223         {
 224             /* reduce the timeout: servers may not reset their timeout
 225              * when they send some information asynchronously */
 226             mytimeout = idle_timeout - (time((time_t *) NULL) - idle_start_time);
 227             if (mytimeout <= 0)
 228                 return(PS_IDLETIMEOUT);
 229         }
 230     } while
 231         (tag[0] != '\0' && strncmp(buf, tag, strlen(tag)));
 232
 233     if (tag[0] == '\0')
 234     {
 235         if (argbuf)
 236             strcpy(argbuf, buf);
 237         return(PS_SUCCESS);
 238     }
 239     else
 240     {
 241         char    *cp;
 242
 243         /* skip the tag */
 244         for (cp = buf; !isspace((unsigned char)*cp); cp++)
 245             continue;
 246         while (isspace((unsigned char)*cp))
 247             cp++;
 248
 249         if (strncasecmp(cp, "OK", 2) == 0)
 250         {
 251             if (argbuf)
 252                 strcpy(argbuf, cp);
 253             return(PS_SUCCESS);
 254         }
 255         else if (strncasecmp(cp, "BAD", 3) == 0)
 256             return(PS_ERROR);
 257         else if (strncasecmp(cp, "NO", 2) == 0)
 258         {
 259             if (stage == STAGE_GETAUTH)
 260                 return(PS_AUTHFAIL);    /* RFC2060, 6.2.2 */
 261             else if (stage == STAGE_GETSIZES)
 262                 return(PS_SUCCESS);     /* see comments in imap_getpartialsizes() */
 263             else
 264                 return(PS_ERROR);
 265         }
 266         else
 267             return(PS_PROTOCOL);
 268     }
 269 }
 270
 271 static int imap_ok(int sock, char *argbuf)
 272 /* parse command response */
 273 {
 274     int ok;
 275
 276     while ((ok = imap_response(sock, argbuf, NULL)) == PS_UNTAGGED)
 277         ; /* wait for the tagged response */
 278     return(ok);
 279 }
 280
 281 #ifdef NTLM_ENABLE
 282 #include "ntlm.h"
 283
 284 /*
 285  * NTLM support by Grant Edwards.
 286  *
 287  * Handle MS-Exchange NTLM authentication method.  This is the same
 288  * as the NTLM auth used by Samba for SMB related services. We just
 289  * encode the packets in base64 instead of sending them out via a
 290  * network interface.
 291  *
 292  * Much source (ntlm.h, smb*.c smb*.h) was borrowed from Samba.
 293  */
 294
 295 static int do_imap_ntlm(int sock, struct query *ctl)
 296 {
 297     int result;
 298
 299     gen_send(sock, "AUTHENTICATE NTLM");
 300
 301     if ((result = ntlm_helper(sock, ctl, "IMAP")))
 302         return result;
 303
 304     result = imap_ok (sock, NULL);
 305     if (result == PS_SUCCESS)
 306         return PS_SUCCESS;
 307     else
 308         return PS_AUTHFAIL;
 309 }
 310 #endif /* NTLM */
 311
 312 static void imap_canonicalize(char *result, char *raw, size_t maxlen)
 313 /* encode an IMAP password as per RFC1730's quoting conventions */
 314 {
 315     size_t i, j;
 316
 317     j = 0;
 318     for (i = 0; i < strlen(raw) && i < maxlen; i++)
 319     {
 320         if ((raw[i] == '\\') || (raw[i] == '"'))
 321             result[j++] = '\\';
 322         result[j++] = raw[i];
 323     }
 324     result[j] = '\0';
 325 }
 326
 327 static int capa_probe(int sock, struct query *ctl)
 328 /* set capability variables from a CAPA probe */
 329 {
 330     int ok;
 331
 332     /* probe to see if we're running IMAP4 and can use RFC822.PEEK */
 333     capabilities[0] = '\0';
 334     if ((ok = gen_transact(sock, "CAPABILITY")) == PS_SUCCESS)
 335     {
 336         char    *cp;
 337
 338         /* capability checks are supposed to be caseblind */
 339         for (cp = capabilities; *cp; cp++)
 340             *cp = toupper((unsigned char)*cp);
 341
 342         /* UW-IMAP server 10.173 notifies in all caps, but RFC2060 says we
 343            should expect a response in mixed-case */
 344         if (strstr(capabilities, "IMAP4REV1"))
 345         {
 346             imap_version = IMAP4rev1;
 347             if (outlevel >= O_DEBUG)
 348                 report(stdout, GT_("Protocol identified as IMAP4 rev 1\n"));
 349         }
 350         else
 351         {
 352             imap_version = IMAP4;
 353             if (outlevel >= O_DEBUG)
 354                 report(stdout, GT_("Protocol identified as IMAP4 rev 0\n"));
 355         }
 356     }
 357     else if (ok == PS_ERROR)
 358     {
 359         imap_version = IMAP2;
 360         if (outlevel >= O_DEBUG)
 361             report(stdout, GT_("Protocol identified as IMAP2 or IMAP2BIS\n"));
 362     }
 363     else
 364         return ok;
 365
 366     /*
 367      * Handle idling.  We depend on coming through here on startup
 368      * and after each timeout (including timeouts during idles).
 369      */
 370     do_idle = ctl->idle;
 371     if (ctl->idle)
 372     {
 373         if (strstr(capabilities, "IDLE"))
 374             has_idle = TRUE;
 375         else
 376             has_idle = FALSE;
 377         if (outlevel >= O_VERBOSE)
 378             report(stdout, GT_("will idle after poll\n"));
 379     }
 380
 381     peek_capable = (imap_version >= IMAP4);
 382
 383     return PS_SUCCESS;
 384 }
 385
 386 static int do_authcert (int sock, const char *command, const char *name)
 387 /* do authentication "external" (authentication provided by client cert) */
 388 {
 389     char buf[256];
 390
 391     if (name && name[0])
 392     {
 393         size_t len = strlen(name);
 394         if ((len / 3) + ((len % 3) ? 4 : 0)  < sizeof(buf))
 395             to64frombits (buf, name, strlen(name));
 396         else
 397             return PS_AUTHFAIL; /* buffer too small. */
 398     }
 399     else
 400         buf[0]=0;
 401     return gen_transact(sock, "%s EXTERNAL %s",command,buf);
 402 }
 403
 404 static int imap_getauth(int sock, struct query *ctl, char *greeting)
 405 /* apply for connection authorization */
 406 {
 407     int ok = 0;
 408     (void)greeting;
 409
 410     /*
 411      * Assumption: expunges are cheap, so we want to do them
 412      * after every message unless user said otherwise.
 413      */
 414     if (NUM_SPECIFIED(ctl->expunge))
 415         expunge_period = NUM_VALUE_OUT(ctl->expunge);
 416     else
 417         expunge_period = 1;
 418
 419     if ((ok = capa_probe(sock, ctl)))
 420         return ok;
 421
 422     /*
 423      * If either (a) we saw a PREAUTH token in the greeting, or
 424      * (b) the user specified ssh preauthentication, then we're done.
 425      */
 426     if (preauth || ctl->server.authenticate == A_SSH)
 427     {
 428         preauth = FALSE;  /* reset for the next session */
 429         return(PS_SUCCESS);
 430     }
 431
 432 #ifdef SSL_ENABLE
 433     if (maybe_tls(ctl)) {
 434         char *commonname;
 435
 436         commonname = ctl->server.pollname;
 437         if (ctl->server.via)
 438             commonname = ctl->server.via;
 439         if (ctl->sslcommonname)
 440             commonname = ctl->sslcommonname;
 441
 442         if (strstr(capabilities, "STARTTLS")
 443                 || must_tls(ctl)) /* if TLS is mandatory, ignore capabilities */
 444         {
 445             /* Use "tls1" rather than ctl->sslproto because tls1 is the only
 446              * protocol that will work with STARTTLS.  Don't need to worry
 447              * whether TLS is mandatory or opportunistic unless SSLOpen() fails
 448              * (see below). */
 449             if (gen_transact(sock, "STARTTLS") == PS_SUCCESS
 450                     && (set_timeout(mytimeout), SSLOpen(sock, ctl->sslcert, ctl->sslkey, "tls1", ctl->sslcertck,
 451                         ctl->sslcertfile, ctl->sslcertpath, ctl->sslfingerprint, commonname,
 452                         ctl->server.pollname, &ctl->remotename)) != -1)
 453             {
 454                 /*
 455                  * RFC 2595 says this:
 456                  *
 457                  * "Once TLS has been started, the client MUST discard cached
 458                  * information about server capabilities and SHOULD re-issue the
 459                  * CAPABILITY command.  This is necessary to protect against
 460                  * man-in-the-middle attacks which alter the capabilities list prior
 461                  * to STARTTLS.  The server MAY advertise different capabilities
 462                  * after STARTTLS."
 463                  *
 464                  * Now that we're confident in our TLS connection we can
 465                  * guarantee a secure capability re-probe.
 466                  */
 467                 if ((ok = capa_probe(sock, ctl)))
 468                     return ok;
 469                 if (outlevel >= O_VERBOSE)
 470                 {
 471                     report(stdout, GT_("%s: upgrade to TLS succeeded.\n"), commonname);
 472                 }
 473             } else if (must_tls(ctl)) {
 474                 /* Config required TLS but we couldn't guarantee it, so we must
 475                  * stop. */
 476                 set_timeout(0);
 477                 report(stderr, GT_("%s: upgrade to TLS failed.\n"), commonname);
 478                 return PS_SOCKET;
 479             } else {
 480                 set_timeout(0);
 481                 if (outlevel >= O_VERBOSE) {
 482                     report(stdout, GT_("%s: opportunistic upgrade to TLS failed, trying to continue\n"), commonname);
 483                 }
 484                 /* We don't know whether the connection is in a working state, so
 485                  * test by issuing a NOOP. */
 486                 if (gen_transact(sock, "NOOP") != PS_SUCCESS) {
 487                     /* Not usable.  Empty sslproto to force an unencrypted
 488                      * connection on the next attempt, and repoll. */
 489                     ctl->sslproto = xstrdup("");
 490                     return PS_REPOLL;
 491                 }
 492                 /* Usable.  Proceed with authenticating insecurely. */
 493             }
 494         }
 495     }
 496 #endif /* SSL_ENABLE */
 497
 498     /*
 499      * Time to authenticate the user.
 500      * Try the protocol variants that don't require passwords first.
 501      */
 502     ok = PS_AUTHFAIL;
 503
 504     /* Yahoo hack - we'll just try ID if it was offered by the server,
 505      * and IGNORE errors. */
 506     {
 507         char *tmp = strstr(capabilities, " ID");
 508         if (tmp && !isalnum((unsigned char)tmp[3]) && strstr(ctl->server.via ? ctl->server.via : ctl->server.pollname, "yahoo.com")) {
 509                 (void)gen_transact(sock, "ID (\"guid\" \"1\")");
 510         }
 511     }
 512
 513     if ((ctl->server.authenticate == A_ANY
 514          || ctl->server.authenticate == A_EXTERNAL)
 515         && strstr(capabilities, "AUTH=EXTERNAL"))
 516     {
 517         ok = do_authcert(sock, "AUTHENTICATE", ctl->remotename);
 518         if (ok)
 519         {
 520             /* SASL cancellation of authentication */
 521             gen_send(sock, "*");
 522             if (ctl->server.authenticate != A_ANY)
 523                 return ok;
 524         } else {
 525             return ok;
 526         }
 527     }
 528
 529 #ifdef GSSAPI
 530     if (((ctl->server.authenticate == A_ANY && check_gss_creds("imap", ctl->server.truename) == PS_SUCCESS)
 531          || ctl->server.authenticate == A_GSSAPI)
 532         && strstr(capabilities, "AUTH=GSSAPI"))
 533     {
 534         if ((ok = do_gssauth(sock, "AUTHENTICATE", "imap",
 535                         ctl->server.truename, ctl->remotename)))
 536         {
 537             if (ctl->server.authenticate != A_ANY)
 538                 return ok;
 539         } else  {
 540             return ok;
 541         }
 542     }
 543 #endif /* GSSAPI */
 544
 545 #ifdef KERBEROS_V4
 546     if ((ctl->server.authenticate == A_ANY
 547          || ctl->server.authenticate == A_KERBEROS_V4
 548          || ctl->server.authenticate == A_KERBEROS_V5)
 549         && strstr(capabilities, "AUTH=KERBEROS_V4"))
 550     {
 551         if ((ok = do_rfc1731(sock, "AUTHENTICATE", ctl->server.truename)))
 552         {
 553             /* SASL cancellation of authentication */
 554             gen_send(sock, "*");
 555             if(ctl->server.authenticate != A_ANY)
 556                 return ok;
 557         }
 558         else
 559             return ok;
 560     }
 561 #endif /* KERBEROS_V4 */
 562
 563     /*
 564      * No such luck.  OK, now try the variants that mask your password
 565      * in a challenge-response.
 566      */
 567
 568     if ((ctl->server.authenticate == A_ANY && strstr(capabilities, "AUTH=CRAM-MD5"))
 569         || ctl->server.authenticate == A_CRAM_MD5)
 570     {
 571         if ((ok = do_cram_md5 (sock, "AUTHENTICATE", ctl, NULL)))
 572         {
 573             if(ctl->server.authenticate != A_ANY)
 574                 return ok;
 575         }
 576         else
 577             return ok;
 578     }
 579
 580 #ifdef OPIE_ENABLE
 581     if ((ctl->server.authenticate == A_ANY
 582          || ctl->server.authenticate == A_OTP)
 583         && strstr(capabilities, "AUTH=X-OTP")) {
 584         if ((ok = do_otp(sock, "AUTHENTICATE", ctl)))
 585         {
 586             /* SASL cancellation of authentication */
 587             gen_send(sock, "*");
 588             if(ctl->server.authenticate != A_ANY)
 589                 return ok;
 590         } else {
 591             return ok;
 592         }
 593     }
 594 #else
 595     if (ctl->server.authenticate == A_OTP)
 596     {
 597         report(stderr,
 598            GT_("Required OTP capability not compiled into fetchmail\n"));
 599     }
 600 #endif /* OPIE_ENABLE */
 601
 602 #ifdef NTLM_ENABLE
 603     if ((ctl->server.authenticate == A_ANY
 604          || ctl->server.authenticate == A_NTLM)
 605         && strstr (capabilities, "AUTH=NTLM")) {
 606         if ((ok = do_imap_ntlm(sock, ctl)))
 607         {
 608             if(ctl->server.authenticate != A_ANY)
 609                 return ok;
 610         }
 611         else
 612             return(ok);
 613     }
 614 #else
 615     if (ctl->server.authenticate == A_NTLM)
 616     {
 617         report(stderr,
 618            GT_("Required NTLM capability not compiled into fetchmail\n"));
 619     }
 620 #endif /* NTLM_ENABLE */
 621
 622 #ifdef __UNUSED__       /* The Cyrus IMAP4rev1 server chokes on this */
 623     /* this handles either AUTH=LOGIN or AUTH-LOGIN */
 624     if ((imap_version >= IMAP4rev1) && (!strstr(capabilities, "LOGIN")))
 625     {
 626         report(stderr,
 627                GT_("Required LOGIN capability not supported by server\n"));
 628     }
 629 #endif /* __UNUSED__ */
 630
 631     /*
 632      * We're stuck with sending the password en clair.
 633      * The reason for this odd-looking logic is that some
 634      * servers return LOGINDISABLED even though login
 635      * actually works.  So arrange things in such a way that
 636      * setting auth passwd makes it ignore this capability.
 637      */
 638     if((ctl->server.authenticate==A_ANY&&!strstr(capabilities,"LOGINDISABLED"))
 639         || ctl->server.authenticate == A_PASSWORD)
 640     {
 641         /* these sizes guarantee no buffer overflow */
 642         char *remotename, *password;
 643         size_t rnl, pwl;
 644         rnl = 2 * strlen(ctl->remotename) + 1;
 645         pwl = 2 * strlen(ctl->password) + 1;
 646         remotename = (char *)xmalloc(rnl);
 647         password = (char *)xmalloc(pwl);
 648
 649         imap_canonicalize(remotename, ctl->remotename, rnl);
 650         imap_canonicalize(password, ctl->password, pwl);
 651
 652         snprintf(shroud, sizeof (shroud), "\"%s\"", password);
 653         ok = gen_transact(sock, "LOGIN \"%s\" \"%s\"", remotename, password);
 654         memset(shroud, 0x55, sizeof(shroud));
 655         shroud[0] = '\0';
 656         memset(password, 0x55, strlen(password));
 657         free(password);
 658         free(remotename);
 659         if (ok)
 660         {
 661             if(ctl->server.authenticate != A_ANY)
 662                 return ok;
 663         }
 664         else
 665             return(ok);
 666     }
 667
 668     return(ok);
 669 }
 670
 671 static int internal_expunge(int sock)
 672 /* ship an expunge, resetting associated counters */
 673 {
 674     int ok;
 675
 676     actual_deletions = 0;
 677
 678     if ((ok = gen_transact(sock, "EXPUNGE")))
 679         return(ok);
 680
 681     /* if there is a mismatch between the number of mails which should
 682      * have been expunged and the number of mails actually expunged,
 683      * another email client may be deleting mails. Quit here,
 684      * otherwise fetchmail gets out-of-sync with the imap server,
 685      * reports the wrong size to the SMTP server on MAIL FROM: and
 686      * triggers a "message ... was not the expected length" error on
 687      * every subsequent mail */
 688     if (deletions > 0 && deletions != actual_deletions)
 689     {
 690         report(stderr,
 691                 GT_("mail expunge mismatch (%d actual != %d expected)\n"),
 692                 actual_deletions, deletions);
 693         deletions = 0;
 694         return(PS_ERROR);
 695     }
 696
 697     expunged += deletions;
 698     deletions = 0;
 699
 700 #ifdef IMAP_UID /* not used */
 701     expunge_uids(ctl);
 702 #endif /* IMAP_UID */
 703
 704     return(PS_SUCCESS);
 705 }
 706
 707 static int imap_idle(int sock)
 708 /* start an RFC2177 IDLE, or fake one if unsupported */
 709 {
 710     int ok;
 711
 712     saved_timeout = mytimeout;
 713
 714     if (has_idle) {
 715         /* special timeout to terminate the IDLE and re-issue it
 716          * at least every 28 minutes:
 717          * (the server may have an inactivity timeout) */
 718         mytimeout = idle_timeout = 1680; /* 28 min */
 719         time(&idle_start_time);
 720         stage = STAGE_IDLE;
 721         /* enter IDLE mode */
 722         ok = gen_transact(sock, "IDLE");
 723
 724         if (ok == PS_IDLETIMEOUT) {
 725             /* send "DONE" continuation */
 726             SockWrite(sock, "DONE\r\n", 6);
 727             if (outlevel >= O_MONITOR)
 728                 report(stdout, "IMAP> DONE\n");
 729             /* reset stage and timeout here: we are not idling any more */
 730             mytimeout = saved_timeout;
 731             stage = STAGE_GETRANGE;
 732             /* get OK IDLE message */
 733             ok = imap_ok(sock, NULL);
 734         }
 735     } else {  /* no idle support, fake it */
 736         /* Note: stage and timeout have not been changed here as NOOP
 737          * does not idle */
 738         ok = gen_transact(sock, "NOOP");
 739
 740         /* no error, but no new mail either */
 741         if (ok == PS_SUCCESS && recentcount == 0)
 742         {
 743             /* There are some servers who do send new mail
 744              * notification out of the blue. This is in compliance
 745              * with RFC 2060 section 5.3. Wait for that with a low
 746              * timeout */
 747             mytimeout = idle_timeout = 28;
 748             time(&idle_start_time);
 749             stage = STAGE_IDLE;
 750             /* We are waiting for notification; no tag needed */
 751             tag[0] = '\0';
 752             /* wait (briefly) for an unsolicited status update */
 753             ok = imap_ok(sock, NULL);
 754             if (ok == PS_IDLETIMEOUT) {
 755                 /* no notification came; ok */
 756                 ok = PS_SUCCESS;
 757             }
 758         }
 759     }
 760
 761     /* restore normal timeout value */
 762     set_timeout(0);
 763     mytimeout = saved_timeout;
 764     stage = STAGE_GETRANGE;
 765
 766     return(ok);
 767 }
 768
 769 static int imap_search(int sock, struct query *ctl, int count)
 770 /* search for unseen messages */
 771 {
 772     int ok;
 773     char buf[MSGBUFSIZE+1], *cp;
 774
 775     /* Don't count deleted messages. Enabled only for IMAP4 servers or
 776      * higher and only when keeping mails. This flag will have an
 777      * effect only when user has marked some unread mails for deletion
 778      * using another e-mail client. */
 779     flag skipdeleted = (imap_version >= IMAP4) && ctl->keep;
 780     const char *undeleted;
 781
 782     /* structure to keep the end portion of the incomplete response */
 783     struct RecvSplit rs;
 784
 785     /* startcount is higher than count so that if there are no
 786      * unseen messages, imap_getsizes() will not need to do
 787      * anything! */
 788     startcount = count + 1;
 789
 790     for (;;)
 791     {
 792         undeleted = (skipdeleted ? " UNDELETED" : "");
 793         gen_send(sock, "SEARCH UNSEEN%s", undeleted);
 794         gen_recv_split_init("* SEARCH", &rs);
 795         while ((ok = imap_response(sock, buf, &rs)) == PS_UNTAGGED)
 796         {
 797             if ((cp = strstr(buf, "* SEARCH")))
 798             {
 799                 char    *ep;
 800
 801                 cp += 8;        /* skip "* SEARCH" */
 802                 while (*cp && unseen < count)
 803                 {
 804                     /* skip whitespace */
 805                     while (*cp && isspace((unsigned char)*cp))
 806                         cp++;
 807                     if (*cp)
 808                     {
 809                         unsigned long um;
 810
 811                         errno = 0;
 812                         um = strtoul(cp,&ep,10);
 813                         if (errno == 0 && ep > cp
 814                                 && um <= INT_MAX && um <= (unsigned)count)
 815                         {
 816                             unseen_messages[unseen++] = um;
 817                             if (outlevel >= O_DEBUG)
 818                                 report(stdout, GT_("%lu is unseen\n"), um);
 819                             if (startcount > um)
 820                                 startcount = um;
 821                         }
 822                         cp = ep;
 823                     }
 824                 }
 825             }
 826         }
 827         if (ok != PS_ERROR) /* success or non-protocol error */
 828             return(ok);
 829
 830         /* there is a protocol error. try a different search command. */
 831         if (skipdeleted)
 832         {
 833             /* retry with "SEARCH UNSEEN" */
 834             skipdeleted = FALSE;
 835             continue;
 836         }
 837         /* try with "FETCH 1:n FLAGS" */
 838         break;
 839     }
 840
 841     if (count == 1)
 842         gen_send(sock, "FETCH %d FLAGS", count);
 843     else
 844         gen_send(sock, "FETCH %d:%d FLAGS", 1, count);
 845     while ((ok = imap_response(sock, buf, NULL)) == PS_UNTAGGED)
 846     {
 847         unsigned int num;
 848         int consumed;
 849
 850         /* expected response format:
 851          * IMAP< * 1 FETCH (FLAGS (\Seen))
 852          * IMAP< * 2 FETCH (FLAGS (\Seen \Deleted))
 853          * IMAP< * 3 FETCH (FLAGS ())
 854          * IMAP< * 4 FETCH (FLAGS (\Recent))
 855          * IMAP< * 5 FETCH (UID 10 FLAGS (\Recent))
 856          */
 857         if (unseen < count
 858                 && sscanf(buf, "* %u %n", &num, &consumed) == 1
 859                 && 0 == strncasecmp(buf+consumed, "FETCH", 5)
 860                 && isspace((unsigned char)buf[consumed+5])
 861                 && num >= 1 && num <= (unsigned)count
 862                 && strstr(buf, "FLAGS ")
 863                 && !strstr(buf, "\\SEEN")
 864                 && !strstr(buf, "\\DELETED"))
 865         {
 866             unseen_messages[unseen++] = num;
 867             if (outlevel >= O_DEBUG)
 868                 report(stdout, GT_("%u is unseen\n"), num);
 869             if (startcount > num)
 870                 startcount = num;
 871         }
 872     }
 873     return(ok);
 874 }
 875
 876 static int imap_getrange(int sock,
 877                          struct query *ctl,
 878                          const char *folder,
 879                          int *countp, int *newp, int *bytes)
 880 /* get range of messages to be fetched */
 881 {
 882     int ok;
 883
 884     /* find out how many messages are waiting */
 885     *bytes = -1;
 886
 887     if (pass > 1)
 888     {
 889         /* deleted mails have already been expunged by
 890          * end_mailbox_poll().
 891          *
 892          * recentcount is already set here by the last imap command which
 893          * returned EXISTS on detecting new mail. if recentcount is 0, wait
 894          * for new mail.
 895          *
 896          * this is a while loop because imap_idle() might return on other
 897          * mailbox changes also */
 898         while (recentcount == 0 && do_idle) {
 899             smtp_close(ctl, 1);
 900             ok = imap_idle(sock);
 901             if (ok)
 902             {
 903                 report(stderr, GT_("re-poll failed\n"));
 904                 return(ok);
 905             }
 906         }
 907         /* if recentcount is 0, return no mail */
 908         if (recentcount == 0)
 909                 count = 0;
 910         if (outlevel >= O_DEBUG)
 911             report(stdout, ngettext("%d message waiting after re-poll\n",
 912                                     "%d messages waiting after re-poll\n",
 913                                     count), count);
 914     }
 915     else
 916     {
 917         oldcount = count = 0;
 918         ok = gen_transact(sock,
 919                           check_only ? "EXAMINE \"%s\"" : "SELECT \"%s\"",
 920                           folder ? folder : "INBOX");
 921         /* imap_ok returns PS_LOCKBUSY for READ-ONLY folders,
 922          * which we can safely use in fetchall keep only */
 923         if (ok == PS_LOCKBUSY && ctl->fetchall && ctl-> keep)
 924             ok = 0;
 925
 926         if (ok != 0)
 927         {
 928             report(stderr, GT_("mailbox selection failed\n"));
 929             return(ok);
 930         }
 931         else if (outlevel >= O_DEBUG)
 932             report(stdout, ngettext("%d message waiting after first poll\n",
 933                                     "%d messages waiting after first poll\n",
 934                                     count), count);
 935
 936         /*
 937          * We should have an expunge here to
 938          * a) avoid fetching deleted mails during 'fetchall'
 939          * b) getting a wrong count of mails during 'no fetchall'
 940          */
 941         if (!check_only && !ctl->keep && count > 0)
 942         {
 943             ok = internal_expunge(sock);
 944             if (ok)
 945             {
 946                 report(stderr, GT_("expunge failed\n"));
 947                 return(ok);
 948             }
 949             if (outlevel >= O_DEBUG)
 950                 report(stdout, ngettext("%d message waiting after expunge\n",
 951                                         "%d messages waiting after expunge\n",
 952                                         count), count);
 953         }
 954
 955         if (count == 0 && do_idle)
 956         {
 957             /* no messages?  then we may need to idle until we get some */
 958             while (count == 0) {
 959                 ok = imap_idle(sock);
 960                 if (ok)
 961                 {
 962                     report(stderr, GT_("re-poll failed\n"));
 963                     return(ok);
 964                 }
 965             }
 966             if (outlevel >= O_DEBUG)
 967                 report(stdout, ngettext("%d message waiting after re-poll\n",
 968                                         "%d messages waiting after re-poll\n",
 969                                         count), count);
 970         }
 971     }
 972
 973     *countp = oldcount = count;
 974     recentcount = 0;
 975     startcount = 1;
 976
 977     /* OK, now get a count of unseen messages and their indices */
 978     if (!ctl->fetchall && count > 0)
 979     {
 980         if (unseen_messages)
 981             free(unseen_messages);
 982         unseen_messages = (unsigned int *)xmalloc(count * sizeof(unsigned int));
 983         memset(unseen_messages, 0, count * sizeof(unsigned int));
 984         unseen = 0;
 985
 986         ok = imap_search(sock, ctl, count);
 987         if (ok != 0)
 988         {
 989             report(stderr, GT_("search for unseen messages failed\n"));
 990             return(ok);
 991         }
 992
 993         if (outlevel >= O_DEBUG && unseen > 0)
 994             report(stdout, GT_("%u is first unseen\n"), startcount);
 995     } else
 996         unseen = -1;
 997
 998     *newp = unseen;
 999     expunged = 0;
1000     deletions = 0;
1001
1002     return(PS_SUCCESS);
1003 }
1004
1005 static int imap_getpartialsizes(int sock, int first, int last, int *sizes)
1006 /* capture the sizes of messages #first-#last */
1007 {
1008     char buf [MSGBUFSIZE+1];
1009     int ok;
1010
1011     /*
1012      * Some servers (as in, PMDF5.1-9.1 under OpenVMS 6.1)
1013      * won't accept 1:1 as valid set syntax.  Some implementors
1014      * should be taken out and shot for excessive anality.
1015      *
1016      * Microsoft Exchange (brain-dead piece of crap that it is)
1017      * sometimes gets its knickers in a knot about bodiless messages.
1018      * You may see responses like this:
1019      *
1020      *  fetchmail: IMAP> A0004 FETCH 1:9 RFC822.SIZE
1021      *  fetchmail: IMAP< * 2 FETCH (RFC822.SIZE 1187)
1022      *  fetchmail: IMAP< * 3 FETCH (RFC822.SIZE 3954)
1023      *  fetchmail: IMAP< * 4 FETCH (RFC822.SIZE 1944)
1024      *  fetchmail: IMAP< * 5 FETCH (RFC822.SIZE 2933)
1025      *  fetchmail: IMAP< * 6 FETCH (RFC822.SIZE 1854)
1026      *  fetchmail: IMAP< * 7 FETCH (RFC822.SIZE 34054)
1027      *  fetchmail: IMAP< * 8 FETCH (RFC822.SIZE 5561)
1028      *  fetchmail: IMAP< * 9 FETCH (RFC822.SIZE 1101)
1029      *  fetchmail: IMAP< A0004 NO The requested item could not be found.
1030      *
1031      * This means message 1 has only headers.  For kicks and grins
1032      * you can telnet in and look:
1033      *  A003 FETCH 1 FULL
1034      *  A003 NO The requested item could not be found.
1035      *  A004 fetch 1 rfc822.header
1036      *  A004 NO The requested item could not be found.
1037      *  A006 FETCH 1 BODY
1038      *  * 1 FETCH (BODY ("TEXT" "PLAIN" ("CHARSET" "US-ASCII") NIL NIL "7BIT" 35 3))
1039      *  A006 OK FETCH completed.
1040      *
1041      * To get around this, we treat the final NO as success and count
1042      * on the fact that the sizes array has been preinitialized with a
1043      * known-bad size value.
1044      */
1045
1046     /* expunges change the fetch numbers */
1047     first -= expunged;
1048     last -= expunged;
1049
1050     if (last == first)
1051         gen_send(sock, "FETCH %d RFC822.SIZE", last);
1052     else if (last > first)
1053         gen_send(sock, "FETCH %d:%d RFC822.SIZE", first, last);
1054     else /* no unseen messages! */
1055         return(PS_SUCCESS);
1056     while ((ok = imap_response(sock, buf, NULL)) == PS_UNTAGGED)
1057     {
1058         unsigned int size;
1059         int num;
1060         int consumed;
1061         char *ptr;
1062
1063         /* expected response formats:
1064          * IMAP> A0005 FETCH 1 RFC822.SIZE
1065          * IMAP< * 1 FETCH (RFC822.SIZE 1187)
1066          * IMAP< * 1 FETCH (UID 16 RFC822.SIZE 1447)
1067          */
1068         if (sscanf(buf, "* %d %n", &num, &consumed) == 1
1069             && 0 == strncasecmp(buf + consumed, "FETCH", 5)
1070             && isspace((unsigned char)buf[consumed + 5])
1071                 && (ptr = strstr(buf, "RFC822.SIZE "))
1072                 && sscanf(ptr, "RFC822.SIZE %u", &size) == 1)
1073         {
1074             if (num >= first && num <= last)
1075                 sizes[num - first] = size;
1076             else
1077                 report(stderr,
1078                         GT_("Warning: ignoring bogus data for message sizes returned by the server.\n"));
1079         }
1080     }
1081     return(ok);
1082 }
1083
1084 static int imap_getsizes(int sock, int count, int *sizes)
1085 /* capture the sizes of all messages */
1086 {
1087     return imap_getpartialsizes(sock, 1, count, sizes);
1088 }
1089
1090 static int imap_is_old(int sock, struct query *ctl, int number)
1091 /* is the given message old? */
1092 {
1093     flag seen = TRUE;
1094     int i;
1095
1096     (void)sock;
1097     (void)ctl;
1098     /*
1099      * Expunges change the fetch numbers, but unseen_messages contains
1100      * indices from before any expungees were done.  So neither the
1101      * argument nor the values in message_sequence need to be decremented.
1102      */
1103
1104     seen = TRUE;
1105     for (i = 0; i < unseen; i++)
1106         if (unseen_messages[i] == (unsigned)number)
1107         {
1108             seen = FALSE;
1109             break;
1110         }
1111
1112     return(seen);
1113 }
1114
1115 #if 0
1116 static char *skip_token(char *ptr)
1117 {
1118     while(isspace((unsigned char)*ptr)) ptr++;
1119     while(!isspace((unsigned char)*ptr) && !iscntrl((unsigned char)*ptr)) ptr++;
1120     while(isspace((unsigned char)*ptr)) ptr++;
1121     return(ptr);
1122 }
1123 #endif
1124
1125 static int imap_fetch_headers(int sock, struct query *ctl,int number,int *lenp)
1126 /* request headers of nth message */
1127 {
1128     char buf [MSGBUFSIZE+1];
1129     int num;
1130     int ok;
1131     char *ptr;
1132
1133     (void)ctl;
1134     /* expunges change the fetch numbers */
1135     number -= expunged;
1136
1137     /*
1138      * This is blessed by RFC1176, RFC1730, RFC2060.
1139      * According to the RFCs, it should *not* set the \Seen flag.
1140      */
1141     gen_send(sock, "FETCH %d RFC822.HEADER", number);
1142
1143     /* looking for FETCH response */
1144     if ((ok = imap_response(sock, buf, NULL)) == PS_UNTAGGED)
1145     {
1146                 int consumed;
1147         /* expected response formats:
1148          * IMAP> A0006 FETCH 1 RFC822.HEADER
1149          * IMAP< * 1 FETCH (RFC822.HEADER {1360}
1150          * IMAP< * 1 FETCH (UID 16 RFC822.HEADER {1360}
1151          * IMAP< * 1 FETCH (UID 16 RFC822.SIZE 4029 RFC822.HEADER {1360}
1152          */
1153         if (sscanf(buf, "* %d %n", &num, &consumed) == 1
1154             && 0 == strncasecmp(buf + consumed, "FETCH", 5)
1155             && isspace((unsigned char)buf[5+consumed])
1156                 && num == number
1157                 && (ptr = strstr(buf, "RFC822.HEADER"))
1158                 && sscanf(ptr, "RFC822.HEADER {%d}%n", lenp, &consumed) == 1
1159                 && ptr[consumed-1] == '}')
1160         {
1161             return(PS_SUCCESS);
1162         }
1163
1164         /* wait for a tagged response */
1165         imap_ok (sock, 0);
1166
1167         /* try to recover for some responses */
1168         if (!strncmp(buf, "* NO", 4) ||
1169                 !strncmp(buf, "* BAD", 5) ||
1170                 strstr(buf, "FETCH ()"))
1171         {
1172             return(PS_TRANSIENT);
1173         }
1174
1175         /* a response which does not match any of the above */
1176         if (outlevel > O_SILENT)
1177             report(stderr, GT_("Incorrect FETCH response: %s.\n"), buf);
1178         return(PS_ERROR);
1179     }
1180     else if (ok == PS_SUCCESS)
1181     {
1182         /* an unexpected tagged response */
1183         if (outlevel > O_SILENT)
1184             report(stderr, GT_("Incorrect FETCH response: %s.\n"), buf);
1185         return(PS_TRANSIENT);
1186     }
1187     return(ok);
1188 }
1189
1190 static int imap_fetch_body(int sock, struct query *ctl, int number, int *lenp)
1191 /* request body of nth message */
1192 {
1193     char buf [MSGBUFSIZE+1], *cp;
1194     int num;
1195
1196     (void)ctl;
1197     /* expunges change the fetch numbers */
1198     number -= expunged;
1199
1200     /*
1201      * If we're using IMAP4, we can fetch the message without setting its
1202      * seen flag.  This is good!  It means that if the protocol exchange
1203      * craps out during the message, it will still be marked `unseen' on
1204      * the server.
1205      *
1206      * According to RFC2060, and Mark Crispin the IMAP maintainer,
1207      * FETCH %d BODY[TEXT] and RFC822.TEXT are "functionally
1208      * equivalent".  However, we know of at least one server that
1209      * treats them differently in the presence of MIME attachments;
1210      * the latter form downloads the attachment, the former does not.
1211      * The server is InterChange, and the fool who implemented this
1212      * misfeature ought to be strung up by his thumbs.
1213      *
1214      * When I tried working around this by disabling use of the 4rev1 form,
1215      * I found that doing this breaks operation with M$ Exchange.
1216      * Annoyingly enough, Exchange's refusal to cope is technically legal
1217      * under RFC2062.  Trust Microsoft, the Great Enemy of interoperability
1218      * standards, to find a way to make standards compliance irritating....
1219      */
1220     switch (imap_version)
1221     {
1222     case IMAP4rev1:     /* RFC 2060 */
1223         gen_send(sock, "FETCH %d BODY.PEEK[TEXT]", number);
1224         break;
1225
1226     case IMAP4:         /* RFC 1730 */
1227         gen_send(sock, "FETCH %d RFC822.TEXT.PEEK", number);
1228         break;
1229
1230     default:            /* RFC 1176 */
1231         gen_send(sock, "FETCH %d RFC822.TEXT", number);
1232         break;
1233     }
1234
1235     /* looking for FETCH response */
1236     do {
1237         int     ok;
1238
1239         if ((ok = gen_recv(sock, buf, sizeof(buf))))
1240             return(ok);
1241     } while
1242         (!strstr(buf+4, "FETCH") || sscanf(buf+2, "%d", &num) != 1);
1243
1244     if (num != number)
1245         return(PS_ERROR);
1246
1247     /* Understand "NIL" as length => no body present
1248      * (MS Exchange, BerliOS Bug #11980) */
1249     if (strstr(buf+10, "NIL)")) {
1250             *lenp = 0;
1251             return PS_SUCCESS;
1252     }
1253
1254     /* Understand the empty string. Seen on Yahoo. */
1255     /* XXX FIXME: we should be able to handle strings here. */
1256     if (strstr(buf+10, "\"\")")) {
1257             *lenp = 0;
1258             return PS_SUCCESS;
1259     }
1260
1261     /*
1262      * Try to extract a length from the FETCH response.  RFC2060 requires
1263      * it to be present, but at least one IMAP server (Novell GroupWise)
1264      * botches this.  The overflow check is needed because of a broken
1265      * server called dbmail that returns huge garbage lengths.
1266      */
1267     if ((cp = strchr(buf, '{'))) {
1268         long l; char *t;
1269         errno = 0;
1270         ++ cp;
1271         l = strtol(cp, &t, 10);
1272         if (errno || t == cp || (t && !strchr(t, '}')) /* parse error */
1273                     || l < 0 || l > INT_MAX /* range check */) {
1274             *lenp = -1;
1275         } else {
1276             *lenp = l;
1277         }
1278     } else {
1279         *lenp = -1;     /* missing length part in FETCH reponse */
1280     }
1281
1282     return PS_SUCCESS;
1283 }
1284
1285 static int imap_trail(int sock, struct query *ctl, const char *tag)
1286 /* discard tail of FETCH response after reading message text */
1287 {
1288     /* expunges change the fetch numbers */
1289     /* number -= expunged; */
1290
1291     (void)ctl;
1292     (void)tag;
1293
1294     return imap_ok(sock, NULL);
1295 }
1296
1297 static int imap_delete(int sock, struct query *ctl, int number)
1298 /* set delete flag for given message */
1299 {
1300     int ok;
1301     /* Select which flags to set on message deletion: */
1302     const char delflags_seen[] = "\\Seen \\Deleted";
1303     static const char *delflags;
1304     /* Which environment variable to look for: */
1305
1306     /* DEFAULT since many fetchmail versions <= 6.3.X */
1307     delflags = delflags_seen;
1308
1309     (void)ctl;
1310     /* expunges change the fetch numbers */
1311     number -= expunged;
1312
1313     /*
1314      * Use SILENT if possible as a minor throughput optimization.
1315      * Note: this has been dropped from IMAP4rev1.
1316      *
1317      * We set \Seen because there are some IMAP servers (notably HP
1318      * OpenMail and MS Exchange) do message-receipt DSNs,
1319      * but only when the seen bit gets set.
1320      * This is the appropriate time -- we get here right
1321      * after the local SMTP response that says delivery was
1322      * successful.
1323      */
1324     if ((ok = gen_transact(sock,
1325                         imap_version == IMAP4
1326                                 ? "STORE %d +FLAGS.SILENT (%s)"
1327                                 : "STORE %d +FLAGS (%s)",
1328                         number, delflags)))
1329         return(ok);
1330     else
1331         deletions++;
1332
1333     /*
1334      * We do an expunge after expunge_period messages, rather than
1335      * just before quit, so that a line hit during a long session
1336      * won't result in lots of messages being fetched again during
1337      * the next session.
1338      */
1339     if (NUM_NONZERO(expunge_period) && (deletions % expunge_period) == 0)
1340     {
1341         if ((ok = internal_expunge(sock)))
1342             return(ok);
1343     }
1344
1345     return(PS_SUCCESS);
1346 }
1347
1348 static int imap_mark_seen(int sock, struct query *ctl, int number)
1349 /* mark the given message as seen */
1350 {
1351     (void)ctl;
1352
1353     /* expunges change the message numbers */
1354     number -= expunged;
1355
1356     return(gen_transact(sock,
1357         imap_version == IMAP4
1358         ? "STORE %d +FLAGS.SILENT (\\Seen)"
1359         : "STORE %d +FLAGS (\\Seen)",
1360         number));
1361 }
1362
1363 static int imap_end_mailbox_poll(int sock, struct query *ctl)
1364 /* cleanup mailbox before we idle or switch to another one */
1365 {
1366     (void)ctl;
1367     if (deletions)
1368         internal_expunge(sock);
1369     return(PS_SUCCESS);
1370 }
1371
1372 static int imap_logout(int sock, struct query *ctl)
1373 /* send logout command */
1374 {
1375     (void)ctl;
1376     /* if any un-expunged deletions remain, ship an expunge now */
1377     if (deletions)
1378         internal_expunge(sock);
1379
1380 #ifdef USE_SEARCH
1381     /* Memory clean-up */
1382     if (unseen_messages)
1383         free(unseen_messages);
1384 #endif /* USE_SEARCH */
1385
1386     return(gen_transact(sock, "LOGOUT"));
1387 }
1388
1389 static const struct method imap =
1390 {
1391     "IMAP",             /* Internet Message Access Protocol */
1392     "imap",             /* service (plain and TLS) */
1393     "imaps",            /* service (SSL) */
1394     TRUE,               /* this is a tagged protocol */
1395     FALSE,              /* no message delimiter */
1396     imap_ok,            /* parse command response */
1397     imap_getauth,       /* get authorization */
1398     imap_getrange,      /* query range of messages */
1399     imap_getsizes,      /* get sizes of messages (used for ESMTP SIZE option) */
1400     imap_getpartialsizes,       /* get sizes of subset of messages (used for ESMTP SIZE option) */
1401     imap_is_old,        /* no UID check */
1402     imap_fetch_headers, /* request given message headers */
1403     imap_fetch_body,    /* request given message body */
1404     imap_trail,         /* eat message trailer */
1405     imap_delete,        /* delete the message */
1406     imap_mark_seen,     /* how to mark a message as seen */
1407     imap_end_mailbox_poll,      /* end-of-mailbox processing */
1408     imap_logout,        /* expunge and exit */
1409     TRUE,               /* yes, we can re-poll */
1410 };
1411
1412 int doIMAP(struct query *ctl)
1413 /* retrieve messages using IMAP Version 2bis or Version 4 */
1414 {
1415     return(do_protocol(ctl, &imap));
1416 }
1417
1418 /* imap.c ends here */