2 * Copyright notice from original mutt:
3 * Copyright (C) 1996-8 Michael R. Elkins <me@mutt.org>
4 * Copyright (C) 1996-9 Brandon Long <blong@fiction.net>
5 * Copyright (C) 1999-2005 Brendan Cully <brendan@kublai.com>
7 * This file is part of mutt-ng, see http://www.muttng.org/.
8 * It's licensed under the GNU General Public License,
9 * please see the file GPL in the top level source directory.
12 /* Support for IMAP4rev1, with the occasional nod to IMAP 4. */
26 #include "imap_private.h"
27 #if defined(USE_SSL) || defined(USE_GNUTLS)
28 # include "mutt_ssl.h"
35 #include "lib/debug.h"
41 #include <sys/types.h>
44 /* imap forward declarations */
45 static int imap_get_delim (IMAP_DATA * idata);
46 static char *imap_get_flags (LIST ** hflags, char *s);
47 static int imap_check_acl (IMAP_DATA * idata);
48 static int imap_check_capabilities (IMAP_DATA * idata);
49 static void imap_set_flag (IMAP_DATA * idata, int aclbit, int flag,
50 const char *str, char *flags, size_t flsize);
52 /* imap_access: Check permissions on an IMAP mailbox.
53 * TODO: ACL checks. Right now we assume if it exists we can
55 int imap_access (const char *path, int flags)
59 char buf[LONG_STRING];
60 char mailbox[LONG_STRING];
61 char mbox[LONG_STRING];
63 if (imap_parse_path (path, &mx))
66 if (!(idata = imap_conn_find (&mx.account,
67 option (OPTIMAPPASSIVE) ? M_IMAP_CONN_NONEW :
73 imap_fix_path (idata, mx.mbox, mailbox, sizeof (mailbox));
75 /* we may already be in the folder we're checking */
76 if (!ascii_strcmp(idata->mailbox, mx.mbox)) {
82 imap_munge_mbox_name (mbox, sizeof (mbox), mailbox);
84 if (mutt_bit_isset (idata->capabilities, IMAP4REV1))
85 snprintf (buf, sizeof (buf), "STATUS %s (UIDVALIDITY)", mbox);
86 else if (mutt_bit_isset (idata->capabilities, STATUS))
87 snprintf (buf, sizeof (buf), "STATUS %s (UID-VALIDITY)", mbox);
89 debug_print (2, ("STATUS not supported?\n"));
93 if (imap_exec (idata, buf, IMAP_CMD_FAIL_OK) < 0) {
94 debug_print (1, ("Can't check STATUS of %s\n", mbox));
101 int imap_create_mailbox (IMAP_DATA * idata, char *mailbox)
103 char buf[LONG_STRING], mbox[LONG_STRING];
105 imap_munge_mbox_name (mbox, sizeof (mbox), mailbox);
106 snprintf (buf, sizeof (buf), "CREATE %s", mbox);
108 if (imap_exec (idata, buf, 0) != 0)
114 int imap_rename_mailbox (IMAP_DATA * idata, IMAP_MBOX * mx,
117 char oldmbox[LONG_STRING];
118 char newmbox[LONG_STRING];
119 char buf[LONG_STRING];
121 imap_munge_mbox_name (oldmbox, sizeof (oldmbox), mx->mbox);
122 imap_munge_mbox_name (newmbox, sizeof (newmbox), newname);
124 snprintf (buf, sizeof (buf), "RENAME %s %s", oldmbox, newmbox);
126 if (imap_exec (idata, buf, 0) != 0)
132 int imap_delete_mailbox (CONTEXT * ctx, IMAP_MBOX mx)
134 char buf[LONG_STRING], mbox[LONG_STRING];
137 if (!ctx || !ctx->data) {
138 if (!(idata = imap_conn_find (&mx.account,
139 option (OPTIMAPPASSIVE) ? M_IMAP_CONN_NONEW
149 imap_munge_mbox_name (mbox, sizeof (mbox), mx.mbox);
150 snprintf (buf, sizeof (buf), "DELETE %s", mbox);
152 if (imap_exec ((IMAP_DATA *) idata, buf, 0) != 0)
158 /* imap_logout_all: close all open connections. Quick and dirty until we can
159 * make sure we've got all the context we need. */
160 void imap_logout_all (void)
165 conn = mutt_socket_head ();
170 if (conn->account.type == M_ACCT_TYPE_IMAP && conn->fd >= 0) {
171 mutt_message (_("Closing connection to %s..."), conn->account.host);
172 imap_logout ((IMAP_DATA *) conn->data);
174 mutt_socket_close (conn);
175 mutt_socket_free (conn);
182 /* imap_read_literal: read bytes bytes from server into file. Not explicitly
183 * buffered, relies on FILE buffering. NOTE: strips \r from \r\n.
184 * Apparently even literals use \r\n-terminated strings ?! */
185 int imap_read_literal (FILE * fp, IMAP_DATA * idata, long bytes, progress_t* bar)
192 debug_print (2, ("reading %ld bytes\n", bytes));
194 for (pos = 0; pos < bytes; pos++) {
195 if (mutt_socket_readchar (idata->conn, &c) != 1) {
196 debug_print (1, ("error during read, %ld bytes read\n", pos));
197 idata->status = IMAP_FATAL;
203 if (r == 1 && c != '\n')
214 if (bar && !(pos % 1024))
215 mutt_progress_bar (bar, pos);
217 if (DebugLevel >= IMAP_LOG_LTRL)
218 fputc (c, DebugFile);
225 /* imap_expunge_mailbox: Purge IMAP portion of expunged messages from the
226 * context. Must not be done while something has a handle on any headers
227 * (eg inside pager or editor). That is, check IMAP_REOPEN_ALLOW. */
228 void imap_expunge_mailbox (IMAP_DATA * idata)
233 for (i = 0; i < idata->ctx->msgcount; i++) {
234 h = idata->ctx->hdrs[i];
236 if (h->index == -1) {
237 debug_print (2, ("Expunging message UID %d.\n", HEADER_DATA (h)->uid));
241 /* free cached body from disk, if neccessary */
242 cacheno = HEADER_DATA (h)->uid % IMAP_CACHE_LEN;
243 if (idata->cache[cacheno].uid == HEADER_DATA (h)->uid &&
244 idata->cache[cacheno].path) {
245 unlink (idata->cache[cacheno].path);
246 mem_free (&idata->cache[cacheno].path);
249 imap_free_header_data (&h->data);
253 /* We may be called on to expunge at any time. We can't rely on the caller
254 * to always know to rethread */
255 mx_update_tables (idata->ctx, 0);
256 mutt_sort_headers (idata->ctx, 1);
259 static int imap_get_delim (IMAP_DATA * idata)
264 /* assume that the delim is /. If this fails, we're in bigger trouble
265 * than getting the delim wrong */
268 imap_cmd_start (idata, "LIST \"\" \"\"");
271 if ((rc = imap_cmd_step (idata)) != IMAP_CMD_CONTINUE)
274 s = imap_next_word (idata->cmd.buf);
275 if (ascii_strncasecmp ("LIST", s, 4) == 0) {
276 s = imap_next_word (s);
277 s = imap_next_word (s);
278 if (s && s[0] == '\"' && s[1] && s[2] == '\"')
280 else if (s && s[0] == '\"' && s[1] && s[1] == '\\' && s[2]
285 while (rc == IMAP_CMD_CONTINUE);
287 if (rc != IMAP_CMD_OK) {
288 debug_print (1, ("failed.\n"));
292 debug_print (2, ("Delimiter: %c\n", idata->delim));
297 /* get rights for folder, let imap_handle_untagged do the rest */
298 static int imap_check_acl (IMAP_DATA * idata)
300 char buf[LONG_STRING];
301 char mbox[LONG_STRING];
303 imap_munge_mbox_name (mbox, sizeof (mbox), idata->mailbox);
304 snprintf (buf, sizeof (buf), "MYRIGHTS %s", mbox);
305 if (imap_exec (idata, buf, 0) != 0) {
306 imap_error ("imap_check_acl", buf);
312 /* imap_check_capabilities: make sure we can log in to this server. */
313 static int imap_check_capabilities (IMAP_DATA * idata)
315 if (imap_exec (idata, "CAPABILITY", 0) != 0) {
316 imap_error ("imap_check_capabilities", idata->cmd.buf);
320 if (!(mutt_bit_isset (idata->capabilities, IMAP4)
321 || mutt_bit_isset (idata->capabilities, IMAP4REV1))) {
322 mutt_error _("This IMAP server is ancient. Mutt does not work with it.");
324 mutt_sleep (2); /* pause a moment to let the user see the error */
332 /* imap_conn_find: Find an open IMAP connection matching account, or open
333 * a new one if none can be found. */
334 IMAP_DATA *imap_conn_find (const ACCOUNT * account, int flags)
341 if (!(conn = mutt_conn_find (NULL, account)))
344 /* if opening a new UNSELECTED connection, preserve existing creds */
345 creds = &(conn->account);
347 /* make sure this connection is not in SELECTED state, if neccessary */
348 if (flags & M_IMAP_CONN_NOSELECT)
349 while (conn->data && ((IMAP_DATA *) conn->data)->state == IMAP_SELECTED) {
350 if (!(conn = mutt_conn_find (conn, account)))
352 memcpy (&(conn->account), creds, sizeof (ACCOUNT));
355 idata = (IMAP_DATA *) conn->data;
357 /* don't open a new connection if one isn't wanted */
358 if (flags & M_IMAP_CONN_NONEW) {
360 mutt_socket_free (conn);
363 if (idata->state < IMAP_AUTHENTICATED)
368 /* The current connection is a new connection */
369 if (!(idata = imap_new_idata ())) {
370 mutt_socket_free (conn);
379 if (idata->state == IMAP_DISCONNECTED)
380 imap_open_connection (idata);
381 if (idata->state == IMAP_CONNECTED) {
382 if (!imap_authenticate (idata)) {
383 idata->state = IMAP_AUTHENTICATED;
384 if (idata->conn->ssf)
385 debug_print (2, ("Communication encrypted at %d bits\n", idata->conn->ssf));
388 mutt_account_unsetpass (&idata->conn->account);
390 mem_free (&idata->capstr);
392 if (new && idata->state == IMAP_AUTHENTICATED) {
393 imap_get_delim (idata);
394 if (option (OPTIMAPCHECKSUBSCRIBED)) {
395 mutt_message _("Checking mailbox subscriptions");
396 imap_exec (idata, "LSUB \"\" \"*\"", 0);
403 int imap_open_connection (IMAP_DATA * idata)
405 char buf[LONG_STRING];
407 if (mutt_socket_open (idata->conn) < 0)
410 idata->state = IMAP_CONNECTED;
412 if (imap_cmd_step (idata) != IMAP_CMD_CONTINUE) {
413 mutt_socket_close (idata->conn);
414 idata->state = IMAP_DISCONNECTED;
418 if (ascii_strncasecmp ("* OK", idata->cmd.buf, 4) == 0) {
419 /* TODO: Parse new tagged CAPABILITY data (* OK [CAPABILITY...]) */
420 if (imap_check_capabilities (idata))
422 #if defined(USE_SSL) || defined(USE_GNUTLS)
423 /* Attempt STARTTLS if available and desired. */
424 if (!idata->conn->ssf && (option(OPTSSLFORCETLS) ||
425 mutt_bit_isset (idata->capabilities, STARTTLS))) {
428 if (option (OPTSSLFORCETLS))
430 else if ((rc = query_quadoption (OPT_SSLSTARTTLS,
431 _("Secure connection with TLS?"))) == -1)
434 if ((rc = imap_exec (idata, "STARTTLS", IMAP_CMD_FAIL_OK)) == -1)
437 #if defined (USE_SSL) || defined (USE_GNUTLS)
438 if (mutt_ssl_starttls (idata->conn))
441 mutt_error (_("Could not negotiate TLS connection"));
446 /* RFC 2595 demands we recheck CAPABILITY after TLS completes. */
447 if (imap_exec (idata, "CAPABILITY", 0))
454 if (option(OPTSSLFORCETLS) && ! idata->conn->ssf) {
455 mutt_error _("Encrypted connection unavailable");
461 else if (ascii_strncasecmp ("* PREAUTH", idata->cmd.buf, 9) == 0) {
462 idata->state = IMAP_AUTHENTICATED;
463 if (imap_check_capabilities (idata) != 0)
465 mem_free (&idata->capstr);
468 imap_error ("imap_open_connection()", buf);
475 mutt_socket_close (idata->conn);
476 idata->state = IMAP_DISCONNECTED;
478 mem_free (&idata->capstr);
482 /* imap_get_flags: Make a simple list out of a FLAGS response.
483 * return stream following FLAGS response */
484 static char *imap_get_flags (LIST ** hflags, char *s)
490 /* sanity-check string */
491 if (ascii_strncasecmp ("FLAGS", s, 5) != 0) {
492 debug_print (1, ("not a FLAGS response: %s\n", s));
498 debug_print (1, ("bogus FLAGS response: %s\n", s));
502 /* create list, update caller's flags handle */
503 flags = mutt_new_list ();
506 while (*s && *s != ')') {
510 while (*s && (*s != ')') && !ISSPACE (*s))
515 mutt_add_list (flags, flag_word);
519 /* note bad flags response */
521 debug_print (1, ("Unterminated FLAGS response: %s\n", s));
522 mutt_free_list (hflags);
532 int imap_open_mailbox (CONTEXT * ctx)
536 char buf[LONG_STRING];
537 char bufout[LONG_STRING];
542 if (imap_parse_path (ctx->path, &mx)) {
543 mutt_error (_("%s is an invalid IMAP path"), ctx->path);
547 /* we require a connection which isn't currently in IMAP_SELECTED state */
548 if (!(idata = imap_conn_find (&(mx.account), M_IMAP_CONN_NOSELECT)))
550 if (idata->state < IMAP_AUTHENTICATED)
555 /* once again the context is new */
558 /* Clean up path and replace the one in the ctx */
559 imap_fix_path (idata, mx.mbox, buf, sizeof (buf));
560 mem_free (&(idata->mailbox));
561 idata->mailbox = str_dup (buf);
562 imap_qualify_path (buf, sizeof (buf), &mx, idata->mailbox);
564 mem_free (&(ctx->path));
565 ctx->path = str_dup (buf);
569 /* clear mailbox status */
571 memset (idata->rights, 0, (RIGHTSMAX + 7) / 8);
572 idata->newMailCount = 0;
574 mutt_message (_("Selecting %s..."), idata->mailbox);
575 imap_munge_mbox_name (buf, sizeof (buf), idata->mailbox);
576 snprintf (bufout, sizeof (bufout), "%s %s",
577 ctx->readonly ? "EXAMINE" : "SELECT", buf);
579 idata->state = IMAP_SELECTED;
581 imap_cmd_start (idata, bufout);
586 if ((rc = imap_cmd_step (idata)) != IMAP_CMD_CONTINUE)
589 pc = idata->cmd.buf + 2;
591 /* Obtain list of available flags here, may be overridden by a
592 * PERMANENTFLAGS tag in the OK response */
593 if (ascii_strncasecmp ("FLAGS", pc, 5) == 0) {
594 /* don't override PERMANENTFLAGS */
596 debug_print (2, ("Getting mailbox FLAGS\n"));
597 if ((pc = imap_get_flags (&(idata->flags), pc)) == NULL)
601 /* PERMANENTFLAGS are massaged to look like FLAGS, then override FLAGS */
602 else if (ascii_strncasecmp ("OK [PERMANENTFLAGS", pc, 18) == 0) {
603 debug_print (2, ("Getting mailbox PERMANENTFLAGS\n"));
604 /* safe to call on NULL */
605 mutt_free_list (&(idata->flags));
606 /* skip "OK [PERMANENT" so syntax is the same as FLAGS */
608 if ((pc = imap_get_flags (&(idata->flags), pc)) == NULL)
612 /* save UIDVALIDITY for the header cache */
613 else if (ascii_strncasecmp ("OK [UIDVALIDITY", pc, 14) == 0) {
614 debug_print (2, ("Getting mailbox UIDVALIDITY\n"));
616 pc = imap_next_word (pc);
618 sscanf (pc, "%lu", &(idata->uid_validity));
622 pc = imap_next_word (pc);
623 if (!ascii_strncasecmp ("EXISTS", pc, 6)) {
624 count = idata->newMailCount;
625 idata->newMailCount = 0;
629 while (rc == IMAP_CMD_CONTINUE);
631 if (rc == IMAP_CMD_NO) {
634 s = imap_next_word (idata->cmd.buf); /* skip seq */
635 s = imap_next_word (s); /* Skip response */
636 mutt_error ("%s", s);
641 if (rc != IMAP_CMD_OK)
644 /* check for READ-ONLY notification */
645 if (!ascii_strncasecmp
646 (imap_get_qualifier (idata->cmd.buf), "[READ-ONLY]", 11)
647 && !mutt_bit_isset (idata->capabilities, ACL)) {
648 debug_print (2, ("Mailbox is read-only.\n"));
653 /* dump the mailbox flags we've found */
654 if (DebugLevel > 2) {
656 debug_print (3, ("No folder flags found\n"));
658 LIST *t = idata->flags;
660 debug_print (3, ("Mailbox flags:\n"));
664 debug_print (3, ("[%s]\n", t->data));
671 if (mutt_bit_isset (idata->capabilities, ACL)) {
672 if (imap_check_acl (idata))
674 if (!(mutt_bit_isset (idata->rights, ACL_DELETE) ||
675 mutt_bit_isset (idata->rights, ACL_SEEN) ||
676 mutt_bit_isset (idata->rights, ACL_WRITE) ||
677 mutt_bit_isset (idata->rights, ACL_INSERT)))
680 /* assume we have all rights if ACL is unavailable */
682 mutt_bit_set (idata->rights, ACL_LOOKUP);
683 mutt_bit_set (idata->rights, ACL_READ);
684 mutt_bit_set (idata->rights, ACL_SEEN);
685 mutt_bit_set (idata->rights, ACL_WRITE);
686 mutt_bit_set (idata->rights, ACL_INSERT);
687 mutt_bit_set (idata->rights, ACL_POST);
688 mutt_bit_set (idata->rights, ACL_CREATE);
689 mutt_bit_set (idata->rights, ACL_DELETE);
693 ctx->hdrs = mem_calloc (count, sizeof (HEADER *));
694 ctx->v2r = mem_calloc (count, sizeof (int));
696 if (count && (imap_read_headers (idata, 0, count - 1) < 0)) {
697 mutt_error _("Error opening mailbox");
703 debug_print (2, ("msgcount is %d\n", ctx->msgcount));
708 if (idata->state == IMAP_SELECTED)
709 idata->state = IMAP_AUTHENTICATED;
715 int imap_open_mailbox_append (CONTEXT * ctx)
719 char buf[LONG_STRING];
720 char mailbox[LONG_STRING];
723 if (imap_parse_path (ctx->path, &mx))
726 /* in APPEND mode, we appear to hijack an existing IMAP connection -
727 * ctx is brand new and mostly empty */
729 if (!(idata = imap_conn_find (&(mx.account), 0))) {
738 imap_fix_path (idata, mx.mbox, mailbox, sizeof (mailbox));
742 /* really we should also check for W_OK */
743 if (!imap_access (ctx->path, F_OK))
746 snprintf (buf, sizeof (buf), _("Create %s?"), mailbox);
747 if (option (OPTCONFIRMCREATE) && mutt_yesorno (buf, 1) < 1)
750 if (imap_create_mailbox (idata, mailbox) < 0)
756 /* imap_logout: Gracefully log out of server. */
757 void imap_logout (IMAP_DATA * idata)
759 /* we set status here to let imap_handle_untagged know we _expect_ to
760 * receive a bye response (so it doesn't freak out and close the conn) */
761 idata->status = IMAP_BYE;
762 imap_cmd_start (idata, "LOGOUT");
763 while (imap_cmd_step (idata) == IMAP_CMD_CONTINUE);
764 mem_free (&idata->cmd.buf);
769 int imap_close_connection (CONTEXT *ctx)
771 debug_print (1, (debugfile, "imap_close_connection(): closing connection\n"));
772 if (CTX_DATA->status != IMAP_BYE)
774 mutt_message _("Closing connection to IMAP server...");
775 imap_logout (CTX_DATA);
778 mutt_socket_close (CTX_DATA->conn);
779 CTX_DATA->state = IMAP_DISCONNECTED;
780 CTX_DATA->conn->data = NULL;
785 /* imap_set_flag: append str to flags if we currently have permission
786 * according to aclbit */
787 static void imap_set_flag (IMAP_DATA * idata, int aclbit, int flag,
788 const char *str, char *flags, size_t flsize)
790 if (mutt_bit_isset (idata->rights, aclbit))
792 str_cat (flags, flsize, str);
795 /* imap_make_msg_set: make an IMAP4rev1 UID message set out of a set of
796 * headers, given a flag enum to filter on.
797 * Params: idata: IMAP_DATA containing context containing header set
798 * buf: to write message set into
799 * buflen: length of buffer
800 * flag: enum of flag type on which to filter
801 * changed: include only changed messages in message set
802 * Returns: number of messages in message set (0 if no matches) */
803 int imap_make_msg_set (IMAP_DATA * idata, BUFFER * buf, int flag, int changed)
805 HEADER **hdrs; /* sorted local copy */
806 int count = 0; /* number of messages in message set */
807 int match = 0; /* whether current message matches flag condition */
808 unsigned int setstart = 0; /* start of current message range */
810 short oldsort; /* we clobber reverse, must restore it */
812 /* assuming 32-bit UIDs */
816 /* make copy of header pointers to sort in natural order */
817 hdrs = mem_calloc (idata->ctx->msgcount, sizeof (HEADER *));
818 memcpy (hdrs, idata->ctx->hdrs, idata->ctx->msgcount * sizeof (HEADER *));
820 if (Sort != SORT_ORDER) {
823 qsort ((void *) hdrs, idata->ctx->msgcount, sizeof (HEADER *),
824 mutt_get_sort_func (SORT_ORDER));
828 for (n = 0; n < idata->ctx->msgcount; n++) {
830 /* don't include pending expunged messages */
834 if (hdrs[n]->deleted)
843 if (match && (!changed || hdrs[n]->changed)) {
846 setstart = HEADER_DATA (hdrs[n])->uid;
848 snprintf (uid, sizeof (uid), "%u", HEADER_DATA (hdrs[n])->uid);
849 mutt_buffer_addstr (buf, uid);
853 snprintf (uid, sizeof (uid), ",%u", HEADER_DATA (hdrs[n])->uid);
854 mutt_buffer_addstr (buf, uid);
857 /* tie up if the last message also matches */
858 else if (n == idata->ctx->msgcount - 1) {
859 snprintf (uid, sizeof (uid), ":%u", HEADER_DATA (hdrs[n])->uid);
860 mutt_buffer_addstr (buf, uid);
863 /* this message is not expunged and doesn't match. End current set. */
864 else if (setstart && hdrs[n]->active) {
865 if (HEADER_DATA (hdrs[n - 1])->uid > setstart) {
866 snprintf (uid, sizeof (uid), ":%u", HEADER_DATA (hdrs[n - 1])->uid);
867 mutt_buffer_addstr (buf, uid);
878 /* Update the IMAP server to reflect the flags a single message. */
880 int imap_sync_message (IMAP_DATA *idata, HEADER *hdr, BUFFER *cmd,
883 char flags[LONG_STRING];
888 snprintf (uid, sizeof (uid), "%u", HEADER_DATA(hdr)->uid);
889 cmd->dptr = cmd->data;
890 mutt_buffer_addstr (cmd, "UID STORE ");
891 mutt_buffer_addstr (cmd, uid);
895 imap_set_flag (idata, ACL_SEEN, hdr->read, "\\Seen ",
896 flags, sizeof (flags));
897 imap_set_flag (idata, ACL_WRITE, hdr->flagged,
898 "\\Flagged ", flags, sizeof (flags));
899 imap_set_flag (idata, ACL_WRITE, hdr->replied,
900 "\\Answered ", flags, sizeof (flags));
901 imap_set_flag (idata, ACL_DELETE, hdr->deleted,
902 "\\Deleted ", flags, sizeof (flags));
904 /* now make sure we don't lose custom tags */
905 if (mutt_bit_isset (idata->rights, ACL_WRITE))
906 imap_add_keywords (flags, hdr, idata->flags, sizeof (flags));
908 str_skip_trailws (flags);
910 /* UW-IMAP is OK with null flags, Cyrus isn't. The only solution is to
911 * explicitly revoke all system flags (if we have permission) */
914 imap_set_flag (idata, ACL_SEEN, 1, "\\Seen ", flags, sizeof (flags));
915 imap_set_flag (idata, ACL_WRITE, 1, "\\Flagged ", flags, sizeof (flags));
916 imap_set_flag (idata, ACL_WRITE, 1, "\\Answered ", flags, sizeof (flags));
917 imap_set_flag (idata, ACL_DELETE, 1, "\\Deleted ", flags, sizeof (flags));
919 str_skip_trailws (flags);
921 mutt_buffer_addstr (cmd, " -FLAGS.SILENT (");
923 mutt_buffer_addstr (cmd, " FLAGS.SILENT (");
925 mutt_buffer_addstr (cmd, flags);
926 mutt_buffer_addstr (cmd, ")");
928 /* dumb hack for bad UW-IMAP 4.7 servers spurious FLAGS updates */
931 /* after all this it's still possible to have no flags, if you
932 * have no ACL rights */
933 if (*flags && (imap_exec (idata, cmd->data, 0) != 0) &&
934 err_continue && (*err_continue != M_YES))
936 *err_continue = imap_continue ("imap_sync_message: STORE failed",
938 if (*err_continue != M_YES)
943 idata->ctx->changed--;
948 /* update the IMAP server to reflect message changes done within mutt.
950 * ctx: the current context
951 * expunge: 0 or 1 - do expunge?
954 int imap_sync_mailbox (CONTEXT * ctx, int expunge, int *index_hint)
957 CONTEXT *appendctx = NULL;
961 int err_continue = M_NO; /* continue on error? */
964 idata = (IMAP_DATA *) ctx->data;
966 if (idata->state != IMAP_SELECTED) {
967 debug_print (2, ("no mailbox selected\n"));
971 /* This function is only called when the calling code expects the context
973 imap_allow_reopen (ctx);
975 if ((rc = imap_check_mailbox (ctx, index_hint, 0)) != 0)
978 memset (&cmd, 0, sizeof (cmd));
980 /* if we are expunging anyway, we can do deleted messages very quickly... */
981 if (expunge && mutt_bit_isset (idata->rights, ACL_DELETE)) {
982 mutt_buffer_addstr (&cmd, "UID STORE ");
983 deleted = imap_make_msg_set (idata, &cmd, M_DELETE, 1);
985 /* if we have a message set, then let's delete */
987 mutt_message (_("Marking %d messages deleted..."), deleted);
988 mutt_buffer_addstr (&cmd, " +FLAGS.SILENT (\\Deleted)");
989 /* mark these messages as unchanged so second pass ignores them. Done
990 * here so BOGUS UW-IMAP 4.7 SILENT FLAGS updates are ignored. */
991 for (n = 0; n < ctx->msgcount; n++)
992 if (ctx->hdrs[n]->deleted && ctx->hdrs[n]->changed)
993 ctx->hdrs[n]->active = 0;
994 if (imap_exec (idata, cmd.data, 0) != 0) {
995 mutt_error (_("Expunge failed"));
1003 /* save status changes */
1004 for (n = 0; n < ctx->msgcount; n++) {
1005 if (ctx->hdrs[n]->active && ctx->hdrs[n]->changed) {
1007 mutt_message (_("Saving message status flags... [%d/%d]"), n + 1,
1010 /* if the message has been rethreaded or attachments have been deleted
1011 * we delete the message and reupload it.
1012 * This works better if we're expunging, of course. */
1013 if ((ctx->hdrs[n]->env && (ctx->hdrs[n]->env->refs_changed || ctx->hdrs[n]->env->irt_changed)) ||
1014 ctx->hdrs[n]->attach_del) {
1015 debug_print (3, ("Attachments to be deleted, falling back to _mutt_save_message\n"));
1017 appendctx = mx_open_mailbox (ctx->path, M_APPEND | M_QUIET, NULL);
1019 debug_print (1, ("Error opening mailbox in append mode\n"));
1022 _mutt_save_message (ctx->hdrs[n], appendctx, 1, 0, 0);
1025 if (imap_sync_message (idata, ctx->hdrs[n], &cmd, &err_continue) < 0) {
1033 /* We must send an EXPUNGE command if we're not closing. */
1034 if (expunge && !(ctx->closing) &&
1035 mutt_bit_isset (idata->rights, ACL_DELETE)) {
1036 mutt_message _("Expunging messages from server...");
1038 /* Set expunge bit so we don't get spurious reopened messages */
1039 idata->reopen |= IMAP_EXPUNGE_EXPECTED;
1040 if (imap_exec (idata, "EXPUNGE", 0) != 0) {
1041 imap_error (_("imap_sync_mailbox: EXPUNGE failed"), idata->cmd.buf);
1042 rc = imap_reconnect (ctx);
1047 if (expunge && ctx->closing) {
1048 if (imap_exec (idata, "CLOSE", 0))
1049 mutt_error (_("CLOSE failed"));
1050 idata->state = IMAP_AUTHENTICATED;
1056 mem_free (&cmd.data);
1058 mx_fastclose_mailbox (appendctx);
1059 mem_free (&appendctx);
1064 /* imap_close_mailbox: clean up IMAP data in CONTEXT */
1065 void imap_close_mailbox (CONTEXT * ctx)
1070 idata = (IMAP_DATA *) ctx->data;
1071 /* Check to see if the mailbox is actually open */
1075 if (ctx == idata->ctx) {
1076 if (idata->state != IMAP_FATAL && idata->state == IMAP_SELECTED) {
1077 /* mx_close_mailbox won't sync if there are no deleted messages
1078 * and the mailbox is unchanged, so we may have to close here */
1079 if (!ctx->deleted && imap_exec (idata, "CLOSE", 0))
1080 mutt_error (_("CLOSE failed"));
1081 idata->state = IMAP_AUTHENTICATED;
1084 idata->reopen &= IMAP_REOPEN_ALLOW;
1085 mem_free (&(idata->mailbox));
1086 mutt_free_list (&idata->flags);
1090 /* free IMAP part of headers */
1091 for (i = 0; i < ctx->msgcount; i++)
1092 imap_free_header_data (&(ctx->hdrs[i]->data));
1094 for (i = 0; i < IMAP_CACHE_LEN; i++) {
1095 if (idata->cache[i].path) {
1096 unlink (idata->cache[i].path);
1097 mem_free (&idata->cache[i].path);
1102 /* use the NOOP command to poll for new mail
1105 * M_REOPENED mailbox has been externally modified
1106 * M_NEW_MAIL new mail has arrived!
1110 int imap_check_mailbox (CONTEXT * ctx, int *index_hint, int force)
1112 /* overload keyboard timeout to avoid many mailbox checks in a row.
1113 * Most users don't like having to wait exactly when they press a key. */
1117 idata = (IMAP_DATA *) ctx->data;
1119 if ((force || time (NULL) >= idata->lastread + Timeout)
1120 && imap_exec (idata, "NOOP", 0) != 0)
1123 /* We call this even when we haven't run NOOP in case we have pending
1124 * changes to process, since we can reopen here. */
1125 imap_cmd_finish (idata);
1127 if (idata->check_status & IMAP_EXPUNGE_PENDING)
1128 result = M_REOPENED;
1129 else if (idata->check_status & IMAP_NEWMAIL_PENDING)
1130 result = M_NEW_MAIL;
1131 else if (idata->check_status & IMAP_FLAGS_PENDING)
1134 idata->check_status = 0;
1139 /* returns count of recent messages if new = 1, else count of total messages.
1140 * (useful for at least postponed function)
1141 * Question of taste: use RECENT or UNSEEN for new?
1142 * 0+ number of messages in mailbox
1143 * -1 error while polling mailboxes
1145 int imap_mailbox_check (char *path, int new)
1149 char buf[LONG_STRING];
1150 char mbox[LONG_STRING];
1151 char mbox_unquoted[LONG_STRING];
1158 if (imap_parse_path (path, &mx))
1161 /* If imap_passive is set, don't open a connection to check for new mail */
1162 if (option (OPTIMAPPASSIVE))
1163 connflags = M_IMAP_CONN_NONEW;
1165 if (!(idata = imap_conn_find (&(mx.account), connflags))) {
1166 mem_free (&mx.mbox);
1171 imap_fix_path (idata, mx.mbox, buf, sizeof (buf));
1172 mem_free (&mx.mbox);
1174 imap_munge_mbox_name (mbox, sizeof (mbox), buf);
1175 strfcpy (mbox_unquoted, buf, sizeof (mbox_unquoted));
1177 /* The draft IMAP implementor's guide warns againts using the STATUS
1178 * command on a mailbox that you have selected
1181 if (str_cmp (mbox_unquoted, idata->mailbox) == 0
1182 || (ascii_strcasecmp (mbox_unquoted, "INBOX") == 0
1183 && str_casecmp (mbox_unquoted, idata->mailbox) == 0)) {
1184 strfcpy (buf, "NOOP", sizeof (buf));
1186 else if (mutt_bit_isset (idata->capabilities, IMAP4REV1) ||
1187 mutt_bit_isset (idata->capabilities, STATUS)) {
1188 snprintf (buf, sizeof (buf), "STATUS %s (%s)", mbox,
1189 new ? "RECENT" : "MESSAGES");
1192 /* Server does not support STATUS, and this is not the current mailbox.
1193 * There is no lightweight way to check recent arrivals */
1196 imap_cmd_start (idata, buf);
1199 if ((rc = imap_cmd_step (idata)) != IMAP_CMD_CONTINUE)
1202 s = imap_next_word (idata->cmd.buf);
1203 if (ascii_strncasecmp ("STATUS", s, 6) == 0) {
1204 s = imap_next_word (s);
1205 /* The mailbox name may or may not be quoted here. We could try to
1206 * munge the server response and compare with quoted (or vise versa)
1207 * but it is probably more efficient to just strncmp against both. */
1208 if (str_ncmp (mbox_unquoted, s, str_len (mbox_unquoted)) == 0
1209 || str_ncmp (mbox, s, str_len (mbox)) == 0) {
1210 s = imap_next_word (s);
1211 s = imap_next_word (s);
1212 if (isdigit ((unsigned char) *s)) {
1214 msgcount = atoi (s);
1215 debug_print (2, ("%d new messages in %s\n", msgcount, path));
1220 debug_print (1, ("STATUS response doesn't match requested mailbox.\n"));
1223 while (rc == IMAP_CMD_CONTINUE);
1228 /* returns number of patterns in the search that should be done server-side
1229 * (eg are full-text) */
1230 static int do_search (const pattern_t* search, int allpats)
1233 const pattern_t* pat;
1235 for (pat = search; pat; pat = pat->next) {
1240 if (pat->stringmatch)
1244 if (pat->child && do_search (pat->child, 1))
1255 /* convert mutt pattern_t to IMAP SEARCH command containing only elements
1256 * that require full-text search (mutt already has what it needs for most
1257 * match types, and does a better job (eg server doesn't support regexps). */
1258 static int imap_compile_search (const pattern_t* pat, BUFFER* buf)
1262 if (! do_search (pat, 0))
1266 mutt_buffer_addstr (buf, "NOT ");
1271 if ((clauses = do_search (pat->child, 1)) > 0) {
1272 const pattern_t* clause = pat->child;
1274 mutt_buffer_addch (buf, '(');
1277 if (do_search (clause, 0)) {
1278 if (pat->op == M_OR && clauses > 1)
1279 mutt_buffer_addstr (buf, "OR ");
1281 if (imap_compile_search (clause, buf) < 0)
1285 mutt_buffer_addch (buf, ' ');
1287 clause = clause->next;
1291 mutt_buffer_addch (buf, ')');
1298 mutt_buffer_addstr (buf, "HEADER ");
1300 /* extract header name */
1301 if (! (delim = strchr (pat->str, ':'))) {
1302 mutt_error (_("Header search without header name: %s"), pat->str);
1306 imap_quote_string (term, sizeof (term), pat->str);
1307 mutt_buffer_addstr (buf, term);
1308 mutt_buffer_addch (buf, ' ');
1314 imap_quote_string (term, sizeof (term), delim);
1315 mutt_buffer_addstr (buf, term);
1319 mutt_buffer_addstr (buf, "BODY ");
1320 imap_quote_string (term, sizeof (term), pat->str);
1321 mutt_buffer_addstr (buf, term);
1325 mutt_buffer_addstr (buf, "TEXT ");
1326 imap_quote_string (term, sizeof (term), pat->str);
1327 mutt_buffer_addstr (buf, term);
1335 int imap_search (CONTEXT* ctx, const pattern_t* pat) {
1337 IMAP_DATA* idata = (IMAP_DATA*)ctx->data;
1340 for (i = 0; i < ctx->msgcount; i++)
1341 ctx->hdrs[i]->matched = 0;
1343 if (!do_search (pat, 1))
1346 memset (&buf, 0, sizeof (buf));
1347 mutt_buffer_addstr (&buf, "UID SEARCH ");
1348 if (imap_compile_search (pat, &buf) < 0) {
1349 mem_free (&buf.data);
1352 if (imap_exec (idata, buf.data, 0) < 0) {
1353 mem_free (&buf.data);
1357 mem_free (&buf.data);
1361 /* all this listing/browsing is a mess. I don't like that name is a pointer
1362 * into idata->buf (used to be a pointer into the passed in buffer, just
1363 * as bad), nor do I like the fact that the fetch is done here. This
1364 * code can't possibly handle non-LIST untagged responses properly.
1366 int imap_parse_list_response (IMAP_DATA * idata, char **name, int *noselect,
1367 int *noinferiors, char *delim)
1375 rc = imap_cmd_step (idata);
1376 if (rc == IMAP_CMD_OK)
1378 if (rc != IMAP_CMD_CONTINUE)
1381 s = imap_next_word (idata->cmd.buf);
1382 if ((ascii_strncasecmp ("LIST", s, 4) == 0) ||
1383 (ascii_strncasecmp ("LSUB", s, 4) == 0)) {
1387 s = imap_next_word (s); /* flags */
1393 while (*ep && *ep != ')')
1396 if (!ascii_strncasecmp (s, "\\NoSelect", 9))
1398 if (!ascii_strncasecmp (s, "\\NoInferiors", 12))
1400 /* See draft-gahrns-imap-child-mailbox-?? */
1401 if (!ascii_strncasecmp (s, "\\HasNoChildren", 14))
1405 while (*s && *s != '\\' && *s != ')')
1411 s = imap_next_word (s); /* delim */
1412 /* Reset the delimiter, this can change */
1413 if (ascii_strncasecmp (s, "NIL", 3)) {
1414 if (s && s[0] == '\"' && s[1] && s[2] == '\"')
1416 else if (s && s[0] == '\"' && s[1] && s[1] == '\\' && s[2]
1420 s = imap_next_word (s); /* name */
1421 if (s && *s == '{') { /* Literal */
1422 if (imap_get_literal_count (idata->cmd.buf, &bytes) < 0)
1424 if (imap_cmd_step (idata) != IMAP_CMD_CONTINUE)
1426 *name = idata->cmd.buf;
1435 int imap_subscribe (char *path, int subscribe)
1439 char buf[LONG_STRING];
1440 char mbox[LONG_STRING];
1441 char errstr[STRING];
1445 if (mx_get_magic (path) == M_IMAP || imap_parse_path (path, &mx)) {
1446 mutt_error (_("Bad mailbox name"));
1450 if (!(idata = imap_conn_find (&(mx.account), 0)))
1455 imap_fix_path (idata, mx.mbox, buf, sizeof (buf));
1457 if (option (OPTIMAPCHECKSUBSCRIBED)) {
1458 memset (&token, 0, sizeof (token));
1460 err.dsize = sizeof (errstr);
1461 snprintf (mbox, sizeof (mbox), "%smailboxes \"%s\"",
1462 subscribe ? "" : "un", path);
1463 if (mutt_parse_rc_line (mbox, &token, &err))
1464 debug_print (1, ("Error adding subscribed mailbox: %s\n", errstr));
1465 mem_free (&token.data);
1469 mutt_message (_("Subscribing to %s..."), buf);
1471 mutt_message (_("Unsubscribing to %s..."), buf);
1472 imap_munge_mbox_name (mbox, sizeof (mbox), buf);
1474 snprintf (buf, sizeof (buf), "%sSUBSCRIBE %s", subscribe ? "" : "UN", mbox);
1476 if (imap_exec (idata, buf, 0) < 0)
1479 mem_free (&mx.mbox);
1483 mem_free (&mx.mbox);
1487 /* trim dest to the length of the longest prefix it shares with src,
1488 * returning the length of the trimmed string */
1489 static int longest_common_prefix (char *dest, const char* src,
1490 int start, size_t dlen) {
1493 while (pos < dlen && dest[pos] && dest[pos] == src[pos])
1500 /* look for IMAP URLs to complete from defined mailboxes. Could be extended
1501 * to complete over open connections and account/folder hooks too. */
1502 static int imap_complete_hosts (char *dest, size_t len) {
1509 matchlen = str_len (dest);
1510 if (list_empty (Incoming))
1512 for (i = 0; i < Incoming->length; i++) {
1513 mailbox = (BUFFY*) Incoming->data[i];
1514 if (!str_ncmp (dest, mailbox->path, matchlen)) {
1516 strfcpy (dest, mailbox->path, len);
1519 longest_common_prefix (dest, mailbox->path, matchlen, len);
1523 for (conn = mutt_socket_head (); conn->next; conn = conn->next) {
1525 char urlstr[LONG_STRING];
1527 if (conn->account.type != M_ACCT_TYPE_IMAP)
1530 mutt_account_tourl (&conn->account, &url);
1531 /* FIXME: how to handle multiple users on the same host? */
1534 url_ciss_tostring (&url, urlstr, sizeof (urlstr), 0);
1535 if (!str_ncmp (dest, urlstr, matchlen)) {
1537 strfcpy (dest, urlstr, len);
1540 longest_common_prefix (dest, urlstr, matchlen, len);
1547 /* imap_complete: given a partial IMAP folder path, return a string which
1548 * adds as much to the path as is unique */
1549 int imap_complete (char *dest, size_t dlen, char *path) {
1552 char list[LONG_STRING];
1553 char buf[LONG_STRING];
1554 char *list_word = NULL;
1555 int noselect, noinferiors;
1557 char completion[LONG_STRING];
1558 int clen, matchlen = 0;
1559 int completions = 0;
1562 if (imap_parse_path (path, &mx) || !mx.mbox) {
1563 strfcpy (dest, path, dlen);
1564 return imap_complete_hosts (dest, dlen);
1567 /* don't open a new socket just for completion. Instead complete over
1568 * known mailboxes/hooks/etc */
1569 if (!(idata = imap_conn_find (&(mx.account), M_IMAP_CONN_NONEW))) {
1570 mem_free (&mx.mbox);
1571 strfcpy (dest, path, dlen);
1572 return imap_complete_hosts (dest, dlen);
1576 /* reformat path for IMAP list, and append wildcard */
1577 /* don't use INBOX in place of "" */
1578 if (mx.mbox && mx.mbox[0])
1579 imap_fix_path (idata, mx.mbox, list, sizeof (list));
1583 /* fire off command */
1584 snprintf (buf, sizeof (buf), "%s \"\" \"%s%%\"",
1585 option (OPTIMAPLSUB) ? "LSUB" : "LIST", list);
1587 imap_cmd_start (idata, buf);
1589 /* and see what the results are */
1590 strfcpy (completion, NONULL (mx.mbox), sizeof (completion));
1592 if (imap_parse_list_response (idata, &list_word, &noselect, &noinferiors,
1597 /* store unquoted */
1598 imap_unmunge_mbox_name (list_word);
1600 /* if the folder isn't selectable, append delimiter to force browse
1601 * to enter it on second tab. */
1603 clen = str_len (list_word);
1604 list_word[clen++] = delim;
1605 list_word[clen] = '\0';
1607 /* copy in first word */
1609 strfcpy (completion, list_word, sizeof (completion));
1610 matchlen = str_len (completion);
1615 matchlen = longest_common_prefix (completion, list_word, 0, matchlen);
1619 while (ascii_strncmp (idata->cmd.seq, idata->cmd.buf, SEQLEN));
1622 /* reformat output */
1623 imap_qualify_path (dest, dlen, &mx, completion);
1624 mutt_pretty_mailbox (dest);
1626 mem_free (&mx.mbox);
1633 /* reconnect if connection was lost */
1634 int imap_reconnect (CONTEXT * ctx)
1636 IMAP_DATA *imap_data;
1641 imap_data = (IMAP_DATA *) ctx->data;
1644 if (imap_data->status == IMAP_CONNECTED)
1648 if (query_quadoption
1650 _("Connection lost. Reconnect to IMAP server?")) != M_YES)
1653 mx_open_mailbox (ctx->path, 0, ctx);