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. */
19 #include "mutt_curses.h"
25 #include "imap_private.h"
26 #if defined(USE_SSL) || defined(USE_GNUTLS)
27 # include "mutt_ssl.h"
34 #include "lib/debug.h"
40 #include <sys/types.h>
43 /* imap forward declarations */
44 static int imap_get_delim (IMAP_DATA * idata);
45 static char *imap_get_flags (LIST ** hflags, char *s);
46 static int imap_check_acl (IMAP_DATA * idata);
47 static int imap_check_capabilities (IMAP_DATA * idata);
48 static void imap_set_flag (IMAP_DATA * idata, int aclbit, int flag,
49 const char *str, char *flags, size_t flsize);
51 /* imap_access: Check permissions on an IMAP mailbox.
52 * TODO: ACL checks. Right now we assume if it exists we can
54 int imap_access (const char *path, int flags)
58 char buf[LONG_STRING];
59 char mailbox[LONG_STRING];
60 char mbox[LONG_STRING];
62 if (imap_parse_path (path, &mx))
65 if (!(idata = imap_conn_find (&mx.account,
66 option (OPTIMAPPASSIVE) ? M_IMAP_CONN_NONEW :
72 imap_fix_path (idata, mx.mbox, mailbox, sizeof (mailbox));
74 /* we may already be in the folder we're checking */
75 if (!ascii_strcmp(idata->mailbox, mx.mbox)) {
81 imap_munge_mbox_name (mbox, sizeof (mbox), mailbox);
83 if (mutt_bit_isset (idata->capabilities, IMAP4REV1))
84 snprintf (buf, sizeof (buf), "STATUS %s (UIDVALIDITY)", mbox);
85 else if (mutt_bit_isset (idata->capabilities, STATUS))
86 snprintf (buf, sizeof (buf), "STATUS %s (UID-VALIDITY)", mbox);
88 debug_print (2, ("STATUS not supported?\n"));
92 if (imap_exec (idata, buf, IMAP_CMD_FAIL_OK) < 0) {
93 debug_print (1, ("Can't check STATUS of %s\n", mbox));
100 int imap_create_mailbox (IMAP_DATA * idata, char *mailbox)
102 char buf[LONG_STRING], mbox[LONG_STRING];
104 imap_munge_mbox_name (mbox, sizeof (mbox), mailbox);
105 snprintf (buf, sizeof (buf), "CREATE %s", mbox);
107 if (imap_exec (idata, buf, 0) != 0)
113 int imap_rename_mailbox (IMAP_DATA * idata, IMAP_MBOX * mx,
116 char oldmbox[LONG_STRING];
117 char newmbox[LONG_STRING];
118 char buf[LONG_STRING];
120 imap_munge_mbox_name (oldmbox, sizeof (oldmbox), mx->mbox);
121 imap_munge_mbox_name (newmbox, sizeof (newmbox), newname);
123 snprintf (buf, sizeof (buf), "RENAME %s %s", oldmbox, newmbox);
125 if (imap_exec (idata, buf, 0) != 0)
131 int imap_delete_mailbox (CONTEXT * ctx, IMAP_MBOX mx)
133 char buf[LONG_STRING], mbox[LONG_STRING];
136 if (!ctx || !ctx->data) {
137 if (!(idata = imap_conn_find (&mx.account,
138 option (OPTIMAPPASSIVE) ? M_IMAP_CONN_NONEW
148 imap_munge_mbox_name (mbox, sizeof (mbox), mx.mbox);
149 snprintf (buf, sizeof (buf), "DELETE %s", mbox);
151 if (imap_exec ((IMAP_DATA *) idata, buf, 0) != 0)
157 /* imap_logout_all: close all open connections. Quick and dirty until we can
158 * make sure we've got all the context we need. */
159 void imap_logout_all (void)
164 conn = mutt_socket_head ();
169 if (conn->account.type == M_ACCT_TYPE_IMAP && conn->fd >= 0) {
170 mutt_message (_("Closing connection to %s..."), conn->account.host);
171 imap_logout ((IMAP_DATA *) conn->data);
173 mutt_socket_close (conn);
174 mutt_socket_free (conn);
181 /* imap_read_literal: read bytes bytes from server into file. Not explicitly
182 * buffered, relies on FILE buffering. NOTE: strips \r from \r\n.
183 * Apparently even literals use \r\n-terminated strings ?! */
184 int imap_read_literal (FILE * fp, IMAP_DATA * idata, long bytes)
191 debug_print (2, ("reading %ld bytes\n", bytes));
193 for (pos = 0; pos < bytes; pos++) {
194 if (mutt_socket_readchar (idata->conn, &c) != 1) {
195 debug_print (1, ("error during read, %ld bytes read\n", pos));
196 idata->status = IMAP_FATAL;
202 if (r == 1 && c != '\n')
214 if (DebugLevel >= IMAP_LOG_LTRL)
215 fputc (c, DebugFile);
222 /* imap_expunge_mailbox: Purge IMAP portion of expunged messages from the
223 * context. Must not be done while something has a handle on any headers
224 * (eg inside pager or editor). That is, check IMAP_REOPEN_ALLOW. */
225 void imap_expunge_mailbox (IMAP_DATA * idata)
230 for (i = 0; i < idata->ctx->msgcount; i++) {
231 h = idata->ctx->hdrs[i];
233 if (h->index == -1) {
234 debug_print (2, ("Expunging message UID %d.\n", HEADER_DATA (h)->uid));
238 /* free cached body from disk, if neccessary */
239 cacheno = HEADER_DATA (h)->uid % IMAP_CACHE_LEN;
240 if (idata->cache[cacheno].uid == HEADER_DATA (h)->uid &&
241 idata->cache[cacheno].path) {
242 unlink (idata->cache[cacheno].path);
243 mem_free (&idata->cache[cacheno].path);
246 imap_free_header_data (&h->data);
250 /* We may be called on to expunge at any time. We can't rely on the caller
251 * to always know to rethread */
252 mx_update_tables (idata->ctx, 0);
253 mutt_sort_headers (idata->ctx, 1);
256 static int imap_get_delim (IMAP_DATA * idata)
261 /* assume that the delim is /. If this fails, we're in bigger trouble
262 * than getting the delim wrong */
265 imap_cmd_start (idata, "LIST \"\" \"\"");
268 if ((rc = imap_cmd_step (idata)) != IMAP_CMD_CONTINUE)
271 s = imap_next_word (idata->cmd.buf);
272 if (ascii_strncasecmp ("LIST", s, 4) == 0) {
273 s = imap_next_word (s);
274 s = imap_next_word (s);
275 if (s && s[0] == '\"' && s[1] && s[2] == '\"')
277 else if (s && s[0] == '\"' && s[1] && s[1] == '\\' && s[2]
282 while (rc == IMAP_CMD_CONTINUE);
284 if (rc != IMAP_CMD_OK) {
285 debug_print (1, ("failed.\n"));
289 debug_print (2, ("Delimiter: %c\n", idata->delim));
294 /* get rights for folder, let imap_handle_untagged do the rest */
295 static int imap_check_acl (IMAP_DATA * idata)
297 char buf[LONG_STRING];
298 char mbox[LONG_STRING];
300 imap_munge_mbox_name (mbox, sizeof (mbox), idata->mailbox);
301 snprintf (buf, sizeof (buf), "MYRIGHTS %s", mbox);
302 if (imap_exec (idata, buf, 0) != 0) {
303 imap_error ("imap_check_acl", buf);
309 /* imap_check_capabilities: make sure we can log in to this server. */
310 static int imap_check_capabilities (IMAP_DATA * idata)
312 if (imap_exec (idata, "CAPABILITY", 0) != 0) {
313 imap_error ("imap_check_capabilities", idata->cmd.buf);
317 if (!(mutt_bit_isset (idata->capabilities, IMAP4)
318 || mutt_bit_isset (idata->capabilities, IMAP4REV1))) {
319 mutt_error _("This IMAP server is ancient. Mutt does not work with it.");
321 mutt_sleep (2); /* pause a moment to let the user see the error */
329 /* imap_conn_find: Find an open IMAP connection matching account, or open
330 * a new one if none can be found. */
331 IMAP_DATA *imap_conn_find (const ACCOUNT * account, int flags)
337 if (!(conn = mutt_conn_find (NULL, account)))
340 /* if opening a new UNSELECTED connection, preserve existing creds */
341 creds = &(conn->account);
343 /* make sure this connection is not in SELECTED state, if neccessary */
344 if (flags & M_IMAP_CONN_NOSELECT)
345 while (conn->data && ((IMAP_DATA *) conn->data)->state == IMAP_SELECTED) {
346 if (!(conn = mutt_conn_find (conn, account)))
348 memcpy (&(conn->account), creds, sizeof (ACCOUNT));
351 idata = (IMAP_DATA *) conn->data;
353 /* don't open a new connection if one isn't wanted */
354 if (flags & M_IMAP_CONN_NONEW) {
356 mutt_socket_free (conn);
359 if (idata->state < IMAP_AUTHENTICATED)
364 /* The current connection is a new connection */
365 if (!(idata = imap_new_idata ())) {
366 mutt_socket_free (conn);
374 if (idata->state == IMAP_DISCONNECTED)
375 imap_open_connection (idata);
376 if (idata->state == IMAP_CONNECTED) {
377 if (!imap_authenticate (idata)) {
378 idata->state = IMAP_AUTHENTICATED;
379 if (idata->conn->ssf)
380 debug_print (2, ("Communication encrypted at %d bits\n", idata->conn->ssf));
383 mutt_account_unsetpass (&idata->conn->account);
385 mem_free (&idata->capstr);
387 if (idata->state == IMAP_AUTHENTICATED)
388 imap_get_delim (idata);
393 int imap_open_connection (IMAP_DATA * idata)
395 char buf[LONG_STRING];
397 if (mutt_socket_open (idata->conn) < 0)
400 idata->state = IMAP_CONNECTED;
402 if (imap_cmd_step (idata) != IMAP_CMD_CONTINUE) {
403 mutt_socket_close (idata->conn);
404 idata->state = IMAP_DISCONNECTED;
408 if (ascii_strncasecmp ("* OK", idata->cmd.buf, 4) == 0) {
409 /* TODO: Parse new tagged CAPABILITY data (* OK [CAPABILITY...]) */
410 if (imap_check_capabilities (idata))
412 #if defined(USE_SSL) || defined(USE_GNUTLS)
413 /* Attempt STARTTLS if available and desired. */
414 if (!idata->conn->ssf && (option(OPTSSLFORCETLS) ||
415 mutt_bit_isset (idata->capabilities, STARTTLS))) {
418 if (option (OPTSSLFORCETLS))
420 else if ((rc = query_quadoption (OPT_SSLSTARTTLS,
421 _("Secure connection with TLS?"))) == -1)
424 if ((rc = imap_exec (idata, "STARTTLS", IMAP_CMD_FAIL_OK)) == -1)
428 if (mutt_ssl_starttls (idata->conn))
430 if (mutt_gnutls_starttls (idata->conn))
433 mutt_error (_("Could not negotiate TLS connection"));
438 /* RFC 2595 demands we recheck CAPABILITY after TLS completes. */
439 if (imap_exec (idata, "CAPABILITY", 0))
446 if (option(OPTSSLFORCETLS) && ! idata->conn->ssf) {
447 mutt_error _("Encrypted connection unavailable");
453 else if (ascii_strncasecmp ("* PREAUTH", idata->cmd.buf, 9) == 0) {
454 idata->state = IMAP_AUTHENTICATED;
455 if (imap_check_capabilities (idata) != 0)
457 mem_free (&idata->capstr);
460 imap_error ("imap_open_connection()", buf);
467 mutt_socket_close (idata->conn);
468 idata->state = IMAP_DISCONNECTED;
470 mem_free (&idata->capstr);
474 /* imap_get_flags: Make a simple list out of a FLAGS response.
475 * return stream following FLAGS response */
476 static char *imap_get_flags (LIST ** hflags, char *s)
482 /* sanity-check string */
483 if (ascii_strncasecmp ("FLAGS", s, 5) != 0) {
484 debug_print (1, ("not a FLAGS response: %s\n", s));
490 debug_print (1, ("bogus FLAGS response: %s\n", s));
494 /* create list, update caller's flags handle */
495 flags = mutt_new_list ();
498 while (*s && *s != ')') {
502 while (*s && (*s != ')') && !ISSPACE (*s))
507 mutt_add_list (flags, flag_word);
511 /* note bad flags response */
513 debug_print (1, ("Unterminated FLAGS response: %s\n", s));
514 mutt_free_list (hflags);
524 int imap_open_mailbox (CONTEXT * ctx)
528 char buf[LONG_STRING];
529 char bufout[LONG_STRING];
534 if (imap_parse_path (ctx->path, &mx)) {
535 mutt_error (_("%s is an invalid IMAP path"), ctx->path);
539 /* we require a connection which isn't currently in IMAP_SELECTED state */
540 if (!(idata = imap_conn_find (&(mx.account), M_IMAP_CONN_NOSELECT)))
542 if (idata->state < IMAP_AUTHENTICATED)
547 /* once again the context is new */
550 /* Clean up path and replace the one in the ctx */
551 imap_fix_path (idata, mx.mbox, buf, sizeof (buf));
552 mem_free (&(idata->mailbox));
553 idata->mailbox = str_dup (buf);
554 imap_qualify_path (buf, sizeof (buf), &mx, idata->mailbox);
556 mem_free (&(ctx->path));
557 ctx->path = str_dup (buf);
561 /* clear mailbox status */
563 memset (idata->rights, 0, (RIGHTSMAX + 7) / 8);
564 idata->newMailCount = 0;
566 mutt_message (_("Selecting %s..."), idata->mailbox);
567 imap_munge_mbox_name (buf, sizeof (buf), idata->mailbox);
568 snprintf (bufout, sizeof (bufout), "%s %s",
569 ctx->readonly ? "EXAMINE" : "SELECT", buf);
571 idata->state = IMAP_SELECTED;
573 imap_cmd_start (idata, bufout);
578 if ((rc = imap_cmd_step (idata)) != IMAP_CMD_CONTINUE)
581 pc = idata->cmd.buf + 2;
583 /* Obtain list of available flags here, may be overridden by a
584 * PERMANENTFLAGS tag in the OK response */
585 if (ascii_strncasecmp ("FLAGS", pc, 5) == 0) {
586 /* don't override PERMANENTFLAGS */
588 debug_print (2, ("Getting mailbox FLAGS\n"));
589 if ((pc = imap_get_flags (&(idata->flags), pc)) == NULL)
593 /* PERMANENTFLAGS are massaged to look like FLAGS, then override FLAGS */
594 else if (ascii_strncasecmp ("OK [PERMANENTFLAGS", pc, 18) == 0) {
595 debug_print (2, ("Getting mailbox PERMANENTFLAGS\n"));
596 /* safe to call on NULL */
597 mutt_free_list (&(idata->flags));
598 /* skip "OK [PERMANENT" so syntax is the same as FLAGS */
600 if ((pc = imap_get_flags (&(idata->flags), pc)) == NULL)
604 /* save UIDVALIDITY for the header cache */
605 else if (ascii_strncasecmp ("OK [UIDVALIDITY", pc, 14) == 0) {
606 debug_print (2, ("Getting mailbox UIDVALIDITY\n"));
608 pc = imap_next_word (pc);
610 sscanf (pc, "%lu", &(idata->uid_validity));
614 pc = imap_next_word (pc);
615 if (!ascii_strncasecmp ("EXISTS", pc, 6)) {
616 count = idata->newMailCount;
617 idata->newMailCount = 0;
621 while (rc == IMAP_CMD_CONTINUE);
623 if (rc == IMAP_CMD_NO) {
626 s = imap_next_word (idata->cmd.buf); /* skip seq */
627 s = imap_next_word (s); /* Skip response */
628 mutt_error ("%s", s);
633 if (rc != IMAP_CMD_OK)
636 /* check for READ-ONLY notification */
637 if (!ascii_strncasecmp
638 (imap_get_qualifier (idata->cmd.buf), "[READ-ONLY]", 11)
639 && !mutt_bit_isset (idata->capabilities, ACL)) {
640 debug_print (2, ("Mailbox is read-only.\n"));
645 /* dump the mailbox flags we've found */
646 if (DebugLevel > 2) {
648 debug_print (3, ("No folder flags found\n"));
650 LIST *t = idata->flags;
652 debug_print (3, ("Mailbox flags:\n"));
656 debug_print (3, ("[%s]\n", t->data));
663 if (mutt_bit_isset (idata->capabilities, ACL)) {
664 if (imap_check_acl (idata))
666 if (!(mutt_bit_isset (idata->rights, ACL_DELETE) ||
667 mutt_bit_isset (idata->rights, ACL_SEEN) ||
668 mutt_bit_isset (idata->rights, ACL_WRITE) ||
669 mutt_bit_isset (idata->rights, ACL_INSERT)))
672 /* assume we have all rights if ACL is unavailable */
674 mutt_bit_set (idata->rights, ACL_LOOKUP);
675 mutt_bit_set (idata->rights, ACL_READ);
676 mutt_bit_set (idata->rights, ACL_SEEN);
677 mutt_bit_set (idata->rights, ACL_WRITE);
678 mutt_bit_set (idata->rights, ACL_INSERT);
679 mutt_bit_set (idata->rights, ACL_POST);
680 mutt_bit_set (idata->rights, ACL_CREATE);
681 mutt_bit_set (idata->rights, ACL_DELETE);
685 ctx->hdrs = mem_calloc (count, sizeof (HEADER *));
686 ctx->v2r = mem_calloc (count, sizeof (int));
688 if (count && (imap_read_headers (idata, 0, count - 1) < 0)) {
689 mutt_error _("Error opening mailbox");
695 debug_print (2, ("msgcount is %d\n", ctx->msgcount));
700 if (idata->state == IMAP_SELECTED)
701 idata->state = IMAP_AUTHENTICATED;
707 int imap_open_mailbox_append (CONTEXT * ctx)
711 char buf[LONG_STRING];
712 char mailbox[LONG_STRING];
715 if (imap_parse_path (ctx->path, &mx))
718 /* in APPEND mode, we appear to hijack an existing IMAP connection -
719 * ctx is brand new and mostly empty */
721 if (!(idata = imap_conn_find (&(mx.account), 0))) {
730 imap_fix_path (idata, mx.mbox, mailbox, sizeof (mailbox));
734 /* really we should also check for W_OK */
735 if (!imap_access (ctx->path, F_OK))
738 snprintf (buf, sizeof (buf), _("Create %s?"), mailbox);
739 if (option (OPTCONFIRMCREATE) && mutt_yesorno (buf, 1) < 1)
742 if (imap_create_mailbox (idata, mailbox) < 0)
748 /* imap_logout: Gracefully log out of server. */
749 void imap_logout (IMAP_DATA * idata)
751 /* we set status here to let imap_handle_untagged know we _expect_ to
752 * receive a bye response (so it doesn't freak out and close the conn) */
753 idata->status = IMAP_BYE;
754 imap_cmd_start (idata, "LOGOUT");
755 while (imap_cmd_step (idata) == IMAP_CMD_CONTINUE);
756 mem_free (&idata->cmd.buf);
761 int imap_close_connection (CONTEXT *ctx)
763 debug_print (1, (debugfile, "imap_close_connection(): closing connection\n"));
764 if (CTX_DATA->status != IMAP_BYE)
766 mutt_message _("Closing connection to IMAP server...");
767 imap_logout (CTX_DATA);
770 mutt_socket_close (CTX_DATA->conn);
771 CTX_DATA->state = IMAP_DISCONNECTED;
772 CTX_DATA->conn->data = NULL;
777 /* imap_set_flag: append str to flags if we currently have permission
778 * according to aclbit */
779 static void imap_set_flag (IMAP_DATA * idata, int aclbit, int flag,
780 const char *str, char *flags, size_t flsize)
782 if (mutt_bit_isset (idata->rights, aclbit))
784 str_cat (flags, flsize, str);
787 /* imap_make_msg_set: make an IMAP4rev1 UID message set out of a set of
788 * headers, given a flag enum to filter on.
789 * Params: idata: IMAP_DATA containing context containing header set
790 * buf: to write message set into
791 * buflen: length of buffer
792 * flag: enum of flag type on which to filter
793 * changed: include only changed messages in message set
794 * Returns: number of messages in message set (0 if no matches) */
795 int imap_make_msg_set (IMAP_DATA * idata, BUFFER * buf, int flag, int changed)
797 HEADER **hdrs; /* sorted local copy */
798 int count = 0; /* number of messages in message set */
799 int match = 0; /* whether current message matches flag condition */
800 unsigned int setstart = 0; /* start of current message range */
802 short oldsort; /* we clobber reverse, must restore it */
804 /* assuming 32-bit UIDs */
808 /* make copy of header pointers to sort in natural order */
809 hdrs = mem_calloc (idata->ctx->msgcount, sizeof (HEADER *));
810 memcpy (hdrs, idata->ctx->hdrs, idata->ctx->msgcount * sizeof (HEADER *));
812 if (Sort != SORT_ORDER) {
815 qsort ((void *) hdrs, idata->ctx->msgcount, sizeof (HEADER *),
816 mutt_get_sort_func (SORT_ORDER));
820 for (n = 0; n < idata->ctx->msgcount; n++) {
822 /* don't include pending expunged messages */
826 if (hdrs[n]->deleted)
835 if (match && (!changed || hdrs[n]->changed)) {
838 setstart = HEADER_DATA (hdrs[n])->uid;
840 snprintf (uid, sizeof (uid), "%u", HEADER_DATA (hdrs[n])->uid);
841 mutt_buffer_addstr (buf, uid);
845 snprintf (uid, sizeof (uid), ",%u", HEADER_DATA (hdrs[n])->uid);
846 mutt_buffer_addstr (buf, uid);
849 /* tie up if the last message also matches */
850 else if (n == idata->ctx->msgcount - 1) {
851 snprintf (uid, sizeof (uid), ":%u", HEADER_DATA (hdrs[n])->uid);
852 mutt_buffer_addstr (buf, uid);
855 /* this message is not expunged and doesn't match. End current set. */
856 else if (setstart && hdrs[n]->active) {
857 if (HEADER_DATA (hdrs[n - 1])->uid > setstart) {
858 snprintf (uid, sizeof (uid), ":%u", HEADER_DATA (hdrs[n - 1])->uid);
859 mutt_buffer_addstr (buf, uid);
870 /* Update the IMAP server to reflect the flags a single message. */
872 int imap_sync_message (IMAP_DATA *idata, HEADER *hdr, BUFFER *cmd,
875 char flags[LONG_STRING];
880 snprintf (uid, sizeof (uid), "%u", HEADER_DATA(hdr)->uid);
881 cmd->dptr = cmd->data;
882 mutt_buffer_addstr (cmd, "UID STORE ");
883 mutt_buffer_addstr (cmd, uid);
887 imap_set_flag (idata, ACL_SEEN, hdr->read, "\\Seen ",
888 flags, sizeof (flags));
889 imap_set_flag (idata, ACL_WRITE, hdr->flagged,
890 "\\Flagged ", flags, sizeof (flags));
891 imap_set_flag (idata, ACL_WRITE, hdr->replied,
892 "\\Answered ", flags, sizeof (flags));
893 imap_set_flag (idata, ACL_DELETE, hdr->deleted,
894 "\\Deleted ", flags, sizeof (flags));
896 /* now make sure we don't lose custom tags */
897 if (mutt_bit_isset (idata->rights, ACL_WRITE))
898 imap_add_keywords (flags, hdr, idata->flags, sizeof (flags));
900 str_skip_trailws (flags);
902 /* UW-IMAP is OK with null flags, Cyrus isn't. The only solution is to
903 * explicitly revoke all system flags (if we have permission) */
906 imap_set_flag (idata, ACL_SEEN, 1, "\\Seen ", flags, sizeof (flags));
907 imap_set_flag (idata, ACL_WRITE, 1, "\\Flagged ", flags, sizeof (flags));
908 imap_set_flag (idata, ACL_WRITE, 1, "\\Answered ", flags, sizeof (flags));
909 imap_set_flag (idata, ACL_DELETE, 1, "\\Deleted ", flags, sizeof (flags));
911 str_skip_trailws (flags);
913 mutt_buffer_addstr (cmd, " -FLAGS.SILENT (");
915 mutt_buffer_addstr (cmd, " FLAGS.SILENT (");
917 mutt_buffer_addstr (cmd, flags);
918 mutt_buffer_addstr (cmd, ")");
920 /* dumb hack for bad UW-IMAP 4.7 servers spurious FLAGS updates */
923 /* after all this it's still possible to have no flags, if you
924 * have no ACL rights */
925 if (*flags && (imap_exec (idata, cmd->data, 0) != 0) &&
926 err_continue && (*err_continue != M_YES))
928 *err_continue = imap_continue ("imap_sync_message: STORE failed",
930 if (*err_continue != M_YES)
935 idata->ctx->changed--;
940 /* update the IMAP server to reflect message changes done within mutt.
942 * ctx: the current context
943 * expunge: 0 or 1 - do expunge?
946 int imap_sync_mailbox (CONTEXT * ctx, int expunge, int *index_hint)
949 CONTEXT *appendctx = NULL;
953 int err_continue = M_NO; /* continue on error? */
956 idata = (IMAP_DATA *) ctx->data;
958 if (idata->state != IMAP_SELECTED) {
959 debug_print (2, ("no mailbox selected\n"));
963 /* This function is only called when the calling code expects the context
965 imap_allow_reopen (ctx);
967 if ((rc = imap_check_mailbox (ctx, index_hint, 0)) != 0)
970 memset (&cmd, 0, sizeof (cmd));
972 /* if we are expunging anyway, we can do deleted messages very quickly... */
973 if (expunge && mutt_bit_isset (idata->rights, ACL_DELETE)) {
974 mutt_buffer_addstr (&cmd, "UID STORE ");
975 deleted = imap_make_msg_set (idata, &cmd, M_DELETE, 1);
977 /* if we have a message set, then let's delete */
979 mutt_message (_("Marking %d messages deleted..."), deleted);
980 mutt_buffer_addstr (&cmd, " +FLAGS.SILENT (\\Deleted)");
981 /* mark these messages as unchanged so second pass ignores them. Done
982 * here so BOGUS UW-IMAP 4.7 SILENT FLAGS updates are ignored. */
983 for (n = 0; n < ctx->msgcount; n++)
984 if (ctx->hdrs[n]->deleted && ctx->hdrs[n]->changed)
985 ctx->hdrs[n]->active = 0;
986 if (imap_exec (idata, cmd.data, 0) != 0) {
987 mutt_error (_("Expunge failed"));
995 /* save status changes */
996 for (n = 0; n < ctx->msgcount; n++) {
997 if (ctx->hdrs[n]->active && ctx->hdrs[n]->changed) {
999 mutt_message (_("Saving message status flags... [%d/%d]"), n + 1,
1002 /* if the message has been rethreaded or attachments have been deleted
1003 * we delete the message and reupload it.
1004 * This works better if we're expunging, of course. */
1005 if ((ctx->hdrs[n]->env && (ctx->hdrs[n]->env->refs_changed || ctx->hdrs[n]->env->irt_changed)) ||
1006 ctx->hdrs[n]->attach_del) {
1007 debug_print (3, ("Attachments to be deleted, falling back to _mutt_save_message\n"));
1009 appendctx = mx_open_mailbox (ctx->path, M_APPEND | M_QUIET, NULL);
1011 debug_print (1, ("Error opening mailbox in append mode\n"));
1014 _mutt_save_message (ctx->hdrs[n], appendctx, 1, 0, 0);
1017 if (imap_sync_message (idata, ctx->hdrs[n], &cmd, &err_continue) < 0) {
1025 /* We must send an EXPUNGE command if we're not closing. */
1026 if (expunge && !(ctx->closing) &&
1027 mutt_bit_isset (idata->rights, ACL_DELETE)) {
1028 mutt_message _("Expunging messages from server...");
1030 /* Set expunge bit so we don't get spurious reopened messages */
1031 idata->reopen |= IMAP_EXPUNGE_EXPECTED;
1032 if (imap_exec (idata, "EXPUNGE", 0) != 0) {
1033 imap_error (_("imap_sync_mailbox: EXPUNGE failed"), idata->cmd.buf);
1034 rc = imap_reconnect (ctx);
1039 if (expunge && ctx->closing) {
1040 if (imap_exec (idata, "CLOSE", 0))
1041 mutt_error (_("CLOSE failed"));
1042 idata->state = IMAP_AUTHENTICATED;
1048 mem_free (&cmd.data);
1050 mx_fastclose_mailbox (appendctx);
1051 mem_free (&appendctx);
1056 /* imap_close_mailbox: clean up IMAP data in CONTEXT */
1057 void imap_close_mailbox (CONTEXT * ctx)
1062 idata = (IMAP_DATA *) ctx->data;
1063 /* Check to see if the mailbox is actually open */
1067 if (ctx == idata->ctx) {
1068 if (idata->state != IMAP_FATAL && idata->state == IMAP_SELECTED) {
1069 /* mx_close_mailbox won't sync if there are no deleted messages
1070 * and the mailbox is unchanged, so we may have to close here */
1071 if (!ctx->deleted && imap_exec (idata, "CLOSE", 0))
1072 mutt_error (_("CLOSE failed"));
1073 idata->state = IMAP_AUTHENTICATED;
1076 idata->reopen &= IMAP_REOPEN_ALLOW;
1077 mem_free (&(idata->mailbox));
1078 mutt_free_list (&idata->flags);
1082 /* free IMAP part of headers */
1083 for (i = 0; i < ctx->msgcount; i++)
1084 imap_free_header_data (&(ctx->hdrs[i]->data));
1086 for (i = 0; i < IMAP_CACHE_LEN; i++) {
1087 if (idata->cache[i].path) {
1088 unlink (idata->cache[i].path);
1089 mem_free (&idata->cache[i].path);
1094 /* use the NOOP command to poll for new mail
1097 * M_REOPENED mailbox has been externally modified
1098 * M_NEW_MAIL new mail has arrived!
1102 int imap_check_mailbox (CONTEXT * ctx, int *index_hint, int force)
1104 /* overload keyboard timeout to avoid many mailbox checks in a row.
1105 * Most users don't like having to wait exactly when they press a key. */
1109 idata = (IMAP_DATA *) ctx->data;
1111 if ((force || time (NULL) > idata->lastread + Timeout)
1112 && imap_exec (idata, "NOOP", 0) != 0)
1115 /* We call this even when we haven't run NOOP in case we have pending
1116 * changes to process, since we can reopen here. */
1117 imap_cmd_finish (idata);
1119 if (idata->check_status & IMAP_EXPUNGE_PENDING)
1120 result = M_REOPENED;
1121 else if (idata->check_status & IMAP_NEWMAIL_PENDING)
1122 result = M_NEW_MAIL;
1123 else if (idata->check_status & IMAP_FLAGS_PENDING)
1126 idata->check_status = 0;
1131 /* returns count of recent messages if new = 1, else count of total messages.
1132 * (useful for at least postponed function)
1133 * Question of taste: use RECENT or UNSEEN for new?
1134 * 0+ number of messages in mailbox
1135 * -1 error while polling mailboxes
1137 int imap_mailbox_check (char *path, int new)
1141 char buf[LONG_STRING];
1142 char mbox[LONG_STRING];
1143 char mbox_unquoted[LONG_STRING];
1150 if (imap_parse_path (path, &mx))
1153 /* If imap_passive is set, don't open a connection to check for new mail */
1154 if (option (OPTIMAPPASSIVE))
1155 connflags = M_IMAP_CONN_NONEW;
1157 if (!(idata = imap_conn_find (&(mx.account), connflags))) {
1158 mem_free (&mx.mbox);
1163 imap_fix_path (idata, mx.mbox, buf, sizeof (buf));
1164 mem_free (&mx.mbox);
1166 imap_munge_mbox_name (mbox, sizeof (mbox), buf);
1167 strfcpy (mbox_unquoted, buf, sizeof (mbox_unquoted));
1169 /* The draft IMAP implementor's guide warns againts using the STATUS
1170 * command on a mailbox that you have selected
1173 if (str_cmp (mbox_unquoted, idata->mailbox) == 0
1174 || (ascii_strcasecmp (mbox_unquoted, "INBOX") == 0
1175 && str_casecmp (mbox_unquoted, idata->mailbox) == 0)) {
1176 strfcpy (buf, "NOOP", sizeof (buf));
1178 else if (mutt_bit_isset (idata->capabilities, IMAP4REV1) ||
1179 mutt_bit_isset (idata->capabilities, STATUS)) {
1180 snprintf (buf, sizeof (buf), "STATUS %s (%s)", mbox,
1181 new ? "RECENT" : "MESSAGES");
1184 /* Server does not support STATUS, and this is not the current mailbox.
1185 * There is no lightweight way to check recent arrivals */
1188 imap_cmd_start (idata, buf);
1191 if ((rc = imap_cmd_step (idata)) != IMAP_CMD_CONTINUE)
1194 s = imap_next_word (idata->cmd.buf);
1195 if (ascii_strncasecmp ("STATUS", s, 6) == 0) {
1196 s = imap_next_word (s);
1197 /* The mailbox name may or may not be quoted here. We could try to
1198 * munge the server response and compare with quoted (or vise versa)
1199 * but it is probably more efficient to just strncmp against both. */
1200 if (str_ncmp (mbox_unquoted, s, str_len (mbox_unquoted)) == 0
1201 || str_ncmp (mbox, s, str_len (mbox)) == 0) {
1202 s = imap_next_word (s);
1203 s = imap_next_word (s);
1204 if (isdigit ((unsigned char) *s)) {
1206 msgcount = atoi (s);
1207 debug_print (2, ("%d new messages in %s\n", msgcount, path));
1212 debug_print (1, ("STATUS response doesn't match requested mailbox.\n"));
1215 while (rc == IMAP_CMD_CONTINUE);
1220 /* all this listing/browsing is a mess. I don't like that name is a pointer
1221 * into idata->buf (used to be a pointer into the passed in buffer, just
1222 * as bad), nor do I like the fact that the fetch is done here. This
1223 * code can't possibly handle non-LIST untagged responses properly.
1225 int imap_parse_list_response (IMAP_DATA * idata, char **name, int *noselect,
1226 int *noinferiors, char *delim)
1234 rc = imap_cmd_step (idata);
1235 if (rc == IMAP_CMD_OK)
1237 if (rc != IMAP_CMD_CONTINUE)
1240 s = imap_next_word (idata->cmd.buf);
1241 if ((ascii_strncasecmp ("LIST", s, 4) == 0) ||
1242 (ascii_strncasecmp ("LSUB", s, 4) == 0)) {
1246 s = imap_next_word (s); /* flags */
1252 while (*ep && *ep != ')')
1255 if (!ascii_strncasecmp (s, "\\NoSelect", 9))
1257 if (!ascii_strncasecmp (s, "\\NoInferiors", 12))
1259 /* See draft-gahrns-imap-child-mailbox-?? */
1260 if (!ascii_strncasecmp (s, "\\HasNoChildren", 14))
1264 while (*s && *s != '\\' && *s != ')')
1270 s = imap_next_word (s); /* delim */
1271 /* Reset the delimiter, this can change */
1272 if (ascii_strncasecmp (s, "NIL", 3)) {
1273 if (s && s[0] == '\"' && s[1] && s[2] == '\"')
1275 else if (s && s[0] == '\"' && s[1] && s[1] == '\\' && s[2]
1279 s = imap_next_word (s); /* name */
1280 if (s && *s == '{') { /* Literal */
1281 if (imap_get_literal_count (idata->cmd.buf, &bytes) < 0)
1283 if (imap_cmd_step (idata) != IMAP_CMD_CONTINUE)
1285 *name = idata->cmd.buf;
1294 int imap_subscribe (char *path, int subscribe)
1298 char buf[LONG_STRING];
1299 char mbox[LONG_STRING];
1302 if (mx_get_magic (path) == M_IMAP || imap_parse_path (path, &mx)) {
1303 mutt_error (_("Bad mailbox name"));
1308 if (!(idata = imap_conn_find (&(mx.account), 0)))
1313 imap_fix_path (idata, mx.mbox, buf, sizeof (buf));
1315 mutt_message (_("Subscribing to %s..."), buf);
1317 mutt_message (_("Unsubscribing to %s..."), buf);
1318 imap_munge_mbox_name (mbox, sizeof (mbox), buf);
1320 snprintf (buf, sizeof (buf), "%s %s", subscribe ? "SUBSCRIBE" :
1321 "UNSUBSCRIBE", mbox);
1323 if (imap_exec (idata, buf, 0) < 0)
1326 mem_free (&mx.mbox);
1330 mem_free (&mx.mbox);
1334 /* trim dest to the length of the longest prefix it shares with src,
1335 * returning the length of the trimmed string */
1336 static int longest_common_prefix (char *dest, const char* src,
1337 int start, size_t dlen) {
1340 while (pos < dlen && dest[pos] && dest[pos] == src[pos])
1347 /* look for IMAP URLs to complete from defined mailboxes. Could be extended
1348 * to complete over open connections and account/folder hooks too. */
1349 static int imap_complete_hosts (char *dest, size_t len) {
1356 matchlen = str_len (dest);
1357 if (list_empty (Incoming))
1359 for (i = 0; i < Incoming->length; i++) {
1360 mailbox = (BUFFY*) Incoming->data[i];
1361 if (!str_ncmp (dest, mailbox->path, matchlen)) {
1363 strfcpy (dest, mailbox->path, len);
1366 longest_common_prefix (dest, mailbox->path, matchlen, len);
1370 for (conn = mutt_socket_head (); conn->next; conn = conn->next) {
1372 char urlstr[LONG_STRING];
1374 if (conn->account.type != M_ACCT_TYPE_IMAP)
1377 mutt_account_tourl (&conn->account, &url);
1378 /* FIXME: how to handle multiple users on the same host? */
1381 url_ciss_tostring (&url, urlstr, sizeof (urlstr), 0);
1382 if (!str_ncmp (dest, urlstr, matchlen)) {
1384 strfcpy (dest, urlstr, len);
1387 longest_common_prefix (dest, urlstr, matchlen, len);
1394 /* imap_complete: given a partial IMAP folder path, return a string which
1395 * adds as much to the path as is unique */
1396 int imap_complete (char *dest, size_t dlen, char *path) {
1399 char list[LONG_STRING];
1400 char buf[LONG_STRING];
1401 char *list_word = NULL;
1402 int noselect, noinferiors;
1404 char completion[LONG_STRING];
1405 int clen, matchlen = 0;
1406 int completions = 0;
1409 if (imap_parse_path (path, &mx) || !mx.mbox) {
1410 strfcpy (dest, path, dlen);
1411 return imap_complete_hosts (dest, dlen);
1414 /* don't open a new socket just for completion. Instead complete over
1415 * known mailboxes/hooks/etc */
1416 if (!(idata = imap_conn_find (&(mx.account), M_IMAP_CONN_NONEW))) {
1417 mem_free (&mx.mbox);
1418 strfcpy (dest, path, dlen);
1419 return imap_complete_hosts (dest, dlen);
1423 /* reformat path for IMAP list, and append wildcard */
1424 /* don't use INBOX in place of "" */
1425 if (mx.mbox && mx.mbox[0])
1426 imap_fix_path (idata, mx.mbox, list, sizeof (list));
1430 /* fire off command */
1431 snprintf (buf, sizeof (buf), "%s \"\" \"%s%%\"",
1432 option (OPTIMAPLSUB) ? "LSUB" : "LIST", list);
1434 imap_cmd_start (idata, buf);
1436 /* and see what the results are */
1437 strfcpy (completion, NONULL (mx.mbox), sizeof (completion));
1439 if (imap_parse_list_response (idata, &list_word, &noselect, &noinferiors,
1444 /* store unquoted */
1445 imap_unmunge_mbox_name (list_word);
1447 /* if the folder isn't selectable, append delimiter to force browse
1448 * to enter it on second tab. */
1450 clen = str_len (list_word);
1451 list_word[clen++] = delim;
1452 list_word[clen] = '\0';
1454 /* copy in first word */
1456 strfcpy (completion, list_word, sizeof (completion));
1457 matchlen = str_len (completion);
1462 matchlen = longest_common_prefix (completion, list_word, 0, matchlen);
1466 while (ascii_strncmp (idata->cmd.seq, idata->cmd.buf, SEQLEN));
1469 /* reformat output */
1470 imap_qualify_path (dest, dlen, &mx, completion);
1471 mutt_pretty_mailbox (dest);
1473 mem_free (&mx.mbox);
1480 /* reconnect if connection was lost */
1481 int imap_reconnect (CONTEXT * ctx)
1483 IMAP_DATA *imap_data;
1488 imap_data = (IMAP_DATA *) ctx->data;
1491 if (imap_data->status == IMAP_CONNECTED)
1495 if (query_quadoption
1497 _("Connection lost. Reconnect to IMAP server?")) != M_YES)
1500 mx_open_mailbox (ctx->path, 0, ctx);