-/* Copyright 1996 by Eric S. Raymond
+/*
+ * imap.c -- IMAP2bis/IMAP4 protocol methods
+ *
+ * Copyright 1996 by Eric S. Raymond
* All rights reserved.
* For license terms, see the file COPYING in this directory.
*/
-/***********************************************************************
- module: imap.c
- project: fetchmail
- programmer: Eric S. Raymond
- description: IMAP client code
-
- ***********************************************************************/
-
#include <config.h>
#include <stdio.h>
#include <string.h>
-#include "socket.h"
+#include <ctype.h>
+#if defined(STDC_HEADERS)
+#include <stdlib.h>
+#endif
#include "fetchmail.h"
+#include "socket.h"
-/*********************************************************************
-
- Method declarations for IMAP
+extern char *strstr(); /* needed on sysV68 R3V7.1. */
- *********************************************************************/
+/* imap_version values */
+#define IMAP2 -1 /* IMAP2 or IMAP2BIS, RFC1176 */
+#define IMAP4 0 /* IMAP4 rev 0, RFC1730 */
+#define IMAP4rev1 1 /* IMAP4 rev 1, RFC2060 */
-static int count, seen;
+static int count, seen, recent, unseen, deletecount, imap_version;
-int imap_ok (socket, argbuf)
+int imap_ok (FILE *sockfp, char *argbuf)
/* parse command response */
-char *argbuf;
-int socket;
{
- int ok;
char buf [POPBUFSIZE+1];
- char *bufp;
- int n;
seen = 0;
do {
- if (SockGets(socket, buf, sizeof(buf)) < 0)
- return(PS_SOCKET);
+ int ok;
- if (outlevel == O_VERBOSE)
- fprintf(stderr,"%s\n",buf);
+ if (ok = gen_recv(sockfp, buf, sizeof(buf)))
+ return(ok);
/* interpret untagged status responses */
if (strstr(buf, "EXISTS"))
count = atoi(buf+2);
+ if (strstr(buf, "RECENT"))
+ recent = atoi(buf+2);
+ if (strstr(buf, "UNSEEN"))
+ unseen = atoi(buf+2);
if (strstr(buf, "FLAGS"))
seen = (strstr(buf, "Seen") != (char *)NULL);
} while
if (tag[0] == '\0')
{
strcpy(argbuf, buf);
- return(0);
+ return(PS_SUCCESS);
}
else
{
if (strncmp(cp, "OK", 2) == 0)
{
strcpy(argbuf, cp);
- return(0);
+ return(PS_SUCCESS);
}
else if (strncmp(cp, "BAD", 2) == 0)
return(PS_ERROR);
}
}
-int imap_getauth(socket, queryctl, buf)
+int imap_getauth(FILE *sockfp, struct query *ctl, char *buf)
/* apply for connection authorization */
-int socket;
-struct hostrec *queryctl;
-char *buf;
{
+ char rbuf [POPBUFSIZE+1];
+
/* try to get authorized */
- return(gen_transact(socket,
+ int ok = gen_transact(sockfp,
"LOGIN %s \"%s\"",
- queryctl->remotename, queryctl->password));
+ ctl->remotename, ctl->password);
+
+ if (ok)
+ return(ok);
+
+ /* probe to see if we're running IMAP4 and can use RFC822.PEEK */
+ gen_send(sockfp, "CAPABILITY");
+ if (ok = gen_recv(sockfp, rbuf, sizeof(rbuf)))
+ return(ok);
+ if (strstr(rbuf, "BAD"))
+ {
+ imap_version = IMAP2;
+ if (outlevel == O_VERBOSE)
+ error(0, 0, "Protocol identified as IMAP2 or IMAP2BIS");
+ }
+ else if (strstr(rbuf, "IMAP4rev1"))
+ {
+ imap_version = IMAP4rev1;
+ if (outlevel == O_VERBOSE)
+ error(0, 0, "Protocol identified as IMAP4 rev 1");
+ }
+ else
+ {
+ imap_version = IMAP4;
+ if (outlevel == O_VERBOSE)
+ error(0, 0, "Protocol identified as IMAP4 rev 0");
+ }
+
+ peek_capable = (imap_version >= IMAP4);
+
+ return(PS_SUCCESS);
}
-static imap_getrange(socket, queryctl, countp)
+static int imap_getrange(FILE *sockfp, struct query *ctl, int*countp, int*newp)
/* get range of messages to be fetched */
-int socket;
-struct hostrec *queryctl;
-int *countp;
{
int ok;
/* find out how many messages are waiting */
- ok = gen_transact(socket,
+ recent = unseen = 0;
+ ok = gen_transact(sockfp,
"SELECT %s",
- queryctl->mailbox[0] ? queryctl->mailbox : "INBOX");
+ ctl->mailbox ? ctl->mailbox : "INBOX");
if (ok != 0)
return(ok);
*countp = count;
- return(0);
+ if (unseen) /* optional response, but better if we see it */
+ *newp = unseen;
+ else if (recent) /* mandatory */
+ *newp = recent;
+ else
+ *newp = -1; /* should never happen, RECENT is mandatory */
+
+ deletecount = 0;
+
+ return(PS_SUCCESS);
}
-static imap_is_old(socket, queryctl, num)
-int socket;
-struct hostrec *queryctl;
-int num;
+static int imap_getsizes(FILE *sockfp, int count, int *sizes)
+/* capture the sizes of all messages */
{
char buf [POPBUFSIZE+1];
+
+ gen_send(sockfp, "FETCH 1:%d RFC822.SIZE", count);
+ while (SockGets(buf, sizeof(buf), sockfp))
+ {
+ int num, size, ok;
+
+ if (ok = gen_recv(sockfp, buf, sizeof(buf)))
+ return(ok);
+ if (strstr(buf, "OK"))
+ break;
+ else if (sscanf(buf, "* %d FETCH (RFC822.SIZE %d)", &num, &size) == 2)
+ sizes[num - 1] = size;
+ else
+ sizes[num - 1] = -1;
+ }
+
+ return(PS_SUCCESS);
+}
+
+static int imap_is_old(FILE *sockfp, struct query *ctl, int number)
+/* is the given message old? */
+{
int ok;
- if ((ok = gen_transact(socket, "FETCH %d FLAGS", num)) != 0)
- exit(PS_ERROR);
+ /* expunges change the fetch numbers */
+ number -= deletecount;
+
+ if ((ok = gen_transact(sockfp, "FETCH %d FLAGS", number)) != 0)
+ return(PS_ERROR);
return(seen);
}
-static int imap_fetch(socket, number, lenp)
+static int imap_fetch(FILE *sockfp, struct query *ctl, int number, int *lenp)
/* request nth message */
-int socket;
-int number;
-int *lenp;
{
- char buf [POPBUFSIZE+1];
+ char buf [POPBUFSIZE+1], *fetch;
int num;
- gen_send(socket, "FETCH %d RFC822", number);
+ /* expunges change the fetch numbers */
+ number -= deletecount;
+
+ /*
+ * If we're using IMAP4, we can fetch the message without setting its
+ * seen flag. This is good! It means that if the protocol exchange
+ * craps out during the message, it will still be marked `unseen' on
+ * the server.
+ *
+ * However...*don't* do this if we're using keep to suppress deletion!
+ * In that case, marking the seen flag is the only way to prevent the
+ * message from being re-fetched on subsequent runs.
+ */
+ switch (imap_version)
+ {
+ case IMAP4rev1: /* RFC 2060 */
+ if (!ctl->keep)
+ gen_send(sockfp, "FETCH %d BODY.PEEK[]", number);
+ else
+ gen_send(sockfp, "FETCH %d BODY", number);
+ break;
+
+ case IMAP4: /* RFC 1730 */
+ if (!ctl->keep)
+ gen_send(sockfp, "FETCH %d RFC822.PEEK", number);
+ else
+ gen_send(sockfp, "FETCH %d RFC822", number);
+ break;
+
+ default: /* RFC 1176 */
+ gen_send(sockfp, "FETCH %d RFC822", number);
+ break;
+ }
/* looking for FETCH response */
do {
- if (SockGets(socket, buf,sizeof(buf)) < 0)
- return(PS_SOCKET);
+ int ok;
+
+ if (ok = gen_recv(sockfp, buf, sizeof(buf)))
+ return(ok);
} while
- (sscanf(buf+2, "%d FETCH (RFC822 {%d}", &num, lenp) != 2);
+ /* third token can be "RFC822" or "BODY[]" */
+ (sscanf(buf+2, "%d FETCH (%*s {%d}", &num, lenp) != 2);
if (num != number)
return(PS_ERROR);
else
- return(0);
+ return(PS_SUCCESS);
}
-static imap_trail(socket, queryctl, number)
-/* discard tail of FETCH response */
-int socket;
-struct hostrec *queryctl;
-int number;
+static int imap_trail(FILE *sockfp, struct query *ctl, int number)
+/* discard tail of FETCH response after reading message text */
{
char buf [POPBUFSIZE+1];
- if (SockGets(socket, buf,sizeof(buf)) < 0)
- return(PS_SOCKET);
- else
- return(0);
+ /* expunges change the fetch numbers */
+ /* number -= deletecount; */
+
+ return(gen_recv(sockfp, buf, sizeof(buf)));
}
-static imap_delete(socket, queryctl, number)
+static int imap_delete(FILE *sockfp, struct query *ctl, int number)
/* set delete flag for given message */
-int socket;
-struct hostrec *queryctl;
-int number;
{
- return(gen_transact(socket, "STORE %d +FLAGS (\\Deleted)", number));
+ int ok;
+
+ /* expunges change the fetch numbers */
+ number -= deletecount;
+
+ /* use SILENT if possible as a minor throughput optimization */
+ if ((ok = gen_transact(sockfp,
+ imap_version >= IMAP4
+ ? "STORE %d +FLAGS.SILENT (\\Deleted)"
+ : "STORE %d +FLAGS (\\Deleted)",
+ number)))
+ return(ok);
+
+ /*
+ * We do an expunge after each message, rather than just before quit,
+ * so that a line hit during a long session won't result in lots of
+ * messages being fetched again during the next session.
+ */
+ if ((ok = gen_transact(sockfp, "EXPUNGE")))
+ return(ok);
+
+ deletecount++;
+
+ return(PS_SUCCESS);
}
const static struct method imap =
imap_ok, /* parse command response */
imap_getauth, /* get authorization */
imap_getrange, /* query range of messages */
+ imap_getsizes, /* grab message sizes */
imap_is_old, /* no UID check */
imap_fetch, /* request given message */
imap_trail, /* eat message trailer */
- imap_delete, /* set IMAP delete flag */
- "EXPUNGE", /* the IMAP expunge command */
+ imap_delete, /* delete the message */
"LOGOUT", /* the IMAP exit command */
};
-int doIMAP (queryctl)
+int doIMAP(struct query *ctl)
/* retrieve messages using IMAP Version 2bis or Version 4 */
-struct hostrec *queryctl;
{
- return(do_protocol(queryctl, &imap));
+ return(do_protocol(ctl, &imap));
}
-
+/* imap.c ends here */
projects / ~andy / fetchmail / blobdiff