2 * Copyright (C) 1996-8 Michael R. Elkins <me@mutt.org>
3 * Copyright (C) 1996-9 Brandon Long <blong@fiction.net>
4 * Copyright (C) 1999-2003 Brendan Cully <brendan@kublai.com>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
21 /* Support for IMAP4rev1, with the occasional nod to IMAP 4. */
24 #include "mutt_curses.h"
31 #include "imap_private.h"
33 # include "mutt_ssl.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 int imap_access (const char* path, int flags)
56 char buf[LONG_STRING];
57 char mailbox[LONG_STRING];
58 char mbox[LONG_STRING];
60 if (imap_parse_path (path, &mx))
63 if (!(idata = imap_conn_find (&mx.account,
64 option (OPTIMAPPASSIVE) ? M_IMAP_CONN_NONEW : 0)))
70 imap_fix_path (idata, mx.mbox, mailbox, sizeof (mailbox));
72 imap_munge_mbox_name (mbox, sizeof (mbox), mailbox);
74 /* TODO: ACL checks. Right now we assume if it exists we can mess with it. */
75 if (mutt_bit_isset (idata->capabilities, IMAP4REV1))
76 snprintf (buf, sizeof (buf), "STATUS %s (UIDVALIDITY)", mbox);
77 else if (mutt_bit_isset (idata->capabilities, STATUS))
78 snprintf (buf, sizeof (buf), "STATUS %s (UID-VALIDITY)", mbox);
81 dprint (2, (debugfile, "imap_access: STATUS not supported?\n"));
85 if (imap_exec (idata, buf, IMAP_CMD_FAIL_OK) < 0)
87 dprint (1, (debugfile, "imap_access: Can't check STATUS of %s\n", mbox));
94 int imap_create_mailbox (IMAP_DATA* idata, char* mailbox)
96 char buf[LONG_STRING], mbox[LONG_STRING];
98 imap_munge_mbox_name (mbox, sizeof (mbox), mailbox);
99 snprintf (buf, sizeof (buf), "CREATE %s", mbox);
101 if (imap_exec (idata, buf, 0) != 0)
107 int imap_delete_mailbox (CONTEXT* ctx, IMAP_MBOX mx)
109 char buf[LONG_STRING], mbox[LONG_STRING];
112 if (!ctx || !ctx->data) {
113 if (!(idata = imap_conn_find (&mx.account,
114 option (OPTIMAPPASSIVE) ? M_IMAP_CONN_NONEW : 0)))
123 imap_munge_mbox_name (mbox, sizeof (mbox), mx.mbox);
124 snprintf (buf, sizeof (buf), "DELETE %s", mbox);
126 if (imap_exec ((IMAP_DATA*) idata, buf, 0) != 0)
132 /* imap_logout_all: close all open connections. Quick and dirty until we can
133 * make sure we've got all the context we need. */
134 void imap_logout_all (void)
139 conn = mutt_socket_head ();
145 if (conn->account.type == M_ACCT_TYPE_IMAP && conn->fd >= 0)
147 mutt_message (_("Closing connection to %s..."), conn->account.host);
148 imap_logout ((IMAP_DATA*) conn->data);
150 mutt_socket_close (conn);
151 mutt_socket_free (conn);
158 /* imap_read_literal: read bytes bytes from server into file. Not explicitly
159 * buffered, relies on FILE buffering. NOTE: strips \r from \r\n.
160 * Apparently even literals use \r\n-terminated strings ?! */
161 int imap_read_literal (FILE* fp, IMAP_DATA* idata, long bytes)
168 dprint (2, (debugfile, "imap_read_literal: reading %ld bytes\n", bytes));
170 for (pos = 0; pos < bytes; pos++)
172 if (mutt_socket_readchar (idata->conn, &c) != 1)
174 dprint (1, (debugfile, "imap_read_literal: error during read, %ld bytes read\n", pos));
175 idata->status = IMAP_FATAL;
181 if (r == 1 && c != '\n')
194 if (debuglevel >= IMAP_LOG_LTRL)
195 fputc (c, debugfile);
202 /* imap_expunge_mailbox: Purge IMAP portion of expunged messages from the
203 * context. Must not be done while something has a handle on any headers
204 * (eg inside pager or editor). That is, check IMAP_REOPEN_ALLOW. */
205 void imap_expunge_mailbox (IMAP_DATA* idata)
210 for (i = 0; i < idata->ctx->msgcount; i++)
212 h = idata->ctx->hdrs[i];
216 dprint (2, (debugfile, "Expunging message UID %d.\n", HEADER_DATA (h)->uid));
220 /* free cached body from disk, if neccessary */
221 cacheno = HEADER_DATA(h)->uid % IMAP_CACHE_LEN;
222 if (idata->cache[cacheno].uid == HEADER_DATA(h)->uid &&
223 idata->cache[cacheno].path)
225 unlink (idata->cache[cacheno].path);
226 FREE (&idata->cache[cacheno].path);
229 imap_free_header_data (&h->data);
233 /* We may be called on to expunge at any time. We can't rely on the caller
234 * to always know to rethread */
235 mx_update_tables (idata->ctx, 0);
236 mutt_sort_headers (idata->ctx, 1);
239 static int imap_get_delim (IMAP_DATA *idata)
244 /* assume that the delim is /. If this fails, we're in bigger trouble
245 * than getting the delim wrong */
248 imap_cmd_start (idata, "LIST \"\" \"\"");
252 if ((rc = imap_cmd_step (idata)) != IMAP_CMD_CONTINUE)
255 s = imap_next_word (idata->cmd.buf);
256 if (ascii_strncasecmp ("LIST", s, 4) == 0)
258 s = imap_next_word (s);
259 s = imap_next_word (s);
260 if (s && s[0] == '\"' && s[1] && s[2] == '\"')
262 else if (s && s[0] == '\"' && s[1] && s[1] == '\\' && s[2] && s[3] == '\"')
266 while (rc == IMAP_CMD_CONTINUE);
268 if (rc != IMAP_CMD_OK)
270 dprint (1, (debugfile, "imap_get_delim: failed.\n"));
274 dprint (2, (debugfile, "Delimiter: %c\n", idata->delim));
279 /* get rights for folder, let imap_handle_untagged do the rest */
280 static int imap_check_acl (IMAP_DATA *idata)
282 char buf[LONG_STRING];
283 char mbox[LONG_STRING];
285 imap_munge_mbox_name (mbox, sizeof(mbox), idata->mailbox);
286 snprintf (buf, sizeof (buf), "MYRIGHTS %s", mbox);
287 if (imap_exec (idata, buf, 0) != 0)
289 imap_error ("imap_check_acl", buf);
295 /* imap_check_capabilities: make sure we can log in to this server. */
296 static int imap_check_capabilities (IMAP_DATA* idata)
298 if (imap_exec (idata, "CAPABILITY", 0) != 0)
300 imap_error ("imap_check_capabilities", idata->cmd.buf);
304 if (!(mutt_bit_isset(idata->capabilities,IMAP4)
305 ||mutt_bit_isset(idata->capabilities,IMAP4REV1)))
307 mutt_error _("This IMAP server is ancient. Mutt does not work with it.");
308 mutt_sleep (2); /* pause a moment to let the user see the error */
316 /* imap_conn_find: Find an open IMAP connection matching account, or open
317 * a new one if none can be found. */
318 IMAP_DATA* imap_conn_find (const ACCOUNT* account, int flags)
324 if (!(conn = mutt_conn_find (NULL, account)))
327 /* if opening a new UNSELECTED connection, preserve existing creds */
328 creds = &(conn->account);
330 /* make sure this connection is not in SELECTED state, if neccessary */
331 if (flags & M_IMAP_CONN_NOSELECT)
332 while (conn->data && ((IMAP_DATA*) conn->data)->state == IMAP_SELECTED)
334 if (!(conn = mutt_conn_find (conn, account)))
336 memcpy (&(conn->account), creds, sizeof (ACCOUNT));
339 idata = (IMAP_DATA*) conn->data;
341 /* don't open a new connection if one isn't wanted */
342 if (flags & M_IMAP_CONN_NONEW)
346 mutt_socket_free (conn);
349 if (idata->state < IMAP_AUTHENTICATED)
355 /* The current connection is a new connection */
356 if (! (idata = imap_new_idata ()))
358 mutt_socket_free (conn);
366 if (idata->state == IMAP_DISCONNECTED)
367 imap_open_connection (idata);
368 if (idata->state == IMAP_CONNECTED)
370 if (!imap_authenticate (idata))
372 idata->state = IMAP_AUTHENTICATED;
373 if (idata->conn->ssf)
374 dprint (2, (debugfile, "Communication encrypted at %d bits\n",
378 mutt_account_unsetpass (&idata->conn->account);
380 FREE (&idata->capstr);
382 if (idata->state == IMAP_AUTHENTICATED)
383 imap_get_delim (idata);
388 int imap_open_connection (IMAP_DATA* idata)
390 char buf[LONG_STRING];
392 if (mutt_socket_open (idata->conn) < 0)
395 idata->state = IMAP_CONNECTED;
397 if (imap_cmd_step (idata) != IMAP_CMD_CONTINUE) {
398 mutt_error (_("Unexpected response received from server: %s"), idata->cmd.buf);
401 mutt_socket_close (idata->conn);
402 idata->state = IMAP_DISCONNECTED;
406 if (ascii_strncasecmp ("* OK", idata->cmd.buf, 4) == 0)
408 /* TODO: Parse new tagged CAPABILITY data (* OK [CAPABILITY...]) */
409 if (imap_check_capabilities (idata))
411 #if defined(USE_SSL) && !defined(USE_NSS)
412 /* Attempt STARTTLS if available and desired. */
413 if (mutt_bit_isset (idata->capabilities, STARTTLS) && !idata->conn->ssf)
417 if ((rc = query_quadoption (OPT_SSLSTARTTLS,
418 _("Secure connection with TLS?"))) == -1)
421 if ((rc = imap_exec (idata, "STARTTLS", IMAP_CMD_FAIL_OK)) == -1)
425 if (mutt_ssl_starttls (idata->conn))
427 mutt_error (_("Could not negotiate TLS connection"));
433 /* RFC 2595 demands we recheck CAPABILITY after TLS completes. */
434 if (imap_exec (idata, "CAPABILITY", 0))
442 else if (ascii_strncasecmp ("* PREAUTH", idata->cmd.buf, 9) == 0)
444 idata->state = IMAP_AUTHENTICATED;
445 if (imap_check_capabilities (idata) != 0)
447 FREE (&idata->capstr);
451 imap_error ("imap_open_connection()", buf);
458 mutt_socket_close (idata->conn);
460 FREE (&idata->capstr);
464 /* imap_get_flags: Make a simple list out of a FLAGS response.
465 * return stream following FLAGS response */
466 static char* imap_get_flags (LIST** hflags, char* s)
472 /* sanity-check string */
473 if (ascii_strncasecmp ("FLAGS", s, 5) != 0)
475 dprint (1, (debugfile, "imap_get_flags: not a FLAGS response: %s\n",
483 dprint (1, (debugfile, "imap_get_flags: bogus FLAGS response: %s\n",
488 /* create list, update caller's flags handle */
489 flags = mutt_new_list();
492 while (*s && *s != ')')
497 while (*s && (*s != ')') && !ISSPACE (*s))
502 mutt_add_list (flags, flag_word);
506 /* note bad flags response */
509 dprint (1, (debugfile,
510 "imap_get_flags: Unterminated FLAGS response: %s\n", s));
511 mutt_free_list (hflags);
521 int imap_open_mailbox (CONTEXT* ctx)
525 char buf[LONG_STRING];
526 char bufout[LONG_STRING];
531 if (imap_parse_path (ctx->path, &mx))
533 mutt_error (_("%s is an invalid IMAP path"), ctx->path);
537 /* we require a connection which isn't currently in IMAP_SELECTED state */
538 if (!(idata = imap_conn_find (&(mx.account), M_IMAP_CONN_NOSELECT)))
540 if (idata->state < IMAP_AUTHENTICATED)
545 /* once again the context is new */
548 /* Clean up path and replace the one in the ctx */
549 imap_fix_path (idata, mx.mbox, buf, sizeof (buf));
550 FREE(&(idata->mailbox));
551 idata->mailbox = safe_strdup (buf);
552 imap_qualify_path (buf, sizeof (buf), &mx, idata->mailbox);
555 ctx->path = safe_strdup (buf);
559 /* clear mailbox status */
561 memset (idata->rights, 0, (RIGHTSMAX+7)/8);
562 idata->newMailCount = 0;
564 mutt_message (_("Selecting %s..."), idata->mailbox);
565 imap_munge_mbox_name (buf, sizeof(buf), idata->mailbox);
566 snprintf (bufout, sizeof (bufout), "%s %s",
567 ctx->readonly ? "EXAMINE" : "SELECT", buf);
569 idata->state = IMAP_SELECTED;
571 imap_cmd_start (idata, bufout);
577 if ((rc = imap_cmd_step (idata)) != IMAP_CMD_CONTINUE)
580 pc = idata->cmd.buf + 2;
582 /* Obtain list of available flags here, may be overridden by a
583 * PERMANENTFLAGS tag in the OK response */
584 if (ascii_strncasecmp ("FLAGS", pc, 5) == 0)
586 /* don't override PERMANENTFLAGS */
589 dprint (2, (debugfile, "Getting mailbox FLAGS\n"));
590 if ((pc = imap_get_flags (&(idata->flags), pc)) == NULL)
594 /* PERMANENTFLAGS are massaged to look like FLAGS, then override FLAGS */
595 else if (ascii_strncasecmp ("OK [PERMANENTFLAGS", pc, 18) == 0)
597 dprint (2, (debugfile, "Getting mailbox PERMANENTFLAGS\n"));
598 /* safe to call on NULL */
599 mutt_free_list (&(idata->flags));
600 /* skip "OK [PERMANENT" so syntax is the same as FLAGS */
602 if ((pc = imap_get_flags (&(idata->flags), pc)) == NULL)
607 pc = imap_next_word (pc);
608 if (!ascii_strncasecmp ("EXISTS", pc, 6))
610 count = idata->newMailCount;
611 idata->newMailCount = 0;
615 while (rc == IMAP_CMD_CONTINUE);
617 if (rc == IMAP_CMD_NO)
620 s = imap_next_word (idata->cmd.buf); /* skip seq */
621 s = imap_next_word (s); /* Skip response */
622 mutt_error ("%s", s);
627 if (rc != IMAP_CMD_OK)
630 /* check for READ-ONLY notification */
631 if (!ascii_strncasecmp (imap_get_qualifier (idata->cmd.buf), "[READ-ONLY]", 11) \
632 && !mutt_bit_isset (idata->capabilities, ACL))
634 dprint (2, (debugfile, "Mailbox is read-only.\n"));
639 /* dump the mailbox flags we've found */
643 dprint (3, (debugfile, "No folder flags found\n"));
646 LIST* t = idata->flags;
648 dprint (3, (debugfile, "Mailbox flags: "));
653 dprint (3, (debugfile, "[%s] ", t->data));
656 dprint (3, (debugfile, "\n"));
661 if (mutt_bit_isset (idata->capabilities, ACL))
663 if (imap_check_acl (idata))
665 if (!(mutt_bit_isset(idata->rights, IMAP_ACL_DELETE) ||
666 mutt_bit_isset(idata->rights, IMAP_ACL_SEEN) ||
667 mutt_bit_isset(idata->rights, IMAP_ACL_WRITE) ||
668 mutt_bit_isset(idata->rights, IMAP_ACL_INSERT)))
671 /* assume we have all rights if ACL is unavailable */
674 mutt_bit_set (idata->rights, IMAP_ACL_LOOKUP);
675 mutt_bit_set (idata->rights, IMAP_ACL_READ);
676 mutt_bit_set (idata->rights, IMAP_ACL_SEEN);
677 mutt_bit_set (idata->rights, IMAP_ACL_WRITE);
678 mutt_bit_set (idata->rights, IMAP_ACL_INSERT);
679 mutt_bit_set (idata->rights, IMAP_ACL_POST);
680 mutt_bit_set (idata->rights, IMAP_ACL_CREATE);
681 mutt_bit_set (idata->rights, IMAP_ACL_DELETE);
685 ctx->hdrs = safe_calloc (count, sizeof (HEADER *));
686 ctx->v2r = safe_calloc (count, sizeof (int));
688 if (count && (imap_read_headers (idata, 0, count-1) < 0))
690 mutt_error _("Error opening mailbox");
695 dprint (2, (debugfile, "imap_open_mailbox: 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], mbox[LONG_STRING];
712 char mailbox[LONG_STRING];
716 if (imap_parse_path (ctx->path, &mx))
719 /* in APPEND mode, we appear to hijack an existing IMAP connection -
720 * ctx is brand new and mostly empty */
722 if (!(idata = imap_conn_find (&(mx.account), 0)))
729 /* check mailbox existance */
731 imap_fix_path (idata, mx.mbox, mailbox, sizeof (mailbox));
733 imap_munge_mbox_name (mbox, sizeof (mbox), mailbox);
735 if (mutt_bit_isset(idata->capabilities,IMAP4REV1))
736 snprintf (buf, sizeof (buf), "STATUS %s (UIDVALIDITY)", mbox);
737 else if (mutt_bit_isset(idata->capabilities,STATUS))
738 /* We have no idea what the other guy wants. UW imapd 8.3 wants this
739 * (but it does not work if another mailbox is selected) */
740 snprintf (buf, sizeof (buf), "STATUS %s (UID-VALIDITY)", mbox);
743 /* STATUS not supported */
744 mutt_message _("Unable to append to IMAP mailboxes at this server");
749 r = imap_exec (idata, buf, IMAP_CMD_FAIL_OK);
752 /* command failed cause folder doesn't exist */
753 snprintf (buf, sizeof (buf), _("Create %s?"), mailbox);
754 if (option (OPTCONFIRMCREATE) && mutt_yesorno (buf, 1) < 1)
757 if (imap_create_mailbox (idata, mailbox) < 0)
761 /* Hmm, some other failure */
772 /* imap_logout: Gracefully log out of server. */
773 void imap_logout (IMAP_DATA* idata)
775 /* we set status here to let imap_handle_untagged know we _expect_ to
776 * receive a bye response (so it doesn't freak out and close the conn) */
777 idata->status = IMAP_BYE;
778 imap_cmd_start (idata, "LOGOUT");
779 while (imap_cmd_step (idata) == IMAP_CMD_CONTINUE)
783 int imap_close_connection (CONTEXT *ctx)
785 dprint (1, (debugfile, "imap_close_connection(): closing connection\n"));
786 /* if the server didn't shut down on us, close the connection gracefully */
787 if (CTX_DATA->status != IMAP_BYE)
789 mutt_message _("Closing connection to IMAP server...");
790 imap_logout (CTX_DATA);
793 mutt_socket_close (CTX_DATA->conn);
794 CTX_DATA->state = IMAP_DISCONNECTED;
795 CTX_DATA->conn->data = NULL;
799 /* imap_set_flag: append str to flags if we currently have permission
800 * according to aclbit */
801 static void imap_set_flag (IMAP_DATA* idata, int aclbit, int flag,
802 const char *str, char *flags, size_t flsize)
804 if (mutt_bit_isset (idata->rights, aclbit))
806 strncat (flags, str, flsize);
809 /* imap_make_msg_set: make an IMAP4rev1 UID message set out of a set of
810 * headers, given a flag enum to filter on.
811 * Params: idata: IMAP_DATA containing context containing header set
812 * buf: to write message set into
813 * buflen: length of buffer
814 * flag: enum of flag type on which to filter
815 * changed: include only changed messages in message set
816 * Returns: number of messages in message set (0 if no matches) */
817 int imap_make_msg_set (IMAP_DATA* idata, BUFFER* buf, int flag, int changed)
819 HEADER** hdrs; /* sorted local copy */
820 int count = 0; /* number of messages in message set */
821 int match = 0; /* whether current message matches flag condition */
822 unsigned int setstart = 0; /* start of current message range */
824 short oldsort; /* we clobber reverse, must restore it */
825 /* assuming 32-bit UIDs */
829 /* make copy of header pointers to sort in natural order */
830 hdrs = safe_calloc (idata->ctx->msgcount, sizeof (HEADER*));
831 memcpy (hdrs, idata->ctx->hdrs, idata->ctx->msgcount * sizeof (HEADER*));
833 if (Sort != SORT_ORDER)
837 qsort ((void*) hdrs, idata->ctx->msgcount, sizeof (HEADER*),
838 mutt_get_sort_func (SORT_ORDER));
842 for (n = 0; n < idata->ctx->msgcount; n++)
845 /* don't include pending expunged messages */
850 if (hdrs[n]->deleted)
859 if (match && (!changed || hdrs[n]->changed))
864 setstart = HEADER_DATA (hdrs[n])->uid;
867 snprintf (uid, sizeof (uid), "%u", HEADER_DATA (hdrs[n])->uid);
868 mutt_buffer_addstr (buf, uid);
873 snprintf (uid, sizeof (uid), ",%u", HEADER_DATA (hdrs[n])->uid);
874 mutt_buffer_addstr (buf, uid);
877 /* tie up if the last message also matches */
878 else if (n == idata->ctx->msgcount-1)
880 snprintf (uid, sizeof (uid), ":%u", HEADER_DATA (hdrs[n])->uid);
881 mutt_buffer_addstr (buf, uid);
884 /* this message is not expunged and doesn't match. End current set. */
885 else if (setstart && hdrs[n]->active)
887 if (HEADER_DATA (hdrs[n-1])->uid > setstart)
889 snprintf (uid, sizeof (uid), ":%u", HEADER_DATA (hdrs[n-1])->uid);
890 mutt_buffer_addstr (buf, uid);
901 /* update the IMAP server to reflect message changes done within mutt.
903 * ctx: the current context
904 * expunge: 0 or 1 - do expunge?
907 int imap_sync_mailbox (CONTEXT* ctx, int expunge, int* index_hint)
910 CONTEXT* appendctx = NULL;
912 char flags[LONG_STRING];
916 int err_continue = M_NO; /* continue on error? */
919 idata = (IMAP_DATA*) ctx->data;
921 if (idata->state != IMAP_SELECTED)
923 dprint (2, (debugfile, "imap_sync_mailbox: no mailbox selected\n"));
927 /* CLOSE purges deleted messages. If we don't want to purge them, we must
928 * tell imap_close_mailbox not to issue the CLOSE command */
934 /* This function is only called when the calling code expects the context
936 imap_allow_reopen (ctx);
938 if ((rc = imap_check_mailbox (ctx, index_hint, 0)) != 0)
941 memset (&cmd, 0, sizeof (cmd));
943 /* if we are expunging anyway, we can do deleted messages very quickly... */
944 if (expunge && mutt_bit_isset (idata->rights, IMAP_ACL_DELETE))
946 mutt_buffer_addstr (&cmd, "UID STORE ");
947 deleted = imap_make_msg_set (idata, &cmd, M_DELETE, 1);
949 /* if we have a message set, then let's delete */
952 mutt_message (_("Marking %d messages deleted..."), deleted);
953 mutt_buffer_addstr (&cmd, " +FLAGS.SILENT (\\Deleted)");
954 /* mark these messages as unchanged so second pass ignores them. Done
955 * here so BOGUS UW-IMAP 4.7 SILENT FLAGS updates are ignored. */
956 for (n = 0; n < ctx->msgcount; n++)
957 if (ctx->hdrs[n]->deleted && ctx->hdrs[n]->changed)
958 ctx->hdrs[n]->active = 0;
959 if (imap_exec (idata, cmd.data, 0) != 0)
961 mutt_error (_("Expunge failed"));
969 /* save status changes */
970 for (n = 0; n < ctx->msgcount; n++)
972 if (ctx->hdrs[n]->active && ctx->hdrs[n]->changed)
974 ctx->hdrs[n]->changed = 0;
976 mutt_message (_("Saving message status flags... [%d/%d]"), n+1,
979 snprintf (uid, sizeof (uid), "%u", HEADER_DATA(ctx->hdrs[n])->uid);
981 mutt_buffer_addstr (&cmd, "UID STORE ");
982 mutt_buffer_addstr (&cmd, uid);
984 /* if attachments have been deleted we delete the message and reupload
985 * it. This works better if we're expunging, of course. */
986 if (ctx->hdrs[n]->attach_del)
988 dprint (3, (debugfile, "imap_sync_mailbox: Attachments to be deleted, falling back to _mutt_save_message\n"));
990 appendctx = mx_open_mailbox (ctx->path, M_APPEND | M_QUIET, NULL);
993 dprint (1, (debugfile, "imap_sync_mailbox: Error opening mailbox in append mode\n"));
996 _mutt_save_message (ctx->hdrs[n], appendctx, 1, 0, 0);
1000 imap_set_flag (idata, IMAP_ACL_SEEN, ctx->hdrs[n]->read, "\\Seen ",
1001 flags, sizeof (flags));
1002 imap_set_flag (idata, IMAP_ACL_WRITE, ctx->hdrs[n]->flagged,
1003 "\\Flagged ", flags, sizeof (flags));
1004 imap_set_flag (idata, IMAP_ACL_WRITE, ctx->hdrs[n]->replied,
1005 "\\Answered ", flags, sizeof (flags));
1006 imap_set_flag (idata, IMAP_ACL_DELETE, ctx->hdrs[n]->deleted,
1007 "\\Deleted ", flags, sizeof (flags));
1009 /* now make sure we don't lose custom tags */
1010 if (mutt_bit_isset (idata->rights, IMAP_ACL_WRITE))
1011 imap_add_keywords (flags, ctx->hdrs[n], idata->flags, sizeof (flags));
1013 mutt_remove_trailing_ws (flags);
1015 /* UW-IMAP is OK with null flags, Cyrus isn't. The only solution is to
1016 * explicitly revoke all system flags (if we have permission) */
1019 imap_set_flag (idata, IMAP_ACL_SEEN, 1, "\\Seen ", flags, sizeof (flags));
1020 imap_set_flag (idata, IMAP_ACL_WRITE, 1, "\\Flagged ", flags, sizeof (flags));
1021 imap_set_flag (idata, IMAP_ACL_WRITE, 1, "\\Answered ", flags, sizeof (flags));
1022 imap_set_flag (idata, IMAP_ACL_DELETE, 1, "\\Deleted ", flags, sizeof (flags));
1024 mutt_remove_trailing_ws (flags);
1026 mutt_buffer_addstr (&cmd, " -FLAGS.SILENT (");
1029 mutt_buffer_addstr (&cmd, " FLAGS.SILENT (");
1031 mutt_buffer_addstr (&cmd, flags);
1032 mutt_buffer_addstr (&cmd, ")");
1034 /* dumb hack for bad UW-IMAP 4.7 servers spurious FLAGS updates */
1035 ctx->hdrs[n]->active = 0;
1037 /* after all this it's still possible to have no flags, if you
1038 * have no ACL rights */
1039 if (*flags && (imap_exec (idata, cmd.data, 0) != 0) &&
1040 (err_continue != M_YES))
1042 err_continue = imap_continue ("imap_sync_mailbox: STORE failed",
1044 if (err_continue != M_YES)
1051 ctx->hdrs[n]->active = 1;
1056 /* We must send an EXPUNGE command if we're not closing. */
1057 if (expunge && !(ctx->closing) &&
1058 mutt_bit_isset(idata->rights, IMAP_ACL_DELETE))
1060 mutt_message _("Expunging messages from server...");
1061 /* Set expunge bit so we don't get spurious reopened messages */
1062 idata->reopen |= IMAP_EXPUNGE_EXPECTED;
1063 if (imap_exec (idata, "EXPUNGE", 0) != 0)
1065 imap_error (_("imap_sync_mailbox: EXPUNGE failed"), idata->cmd.buf);
1077 mx_fastclose_mailbox (appendctx);
1083 /* imap_close_mailbox: issue close command if neccessary, reset IMAP_DATA */
1084 void imap_close_mailbox (CONTEXT* ctx)
1089 idata = (IMAP_DATA*) ctx->data;
1090 /* Check to see if the mailbox is actually open */
1094 if ((idata->status != IMAP_FATAL) &&
1095 (idata->state == IMAP_SELECTED) &&
1096 (ctx == idata->ctx))
1098 if (!(idata->noclose) && imap_exec (idata, "CLOSE", 0))
1099 mutt_error (_("CLOSE failed"));
1101 idata->reopen &= IMAP_REOPEN_ALLOW;
1102 idata->state = IMAP_AUTHENTICATED;
1103 FREE (&(idata->mailbox));
1104 mutt_free_list (&idata->flags);
1108 /* free IMAP part of headers */
1109 for (i = 0; i < ctx->msgcount; i++)
1110 imap_free_header_data (&(ctx->hdrs[i]->data));
1112 for (i = 0; i < IMAP_CACHE_LEN; i++)
1114 if (idata->cache[i].path)
1116 unlink (idata->cache[i].path);
1117 FREE (&idata->cache[i].path);
1122 /* use the NOOP command to poll for new mail
1125 * M_REOPENED mailbox has been externally modified
1126 * M_NEW_MAIL new mail has arrived!
1130 int imap_check_mailbox (CONTEXT *ctx, int *index_hint, int force)
1132 /* overload keyboard timeout to avoid many mailbox checks in a row.
1133 * Most users don't like having to wait exactly when they press a key. */
1137 idata = (IMAP_DATA*) ctx->data;
1139 if ((force || time(NULL) > idata->lastread + Timeout)
1140 && imap_exec (idata, "NOOP", 0) != 0)
1143 /* We call this even when we haven't run NOOP in case we have pending
1144 * changes to process, since we can reopen here. */
1145 imap_cmd_finish (idata);
1147 if (idata->check_status & IMAP_EXPUNGE_PENDING)
1148 result = M_REOPENED;
1149 else if (idata->check_status & IMAP_NEWMAIL_PENDING)
1150 result = M_NEW_MAIL;
1151 else if (idata->check_status & IMAP_FLAGS_PENDING)
1154 idata->check_status = 0;
1159 /* returns count of recent messages if new = 1, else count of total messages.
1160 * (useful for at least postponed function)
1161 * Question of taste: use RECENT or UNSEEN for new?
1162 * 0+ number of messages in mailbox
1163 * -1 error while polling mailboxes
1165 int imap_mailbox_check (char* path, int new)
1169 char buf[LONG_STRING];
1170 char mbox[LONG_STRING];
1171 char mbox_unquoted[LONG_STRING];
1178 if (imap_parse_path (path, &mx))
1181 /* If imap_passive is set, don't open a connection to check for new mail */
1182 if (option (OPTIMAPPASSIVE))
1183 connflags = M_IMAP_CONN_NONEW;
1185 if (!(idata = imap_conn_find (&(mx.account), connflags)))
1192 imap_fix_path (idata, mx.mbox, buf, sizeof (buf));
1195 imap_munge_mbox_name (mbox, sizeof(mbox), buf);
1196 strfcpy (mbox_unquoted, buf, sizeof (mbox_unquoted));
1198 /* The draft IMAP implementor's guide warns againts using the STATUS
1199 * command on a mailbox that you have selected
1202 if (mutt_strcmp (mbox_unquoted, idata->mailbox) == 0
1203 || (ascii_strcasecmp (mbox_unquoted, "INBOX") == 0
1204 && mutt_strcasecmp (mbox_unquoted, idata->mailbox) == 0))
1206 strfcpy (buf, "NOOP", sizeof (buf));
1208 else if (mutt_bit_isset(idata->capabilities,IMAP4REV1) ||
1209 mutt_bit_isset(idata->capabilities,STATUS))
1211 snprintf (buf, sizeof (buf), "STATUS %s (%s)", mbox,
1212 new ? "RECENT" : "MESSAGES");
1215 /* Server does not support STATUS, and this is not the current mailbox.
1216 * There is no lightweight way to check recent arrivals */
1219 imap_cmd_start (idata, buf);
1223 if ((rc = imap_cmd_step (idata)) != IMAP_CMD_CONTINUE)
1226 s = imap_next_word (idata->cmd.buf);
1227 if (ascii_strncasecmp ("STATUS", s, 6) == 0)
1229 s = imap_next_word (s);
1230 /* The mailbox name may or may not be quoted here. We could try to
1231 * munge the server response and compare with quoted (or vise versa)
1232 * but it is probably more efficient to just strncmp against both. */
1233 if (mutt_strncmp (mbox_unquoted, s, mutt_strlen (mbox_unquoted)) == 0
1234 || mutt_strncmp (mbox, s, mutt_strlen (mbox)) == 0)
1236 s = imap_next_word (s);
1237 s = imap_next_word (s);
1238 if (isdigit ((unsigned char) *s))
1243 dprint (2, (debugfile, "%d new messages in %s\n", msgcount, path));
1248 dprint (1, (debugfile, "imap_mailbox_check: STATUS response doesn't match requested mailbox.\n"));
1251 while (rc == IMAP_CMD_CONTINUE);
1256 /* all this listing/browsing is a mess. I don't like that name is a pointer
1257 * into idata->buf (used to be a pointer into the passed in buffer, just
1258 * as bad), nor do I like the fact that the fetch is done here. This
1259 * code can't possibly handle non-LIST untagged responses properly.
1261 int imap_parse_list_response(IMAP_DATA* idata, char **name, int *noselect,
1262 int *noinferiors, char *delim)
1270 rc = imap_cmd_step (idata);
1271 if (rc == IMAP_CMD_OK)
1273 if (rc != IMAP_CMD_CONTINUE)
1276 s = imap_next_word (idata->cmd.buf);
1277 if ((ascii_strncasecmp ("LIST", s, 4) == 0) ||
1278 (ascii_strncasecmp ("LSUB", s, 4) == 0))
1283 s = imap_next_word (s); /* flags */
1290 while (*ep && *ep != ')') ep++;
1293 if (!ascii_strncasecmp (s, "\\NoSelect", 9))
1295 if (!ascii_strncasecmp (s, "\\NoInferiors", 12))
1297 /* See draft-gahrns-imap-child-mailbox-?? */
1298 if (!ascii_strncasecmp (s, "\\HasNoChildren", 14))
1302 while (*s && *s != '\\' && *s != ')') s++;
1307 s = imap_next_word (s); /* delim */
1308 /* Reset the delimiter, this can change */
1309 if (ascii_strncasecmp (s, "NIL", 3))
1311 if (s && s[0] == '\"' && s[1] && s[2] == '\"')
1313 else if (s && s[0] == '\"' && s[1] && s[1] == '\\' && s[2] && s[3] == '\"')
1316 s = imap_next_word (s); /* name */
1317 if (s && *s == '{') /* Literal */
1319 if (imap_get_literal_count(idata->cmd.buf, &bytes) < 0)
1321 if (imap_cmd_step (idata) != IMAP_CMD_CONTINUE)
1323 *name = idata->cmd.buf;
1332 int imap_subscribe (char *path, int subscribe)
1336 char buf[LONG_STRING];
1337 char mbox[LONG_STRING];
1340 if (!mx_is_imap (path) || imap_parse_path (path, &mx))
1342 mutt_error (_("Bad mailbox name"));
1347 if (!(idata = imap_conn_find (&(mx.account), 0)))
1352 imap_fix_path (idata, mx.mbox, buf, sizeof (buf));
1354 mutt_message (_("Subscribing to %s..."), buf);
1356 mutt_message (_("Unsubscribing to %s..."), buf);
1357 imap_munge_mbox_name (mbox, sizeof(mbox), buf);
1359 snprintf (buf, sizeof (buf), "%s %s", subscribe ? "SUBSCRIBE" :
1360 "UNSUBSCRIBE", mbox);
1362 if (imap_exec (idata, buf, 0) < 0)
1373 /* imap_complete: given a partial IMAP folder path, return a string which
1374 * adds as much to the path as is unique */
1375 int imap_complete(char* dest, size_t dlen, char* path) {
1378 char list[LONG_STRING];
1379 char buf[LONG_STRING];
1380 char* list_word = NULL;
1381 int noselect, noinferiors;
1383 char completion[LONG_STRING];
1384 int clen, matchlen = 0;
1385 int completions = 0;
1389 /* verify passed in path is an IMAP path */
1390 if (imap_parse_path (path, &mx))
1392 dprint(2, (debugfile, "imap_complete: bad path %s\n", path));
1396 /* don't open a new socket just for completion */
1397 if (!(idata = imap_conn_find (&(mx.account), M_IMAP_CONN_NONEW)))
1401 /* reformat path for IMAP list, and append wildcard */
1402 /* don't use INBOX in place of "" */
1403 if (mx.mbox && mx.mbox[0])
1404 imap_fix_path (idata, mx.mbox, list, sizeof(list));
1408 /* fire off command */
1409 snprintf (buf, sizeof(buf), "%s \"\" \"%s%%\"",
1410 option (OPTIMAPLSUB) ? "LSUB" : "LIST", list);
1412 imap_cmd_start (idata, buf);
1414 /* and see what the results are */
1415 strfcpy (completion, NONULL(mx.mbox), sizeof(completion));
1418 if (imap_parse_list_response(idata, &list_word, &noselect, &noinferiors,
1424 /* store unquoted */
1425 imap_unmunge_mbox_name (list_word);
1427 /* if the folder isn't selectable, append delimiter to force browse
1428 * to enter it on second tab. */
1431 clen = strlen(list_word);
1432 list_word[clen++] = delim;
1433 list_word[clen] = '\0';
1435 /* copy in first word */
1438 strfcpy (completion, list_word, sizeof(completion));
1439 matchlen = strlen (completion);
1445 while (pos < matchlen && list_word[pos] &&
1446 completion[pos] == list_word[pos])
1448 completion[pos] = '\0';
1454 while (ascii_strncmp(idata->cmd.seq, idata->cmd.buf, SEQLEN));
1458 /* reformat output */
1459 imap_qualify_path (dest, dlen, &mx, completion);
1460 mutt_pretty_mailbox (dest);