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. */
14 #include <lib-lib/lib-lib.h>
15 #include <lib-mx/mx.h>
23 #include "imap_private.h"
26 /* imap forward declarations */
27 static int imap_get_delim (IMAP_DATA * idata);
28 static char *imap_get_flags (string_list_t ** hflags, char *s);
29 static int imap_check_acl (IMAP_DATA * idata);
30 static int imap_check_capabilities (IMAP_DATA * idata);
31 static void imap_set_flag (IMAP_DATA * idata, int aclbit, int flag,
32 const char *str, char *flags, size_t flsize);
34 /* imap_access: Check permissions on an IMAP mailbox.
35 * TODO: ACL checks. Right now we assume if it exists we can
37 static int imap_access (const char *path, int flags __attribute__ ((unused)))
41 char buf[LONG_STRING];
42 char mailbox[LONG_STRING];
43 char mbox[LONG_STRING];
45 if (imap_parse_path (path, &mx))
48 if (!(idata = imap_conn_find (&mx.account,
49 option (OPTIMAPPASSIVE) ? M_IMAP_CONN_NONEW :
55 imap_fix_path (idata, mx.mbox, mailbox, sizeof (mailbox));
57 /* we may already be in the folder we're checking */
58 if (!m_strcmp(idata->mailbox, mx.mbox)) {
64 imap_munge_mbox_name (mbox, sizeof (mbox), mailbox);
66 if (mutt_bit_isset (idata->capabilities, IMAP4REV1))
67 snprintf (buf, sizeof (buf), "STATUS %s (UIDVALIDITY)", mbox);
68 else if (mutt_bit_isset (idata->capabilities, STATUS))
69 snprintf (buf, sizeof (buf), "STATUS %s (UID-VALIDITY)", mbox);
74 if (imap_exec (idata, buf, IMAP_CMD_FAIL_OK) < 0) {
81 int imap_create_mailbox (IMAP_DATA * idata, char *mailbox)
83 char buf[LONG_STRING], mbox[LONG_STRING];
85 imap_munge_mbox_name (mbox, sizeof (mbox), mailbox);
86 snprintf (buf, sizeof (buf), "CREATE %s", mbox);
88 if (imap_exec (idata, buf, 0) != 0)
94 int imap_rename_mailbox (IMAP_DATA * idata, IMAP_MBOX * mx,
97 char oldmbox[LONG_STRING];
98 char newmbox[LONG_STRING];
99 char buf[LONG_STRING];
101 imap_munge_mbox_name (oldmbox, sizeof (oldmbox), mx->mbox);
102 imap_munge_mbox_name (newmbox, sizeof (newmbox), newname);
104 snprintf (buf, sizeof (buf), "RENAME %s %s", oldmbox, newmbox);
106 if (imap_exec (idata, buf, 0) != 0)
112 int imap_delete_mailbox (CONTEXT * ctx, IMAP_MBOX mx)
114 char buf[LONG_STRING], mbox[LONG_STRING];
117 if (!ctx || !ctx->data) {
118 if (!(idata = imap_conn_find (&mx.account,
119 option (OPTIMAPPASSIVE) ? M_IMAP_CONN_NONEW
129 imap_munge_mbox_name (mbox, sizeof (mbox), mx.mbox);
130 snprintf (buf, sizeof (buf), "DELETE %s", mbox);
132 if (imap_exec ((IMAP_DATA *) idata, buf, 0) != 0)
138 /* imap_logout_all: close all open connections. Quick and dirty until we can
139 * make sure we've got all the context we need. */
140 void imap_logout_all (void)
145 conn = mutt_socket_head ();
150 if (conn->account.type == M_ACCT_TYPE_IMAP && conn->fd >= 0) {
151 mutt_message (_("Closing connection to %s..."), conn->account.host);
152 imap_logout ((IMAP_DATA *) conn->data);
154 mutt_socket_close (conn);
155 mutt_socket_free (conn);
162 /* imap_read_literal: read bytes bytes from server into file. Not explicitly
163 * buffered, relies on FILE buffering. NOTE: strips \r from \r\n.
164 * Apparently even literals use \r\n-terminated strings ?! */
165 int imap_read_literal (FILE * fp, IMAP_DATA * idata, long bytes, progress_t* bar)
172 for (pos = 0; pos < bytes; pos++) {
173 if (mutt_socket_readchar (idata->conn, &c) != 1) {
174 idata->status = IMAP_FATAL;
179 if (r == 1 && c != '\n')
190 if (bar && !(pos % 1024))
191 mutt_progress_bar (bar, pos);
197 /* imap_expunge_mailbox: Purge IMAP portion of expunged messages from the
198 * context. Must not be done while something has a handle on any headers
199 * (eg inside pager or editor). That is, check IMAP_REOPEN_ALLOW. */
200 void imap_expunge_mailbox (IMAP_DATA * idata)
205 for (i = 0; i < idata->ctx->msgcount; i++) {
206 h = idata->ctx->hdrs[i];
208 if (h->index == -1) {
211 /* free cached body from disk, if neccessary */
212 cacheno = HEADER_DATA (h)->uid % IMAP_CACHE_LEN;
213 if (idata->cache[cacheno].uid == HEADER_DATA (h)->uid &&
214 idata->cache[cacheno].path) {
215 unlink (idata->cache[cacheno].path);
216 p_delete(&idata->cache[cacheno].path);
219 imap_free_header_data (&h->data);
223 /* We may be called on to expunge at any time. We can't rely on the caller
224 * to always know to rethread */
225 mx_update_tables (idata->ctx, 0);
226 mutt_sort_headers (idata->ctx, 1);
229 static int imap_get_delim (IMAP_DATA * idata)
234 /* assume that the delim is /. If this fails, we're in bigger trouble
235 * than getting the delim wrong */
238 imap_cmd_start (idata, "LIST\"\" \"\"");
241 if ((rc = imap_cmd_step (idata)) != IMAP_CMD_CONTINUE)
244 s = imap_next_word (idata->cmd.buf);
245 if (ascii_strncasecmp ("LIST", s, 4) == 0) {
246 s = imap_next_word (s);
247 s = imap_next_word (s);
248 if (s && s[0] == '\"' && s[1] && s[2] == '\"')
250 else if (s && s[0] == '\"' && s[1] && s[1] == '\\' && s[2]
255 while (rc == IMAP_CMD_CONTINUE);
260 /* get rights for folder, let imap_handle_untagged do the rest */
261 static int imap_check_acl (IMAP_DATA * idata)
263 char buf[LONG_STRING];
264 char mbox[LONG_STRING];
266 imap_munge_mbox_name (mbox, sizeof (mbox), idata->mailbox);
267 snprintf (buf, sizeof (buf), "MYRIGHTS %s", mbox);
268 if (imap_exec (idata, buf, 0) != 0) {
269 imap_error ("imap_check_acl", buf);
275 /* imap_check_capabilities: make sure we can log in to this server. */
276 static int imap_check_capabilities (IMAP_DATA * idata)
278 if (imap_exec (idata, "CAPABILITY", 0) != 0) {
279 imap_error ("imap_check_capabilities", idata->cmd.buf);
283 if (!(mutt_bit_isset (idata->capabilities, IMAP4)
284 || mutt_bit_isset (idata->capabilities, IMAP4REV1))) {
285 mutt_error _("This IMAP server is ancient. Mutt does not work with it.");
287 mutt_sleep (2); /* pause a moment to let the user see the error */
295 /* imap_conn_find: Find an open IMAP connection matching account, or open
296 * a new one if none can be found. */
297 IMAP_DATA *imap_conn_find (const ACCOUNT * account, int flags)
304 if (!(conn = mutt_conn_find (NULL, account)))
307 /* if opening a new UNSELECTED connection, preserve existing creds */
308 creds = &(conn->account);
310 /* make sure this connection is not in SELECTED state, if neccessary */
311 if (flags & M_IMAP_CONN_NOSELECT)
312 while (conn->data && ((IMAP_DATA *) conn->data)->state == IMAP_SELECTED) {
313 if (!(conn = mutt_conn_find (conn, account)))
315 memcpy (&(conn->account), creds, sizeof (ACCOUNT));
318 idata = (IMAP_DATA *) conn->data;
320 /* don't open a new connection if one isn't wanted */
321 if (flags & M_IMAP_CONN_NONEW) {
323 mutt_socket_free (conn);
326 if (idata->state < IMAP_AUTHENTICATED)
331 /* The current connection is a new connection */
332 if (!(idata = imap_new_idata ())) {
333 mutt_socket_free (conn);
342 if (idata->state == IMAP_DISCONNECTED)
343 imap_open_connection (idata);
344 if (idata->state == IMAP_CONNECTED) {
345 if (!imap_authenticate (idata)) {
346 idata->state = IMAP_AUTHENTICATED;
348 mutt_account_unsetpass (&idata->conn->account);
351 p_delete(&idata->capstr);
353 if (new && idata->state == IMAP_AUTHENTICATED) {
354 imap_get_delim (idata);
355 if (option (OPTIMAPCHECKSUBSCRIBED)) {
356 mutt_message _("Checking mailbox subscriptions");
357 imap_exec (idata, "LSUB \"\" \"*\"", 0);
364 int imap_open_connection (IMAP_DATA * idata)
366 char buf[LONG_STRING];
368 if (mutt_socket_open (idata->conn) < 0)
371 idata->state = IMAP_CONNECTED;
373 if (imap_cmd_step (idata) != IMAP_CMD_CONTINUE) {
374 mutt_socket_close (idata->conn);
375 idata->state = IMAP_DISCONNECTED;
379 if (ascii_strncasecmp ("* OK", idata->cmd.buf, 4) == 0) {
380 /* TODO: Parse new tagged CAPABILITY data (* OK [CAPABILITY...]) */
381 if (imap_check_capabilities (idata))
383 /* Attempt STARTTLS if available and desired. */
384 if (!idata->conn->ssf && (option(OPTSSLFORCETLS) ||
385 mutt_bit_isset (idata->capabilities, STARTTLS))) {
388 if (option (OPTSSLFORCETLS))
390 else if ((rc = query_quadoption (OPT_SSLSTARTTLS,
391 _("Secure connection with TLS?"))) == -1)
394 if ((rc = imap_exec (idata, "STARTTLS", IMAP_CMD_FAIL_OK)) == -1)
397 if (mutt_ssl_starttls (idata->conn))
399 mutt_error (_("Could not negotiate TLS connection"));
404 /* RFC 2595 demands we recheck CAPABILITY after TLS completes. */
405 if (imap_exec (idata, "CAPABILITY", 0))
412 if (option(OPTSSLFORCETLS) && ! idata->conn->ssf) {
413 mutt_error _("Encrypted connection unavailable");
418 else if (ascii_strncasecmp ("* PREAUTH", idata->cmd.buf, 9) == 0) {
419 idata->state = IMAP_AUTHENTICATED;
420 if (imap_check_capabilities (idata) != 0)
422 p_delete(&idata->capstr);
425 imap_error ("imap_open_connection()", buf);
432 mutt_socket_close (idata->conn);
433 idata->state = IMAP_DISCONNECTED;
435 p_delete(&idata->capstr);
439 /* imap_get_flags: Make a simple list out of a FLAGS response.
440 * return stream following FLAGS response */
441 static char *imap_get_flags (string_list_t ** hflags, char *s)
443 string_list_t *flags;
447 /* sanity-check string */
448 if (ascii_strncasecmp ("FLAGS", s, 5) != 0) {
451 s = vskipspaces(s + 5);
456 /* create list, update caller's flags handle */
457 flags = string_item_new();
460 while (*s && *s != ')') {
461 s = vskipspaces(s + 1);
463 while (*s && (*s != ')') && !ISSPACE (*s))
468 mutt_add_list (flags, flag_word);
472 /* note bad flags response */
474 string_list_wipe(hflags);
484 static int imap_open_mailbox (CONTEXT * ctx)
488 char buf[LONG_STRING];
489 char bufout[LONG_STRING];
494 if (imap_parse_path (ctx->path, &mx)) {
495 mutt_error (_("%s is an invalid IMAP path"), ctx->path);
499 /* we require a connection which isn't currently in IMAP_SELECTED state */
500 if (!(idata = imap_conn_find (&(mx.account), M_IMAP_CONN_NOSELECT)))
502 if (idata->state < IMAP_AUTHENTICATED)
507 /* once again the context is new */
510 /* Clean up path and replace the one in the ctx */
511 imap_fix_path (idata, mx.mbox, buf, sizeof (buf));
512 p_delete(&(idata->mailbox));
513 idata->mailbox = m_strdup(buf);
514 imap_qualify_path (buf, sizeof (buf), &mx, idata->mailbox);
516 p_delete(&(ctx->path));
517 ctx->path = m_strdup(buf);
521 /* clear mailbox status */
523 memset (idata->rights, 0, (RIGHTSMAX + 7) / 8);
524 idata->newMailCount = 0;
526 mutt_message (_("Selecting %s..."), idata->mailbox);
527 imap_munge_mbox_name (buf, sizeof (buf), idata->mailbox);
528 snprintf (bufout, sizeof (bufout), "%s %s",
529 ctx->readonly ? "EXAMINE" : "SELECT", buf);
531 idata->state = IMAP_SELECTED;
533 imap_cmd_start (idata, bufout);
538 if ((rc = imap_cmd_step (idata)) != IMAP_CMD_CONTINUE)
541 pc = idata->cmd.buf + 2;
543 /* Obtain list of available flags here, may be overridden by a
544 * PERMANENTFLAGS tag in the OK response */
545 if (ascii_strncasecmp ("FLAGS", pc, 5) == 0) {
546 /* don't override PERMANENTFLAGS */
548 if ((pc = imap_get_flags (&(idata->flags), pc)) == NULL)
552 /* PERMANENTFLAGS are massaged to look like FLAGS, then override FLAGS */
553 else if (ascii_strncasecmp ("OK [PERMANENTFLAGS", pc, 18) == 0) {
554 /* safe to call on NULL */
555 string_list_wipe(&(idata->flags));
556 /* skip "OK [PERMANENT" so syntax is the same as FLAGS */
558 if ((pc = imap_get_flags (&(idata->flags), pc)) == NULL)
562 /* save UIDVALIDITY for the header cache */
563 else if (ascii_strncasecmp ("OK [UIDVALIDITY", pc, 14) == 0) {
565 pc = imap_next_word (pc);
567 sscanf (pc, "%lu", &(idata->uid_validity));
571 pc = imap_next_word (pc);
572 if (!ascii_strncasecmp ("EXISTS", pc, 6)) {
573 count = idata->newMailCount;
574 idata->newMailCount = 0;
578 while (rc == IMAP_CMD_CONTINUE);
580 if (rc == IMAP_CMD_NO) {
583 s = imap_next_word (idata->cmd.buf); /* skip seq */
584 s = imap_next_word (s); /* Skip response */
585 mutt_error ("%s", s);
590 if (rc != IMAP_CMD_OK)
593 /* check for READ-ONLY notification */
594 if (!ascii_strncasecmp
595 (imap_get_qualifier (idata->cmd.buf), "[READ-ONLY]", 11)
596 && !mutt_bit_isset (idata->capabilities, ACL)) {
600 if (mutt_bit_isset (idata->capabilities, ACL)) {
601 if (imap_check_acl (idata))
603 if (!(mutt_bit_isset (idata->rights, ACL_DELETE) ||
604 mutt_bit_isset (idata->rights, ACL_SEEN) ||
605 mutt_bit_isset (idata->rights, ACL_WRITE) ||
606 mutt_bit_isset (idata->rights, ACL_INSERT)))
609 /* assume we have all rights if ACL is unavailable */
611 mutt_bit_set (idata->rights, ACL_LOOKUP);
612 mutt_bit_set (idata->rights, ACL_READ);
613 mutt_bit_set (idata->rights, ACL_SEEN);
614 mutt_bit_set (idata->rights, ACL_WRITE);
615 mutt_bit_set (idata->rights, ACL_INSERT);
616 mutt_bit_set (idata->rights, ACL_POST);
617 mutt_bit_set (idata->rights, ACL_CREATE);
618 mutt_bit_set (idata->rights, ACL_DELETE);
622 ctx->hdrs = p_new(HEADER *, count);
623 ctx->v2r = p_new(int, count);
625 if (count && (imap_read_headers (idata, 0, count - 1) < 0)) {
626 mutt_error _("Error opening mailbox");
636 if (idata->state == IMAP_SELECTED)
637 idata->state = IMAP_AUTHENTICATED;
643 int imap_open_mailbox_append (CONTEXT * ctx)
647 char buf[LONG_STRING];
648 char mailbox[LONG_STRING];
651 if (imap_parse_path (ctx->path, &mx))
654 /* in APPEND mode, we appear to hijack an existing IMAP connection -
655 * ctx is brand new and mostly empty */
657 if (!(idata = imap_conn_find (&(mx.account), 0))) {
666 imap_fix_path (idata, mx.mbox, mailbox, sizeof (mailbox));
670 /* really we should also check for W_OK */
671 if (!imap_access (ctx->path, F_OK))
674 snprintf (buf, sizeof (buf), _("Create %s?"), mailbox);
675 if (option (OPTCONFIRMCREATE) && mutt_yesorno (buf, 1) < 1)
678 if (imap_create_mailbox (idata, mailbox) < 0)
684 /* imap_logout: Gracefully log out of server. */
685 void imap_logout (IMAP_DATA * idata)
687 /* we set status here to let imap_handle_untagged know we _expect_ to
688 * receive a bye response (so it doesn't freak out and close the conn) */
689 idata->status = IMAP_BYE;
690 imap_cmd_start (idata, "LOGOUT");
691 while (imap_cmd_step (idata) == IMAP_CMD_CONTINUE);
692 p_delete(&idata->cmd.buf);
697 int imap_close_connection (CONTEXT *ctx)
699 if (CTX_DATA->status != IMAP_BYE)
701 mutt_message _("Closing connection to IMAP server...");
702 imap_logout (CTX_DATA);
705 mutt_socket_close (CTX_DATA->conn);
706 CTX_DATA->state = IMAP_DISCONNECTED;
707 CTX_DATA->conn->data = NULL;
712 /* imap_set_flag: append str to flags if we currently have permission
713 * according to aclbit */
714 static void imap_set_flag(IMAP_DATA *idata, int aclbit, int flag,
715 const char *str, char *flags, size_t flsize)
717 if (mutt_bit_isset(idata->rights, aclbit)) {
719 m_strcat(flags, flsize, str);
723 /* imap_make_msg_set: make an IMAP4rev1 UID message set out of a set of
724 * headers, given a flag enum to filter on.
725 * Params: idata: IMAP_DATA containing context containing header set
726 * buf: to write message set into
727 * buflen: length of buffer
728 * flag: enum of flag type on which to filter
729 * changed: include only changed messages in message set
730 * Returns: number of messages in message set (0 if no matches) */
731 int imap_make_msg_set (IMAP_DATA * idata, BUFFER * buf, int flag, int changed)
733 HEADER **hdrs; /* sorted local copy */
734 int count = 0; /* number of messages in message set */
735 int match = 0; /* whether current message matches flag condition */
736 int setstart = 0; /* start of current message range */
738 short oldsort; /* we clobber reverse, must restore it */
740 /* assuming 32-bit UIDs */
744 /* make copy of header pointers to sort in natural order */
745 hdrs = p_dup(idata->ctx->hdrs, idata->ctx->msgcount);
747 if (Sort != SORT_ORDER) {
750 qsort ((void *) hdrs, idata->ctx->msgcount, sizeof (HEADER *),
751 mutt_get_sort_func (SORT_ORDER));
755 for (n = 0; n < idata->ctx->msgcount; n++) {
757 /* don't include pending expunged messages */
761 if (hdrs[n]->deleted)
770 if (match && (!changed || hdrs[n]->changed)) {
773 setstart = HEADER_DATA (hdrs[n])->uid;
775 snprintf (uid, sizeof (uid), "%u", HEADER_DATA (hdrs[n])->uid);
776 mutt_buffer_addstr (buf, uid);
780 snprintf (uid, sizeof (uid), ",%u", HEADER_DATA (hdrs[n])->uid);
781 mutt_buffer_addstr (buf, uid);
784 /* tie up if the last message also matches */
785 else if (n == idata->ctx->msgcount - 1) {
786 snprintf (uid, sizeof (uid), ":%u", HEADER_DATA (hdrs[n])->uid);
787 mutt_buffer_addstr (buf, uid);
790 /* this message is not expunged and doesn't match. End current set. */
791 else if (setstart && hdrs[n]->active) {
792 if (HEADER_DATA (hdrs[n - 1])->uid > setstart) {
793 snprintf (uid, sizeof (uid), ":%u", HEADER_DATA (hdrs[n - 1])->uid);
794 mutt_buffer_addstr (buf, uid);
805 /* Update the IMAP server to reflect the flags a single message. */
807 int imap_sync_message (IMAP_DATA *idata, HEADER *hdr, BUFFER *cmd,
810 char flags[LONG_STRING];
815 snprintf (uid, sizeof (uid), "%u", HEADER_DATA(hdr)->uid);
816 cmd->dptr = cmd->data;
817 mutt_buffer_addstr (cmd, "UID STORE ");
818 mutt_buffer_addstr (cmd, uid);
822 imap_set_flag (idata, ACL_SEEN, hdr->read, "\\Seen ",
823 flags, sizeof (flags));
824 imap_set_flag (idata, ACL_WRITE, hdr->flagged,
825 "\\Flagged ", flags, sizeof (flags));
826 imap_set_flag (idata, ACL_WRITE, hdr->replied,
827 "\\Answered ", flags, sizeof (flags));
828 imap_set_flag (idata, ACL_DELETE, hdr->deleted,
829 "\\Deleted ", flags, sizeof (flags));
831 /* now make sure we don't lose custom tags */
832 if (mutt_bit_isset (idata->rights, ACL_WRITE))
833 imap_add_keywords (flags, hdr, idata->flags, sizeof (flags));
837 /* UW-IMAP is OK with null flags, Cyrus isn't. The only solution is to
838 * explicitly revoke all system flags (if we have permission) */
841 imap_set_flag (idata, ACL_SEEN, 1, "\\Seen ", flags, sizeof (flags));
842 imap_set_flag (idata, ACL_WRITE, 1, "\\Flagged ", flags, sizeof (flags));
843 imap_set_flag (idata, ACL_WRITE, 1, "\\Answered ", flags, sizeof (flags));
844 imap_set_flag (idata, ACL_DELETE, 1, "\\Deleted ", flags, sizeof (flags));
848 mutt_buffer_addstr (cmd, " -FLAGS.SILENT (");
850 mutt_buffer_addstr (cmd, " FLAGS.SILENT (");
852 mutt_buffer_addstr (cmd, flags);
853 mutt_buffer_addstr (cmd, ")");
855 /* dumb hack for bad UW-IMAP 4.7 servers spurious FLAGS updates */
858 /* after all this it's still possible to have no flags, if you
859 * have no ACL rights */
860 if (*flags && (imap_exec (idata, cmd->data, 0) != 0) &&
861 err_continue && (*err_continue != M_YES))
863 *err_continue = imap_continue ("imap_sync_message: STORE failed",
865 if (*err_continue != M_YES)
870 idata->ctx->changed--;
875 /* update the IMAP server to reflect message changes done within mutt.
877 * ctx: the current context
878 * expunge: 0 or 1 - do expunge?
881 int imap_sync_mailbox (CONTEXT * ctx, int expunge, int *index_hint)
884 CONTEXT *appendctx = NULL;
888 int err_continue = M_NO; /* continue on error? */
891 idata = (IMAP_DATA *) ctx->data;
893 if (idata->state != IMAP_SELECTED) {
897 /* This function is only called when the calling code expects the context
899 imap_allow_reopen (ctx);
901 if ((rc = imap_check_mailbox (ctx, index_hint, 0)) != 0)
906 /* if we are expunging anyway, we can do deleted messages very quickly... */
907 if (expunge && mutt_bit_isset (idata->rights, ACL_DELETE)) {
908 mutt_buffer_addstr (&cmd, "UID STORE ");
909 deleted = imap_make_msg_set (idata, &cmd, M_DELETE, 1);
911 /* if we have a message set, then let's delete */
913 mutt_message (_("Marking %d messages deleted..."), deleted);
914 mutt_buffer_addstr (&cmd, " +FLAGS.SILENT (\\Deleted)");
915 /* mark these messages as unchanged so second pass ignores them. Done
916 * here so BOGUS UW-IMAP 4.7 SILENT FLAGS updates are ignored. */
917 for (n = 0; n < ctx->msgcount; n++)
918 if (ctx->hdrs[n]->deleted && ctx->hdrs[n]->changed)
919 ctx->hdrs[n]->active = 0;
920 if (imap_exec (idata, cmd.data, 0) != 0) {
921 mutt_error (_("Expunge failed"));
929 /* save status changes */
930 for (n = 0; n < ctx->msgcount; n++) {
931 if (ctx->hdrs[n]->active && ctx->hdrs[n]->changed) {
933 mutt_message (_("Saving message status flags... [%d/%d]"), n + 1,
936 /* if the message has been rethreaded or attachments have been deleted
937 * we delete the message and reupload it.
938 * This works better if we're expunging, of course. */
939 if ((ctx->hdrs[n]->env && (ctx->hdrs[n]->env->refs_changed || ctx->hdrs[n]->env->irt_changed)) ||
940 ctx->hdrs[n]->attach_del) {
942 appendctx = mx_open_mailbox (ctx->path, M_APPEND | M_QUIET, NULL);
944 _mutt_save_message (ctx->hdrs[n], appendctx, 1, 0, 0);
948 if (imap_sync_message (idata, ctx->hdrs[n], &cmd, &err_continue) < 0) {
956 /* We must send an EXPUNGE command if we're not closing. */
957 if (expunge && !(ctx->closing) &&
958 mutt_bit_isset (idata->rights, ACL_DELETE)) {
959 mutt_message _("Expunging messages from server...");
961 /* Set expunge bit so we don't get spurious reopened messages */
962 idata->reopen |= IMAP_EXPUNGE_EXPECTED;
963 if (imap_exec (idata, "EXPUNGE", 0) != 0) {
964 imap_error (_("imap_sync_mailbox: EXPUNGE failed"), idata->cmd.buf);
965 rc = imap_reconnect (ctx);
970 if (expunge && ctx->closing) {
971 if (imap_exec (idata, "CLOSE", 0))
972 mutt_error (_("CLOSE failed"));
973 idata->state = IMAP_AUTHENTICATED;
981 mx_fastclose_mailbox (appendctx);
982 p_delete(&appendctx);
987 /* imap_close_mailbox: clean up IMAP data in CONTEXT */
988 static void imap_close_mailbox (CONTEXT * ctx)
993 idata = (IMAP_DATA *) ctx->data;
994 /* Check to see if the mailbox is actually open */
998 if (ctx == idata->ctx) {
999 if (idata->state != IMAP_FATAL && idata->state == IMAP_SELECTED) {
1000 /* mx_close_mailbox won't sync if there are no deleted messages
1001 * and the mailbox is unchanged, so we may have to close here */
1002 if (!ctx->deleted && imap_exec (idata, "CLOSE", 0))
1003 mutt_error (_("CLOSE failed"));
1004 idata->state = IMAP_AUTHENTICATED;
1007 idata->reopen &= IMAP_REOPEN_ALLOW;
1008 p_delete(&(idata->mailbox));
1009 string_list_wipe(&idata->flags);
1013 /* free IMAP part of headers */
1014 for (i = 0; i < ctx->msgcount; i++)
1015 imap_free_header_data (&(ctx->hdrs[i]->data));
1017 for (i = 0; i < IMAP_CACHE_LEN; i++) {
1018 if (idata->cache[i].path) {
1019 unlink (idata->cache[i].path);
1020 p_delete(&idata->cache[i].path);
1025 /* use the NOOP command to poll for new mail
1028 * M_REOPENED mailbox has been externally modified
1029 * M_NEW_MAIL new mail has arrived!
1033 int imap_check_mailbox (CONTEXT * ctx, int *index_hint __attribute__ ((unused)), int force)
1035 /* overload keyboard timeout to avoid many mailbox checks in a row.
1036 * Most users don't like having to wait exactly when they press a key. */
1040 idata = (IMAP_DATA *) ctx->data;
1042 if ((force || time (NULL) >= idata->lastread + Timeout)
1043 && imap_exec (idata, "NOOP", 0) != 0)
1046 /* We call this even when we haven't run NOOP in case we have pending
1047 * changes to process, since we can reopen here. */
1048 imap_cmd_finish (idata);
1050 if (idata->check_status & IMAP_EXPUNGE_PENDING)
1051 result = M_REOPENED;
1052 else if (idata->check_status & IMAP_NEWMAIL_PENDING)
1053 result = M_NEW_MAIL;
1054 else if (idata->check_status & IMAP_FLAGS_PENDING)
1057 idata->check_status = 0;
1068 * 0+ number of messages in mailbox
1069 * -1 error while polling mailboxes
1071 int imap_mailbox_check (char *path, int new)
1075 char buf[LONG_STRING];
1076 char mbox[LONG_STRING];
1077 char mbox_unquoted[LONG_STRING];
1084 if (imap_parse_path (path, &mx))
1087 /* If imap_passive is set, don't open a connection to check for new mail */
1088 if (option (OPTIMAPPASSIVE))
1089 connflags = M_IMAP_CONN_NONEW;
1091 if (!(idata = imap_conn_find (&(mx.account), connflags))) {
1097 imap_fix_path (idata, mx.mbox, buf, sizeof (buf));
1100 imap_munge_mbox_name (mbox, sizeof (mbox), buf);
1101 m_strcpy(mbox_unquoted, sizeof(mbox_unquoted), buf);
1103 /* The draft IMAP implementor's guide warns againts using the STATUS
1104 * command on a mailbox that you have selected
1107 if (m_strcmp(mbox_unquoted, idata->mailbox) == 0
1108 || (ascii_strcasecmp (mbox_unquoted, "INBOX") == 0
1109 && m_strcasecmp(mbox_unquoted, idata->mailbox) == 0)) {
1110 m_strcpy(buf, sizeof(buf), "NOOP");
1112 else if (mutt_bit_isset (idata->capabilities, IMAP4REV1) ||
1113 mutt_bit_isset (idata->capabilities, STATUS)) {
1114 snprintf (buf, sizeof (buf), "STATUS %s (%s)", mbox,
1115 new == 1 ? "RECENT" : (new == 2 ? "UNSEEN" : "MESSAGES"));
1118 /* Server does not support STATUS, and this is not the current mailbox.
1119 * There is no lightweight way to check recent arrivals */
1122 imap_cmd_start (idata, buf);
1125 if ((rc = imap_cmd_step (idata)) != IMAP_CMD_CONTINUE)
1128 s = imap_next_word (idata->cmd.buf);
1129 if (ascii_strncasecmp ("STATUS", s, 6) == 0) {
1130 s = imap_next_word (s);
1131 /* The mailbox name may or may not be quoted here. We could try to
1132 * munge the server response and compare with quoted (or vise versa)
1133 * but it is probably more efficient to just strncmp against both. */
1134 if (m_strncmp(mbox_unquoted, s, m_strlen(mbox_unquoted)) == 0
1135 || m_strncmp(mbox, s, m_strlen(mbox)) == 0) {
1136 s = imap_next_word (s);
1137 s = imap_next_word (s);
1138 if (isdigit ((unsigned char) *s)) {
1140 msgcount = atoi (s);
1146 while (rc == IMAP_CMD_CONTINUE);
1151 /* returns number of patterns in the search that should be done server-side
1152 * (eg are full-text) */
1153 static int do_search (const pattern_t* search, int allpats)
1156 const pattern_t* pat;
1158 for (pat = search; pat; pat = pat->next) {
1163 if (pat->stringmatch)
1167 if (pat->child && do_search (pat->child, 1))
1178 /* convert mutt pattern_t to IMAP SEARCH command containing only elements
1179 * that require full-text search (mutt already has what it needs for most
1180 * match types, and does a better job (eg server doesn't support regexps). */
1181 static int imap_compile_search (const pattern_t* pat, BUFFER* buf)
1183 if (! do_search (pat, 0))
1187 mutt_buffer_addstr (buf, "NOT ");
1192 if ((clauses = do_search (pat->child, 1)) > 0) {
1193 const pattern_t* clause = pat->child;
1195 mutt_buffer_addch (buf, '(');
1198 if (do_search (clause, 0)) {
1199 if (pat->op == M_OR && clauses > 1)
1200 mutt_buffer_addstr (buf, "OR ");
1202 if (imap_compile_search (clause, buf) < 0)
1206 mutt_buffer_addch (buf, ' ');
1208 clause = clause->next;
1212 mutt_buffer_addch (buf, ')');
1220 mutt_buffer_addstr (buf, "HEADER ");
1222 /* extract header name */
1223 if (! (delim = strchr (pat->str, ':'))) {
1224 mutt_error (_("Header search without header name: %s"), pat->str);
1228 imap_quote_string (term, sizeof (term), pat->str);
1229 mutt_buffer_addstr (buf, term);
1230 mutt_buffer_addch (buf, ' ');
1234 delim = vskipspaces(delim);
1235 imap_quote_string (term, sizeof (term), delim);
1236 mutt_buffer_addstr (buf, term);
1240 mutt_buffer_addstr (buf, "BODY ");
1241 imap_quote_string (term, sizeof (term), pat->str);
1242 mutt_buffer_addstr (buf, term);
1246 mutt_buffer_addstr (buf, "TEXT ");
1247 imap_quote_string (term, sizeof (term), pat->str);
1248 mutt_buffer_addstr (buf, term);
1256 int imap_search (CONTEXT* ctx, const pattern_t* pat) {
1258 IMAP_DATA* idata = (IMAP_DATA*)ctx->data;
1261 for (i = 0; i < ctx->msgcount; i++)
1262 ctx->hdrs[i]->matched = 0;
1264 if (!do_search (pat, 1))
1268 mutt_buffer_addstr (&buf, "UID SEARCH ");
1269 if (imap_compile_search (pat, &buf) < 0) {
1270 p_delete(&buf.data);
1273 if (imap_exec (idata, buf.data, 0) < 0) {
1274 p_delete(&buf.data);
1278 p_delete(&buf.data);
1282 /* all this listing/browsing is a mess. I don't like that name is a pointer
1283 * into idata->buf (used to be a pointer into the passed in buffer, just
1284 * as bad), nor do I like the fact that the fetch is done here. This
1285 * code can't possibly handle non-string_list_t untagged responses properly.
1287 int imap_parse_list_response (IMAP_DATA * idata, char **name, int *noselect,
1288 int *noinferiors, char *delim)
1296 rc = imap_cmd_step (idata);
1297 if (rc == IMAP_CMD_OK)
1299 if (rc != IMAP_CMD_CONTINUE)
1302 s = imap_next_word (idata->cmd.buf);
1303 if ((ascii_strncasecmp ("LIST", s, 4) == 0) ||
1304 (ascii_strncasecmp ("LSUB", s, 4) == 0)) {
1308 s = imap_next_word (s); /* flags */
1314 while (*ep && *ep != ')')
1317 if (!ascii_strncasecmp (s, "\\NoSelect", 9))
1319 if (!ascii_strncasecmp (s, "\\NoInferiors", 12))
1321 /* See draft-gahrns-imap-child-mailbox-?? */
1322 if (!ascii_strncasecmp (s, "\\HasNoChildren", 14))
1326 while (*s && *s != '\\' && *s != ')')
1332 s = imap_next_word (s); /* delim */
1333 /* Reset the delimiter, this can change */
1334 if (ascii_strncasecmp (s, "NIL", 3)) {
1335 if (s && s[0] == '\"' && s[1] && s[2] == '\"')
1337 else if (s && s[0] == '\"' && s[1] && s[1] == '\\' && s[2]
1341 s = imap_next_word (s); /* name */
1342 if (s && *s == '{') { /* Literal */
1343 if (imap_get_literal_count (idata->cmd.buf, &bytes) < 0)
1345 if (imap_cmd_step (idata) != IMAP_CMD_CONTINUE)
1347 *name = idata->cmd.buf;
1356 int imap_subscribe (char *path, int subscribe)
1360 char buf[LONG_STRING];
1361 char mbox[LONG_STRING];
1362 char errstr[STRING];
1366 if (mx_get_magic (path) != M_IMAP || imap_parse_path (path, &mx) < 0) {
1367 mutt_error (_("Bad mailbox name"));
1371 if (!(idata = imap_conn_find (&(mx.account), 0)))
1376 imap_fix_path (idata, mx.mbox, buf, sizeof (buf));
1378 if (option (OPTIMAPCHECKSUBSCRIBED)) {
1381 err.dsize = sizeof (errstr);
1382 snprintf (mbox, sizeof (mbox), "%smailboxes \"%s\"",
1383 subscribe ? "" : "un", path);
1384 mutt_parse_rc_line (mbox, &token, &err);
1385 p_delete(&token.data);
1389 mutt_message (_("Subscribing to %s..."), buf);
1391 mutt_message (_("Unsubscribing to %s..."), buf);
1392 imap_munge_mbox_name (mbox, sizeof (mbox), buf);
1394 snprintf (buf, sizeof (buf), "%sSUBSCRIBE %s", subscribe ? "" : "UN", mbox);
1396 if (imap_exec (idata, buf, 0) < 0)
1407 /* trim dest to the length of the longest prefix it shares with src,
1408 * returning the length of the trimmed string */
1409 static int longest_common_prefix (char *dest, const char* src,
1410 int start, ssize_t dlen) {
1413 while (pos < dlen && dest[pos] && dest[pos] == src[pos])
1420 /* look for IMAP URLs to complete from defined mailboxes. Could be extended
1421 * to complete over open connections and account/folder hooks too. */
1422 static int imap_complete_hosts (char *dest, ssize_t len) {
1429 matchlen = m_strlen(dest);
1432 for (i = 0; i < Incoming.len; i++) {
1433 mailbox = Incoming.arr[i];
1434 if (!m_strncmp(dest, mailbox->path, matchlen)) {
1436 m_strcpy(dest, len, mailbox->path);
1439 longest_common_prefix (dest, mailbox->path, matchlen, len);
1443 for (conn = mutt_socket_head (); conn && conn->next; conn = conn->next) {
1445 char urlstr[LONG_STRING];
1447 if (conn->account.type != M_ACCT_TYPE_IMAP)
1450 mutt_account_tourl (&conn->account, &url);
1451 /* FIXME: how to handle multiple users on the same host? */
1454 url_ciss_tostring (&url, urlstr, sizeof (urlstr), 0);
1455 if (!m_strncmp(dest, urlstr, matchlen)) {
1457 m_strcpy(dest, len, urlstr);
1460 longest_common_prefix (dest, urlstr, matchlen, len);
1467 /* imap_complete: given a partial IMAP folder path, return a string which
1468 * adds as much to the path as is unique */
1469 int imap_complete (char *dest, size_t dlen, char *path) {
1472 char list[LONG_STRING];
1473 char buf[LONG_STRING];
1474 char *list_word = NULL;
1475 int noselect, noinferiors;
1477 char completion[LONG_STRING];
1478 int clen, matchlen = 0;
1479 int completions = 0;
1482 if (imap_parse_path (path, &mx) || !mx.mbox) {
1483 m_strcpy(dest, dlen, path);
1484 return imap_complete_hosts (dest, dlen);
1487 /* don't open a new socket just for completion. Instead complete over
1488 * known mailboxes/hooks/etc */
1489 if (!(idata = imap_conn_find (&(mx.account), M_IMAP_CONN_NONEW))) {
1491 m_strcpy(dest, dlen, path);
1492 return imap_complete_hosts (dest, dlen);
1496 /* reformat path for IMAP list, and append wildcard */
1497 /* don't use INBOX in place of "" */
1498 if (mx.mbox && mx.mbox[0])
1499 imap_fix_path (idata, mx.mbox, list, sizeof (list));
1503 /* fire off command */
1504 snprintf (buf, sizeof (buf), "%s \"\" \"%s%%\"",
1505 option (OPTIMAPLSUB) ? "LSUB" : "LIST", list);
1507 imap_cmd_start (idata, buf);
1509 /* and see what the results are */
1510 m_strcpy(completion, sizeof(completion), NONULL(mx.mbox));
1512 if (imap_parse_list_response (idata, &list_word, &noselect, &noinferiors,
1517 /* store unquoted */
1518 imap_unmunge_mbox_name (list_word);
1520 /* if the folder isn't selectable, append delimiter to force browse
1521 * to enter it on second tab. */
1523 clen = m_strlen(list_word);
1524 list_word[clen++] = delim;
1525 list_word[clen] = '\0';
1527 /* copy in first word */
1529 m_strcpy(completion, sizeof(completion), list_word);
1530 matchlen = m_strlen(completion);
1535 matchlen = longest_common_prefix (completion, list_word, 0, matchlen);
1539 while (m_strncmp(idata->cmd.seq, idata->cmd.buf, SEQLEN));
1542 /* reformat output */
1543 imap_qualify_path (dest, dlen, &mx, completion);
1544 mutt_pretty_mailbox (dest);
1553 /* reconnect if connection was lost */
1554 int imap_reconnect (CONTEXT * ctx)
1556 IMAP_DATA *imap_data;
1561 imap_data = (IMAP_DATA *) ctx->data;
1564 if (imap_data->status == IMAP_CONNECTED)
1568 if (query_quadoption
1570 _("Connection lost. Reconnect to IMAP server?")) != M_YES)
1573 mx_open_mailbox (ctx->path, 0, ctx);
1577 int imap_is_magic (const char* path, struct stat* st __attribute__ ((unused))) {
1579 if (!path || !*path)
1581 s = url_check_scheme (NONULL (path));
1582 return ((s == U_IMAP || s == U_IMAPS) ? M_IMAP : -1);
1585 static int acl_check_imap (CONTEXT* ctx, int bit) {
1586 return (!mutt_bit_isset (((IMAP_DATA*) ctx->data)->capabilities, ACL) ||
1587 mutt_bit_isset (((IMAP_DATA*) ctx->data)->rights, bit));
1590 static int imap_open_new_message (MESSAGE * msg,
1591 CONTEXT * dest __attribute__ ((unused)),
1592 HEADER * hdr __attribute__ ((unused)))
1594 char tmp[_POSIX_PATH_MAX];
1596 msg->fp = m_tempfile(tmp, sizeof(tmp), NONULL(MCore.tmpdir), NULL);
1602 msg->path = m_strdup(tmp);
1606 /* this ugly kludge is required since the last int to
1607 * imap_check_mailbox() doesn't mean 'lock' but 'force'... */
1608 static int _imap_check_mailbox (CONTEXT* ctx,
1610 int lock __attribute__ ((unused))) {
1611 return (imap_check_mailbox (ctx, index_hint, 0));
1614 static int imap_commit_message (MESSAGE* msg, CONTEXT* ctx) {
1617 if ((r = m_fclose(&msg->fp)) == 0)
1618 r = imap_append_message (ctx, msg);
1622 mx_t const imap_mx = {
1629 imap_open_new_message,
1631 _imap_check_mailbox,
1634 imap_commit_message,