git.chise.org Git - elisp/gnus.git-/blob - lisp/nnimap.el

   1 ;;; nnimap.el --- imap backend for Gnus
   2 ;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003
   3 ;;        Free Software Foundation, Inc.
   4
   5 ;; Author: Simon Josefsson <jas@pdc.kth.se>
   6 ;;         Jim Radford <radford@robby.caltech.edu>
   7 ;; Keywords: mail
   8
   9 ;; This file is part of GNU Emacs.
  10
  11 ;; GNU Emacs is free software; you can redistribute it and/or modify
  12 ;; it under the terms of the GNU General Public License as published by
  13 ;; the Free Software Foundation; either version 2, or (at your option)
  14 ;; any later version.
  15
  16 ;; GNU Emacs is distributed in the hope that it will be useful,
  17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 ;; GNU General Public License for more details.
  20
  21 ;; You should have received a copy of the GNU General Public License
  22 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  24 ;; Boston, MA 02111-1307, USA.
  25
  26 ;;; Commentary:
  27
  28 ;; Todo, major things:
  29 ;;
  30 ;;   o Fix Gnus to view correct number of unread/total articles in group buffer
  31 ;;   o Fix Gnus to handle leading '.' in group names (fixed?)
  32 ;;   o Finish disconnected mode (moving articles between mailboxes unplugged)
  33 ;;   o Sieve
  34 ;;   o MIME (partial article fetches)
  35 ;;   o Split to other backends, different split rules for different
  36 ;;     servers/inboxes
  37 ;;
  38 ;; Todo, minor things:
  39 ;;
  40 ;;   o Don't require half of Gnus -- backends should be standalone
  41 ;;   o Verify that we don't use IMAP4rev1 specific things (RFC2060 App B)
  42 ;;   o Dont uid fetch 1,* in nnimap-retrive-groups (slow)
  43 ;;   o Split up big fetches (1,* header especially) in smaller chunks
  44 ;;   o What do I do with gnus-newsgroup-*?
  45 ;;   o Tell Gnus about new groups (how can we tell?)
  46 ;;   o Respooling (fix Gnus?) (unnecessary?)
  47 ;;   o Add support for the following: (if applicable)
  48 ;;       request-list-newsgroups, request-regenerate
  49 ;;       list-active-group,
  50 ;;       request-associate-buffer, request-restore-buffer,
  51 ;;   o Do The Right Thing when UIDVALIDITY changes (what's the right thing?)
  52 ;;   o Support RFC2221 (Login referrals)
  53 ;;   o IMAP2BIS compatibility? (RFC2061)
  54 ;;   o ACAP stuff (perhaps a different project, would be nice to ACAPify
  55 ;;     .newsrc.eld)
  56 ;;   o What about Gnus's article editing, can we support it?  NO!
  57 ;;   o Use \Draft to support the draft group??
  58 ;;   o Duplicate suppression
  59 ;;   o Rewrite UID SEARCH UID X as UID FETCH X (UID) for those with slow servers
  60
  61 ;;; Code:
  62
  63 (eval-when-compile (require 'cl))
  64 (eval-when-compile (require 'gnus-clfns))
  65 (require 'imap)
  66
  67 (require 'nnoo)
  68 (require 'nnmail)
  69 (require 'nnheader)
  70 (require 'gnus)
  71 (require 'gnus-range)
  72 (require 'gnus-start)
  73 (require 'gnus-int)
  74
  75 (eval-when-compile (require 'cl))
  76
  77 (nnoo-declare nnimap)
  78
  79 (defconst nnimap-version "nnimap 1.0")
  80
  81 (defgroup nnimap nil
  82   "Reading IMAP mail with Gnus."
  83   :group 'gnus)
  84
  85 (defvoo nnimap-address nil
  86   "Address of physical IMAP server.  If nil, use the virtual server's name.")
  87
  88 (defvoo nnimap-server-port nil
  89   "Port number on physical IMAP server.
  90 If nil, defaults to 993 for TLS/SSL connections and 143 otherwise.")
  91
  92 ;; Splitting variables
  93
  94 (defcustom nnimap-split-crosspost t
  95   "If non-nil, do crossposting if several split methods match the mail.
  96 If nil, the first match found will be used."
  97   :group 'nnimap
  98   :type 'boolean)
  99
 100 (defcustom nnimap-split-inbox nil
 101   "Name of mailbox to split mail from.
 102
 103 Mail is read from this mailbox and split according to rules in
 104 `nnimap-split-rule'.
 105
 106 This can be a string or a list of strings."
 107   :group 'nnimap
 108   :type '(choice (string)
 109                  (repeat string)))
 110
 111 (define-widget 'nnimap-strict-function 'function
 112   "This widget only matches values that are functionp.
 113
 114 Warning: This means that a value that is the symbol of a not yet
 115 loaded function will not match.  Use with care."
 116   :match 'nnimap-strict-function-match)
 117
 118 (defun nnimap-strict-function-match (widget value)
 119   "Ignoring WIDGET, match if VALUE is a function."
 120   (functionp value))
 121
 122 (defcustom nnimap-split-rule nil
 123   "Mail will be split according to these rules.
 124
 125 Mail is read from mailbox(es) specified in `nnimap-split-inbox'.
 126
 127 If you'd like, for instance, one mail group for mail from the
 128 \"gnus-imap\" mailing list, one group for junk mail and leave
 129 everything else in the incoming mailbox, you could do something like
 130 this:
 131
 132 \(setq nnimap-split-rule '((\"INBOX.gnus-imap\"   \"From:.*gnus-imap\")
 133                           (\"INBOX.junk\"        \"Subject:.*buy\")))
 134
 135 As you can see, `nnimap-split-rule' is a list of lists, where the
 136 first element in each \"rule\" is the name of the IMAP mailbox (or the
 137 symbol `junk' if you want to remove the mail), and the second is a
 138 regexp that nnimap will try to match on the header to find a fit.
 139
 140 The second element can also be a function.  In that case, it will be
 141 called narrowed to the headers with the first element of the rule as
 142 the argument.  It should return a non-nil value if it thinks that the
 143 mail belongs in that group.
 144
 145 This variable can also have a function as its value, the function will
 146 be called with the headers narrowed and should return a group where it
 147 thinks the article should be splitted to.  See `nnimap-split-fancy'.
 148
 149 To allow for different split rules on different virtual servers, and
 150 even different split rules in different inboxes on the same server,
 151 the syntax of this variable have been extended along the lines of:
 152
 153 \(setq nnimap-split-rule
 154       '((\"my1server\"    (\".*\"    ((\"ding\"    \"ding@gnus.org\")
 155                                   (\"junk\"    \"From:.*Simon\")))
 156         (\"my2server\"    (\"INBOX\" nnimap-split-fancy))
 157         (\"my[34]server\" (\".*\"    ((\"private\" \"To:.*Simon\")
 158                                   (\"junk\"    my-junk-func)))))
 159
 160 The virtual server name is in fact a regexp, so that the same rules
 161 may apply to several servers.  In the example, the servers
 162 \"my3server\" and \"my4server\" both use the same rules.  Similarly,
 163 the inbox string is also a regexp.  The actual splitting rules are as
 164 before, either a function, or a list with group/regexp or
 165 group/function elements."
 166   :group 'nnimap
 167   :type '(choice :tag "Rule type"
 168                  (repeat :menu-tag "Single-server"
 169                          :tag "Single-server list"
 170                          (list (string :tag "Mailbox")
 171                                (choice :tag "Predicate"
 172                                        (regexp :tag "A regexp")
 173                                        (nnimap-strict-function :tag "A function"))))
 174                  (choice :menu-tag "A function"
 175                          :tag "A function"
 176                          (function-item nnimap-split-fancy)
 177                          (function-item nnmail-split-fancy)
 178                          (nnimap-strict-function :tag "User-defined function"))
 179                  (repeat :menu-tag "Multi-server (extended)"
 180                          :tag "Multi-server list"
 181                          (list (regexp :tag "Server regexp")
 182                                (list (regexp :tag "Incoming Mailbox regexp")
 183                                      (repeat :tag "Rules for matching server(s) and mailbox(es)"
 184                                              (list (string :tag "Destination mailbox")
 185                                                    (choice :tag "Predicate"
 186                                                            (regexp :tag "A Regexp")
 187                                                            (nnimap-strict-function :tag "A Function")))))))))
 188
 189 (defcustom nnimap-split-predicate "UNSEEN UNDELETED"
 190   "The predicate used to find articles to split.
 191 If you use another IMAP client to peek on articles but always would
 192 like nnimap to split them once it's started, you could change this to
 193 \"UNDELETED\". Other available predicates are available in
 194 RFC2060 section 6.4.4."
 195   :group 'nnimap
 196   :type 'string)
 197
 198 (defcustom nnimap-split-fancy nil
 199   "Like the variable `nnmail-split-fancy'."
 200   :group 'nnimap
 201   :type 'sexp)
 202
 203 (defvar nnimap-split-download-body-default nil
 204   "Internal variable with default value for `nnimap-split-download-body'.")
 205
 206 (defcustom nnimap-split-download-body 'default
 207   "Whether to download entire articles during splitting.
 208 This is generally not required, and will slow things down considerably.
 209 You may need it if you want to use an advanced splitting function that
 210 analyses the body before splitting the article.
 211 If this variable is nil, bodies will not be downloaded; if this
 212 variable is the symbol `default' the default behaviour is
 213 used (which currently is nil, unless you use a statistical
 214 spam.el test); if this variable is another non-nil value bodies
 215 will be downloaded."
 216   :group 'nnimap
 217   :type '(choice (const :tag "Let system decide" deault)
 218                  boolean))
 219
 220 ;; Performance / bug workaround variables
 221
 222 (defcustom nnimap-close-asynchronous t
 223   "Close mailboxes asynchronously in `nnimap-close-group'.
 224 This means that errors cought by nnimap when closing the mailbox will
 225 not prevent Gnus from updating the group status, which may be harmful.
 226 However, it increases speed."
 227   :type 'boolean
 228   :group 'nnimap)
 229
 230 (defcustom nnimap-dont-close t
 231   "Never close mailboxes.
 232 This increases the speed of closing mailboxes (quiting group) but may
 233 decrease the speed of selecting another mailbox later.  Re-selecting
 234 the same mailbox will be faster though."
 235   :type 'boolean
 236   :group 'nnimap)
 237
 238 (defcustom nnimap-retrieve-groups-asynchronous t
 239   "Send asynchronous STATUS commands for each mailbox before checking mail.
 240 If you have mailboxes that rarely receives mail, this speeds up new
 241 mail checking.  It works by first sending STATUS commands for each
 242 mailbox, and then only checking groups which has a modified UIDNEXT
 243 more carefully for new mail.
 244
 245 In summary, the default is O((1-p)*k+p*n) and changing it to nil makes
 246 it O(n).  If p is small, then the default is probably faster."
 247   :type 'boolean
 248   :group 'nnimap)
 249
 250 (defvoo nnimap-need-unselect-to-notice-new-mail nil
 251   "Unselect mailboxes before looking for new mail in them.
 252 Some servers seem to need this under some circumstances.")
 253
 254 ;; Authorization / Privacy variables
 255
 256 (defvoo nnimap-auth-method nil
 257   "Obsolete.")
 258
 259 (defvoo nnimap-stream nil
 260   "How nnimap will connect to the server.
 261
 262 The default, nil, will try to use the \"best\" method the server can
 263 handle.
 264
 265 Change this if
 266
 267 1) you want to connect with TLS/SSL.  The TLS/SSL integration
 268    with IMAP is suboptimal so you'll have to tell it
 269    specifically.
 270
 271 2) your server is more capable than your environment -- i.e. your
 272    server accept Kerberos login's but you haven't installed the
 273    `imtest' program or your machine isn't configured for Kerberos.
 274
 275 Possible choices: gssapi, kerberos4, starttls, tls, ssl, network, shell.
 276 See also `imap-streams' and `imap-stream-alist'.")
 277
 278 (defvoo nnimap-authenticator nil
 279   "How nnimap authenticate itself to the server.
 280
 281 The default, nil, will try to use the \"best\" method the server can
 282 handle.
 283
 284 There is only one reason for fiddling with this variable, and that is
 285 if your server is more capable than your environment -- i.e. you
 286 connect to a server that accept Kerberos login's but you haven't
 287 installed the `imtest' program or your machine isn't configured for
 288 Kerberos.
 289
 290 Possible choices: gssapi, kerberos4, digest-md5, cram-md5, login, anonymous.
 291 See also `imap-authenticators' and `imap-authenticator-alist'")
 292
 293 (defvoo nnimap-directory (nnheader-concat gnus-directory "overview/")
 294   "Directory to keep NOV cache files for nnimap groups.
 295 See also `nnimap-nov-file-name'.")
 296
 297 (defvoo nnimap-nov-file-name "nnimap."
 298   "NOV cache base filename.
 299 The group name and `nnimap-nov-file-name-suffix' will be appended.  A
 300 typical complete file name would be
 301 ~/News/overview/nnimap.pdc.INBOX.ding.nov, or
 302 ~/News/overview/nnimap/pdc/INBOX/ding/nov if
 303 `nnmail-use-long-file-names' is nil")
 304
 305 (defvoo nnimap-nov-file-name-suffix ".novcache"
 306   "Suffix for NOV cache base filename.")
 307
 308 (defvoo nnimap-nov-is-evil gnus-agent
 309   "If non-nil, never generate or use a local nov database for this backend.
 310 Using nov databases should speed up header fetching considerably.
 311 However, it will invoke a UID SEARCH UID command on the server, and
 312 some servers implement this command inefficiently by opening each and
 313 every message in the group, thus making it quite slow.
 314 Unlike other backends, you do not need to take special care if you
 315 flip this variable.")
 316
 317 (defvoo nnimap-expunge-on-close 'always ; 'ask, 'never
 318   "Whether to expunge a group when it is closed.
 319 When a IMAP group with articles marked for deletion is closed, this
 320 variable determine if nnimap should actually remove the articles or
 321 not.
 322
 323 If always, nnimap always perform a expunge when closing the group.
 324 If never, nnimap never expunges articles marked for deletion.
 325 If ask, nnimap will ask you if you wish to expunge marked articles.
 326
 327 When setting this variable to `never', you can only expunge articles
 328 by using `G x' (gnus-group-nnimap-expunge) from the Group buffer.")
 329
 330 (defvoo nnimap-list-pattern "*"
 331   "A string LIMIT or list of strings with mailbox wildcards used to limit available groups.
 332 See below for available wildcards.
 333
 334 The LIMIT string can be a cons cell (REFERENCE . LIMIT), where
 335 REFERENCE will be passed as the first parameter to LIST/LSUB.  The
 336 semantics of this are server specific, on the University of Washington
 337 server you can specify a directory.
 338
 339 Example:
 340  '(\"INBOX\" \"mail/*\" (\"~friend/mail/\" . \"list/*\"))
 341
 342 There are two wildcards * and %. * matches everything, % matches
 343 everything in the current hierarchy.")
 344
 345 (defvoo nnimap-news-groups nil
 346   "IMAP support a news-like mode, also known as bulletin board mode,
 347 where replies is sent via IMAP instead of SMTP.
 348
 349 This variable should contain a regexp matching groups where you wish
 350 replies to be stored to the mailbox directly.
 351
 352 Example:
 353   '(\"^[^I][^N][^B][^O][^X].*$\")
 354
 355 This will match all groups not beginning with \"INBOX\".
 356
 357 Note that there is nothing technically different between mail-like and
 358 news-like mailboxes.  If you wish to have a group with todo items or
 359 similar which you wouldn't want to set up a mailing list for, you can
 360 use this to make replies go directly to the group.")
 361
 362 (defvoo nnimap-expunge-search-string "UID %s NOT SINCE %s"
 363   "IMAP search command to use for articles that are to be expired.
 364 The first %s is replaced by a UID set of articles to search on,
 365 and the second %s is replaced by a date criterium.
 366
 367 One useful (and perhaps the only useful) value to change this to would
 368 be `UID %s NOT SENTSINCE %s' to make nnimap use the Date: header
 369 instead of the internal date of messages.  See section 6.4.4 of RFC
 370 2060 for more information on valid strings.")
 371
 372 (defvoo nnimap-importantize-dormant t
 373   "If non-nil, mark \"dormant\" articles as \"ticked\" for other IMAP clients.
 374 Note that within Gnus, dormant articles will still (only) be
 375 marked as ticked.  This is to make \"dormant\" articles stand out,
 376 just like \"ticked\" articles, in other IMAP clients.")
 377
 378 (defvoo nnimap-server-address nil
 379   "Obsolete.  Use `nnimap-address'.")
 380
 381 (defcustom nnimap-authinfo-file "~/.authinfo"
 382   "Authorization information for IMAP servers.  In .netrc format."
 383   :type
 384   '(choice file
 385            (repeat :tag "Entries"
 386                    :menu-tag "Inline"
 387                    (list :format "%v"
 388                          :value ("" ("login" . "") ("password" . ""))
 389                          (string :tag "Host")
 390                          (checklist :inline t
 391                                     (cons :format "%v"
 392                                           (const :format "" "login")
 393                                           (string :format "Login: %v"))
 394                                     (cons :format "%v"
 395                                           (const :format "" "password")
 396                                           (string :format "Password: %v")))))))
 397
 398 (defcustom nnimap-prune-cache t
 399   "If non-nil, nnimap check whether articles still exist on server before using data stored in NOV cache."
 400   :type 'boolean)
 401
 402 (defvar nnimap-request-list-method 'imap-mailbox-list
 403   "Method to use to request a list of all folders from the server.
 404 If this is 'imap-mailbox-lsub, then use a server-side subscription list to
 405 restrict visible folders.")
 406
 407 (defcustom nnimap-id nil
 408   "Plist with client identity to send to server upon login.
 409 Nil means no information is sent, symbol `no' to disable ID query
 410 alltogheter, or plist with identifier-value pairs to send to
 411 server.  RFC 2971 describes the list as follows:
 412
 413    Any string may be sent as a field, but the following are defined to
 414    describe certain values that might be sent.  Implementations are free
 415    to send none, any, or all of these.  Strings are not case-sensitive.
 416    Field strings MUST NOT be longer than 30 octets.  Value strings MUST
 417    NOT be longer than 1024 octets.  Implementations MUST NOT send more
 418    than 30 field-value pairs.
 419
 420      name            Name of the program
 421      version         Version number of the program
 422      os              Name of the operating system
 423      os-version      Version of the operating system
 424      vendor          Vendor of the client/server
 425      support-url     URL to contact for support
 426      address         Postal address of contact/vendor
 427      date            Date program was released, specified as a date-time
 428                        in IMAP4rev1
 429      command         Command used to start the program
 430      arguments       Arguments supplied on the command line, if any
 431                        if any
 432      environment     Description of environment, i.e., UNIX environment
 433                        variables or Windows registry settings
 434
 435    Implementations MUST NOT send the same field name more than once.
 436
 437 An example plist would be '(\"name\" \"Gnus\" \"version\" gnus-version-number
 438 \"os\" system-configuration \"vendor\" \"GNU\")."
 439   :group 'nnimap
 440   :type '(choice (const :tag "No information" nil)
 441                  (const :tag "Disable ID query" no)
 442                  (plist :key-type string :value-type string)))
 443
 444 (defcustom nnimap-debug nil
 445   "If non-nil, random debug spews are placed in *nnimap-debug* buffer."
 446   :group 'nnimap
 447   :type 'boolean)
 448
 449 ;; Internal variables:
 450
 451 (defvar nnimap-debug-buffer "*nnimap-debug*")
 452 (defvar nnimap-mailbox-info (gnus-make-hashtable 997))
 453 (defvar nnimap-current-move-server nil)
 454 (defvar nnimap-current-move-group nil)
 455 (defvar nnimap-current-move-article nil)
 456 (defvar nnimap-length)
 457 (defvar nnimap-progress-chars '(?| ?/ ?- ?\\))
 458 (defvar nnimap-progress-how-often 20)
 459 (defvar nnimap-counter)
 460 (defvar nnimap-server-buffer-alist nil) ;; Map server name to buffers.
 461 (defvar nnimap-current-server nil)      ;; Current server
 462 (defvar nnimap-server-buffer nil)       ;; Current servers' buffer
 463
 464 \f
 465
 466 (nnoo-define-basics nnimap)
 467
 468 ;; Utility functions:
 469
 470 (defsubst nnimap-get-server-buffer (server)
 471   "Return buffer for SERVER, if nil use current server."
 472   (cadr (assoc (or server nnimap-current-server) nnimap-server-buffer-alist)))
 473
 474 (defun nnimap-possibly-change-server (server)
 475   "Return buffer for SERVER, changing the current server as a side-effect.
 476 If SERVER is nil, uses the current server."
 477   (setq nnimap-current-server (or server nnimap-current-server)
 478         nnimap-server-buffer (nnimap-get-server-buffer nnimap-current-server)))
 479
 480 (defun nnimap-verify-uidvalidity (group server)
 481   "Verify stored uidvalidity match current one in GROUP on SERVER."
 482   (let* ((gnusgroup (gnus-group-prefixed-name
 483                      group (gnus-server-to-method
 484                             (format "nnimap:%s" server))))
 485          (new-uidvalidity (imap-mailbox-get 'uidvalidity))
 486          (old-uidvalidity (gnus-group-get-parameter gnusgroup 'uidvalidity))
 487          (dir (file-name-as-directory (expand-file-name nnimap-directory)))
 488          (nameuid (nnheader-translate-file-chars
 489                    (concat nnimap-nov-file-name
 490                            (if (equal server "")
 491                                "unnamed"
 492                              server) "." group "." old-uidvalidity
 493                              nnimap-nov-file-name-suffix) t))
 494          (file (if (or nnmail-use-long-file-names
 495                        (file-exists-p (expand-file-name nameuid dir)))
 496                    (expand-file-name nameuid dir)
 497                  (expand-file-name
 498                   (encode-coding-string
 499                    (nnheader-replace-chars-in-string nameuid ?. ?/)
 500                    nnmail-pathname-coding-system)
 501                   dir))))
 502     (if old-uidvalidity
 503         (if (not (equal old-uidvalidity new-uidvalidity))
 504             ;; uidvalidity clash
 505             (gnus-delete-file file)
 506           (gnus-group-set-parameter gnusgroup 'uidvalidity new-uidvalidity)
 507           t)
 508       (gnus-group-add-parameter gnusgroup (cons 'uidvalidity new-uidvalidity))
 509       t)))
 510
 511 (defun nnimap-before-find-minmax-bugworkaround ()
 512   "Function called before iterating through mailboxes with
 513 `nnimap-find-minmax-uid'."
 514   (when nnimap-need-unselect-to-notice-new-mail
 515     ;; XXX this is for UoW imapd problem, it doesn't notice new mail in
 516     ;; currently selected mailbox without a re-select/examine.
 517     (or (null (imap-current-mailbox nnimap-server-buffer))
 518         (imap-mailbox-unselect nnimap-server-buffer))))
 519
 520 (defun nnimap-find-minmax-uid (group &optional examine)
 521   "Find lowest and highest active article number in GROUP.
 522 If EXAMINE is non-nil the group is selected read-only."
 523   (with-current-buffer nnimap-server-buffer
 524     (when (or (string= group (imap-current-mailbox))
 525               (imap-mailbox-select group examine))
 526       (let (minuid maxuid)
 527         (when (> (imap-mailbox-get 'exists) 0)
 528           (imap-fetch "1,*" "UID" nil 'nouidfetch)
 529           (imap-message-map (lambda (uid Uid)
 530                               (setq minuid (if minuid (min minuid uid) uid)
 531                                     maxuid (if maxuid (max maxuid uid) uid)))
 532                             'UID))
 533         (list (imap-mailbox-get 'exists) minuid maxuid)))))
 534
 535 (defun nnimap-possibly-change-group (group &optional server)
 536   "Make GROUP the current group, and SERVER the current server."
 537   (when (nnimap-possibly-change-server server)
 538     (with-current-buffer nnimap-server-buffer
 539       (if (or (null group) (imap-current-mailbox-p group))
 540           imap-current-mailbox
 541         (if (imap-mailbox-select group)
 542             (if (or (nnimap-verify-uidvalidity
 543                      group (or server nnimap-current-server))
 544                     (zerop (imap-mailbox-get 'exists group))
 545                     t ;; for OGnus to see if ignoring uidvalidity
 546                       ;; changes has any bad effects.
 547                     (yes-or-no-p
 548                      (format
 549                       "nnimap: Group %s is not uidvalid.  Continue? " group)))
 550                 imap-current-mailbox
 551               (imap-mailbox-unselect)
 552               (error "nnimap: Group %s is not uid-valid" group))
 553           (nnheader-report 'nnimap (imap-error-text)))))))
 554
 555 (defun nnimap-replace-whitespace (string)
 556   "Return STRING with all whitespace replaced with space."
 557   (when string
 558     (while (string-match "[\r\n\t]+" string)
 559       (setq string (replace-match " " t t string)))
 560     string))
 561
 562 ;; Required backend functions
 563
 564 (defun nnimap-retrieve-headers-progress ()
 565   "Hook to insert NOV line for current article into `nntp-server-buffer'."
 566   (and (numberp nnmail-large-newsgroup)
 567        (zerop (% (incf nnimap-counter) nnimap-progress-how-often))
 568        (> nnimap-length nnmail-large-newsgroup)
 569        (nnheader-message 6 "nnimap: Retrieving headers... %c"
 570                          (nth (/ (% nnimap-counter
 571                                     (* (length nnimap-progress-chars)
 572                                        nnimap-progress-how-often))
 573                                  nnimap-progress-how-often)
 574                               nnimap-progress-chars)))
 575   (with-current-buffer nntp-server-buffer
 576     (let (headers lines chars uid mbx)
 577       (with-current-buffer nnimap-server-buffer
 578         (setq uid imap-current-message
 579               mbx imap-current-mailbox
 580               headers (nnimap-demule
 581                        (if (imap-capability 'IMAP4rev1)
 582                            ;; xxx don't just use car? alist doesn't contain
 583                            ;; anything else now, but it might...
 584                            (nth 2 (car (imap-message-get uid 'BODYDETAIL)))
 585                          (imap-message-get uid 'RFC822.HEADER)))
 586               lines (imap-body-lines (imap-message-body imap-current-message))
 587               chars (imap-message-get imap-current-message 'RFC822.SIZE)))
 588       (nnheader-insert-nov
 589        (with-temp-buffer
 590          (buffer-disable-undo)
 591          (insert headers)
 592          (let ((head (nnheader-parse-naked-head)))
 593            (mail-header-set-number head uid)
 594            (mail-header-set-chars head chars)
 595            (mail-header-set-lines head lines)
 596            (mail-header-set-xref
 597             head (format "%s %s:%d" (system-name) mbx uid))
 598            head))))))
 599
 600 (defun nnimap-retrieve-which-headers (articles fetch-old)
 601   "Get a range of articles to fetch based on ARTICLES and FETCH-OLD."
 602   (with-current-buffer nnimap-server-buffer
 603     (if (numberp (car-safe articles))
 604         (imap-search
 605          (concat "UID "
 606                  (imap-range-to-message-set
 607                   (gnus-compress-sequence
 608                    (append (gnus-uncompress-sequence
 609                             (and fetch-old
 610                                  (cons (if (numberp fetch-old)
 611                                            (max 1 (- (car articles) fetch-old))
 612                                          1)
 613                                        (1- (car articles)))))
 614                            articles)))))
 615       (mapcar (lambda (msgid)
 616                 (imap-search
 617                  (format "HEADER Message-Id \"%s\"" msgid)))
 618               articles))))
 619
 620 (defun nnimap-group-overview-filename (group server)
 621   "Make file name for GROUP on SERVER."
 622   (let* ((dir (file-name-as-directory (expand-file-name nnimap-directory)))
 623          (uidvalidity (gnus-group-get-parameter
 624                        (gnus-group-prefixed-name
 625                         group (gnus-server-to-method
 626                                (format "nnimap:%s" server)))
 627                        'uidvalidity))
 628          (name (nnheader-translate-file-chars
 629                 (concat nnimap-nov-file-name
 630                         (if (equal server "")
 631                             "unnamed"
 632                           server) "." group nnimap-nov-file-name-suffix) t))
 633          (nameuid (nnheader-translate-file-chars
 634                    (concat nnimap-nov-file-name
 635                            (if (equal server "")
 636                                "unnamed"
 637                              server) "." group "." uidvalidity
 638                              nnimap-nov-file-name-suffix) t))
 639          (oldfile (if (or nnmail-use-long-file-names
 640                           (file-exists-p (expand-file-name name dir)))
 641                       (expand-file-name name dir)
 642                     (expand-file-name
 643                      (encode-coding-string
 644                       (nnheader-replace-chars-in-string name ?. ?/)
 645                       nnmail-pathname-coding-system)
 646                      dir)))
 647          (newfile (if (or nnmail-use-long-file-names
 648                           (file-exists-p (expand-file-name nameuid dir)))
 649                       (expand-file-name nameuid dir)
 650                     (expand-file-name
 651                      (encode-coding-string
 652                       (nnheader-replace-chars-in-string nameuid ?. ?/)
 653                       nnmail-pathname-coding-system)
 654                      dir))))
 655     (when (and (file-exists-p oldfile) (not (file-exists-p newfile)))
 656       (message "nnimap: Upgrading novcache filename...")
 657       (sit-for 1)
 658       (gnus-make-directory (file-name-directory newfile))
 659       (unless (ignore-errors (rename-file oldfile newfile) t)
 660         (if (ignore-errors (copy-file oldfile newfile) t)
 661             (delete-file oldfile)
 662           (error "Can't rename `%s' to `%s'" oldfile newfile))))
 663     newfile))
 664
 665 (defun nnimap-retrieve-headers-from-file (group server)
 666   (with-current-buffer nntp-server-buffer
 667     (let ((nov (nnimap-group-overview-filename group server)))
 668       (when (file-exists-p nov)
 669         (nnheader-insert-file-contents nov)
 670         (set-buffer-modified-p nil)
 671         (let ((min (ignore-errors (goto-char (point-min))
 672                                   (read (current-buffer))))
 673               (max (ignore-errors (goto-char (point-max))
 674                                   (forward-line -1)
 675                                   (read (current-buffer)))))
 676           (if (and (numberp min) (numberp max))
 677               (cons min max)
 678             ;; junk, remove it, it's saved later
 679             (erase-buffer)
 680             nil))))))
 681
 682 (defun nnimap-retrieve-headers-from-server (articles group server)
 683   (with-current-buffer nnimap-server-buffer
 684     (let ((imap-fetch-data-hook '(nnimap-retrieve-headers-progress))
 685           (nnimap-length (gnus-range-length articles))
 686           (nnimap-counter 0))
 687       (imap-fetch (imap-range-to-message-set articles)
 688                   (concat "(UID RFC822.SIZE BODY "
 689                           (let ((headers
 690                                  (append '(Subject From Date Message-Id
 691                                                    References In-Reply-To Xref)
 692                                          (copy-sequence
 693                                           nnmail-extra-headers))))
 694                             (if (imap-capability 'IMAP4rev1)
 695                                 (format "BODY.PEEK[HEADER.FIELDS %s])" headers)
 696                               (format "RFC822.HEADER.LINES %s)" headers)))))
 697       (and (numberp nnmail-large-newsgroup)
 698            (> nnimap-length nnmail-large-newsgroup)
 699            (nnheader-message 6 "nnimap: Retrieving headers...done")))))
 700
 701 (defun nnimap-dont-use-nov-p (group server)
 702   (or gnus-nov-is-evil nnimap-nov-is-evil
 703       (unless (and (gnus-make-directory
 704                     (file-name-directory
 705                      (nnimap-group-overview-filename group server)))
 706                    (file-writable-p
 707                     (nnimap-group-overview-filename group server)))
 708         (message "nnimap: Nov cache not writable, %s"
 709                  (nnimap-group-overview-filename group server)))))
 710
 711 (deffoo nnimap-retrieve-headers (articles &optional group server fetch-old)
 712   (when (nnimap-possibly-change-group group server)
 713     (with-current-buffer nntp-server-buffer
 714       (erase-buffer)
 715       (if (nnimap-dont-use-nov-p group server)
 716           (nnimap-retrieve-headers-from-server
 717            (gnus-compress-sequence articles) group server)
 718         (let (uids cached low high)
 719           (when (setq uids (nnimap-retrieve-which-headers articles fetch-old)
 720                       low (car uids)
 721                       high (car (last uids)))
 722             (if (setq cached (nnimap-retrieve-headers-from-file group server))
 723                 (progn
 724                   ;; fetch articles with uids before cache block
 725                   (when (< low (car cached))
 726                     (goto-char (point-min))
 727                     (nnimap-retrieve-headers-from-server
 728                      (cons low (1- (car cached))) group server))
 729                   ;; fetch articles with uids after cache block
 730                   (when (> high (cdr cached))
 731                     (goto-char (point-max))
 732                     (nnimap-retrieve-headers-from-server
 733                      (cons (1+ (cdr cached)) high) group server))
 734                   (when nnimap-prune-cache
 735                     ;; remove nov's for articles which has expired on server
 736                     (goto-char (point-min))
 737                     (dolist (uid (gnus-set-difference articles uids))
 738                       (when (re-search-forward (format "^%d\t" uid) nil t)
 739                         (gnus-delete-line)))))
 740               ;; nothing cached, fetch whole range from server
 741               (nnimap-retrieve-headers-from-server
 742                (cons low high) group server))
 743             (when (buffer-modified-p)
 744               (nnmail-write-region
 745                (point-min) (point-max)
 746                (nnimap-group-overview-filename group server) nil 'nomesg))
 747             (nnheader-nov-delete-outside-range low high))))
 748       'nov)))
 749
 750 (defun nnimap-open-connection (server)
 751   (if (not (imap-open nnimap-address nnimap-server-port nnimap-stream
 752                       nnimap-authenticator nnimap-server-buffer))
 753       (nnheader-report 'nnimap "Can't open connection to server %s" server)
 754     (unless (or (imap-capability 'IMAP4 nnimap-server-buffer)
 755                 (imap-capability 'IMAP4rev1 nnimap-server-buffer))
 756       (imap-close nnimap-server-buffer)
 757       (nnheader-report 'nnimap "Server %s is not IMAP4 compliant" server))
 758     (let* ((list (gnus-parse-netrc nnimap-authinfo-file))
 759            (port (if nnimap-server-port
 760                      (int-to-string nnimap-server-port)
 761                    "imap"))
 762            (alist (or (gnus-netrc-machine list server port "imap")
 763                       (gnus-netrc-machine list
 764                                           (or nnimap-server-address
 765                                               nnimap-address)
 766                                           port "imap")))
 767            (user (gnus-netrc-get alist "login"))
 768            (passwd (gnus-netrc-get alist "password")))
 769       (if (imap-authenticate user passwd nnimap-server-buffer)
 770           (prog1
 771               (push (list server nnimap-server-buffer)
 772                     nnimap-server-buffer-alist)
 773             (imap-id nnimap-id nnimap-server-buffer)
 774             (nnimap-possibly-change-server server))
 775         (imap-close nnimap-server-buffer)
 776         (kill-buffer nnimap-server-buffer)
 777         (nnheader-report 'nnimap "Could not authenticate to %s" server)))))
 778
 779 (deffoo nnimap-open-server (server &optional defs)
 780   (nnheader-init-server-buffer)
 781   (if (nnimap-server-opened server)
 782       t
 783     (unless (assq 'nnimap-server-buffer defs)
 784       (push (list 'nnimap-server-buffer (concat " *nnimap* " server)) defs))
 785     ;; translate `nnimap-server-address' to `nnimap-address' in defs
 786     ;; for people that configured nnimap with a very old version
 787     (unless (assq 'nnimap-address defs)
 788       (if (assq 'nnimap-server-address defs)
 789           (push (list 'nnimap-address
 790                       (cadr (assq 'nnimap-server-address defs))) defs)
 791         (push (list 'nnimap-address server) defs)))
 792     (nnoo-change-server 'nnimap server defs)
 793     (or nnimap-server-buffer
 794         (setq nnimap-server-buffer (cadr (assq 'nnimap-server-buffer defs))))
 795     (with-current-buffer (get-buffer-create nnimap-server-buffer)
 796       (nnoo-change-server 'nnimap server defs))
 797     (or (and nnimap-server-buffer
 798              (imap-opened nnimap-server-buffer)
 799              (if (with-current-buffer nnimap-server-buffer
 800                    (memq imap-state '(auth select examine)))
 801                  t
 802                (imap-close nnimap-server-buffer)
 803                (nnimap-open-connection server)))
 804         (nnimap-open-connection server))))
 805
 806 (deffoo nnimap-server-opened (&optional server)
 807   "Whether SERVER is opened.
 808 If SERVER is the current virtual server, and the connection to the
 809 physical server is alive, this function return a non-nil value.  If
 810 SERVER is nil, it is treated as the current server."
 811   ;; clean up autologouts??
 812   (and (or server nnimap-current-server)
 813        (nnoo-server-opened 'nnimap (or server nnimap-current-server))
 814        (imap-opened (nnimap-get-server-buffer server))))
 815
 816 (deffoo nnimap-close-server (&optional server)
 817   "Close connection to server and free all resources connected to it.
 818 Return nil if the server couldn't be closed for some reason."
 819   (let ((server (or server nnimap-current-server)))
 820     (when (or (nnimap-server-opened server)
 821               (imap-opened (nnimap-get-server-buffer server)))
 822       (imap-close (nnimap-get-server-buffer server))
 823       (kill-buffer (nnimap-get-server-buffer server))
 824       (setq nnimap-server-buffer nil
 825             nnimap-current-server nil
 826             nnimap-server-buffer-alist
 827             (delq server nnimap-server-buffer-alist)))
 828     (nnoo-close-server 'nnimap server)))
 829
 830 (deffoo nnimap-request-close ()
 831   "Close connection to all servers and free all resources that the backend have reserved.
 832 All buffers that have been created by that
 833 backend should be killed.  (Not the nntp-server-buffer, though.) This
 834 function is generally only called when Gnus is shutting down."
 835   (mapcar (lambda (server) (nnimap-close-server (car server)))
 836           nnimap-server-buffer-alist)
 837   (setq nnimap-server-buffer-alist nil))
 838
 839 (deffoo nnimap-status-message (&optional server)
 840   "This function returns the last error message from server."
 841   (when (nnimap-possibly-change-server server)
 842     (nnoo-status-message 'nnimap server)))
 843
 844 (defun nnimap-demule (string)
 845   (funcall (if (and (fboundp 'string-as-multibyte)
 846                     (subrp (symbol-function 'string-as-multibyte)))
 847                'string-as-multibyte
 848              'identity)
 849            (or string "")))
 850
 851 (defun nnimap-make-callback (article gnus-callback buffer)
 852   "Return a callback function."
 853   `(lambda ()
 854      (nnimap-callback ,article ,gnus-callback ,buffer)))
 855
 856 (defun nnimap-callback (article gnus-callback buffer)
 857   (when (eq article (imap-current-message))
 858     (remove-hook 'imap-fetch-data-hook
 859                  (nnimap-make-callback article gnus-callback buffer))
 860     (with-current-buffer buffer
 861       (insert
 862        (with-current-buffer nnimap-server-buffer
 863          (nnimap-demule
 864           (if (imap-capability 'IMAP4rev1)
 865               ;; xxx don't just use car? alist doesn't contain
 866               ;; anything else now, but it might...
 867               (nth 2 (car (imap-message-get article 'BODYDETAIL)))
 868             (imap-message-get article 'RFC822)))))
 869       (nnheader-ms-strip-cr)
 870       (funcall gnus-callback t))))
 871
 872 (defun nnimap-request-article-part (article part prop &optional
 873                                             group server to-buffer detail)
 874   (when (nnimap-possibly-change-group group server)
 875     (let ((article (if (stringp article)
 876                        (car-safe (imap-search
 877                                   (format "HEADER Message-Id \"%s\"" article)
 878                                   nnimap-server-buffer))
 879                      article)))
 880       (when article
 881         (gnus-message 10 "nnimap: Fetching (part of) article %d from %s..."
 882                       article (or group imap-current-mailbox
 883                                   gnus-newsgroup-name))
 884         (if (not nnheader-callback-function)
 885             (with-current-buffer (or to-buffer nntp-server-buffer)
 886               (erase-buffer)
 887               (let ((data (imap-fetch article part prop nil
 888                                       nnimap-server-buffer)))
 889                 (when data
 890                   (insert (nnimap-demule (if detail (nth 2 (car data)) data)))
 891                   (nnheader-ms-strip-cr)
 892                   (gnus-message
 893                    10 "nnimap: Fetching (part of) article %d from %s...done"
 894                    article (or group imap-current-mailbox gnus-newsgroup-name))
 895                   (if (bobp)
 896                       (nnheader-report 'nnimap "No such article %d in %s: %s"
 897                                        article (or group imap-current-mailbox
 898                                                    gnus-newsgroup-name)
 899                                        (imap-error-text nnimap-server-buffer))
 900                     (cons group article)))))
 901           (add-hook 'imap-fetch-data-hook
 902                     (nnimap-make-callback article
 903                                           nnheader-callback-function
 904                                           nntp-server-buffer))
 905           (imap-fetch-asynch article part nil nnimap-server-buffer)
 906           (cons group article))))))
 907
 908 (deffoo nnimap-asynchronous-p ()
 909   t)
 910
 911 (deffoo nnimap-request-article (article &optional group server to-buffer)
 912   (if (imap-capability 'IMAP4rev1 nnimap-server-buffer)
 913       (nnimap-request-article-part
 914        article "BODY.PEEK[]" 'BODYDETAIL group server to-buffer 'detail)
 915     (nnimap-request-article-part
 916      article "RFC822.PEEK" 'RFC822 group server to-buffer)))
 917
 918 (deffoo nnimap-request-head (article &optional group server to-buffer)
 919   (if (imap-capability 'IMAP4rev1 nnimap-server-buffer)
 920       (nnimap-request-article-part
 921        article "BODY.PEEK[HEADER]" 'BODYDETAIL group server to-buffer 'detail)
 922     (nnimap-request-article-part
 923      article "RFC822.HEADER" 'RFC822.HEADER group server to-buffer)))
 924
 925 (deffoo nnimap-request-body (article &optional group server to-buffer)
 926   (if (imap-capability 'IMAP4rev1 nnimap-server-buffer)
 927       (nnimap-request-article-part
 928        article "BODY.PEEK[TEXT]" 'BODYDETAIL group server to-buffer 'detail)
 929     (nnimap-request-article-part
 930      article "RFC822.TEXT.PEEK" 'RFC822.TEXT group server to-buffer)))
 931
 932 (deffoo nnimap-request-group (group &optional server fast)
 933   (nnimap-request-update-info-internal
 934    group
 935    (gnus-get-info (gnus-group-prefixed-name
 936                    group (gnus-server-to-method (format "nnimap:%s" server))))
 937    server)
 938   (when (nnimap-possibly-change-group group server)
 939     (nnimap-before-find-minmax-bugworkaround)
 940     (let (info)
 941       (cond (fast group)
 942             ((null (setq info (nnimap-find-minmax-uid group t)))
 943              (nnheader-report 'nnimap "Could not get active info for %s"
 944                               group))
 945             (t
 946              (nnheader-insert "211 %d %d %d %s\n" (or (nth 0 info) 0)
 947                               (max 1 (or (nth 1 info) 1))
 948                               (or (nth 2 info) 0) group)
 949              (nnheader-report 'nnimap "Group %s selected" group)
 950              t)))))
 951
 952 (defun nnimap-update-unseen (group &optional server)
 953   "Update the unseen count in `nnimap-mailbox-info'."
 954   (gnus-sethash
 955    (gnus-group-prefixed-name group server)
 956    (let ((old (gnus-gethash-safe (gnus-group-prefixed-name group server)
 957                                  nnimap-mailbox-info)))
 958      (list (nth 0 old) (nth 1 old)
 959            (imap-mailbox-status group 'unseen nnimap-server-buffer)
 960            (nth 3 old)))
 961    nnimap-mailbox-info))
 962
 963 (defun nnimap-close-group (group &optional server)
 964   (with-current-buffer nnimap-server-buffer
 965     (when (and (imap-opened)
 966                (nnimap-possibly-change-group group server))
 967       (nnimap-update-unseen group server)
 968       (case nnimap-expunge-on-close
 969         (always (progn
 970                   (imap-mailbox-expunge nnimap-close-asynchronous)
 971                   (unless nnimap-dont-close
 972                     (imap-mailbox-close nnimap-close-asynchronous))))
 973         (ask (if (and (imap-search "DELETED")
 974                       (gnus-y-or-n-p (format "Expunge articles in group `%s'? "
 975                                              imap-current-mailbox)))
 976                  (progn
 977                    (imap-mailbox-expunge nnimap-close-asynchronous)
 978                    (unless nnimap-dont-close
 979                      (imap-mailbox-close nnimap-close-asynchronous)))
 980                (imap-mailbox-unselect)))
 981         (t (imap-mailbox-unselect)))
 982       (not imap-current-mailbox))))
 983
 984 (defun nnimap-pattern-to-list-arguments (pattern)
 985   (mapcar (lambda (p)
 986             (cons (car-safe p) (or (cdr-safe p) p)))
 987           (if (and (listp pattern)
 988                    (listp (cdr pattern)))
 989               pattern
 990             (list pattern))))
 991
 992 (deffoo nnimap-request-list (&optional server)
 993   (when (nnimap-possibly-change-server server)
 994     (with-current-buffer nntp-server-buffer
 995       (erase-buffer))
 996     (gnus-message 5 "nnimap: Generating active list%s..."
 997                   (if (> (length server) 0) (concat " for " server) ""))
 998     (nnimap-before-find-minmax-bugworkaround)
 999     (with-current-buffer nnimap-server-buffer
1000       (dolist (pattern (nnimap-pattern-to-list-arguments nnimap-list-pattern))
1001         (dolist (mbx (funcall nnimap-request-list-method
1002                               (cdr pattern) (car pattern)))
1003           (or (member "\\NoSelect" (imap-mailbox-get 'list-flags mbx))
1004               (let ((info (nnimap-find-minmax-uid mbx 'examine)))
1005                 (when info
1006                   (with-current-buffer nntp-server-buffer
1007                     (insert (format "\"%s\" %d %d y\n"
1008                                     mbx (or (nth 2 info) 0)
1009                                     (max 1 (or (nth 1 info) 1)))))))))))
1010     (gnus-message 5 "nnimap: Generating active list%s...done"
1011                   (if (> (length server) 0) (concat " for " server) ""))
1012     t))
1013
1014 (deffoo nnimap-request-post (&optional server)
1015   (let ((success t))
1016     (dolist (mbx (message-unquote-tokens
1017                   (message-tokenize-header
1018                    (message-fetch-field "Newsgroups") ", ")) success)
1019       (let ((to-newsgroup (gnus-group-prefixed-name mbx gnus-command-method)))
1020         (or (gnus-active to-newsgroup)
1021             (gnus-activate-group to-newsgroup)
1022             (if (gnus-y-or-n-p (format "No such group: %s.  Create it? "
1023                                        to-newsgroup))
1024                 (or (and (gnus-request-create-group
1025                           to-newsgroup gnus-command-method)
1026                          (gnus-activate-group to-newsgroup nil nil
1027                                               gnus-command-method))
1028                     (error "Couldn't create group %s" to-newsgroup)))
1029             (error "No such group: %s" to-newsgroup))
1030         (unless (nnimap-request-accept-article mbx (nth 1 gnus-command-method))
1031           (setq success nil))))))
1032
1033 ;; Optional backend functions
1034
1035 (defun nnimap-string-lessp-numerical (s1 s2)
1036   "Return t if first arg string is less than second in numerical order."
1037   (cond ((string= s1 s2)
1038          nil)
1039         ((> (length s1) (length s2))
1040          nil)
1041         ((< (length s1) (length s2))
1042          t)
1043         ((< (string-to-number (substring s1 0 1))
1044             (string-to-number (substring s2 0 1)))
1045          t)
1046         ((> (string-to-number (substring s1 0 1))
1047             (string-to-number (substring s2 0 1)))
1048          nil)
1049         (t
1050          (nnimap-string-lessp-numerical (substring s1 1) (substring s2 1)))))
1051
1052 (deffoo nnimap-retrieve-groups (groups &optional server)
1053   (when (nnimap-possibly-change-server server)
1054     (gnus-message 5 "nnimap: Checking mailboxes...")
1055     (with-current-buffer nntp-server-buffer
1056       (erase-buffer)
1057       (nnimap-before-find-minmax-bugworkaround)
1058       (let (asyncgroups slowgroups)
1059         (if (null nnimap-retrieve-groups-asynchronous)
1060             (setq slowgroups groups)
1061           (dolist (group groups)
1062             (gnus-message 9 "nnimap: Quickly checking mailbox %s" group)
1063             (add-to-list (if (gnus-gethash-safe
1064                               (gnus-group-prefixed-name group server)
1065                               nnimap-mailbox-info)
1066                              'asyncgroups
1067                            'slowgroups)
1068                          (list group (imap-mailbox-status-asynch
1069                                       group '(uidvalidity uidnext unseen)
1070                                       nnimap-server-buffer))))
1071           (dolist (asyncgroup asyncgroups)
1072             (let ((group (nth 0 asyncgroup))
1073                   (tag   (nth 1 asyncgroup))
1074                   new old)
1075               (when (imap-ok-p (imap-wait-for-tag tag nnimap-server-buffer))
1076                 (if (or (not (string=
1077                               (nth 0 (gnus-gethash (gnus-group-prefixed-name
1078                                                     group server)
1079                                                    nnimap-mailbox-info))
1080                               (imap-mailbox-get 'uidvalidity group
1081                                                 nnimap-server-buffer)))
1082                         (not (string=
1083                               (nth 1 (gnus-gethash (gnus-group-prefixed-name
1084                                                     group server)
1085                                                    nnimap-mailbox-info))
1086                               (imap-mailbox-get 'uidnext group
1087                                                 nnimap-server-buffer))))
1088                     (push (list group) slowgroups)
1089                   (insert (nth 3 (gnus-gethash (gnus-group-prefixed-name
1090                                                 group server)
1091                                                nnimap-mailbox-info))))))))
1092         (dolist (group slowgroups)
1093           (if nnimap-retrieve-groups-asynchronous
1094               (setq group (car group)))
1095           (gnus-message 7 "nnimap: Mailbox %s modified" group)
1096           (imap-mailbox-put 'uidnext nil group nnimap-server-buffer)
1097           (or (member "\\NoSelect" (imap-mailbox-get 'list-flags group
1098                                                      nnimap-server-buffer))
1099               (let* ((info (nnimap-find-minmax-uid group 'examine))
1100                      (str (format "\"%s\" %d %d y\n" group
1101                                   (or (nth 2 info) 0)
1102                                   (max 1 (or (nth 1 info) 1)))))
1103                 (when (> (or (imap-mailbox-get 'recent group
1104                                                nnimap-server-buffer) 0)
1105                          0)
1106                   (push (list (cons group 0)) nnmail-split-history))
1107                 (insert str)
1108                 (when nnimap-retrieve-groups-asynchronous
1109                   (gnus-sethash
1110                    (gnus-group-prefixed-name group server)
1111                    (list (or (imap-mailbox-get
1112                               'uidvalidity group nnimap-server-buffer)
1113                              (imap-mailbox-status
1114                               group 'uidvalidity nnimap-server-buffer))
1115                          (or (imap-mailbox-get
1116                               'uidnext group nnimap-server-buffer)
1117                              (imap-mailbox-status
1118                               group 'uidnext nnimap-server-buffer))
1119                          (or (imap-mailbox-get
1120                               'unseen group nnimap-server-buffer)
1121                              (imap-mailbox-status
1122                               group 'unseen nnimap-server-buffer))
1123                          str)
1124                    nnimap-mailbox-info)))))))
1125     (gnus-message 5 "nnimap: Checking mailboxes...done")
1126     'active))
1127
1128 (deffoo nnimap-request-update-info-internal (group info &optional server)
1129   (when (nnimap-possibly-change-group group server)
1130     (when info;; xxx what does this mean? should we create a info?
1131       (with-current-buffer nnimap-server-buffer
1132         (gnus-message 5 "nnimap: Updating info for %s..."
1133                       (gnus-info-group info))
1134
1135         (when (nnimap-mark-permanent-p 'read)
1136           (let (seen unseen)
1137             ;; read info could contain articles marked unread by other
1138             ;; imap clients!  we correct this
1139             (setq seen (gnus-uncompress-range (gnus-info-read info))
1140                   unseen (imap-search "UNSEEN UNDELETED")
1141                   seen (gnus-set-difference seen unseen)
1142                   ;; seen might lack articles marked as read by other
1143                   ;; imap clients! we correct this
1144                   seen (append seen (imap-search "SEEN"))
1145                   ;; remove dupes
1146                   seen (sort seen '<)
1147                   seen (gnus-compress-sequence seen t)
1148                   ;; we can't return '(1) since this isn't a "list of ranges",
1149                   ;; and we can't return '((1)) since g-list-of-unread-articles
1150                   ;; is buggy so we return '((1 . 1)).
1151                   seen (if (and (integerp (car seen))
1152                                 (null (cdr seen)))
1153                            (list (cons (car seen) (car seen)))
1154                          seen))
1155             (gnus-info-set-read info seen)))
1156
1157         (mapcar (lambda (pred)
1158                   (when (or (eq (cdr pred) 'recent)
1159                             (and (nnimap-mark-permanent-p (cdr pred))
1160                                  (member (nnimap-mark-to-flag (cdr pred))
1161                                          (imap-mailbox-get 'flags))))
1162                     (gnus-info-set-marks
1163                      info
1164                      (gnus-update-alist-soft
1165                       (cdr pred)
1166                       (gnus-compress-sequence
1167                        (imap-search (nnimap-mark-to-predicate (cdr pred))))
1168                       (gnus-info-marks info))
1169                      t)))
1170                 gnus-article-mark-lists)
1171
1172         (when nnimap-importantize-dormant
1173           ;; nnimap mark dormant article as ticked too (for other clients)
1174           ;; so we remove that mark for gnus since we support dormant
1175           (gnus-info-set-marks
1176            info
1177            (gnus-update-alist-soft
1178             'tick
1179             (gnus-remove-from-range
1180              (cdr-safe (assoc 'tick (gnus-info-marks info)))
1181              (cdr-safe (assoc 'dormant (gnus-info-marks info))))
1182             (gnus-info-marks info))
1183            t))
1184
1185         (gnus-message 5 "nnimap: Updating info for %s...done"
1186                       (gnus-info-group info))
1187
1188         info))))
1189
1190 (deffoo nnimap-request-type (group &optional article)
1191   (if (and nnimap-news-groups (string-match nnimap-news-groups group))
1192       'news
1193     'mail))
1194
1195 (deffoo nnimap-request-set-mark (group actions &optional server)
1196   (when (nnimap-possibly-change-group group server)
1197     (with-current-buffer nnimap-server-buffer
1198       (let (action)
1199         (gnus-message 7 "nnimap: Setting marks in %s..." group)
1200         (while (setq action (pop actions))
1201           (let ((range (nth 0 action))
1202                 (what  (nth 1 action))
1203                 (cmdmarks (nth 2 action))
1204                 marks)
1205             ;; bookmark can't be stored (not list/range
1206             (setq cmdmarks (delq 'bookmark cmdmarks))
1207             ;; killed can't be stored (not list/range
1208             (setq cmdmarks (delq 'killed cmdmarks))
1209             ;; unsent are for nndraft groups only
1210             (setq cmdmarks (delq 'unsent cmdmarks))
1211             ;; cache flags are pointless on the server
1212             (setq cmdmarks (delq 'cache cmdmarks))
1213             ;; seen flags are local to each gnus
1214             (setq cmdmarks (delq 'seen cmdmarks))
1215             ;; recent marks can't be set
1216             (setq cmdmarks (delq 'recent cmdmarks))
1217             (when nnimap-importantize-dormant
1218               ;; flag dormant articles as ticked
1219               (if (memq 'dormant cmdmarks)
1220                   (setq cmdmarks (cons 'tick cmdmarks))))
1221             ;; remove stuff we are forbidden to store
1222             (mapcar (lambda (mark)
1223                       (if (imap-message-flag-permanent-p
1224                            (nnimap-mark-to-flag mark))
1225                           (setq marks (cons mark marks))))
1226                     cmdmarks)
1227             (when (and range marks)
1228               (cond ((eq what 'del)
1229                      (imap-message-flags-del
1230                       (imap-range-to-message-set range)
1231                       (nnimap-mark-to-flag marks nil t)))
1232                     ((eq what 'add)
1233                      (imap-message-flags-add
1234                       (imap-range-to-message-set range)
1235                       (nnimap-mark-to-flag marks nil t)))
1236                     ((eq what 'set)
1237                      (imap-message-flags-set
1238                       (imap-range-to-message-set range)
1239                       (nnimap-mark-to-flag marks nil t)))))))
1240         (gnus-message 7 "nnimap: Setting marks in %s...done" group))))
1241   nil)
1242
1243 (defun nnimap-split-fancy ()
1244   "Like the function `nnmail-split-fancy', but uses `nnimap-split-fancy'."
1245   (let ((nnmail-split-fancy nnimap-split-fancy))
1246     (nnmail-split-fancy)))
1247
1248 (defun nnimap-split-to-groups (rules)
1249   ;; tries to match all rules in nnimap-split-rule against content of
1250   ;; nntp-server-buffer, returns a list of groups that matched.
1251   (with-current-buffer nntp-server-buffer
1252     ;; Fold continuation lines.
1253     (goto-char (point-min))
1254     (while (re-search-forward "\\(\r?\n[ \t]+\\)+" nil t)
1255       (replace-match " " t t))
1256     (if (functionp rules)
1257         (funcall rules)
1258       (let (to-groups regrepp)
1259         (catch 'split-done
1260           (dolist (rule rules to-groups)
1261             (let ((group (car rule))
1262                   (regexp (cadr rule)))
1263               (goto-char (point-min))
1264               (when (and (if (stringp regexp)
1265                              (progn
1266                                (if (not (stringp group))
1267                                    (setq group (eval group))
1268                                  (setq regrepp
1269                                        (string-match "\\\\[0-9&]" group)))
1270                                (re-search-forward regexp nil t))
1271                            (funcall regexp group))
1272                          ;; Don't enter the article into the same group twice.
1273                          (not (assoc group to-groups)))
1274                 (push (if regrepp
1275                           (nnmail-expand-newtext group)
1276                         group)
1277                       to-groups)
1278                 (or nnimap-split-crosspost
1279                     (throw 'split-done to-groups))))))))))
1280
1281 (defun nnimap-assoc-match (key alist)
1282   (let (element)
1283     (while (and alist (not element))
1284       (if (string-match (car (car alist)) key)
1285           (setq element (car alist)))
1286       (setq alist (cdr alist)))
1287     element))
1288
1289 (defun nnimap-split-find-rule (server inbox)
1290   (if (and (listp nnimap-split-rule) (listp (car nnimap-split-rule))
1291            (list (cdar nnimap-split-rule)) (listp (cadar nnimap-split-rule)))
1292       ;; extended format
1293       (cadr (nnimap-assoc-match inbox (cdr (nnimap-assoc-match
1294                                             server nnimap-split-rule))))
1295     nnimap-split-rule))
1296
1297 (defun nnimap-split-find-inbox (server)
1298   (if (listp nnimap-split-inbox)
1299       nnimap-split-inbox
1300     (list nnimap-split-inbox)))
1301
1302 (defun nnimap-split-articles (&optional group server)
1303   (when (nnimap-possibly-change-server server)
1304     (with-current-buffer nnimap-server-buffer
1305       (let (rule inbox removeorig (inboxes (nnimap-split-find-inbox server)))
1306         ;; iterate over inboxes
1307         (while (and (setq inbox (pop inboxes))
1308                     (nnimap-possibly-change-group inbox));; SELECT
1309           ;; find split rule for this server / inbox
1310           (when (setq rule (nnimap-split-find-rule server inbox))
1311             ;; iterate over articles
1312             (dolist (article (imap-search nnimap-split-predicate))
1313               (when (if (if (eq nnimap-split-download-body 'default)
1314                             nnimap-split-download-body-default
1315                           nnimap-split-download-body)
1316                         (and (nnimap-request-article article)
1317                              (with-current-buffer nntp-server-buffer (mail-narrow-to-head)))
1318                       (nnimap-request-head article))
1319                 ;; copy article to right group(s)
1320                 (setq removeorig nil)
1321                 (dolist (to-group (nnimap-split-to-groups rule))
1322                   (cond ((eq to-group 'junk)
1323                          (message "IMAP split removed %s:%s:%d" server inbox
1324                                   article)
1325                          (setq removeorig t))
1326                         ((imap-message-copy (number-to-string article)
1327                                             to-group nil 'nocopyuid)
1328                          (message "IMAP split moved %s:%s:%d to %s" server
1329                                   inbox article to-group)
1330                          (setq removeorig t)
1331                          (when nnmail-cache-accepted-message-ids
1332                            (with-current-buffer nntp-server-buffer
1333                              (let (msgid)
1334                                (and (setq msgid
1335                                           (nnmail-fetch-field "message-id"))
1336                                     (nnmail-cache-insert msgid
1337                                                          to-group
1338                                                          (nnmail-fetch-field "subject"))))))
1339                          ;; Add the group-art list to the history list.
1340                          (push (list (cons to-group 0)) nnmail-split-history))
1341                         (t
1342                          (message "IMAP split failed to move %s:%s:%d to %s"
1343                                   server inbox article to-group))))
1344                 (if (if (eq nnimap-split-download-body 'default)
1345                         nnimap-split-download-body-default
1346                       nnimap-split-download-body)
1347                     (widen))
1348                 ;; remove article if it was successfully copied somewhere
1349                 (and removeorig
1350                      (imap-message-flags-add (format "%d" article)
1351                                              "\\Seen \\Deleted")))))
1352           (when (imap-mailbox-select inbox);; just in case
1353             ;; todo: UID EXPUNGE (if available) to remove splitted articles
1354             (imap-mailbox-expunge)
1355             (imap-mailbox-close)))
1356         (when nnmail-cache-accepted-message-ids
1357           (nnmail-cache-close))
1358         t))))
1359
1360 (deffoo nnimap-request-scan (&optional group server)
1361   (nnimap-split-articles group server))
1362
1363 (deffoo nnimap-request-newgroups (date &optional server)
1364   (when (nnimap-possibly-change-server server)
1365     (with-current-buffer nntp-server-buffer
1366       (gnus-message 5 "nnimap: Listing subscribed mailboxes%s%s..."
1367                     (if (> (length server) 0) " on " "") server)
1368       (erase-buffer)
1369       (nnimap-before-find-minmax-bugworkaround)
1370       (dolist (pattern (nnimap-pattern-to-list-arguments
1371                         nnimap-list-pattern))
1372         (dolist (mbx (imap-mailbox-lsub (cdr pattern) (car pattern) nil
1373                                         nnimap-server-buffer))
1374           (or (catch 'found
1375                 (dolist (mailbox (imap-mailbox-get 'list-flags mbx
1376                                                    nnimap-server-buffer))
1377                   (if (string= (downcase mailbox) "\\noselect")
1378                       (throw 'found t)))
1379                 nil)
1380               (let ((info (nnimap-find-minmax-uid mbx 'examine)))
1381                 (when info
1382                   (insert (format "\"%s\" %d %d y\n"
1383                                   mbx (or (nth 2 info) 0)
1384                                   (max 1 (or (nth 1 info) 1)))))))))
1385       (gnus-message 5 "nnimap: Listing subscribed mailboxes%s%s...done"
1386                     (if (> (length server) 0) " on " "") server))
1387     t))
1388
1389 (deffoo nnimap-request-create-group (group &optional server args)
1390   (when (nnimap-possibly-change-server server)
1391     (or (imap-mailbox-status group 'uidvalidity nnimap-server-buffer)
1392         (imap-mailbox-create group nnimap-server-buffer)
1393         (nnheader-report 'nnimap "%S"
1394                          (imap-error-text nnimap-server-buffer)))))
1395
1396 (defun nnimap-time-substract (time1 time2)
1397   "Return TIME for TIME1 - TIME2."
1398   (let* ((ms (- (car time1) (car time2)))
1399          (ls (- (nth 1 time1) (nth 1 time2))))
1400     (if (< ls 0)
1401         (list (- ms 1) (+ (expt 2 16) ls))
1402       (list ms ls))))
1403
1404 (defun nnimap-date-days-ago (daysago)
1405   "Return date, in format \"3-Aug-1998\", for DAYSAGO days ago."
1406   (let* ((time (nnimap-time-substract (current-time) (days-to-time daysago)))
1407          (date (format-time-string
1408                 (format "%%d-%s-%%Y"
1409                         (capitalize (car (rassoc (nth 4 (decode-time time))
1410                                                  parse-time-months))))
1411                 time)))
1412     (if (eq ?0 (string-to-char date))
1413         (substring date 1)
1414       date)))
1415
1416 (defun nnimap-request-expire-articles-progress ()
1417   (gnus-message 5 "nnimap: Marking article %d for deletion..."
1418                 imap-current-message))
1419
1420 (defun nnimap-expiry-target (arts group server)
1421   (unless (eq nnmail-expiry-target 'delete)
1422     (with-temp-buffer
1423       (dolist (art arts)
1424         (nnimap-request-article art group server (current-buffer))
1425         ;; hints for optimization in `nnimap-request-accept-article'
1426         (let ((nnimap-current-move-article art)
1427               (nnimap-current-move-group group)
1428               (nnimap-current-move-server server))
1429           (nnmail-expiry-target-group nnmail-expiry-target group))))
1430     ;; It is not clear if `nnmail-expiry-target' somehow cause the
1431     ;; current group to be changed or not, so we make sure here.
1432     (nnimap-possibly-change-group group server)))
1433
1434 ;; Notice that we don't actually delete anything, we just mark them deleted.
1435 (deffoo nnimap-request-expire-articles (articles group &optional server force)
1436   (let ((artseq (gnus-compress-sequence articles)))
1437     (when (and artseq (nnimap-possibly-change-group group server))
1438       (with-current-buffer nnimap-server-buffer
1439         (let ((days (or (and nnmail-expiry-wait-function
1440                              (funcall nnmail-expiry-wait-function group))
1441                         nnmail-expiry-wait)))
1442           (cond ((or force (eq days 'immediate))
1443                  (let ((oldarts (imap-search
1444                                  (concat "UID "
1445                                          (imap-range-to-message-set artseq)))))
1446                    (when oldarts
1447                      (nnimap-expiry-target oldarts group server)
1448                      (when (imap-message-flags-add
1449                             (imap-range-to-message-set
1450                              (gnus-compress-sequence oldarts)) "\\Deleted")
1451                        (setq articles (gnus-set-difference
1452                                        articles oldarts))))))
1453                 ((numberp days)
1454                  (let ((oldarts (imap-search
1455                                  (format nnimap-expunge-search-string
1456                                          (imap-range-to-message-set artseq)
1457                                          (nnimap-date-days-ago days))))
1458                        (imap-fetch-data-hook
1459                         '(nnimap-request-expire-articles-progress)))
1460                    (when oldarts
1461                      (nnimap-expiry-target oldarts group server)
1462                      (when (imap-message-flags-add
1463                             (imap-range-to-message-set
1464                              (gnus-compress-sequence oldarts)) "\\Deleted")
1465                        (setq articles (gnus-set-difference
1466                                        articles oldarts)))))))))))
1467   ;; return articles not deleted
1468   articles)
1469
1470 (deffoo nnimap-request-move-article (article group server
1471                                              accept-form &optional last)
1472   (when (nnimap-possibly-change-server server)
1473     (save-excursion
1474       (let ((buf (get-buffer-create " *nnimap move*"))
1475             (nnimap-current-move-article article)
1476             (nnimap-current-move-group group)
1477             (nnimap-current-move-server nnimap-current-server)
1478             result)
1479         (and (nnimap-request-article article group server)
1480              (save-excursion
1481                (set-buffer buf)
1482                (buffer-disable-undo (current-buffer))
1483                (insert-buffer-substring nntp-server-buffer)
1484                (setq result (eval accept-form))
1485                (kill-buffer buf)
1486                result)
1487              (imap-message-flags-add
1488               (imap-range-to-message-set (list article))
1489               "\\Deleted" 'silent nnimap-server-buffer))
1490         result))))
1491
1492 (deffoo nnimap-request-accept-article (group &optional server last)
1493   (when (nnimap-possibly-change-server server)
1494     (let (uid)
1495       (if (setq uid
1496                 (if (string= nnimap-current-server nnimap-current-move-server)
1497                     ;; moving article within same server, speed it up...
1498                     (and (nnimap-possibly-change-group
1499                           nnimap-current-move-group)
1500                          (imap-message-copy (number-to-string
1501                                              nnimap-current-move-article)
1502                                             group 'dontcreate nil
1503                                             nnimap-server-buffer))
1504                   (with-current-buffer (current-buffer)
1505                     (goto-char (point-min))
1506                     ;; remove any 'From blabla' lines, some IMAP servers
1507                     ;; reject the entire message otherwise.
1508                     (when (looking-at "^From[^:]")
1509                       (delete-region (point) (progn (forward-line) (point))))
1510                     ;; turn into rfc822 format (\r\n eol's)
1511                     (while (search-forward "\n" nil t)
1512                       (replace-match "\r\n"))
1513                     (when nnmail-cache-accepted-message-ids
1514                       (nnmail-cache-insert (nnmail-fetch-field "message-id")
1515                                            group
1516                                            (nnmail-fetch-field "subject"))))
1517                   (when (and last nnmail-cache-accepted-message-ids)
1518                     (nnmail-cache-close))
1519                   ;; this 'or' is for Cyrus server bug
1520                   (or (null (imap-current-mailbox nnimap-server-buffer))
1521                       (imap-mailbox-unselect nnimap-server-buffer))
1522                   (imap-message-append group (current-buffer) nil nil
1523                                        nnimap-server-buffer)))
1524           (cons group (nth 1 uid))
1525         (nnheader-report 'nnimap (imap-error-text nnimap-server-buffer))))))
1526
1527 (deffoo nnimap-request-delete-group (group force &optional server)
1528   (when (nnimap-possibly-change-server server)
1529     (with-current-buffer nnimap-server-buffer
1530       (if force
1531           (or (null (imap-mailbox-status group 'uidvalidity))
1532               (imap-mailbox-delete group))
1533         ;; UNSUBSCRIBE?
1534         t))))
1535
1536 (deffoo nnimap-request-rename-group (group new-name &optional server)
1537   (when (nnimap-possibly-change-server server)
1538     (imap-mailbox-rename group new-name nnimap-server-buffer)))
1539
1540 (defun nnimap-expunge (mailbox server)
1541   (when (nnimap-possibly-change-group mailbox server)
1542     (imap-mailbox-expunge nil nnimap-server-buffer)))
1543
1544 (defun nnimap-acl-get (mailbox server)
1545   (when (nnimap-possibly-change-server server)
1546     (and (imap-capability 'ACL nnimap-server-buffer)
1547          (imap-mailbox-acl-get mailbox nnimap-server-buffer))))
1548
1549 (defun nnimap-acl-edit (mailbox method old-acls new-acls)
1550   (when (nnimap-possibly-change-server (cadr method))
1551     (unless (imap-capability 'ACL nnimap-server-buffer)
1552       (error "Your server does not support ACL editing"))
1553     (with-current-buffer nnimap-server-buffer
1554       ;; delete all removed identifiers
1555       (mapcar (lambda (old-acl)
1556                 (unless (assoc (car old-acl) new-acls)
1557                   (or (imap-mailbox-acl-delete (car old-acl) mailbox)
1558                       (error "Can't delete ACL for %s" (car old-acl)))))
1559               old-acls)
1560       ;; set all changed acl's
1561       (mapcar (lambda (new-acl)
1562                 (let ((new-rights (cdr new-acl))
1563                       (old-rights (cdr (assoc (car new-acl) old-acls))))
1564                   (unless (and old-rights new-rights
1565                                (string= old-rights new-rights))
1566                     (or (imap-mailbox-acl-set (car new-acl) new-rights mailbox)
1567                         (error "Can't set ACL for %s to %s" (car new-acl)
1568                                new-rights)))))
1569               new-acls)
1570       t)))
1571
1572 \f
1573 ;;; Internal functions
1574
1575 ;;
1576 ;; This is confusing.
1577 ;;
1578 ;; mark      => read, tick, draft, reply etc
1579 ;; flag      => "\\Seen", "\\Flagged", "\\Draft", "gnus-expire" etc
1580 ;; predicate => "SEEN", "FLAGGED", "DRAFT", "KEYWORD gnus-expire" etc
1581 ;;
1582 ;; Mark should not really contain 'read since it's not a "mark" in the Gnus
1583 ;; world, but we cheat.  Mark == gnus-article-mark-lists + '(read . read).
1584 ;;
1585
1586 (defconst nnimap-mark-to-predicate-alist
1587   (mapcar
1588    (lambda (pair)                       ; cdr is the mark
1589      (or (assoc (cdr pair)
1590                 '((read . "SEEN")
1591                   (tick . "FLAGGED")
1592                   (draft . "DRAFT")
1593                   (recent . "RECENT")
1594                   (reply . "ANSWERED")))
1595          (cons (cdr pair)
1596                (format "KEYWORD gnus-%s" (symbol-name (cdr pair))))))
1597    (cons '(read . read) gnus-article-mark-lists)))
1598
1599 (defun nnimap-mark-to-predicate (pred)
1600   "Convert a Gnus mark (a symbol such as read, tick, expire) to a IMAP predicate.
1601 This is a string such as \"SEEN\", \"FLAGGED\", \"KEYWORD gnus-expire\",
1602 to be used within a IMAP SEARCH query."
1603   (cdr (assq pred nnimap-mark-to-predicate-alist)))
1604
1605 (defconst nnimap-mark-to-flag-alist
1606   (mapcar
1607    (lambda (pair)
1608      (or (assoc (cdr pair)
1609                 '((read . "\\Seen")
1610                   (tick . "\\Flagged")
1611                   (draft . "\\Draft")
1612                   (recent . "\\Recent")
1613                   (reply . "\\Answered")))
1614          (cons (cdr pair)
1615                (format "gnus-%s" (symbol-name (cdr pair))))))
1616    (cons '(read . read) gnus-article-mark-lists)))
1617
1618 (defun nnimap-mark-to-flag-1 (preds)
1619   (if (and (not (null preds)) (listp preds))
1620       (cons (nnimap-mark-to-flag (car preds))
1621             (nnimap-mark-to-flag (cdr preds)))
1622     (cdr (assoc preds nnimap-mark-to-flag-alist))))
1623
1624 (defun nnimap-mark-to-flag (preds &optional always-list make-string)
1625   "Convert a Gnus mark (a symbol such as read, tick, expire) to a IMAP flag.
1626 This is a string such as \"\\Seen\", \"\\Flagged\", \"gnus-expire\", to
1627 be used in a STORE FLAGS command."
1628   (let ((result (nnimap-mark-to-flag-1 preds)))
1629     (setq result (if (and (or make-string always-list)
1630                           (not (listp result)))
1631                      (list result)
1632                    result))
1633     (if make-string
1634         (mapconcat (lambda (flag)
1635                      (if (listp flag)
1636                          (mapconcat 'identity flag " ")
1637                        flag))
1638                    result " ")
1639       result)))
1640
1641 (defun nnimap-mark-permanent-p (mark &optional group)
1642   "Return t iff MARK can be permanently (between IMAP sessions) saved on articles, in GROUP."
1643   (imap-message-flag-permanent-p (nnimap-mark-to-flag mark)))
1644
1645 (when nnimap-debug
1646   (require 'trace)
1647   (buffer-disable-undo (get-buffer-create nnimap-debug-buffer))
1648   (mapcar (lambda (f) (trace-function-background f nnimap-debug-buffer))
1649           '(
1650             nnimap-possibly-change-server
1651             nnimap-verify-uidvalidity
1652             nnimap-find-minmax-uid
1653             nnimap-before-find-minmax-bugworkaround
1654             nnimap-possibly-change-group
1655             ;;nnimap-replace-whitespace
1656             nnimap-retrieve-headers-progress
1657             nnimap-retrieve-which-headers
1658             nnimap-group-overview-filename
1659             nnimap-retrieve-headers-from-file
1660             nnimap-retrieve-headers-from-server
1661             nnimap-retrieve-headers
1662             nnimap-open-connection
1663             nnimap-open-server
1664             nnimap-server-opened
1665             nnimap-close-server
1666             nnimap-request-close
1667             nnimap-status-message
1668             ;;nnimap-demule
1669             nnimap-request-article-part
1670             nnimap-request-article
1671             nnimap-request-head
1672             nnimap-request-body
1673             nnimap-request-group
1674             nnimap-close-group
1675             nnimap-pattern-to-list-arguments
1676             nnimap-request-list
1677             nnimap-request-post
1678             nnimap-retrieve-groups
1679             nnimap-request-update-info-internal
1680             nnimap-request-type
1681             nnimap-request-set-mark
1682             nnimap-split-to-groups
1683             nnimap-split-find-rule
1684             nnimap-split-find-inbox
1685             nnimap-split-articles
1686             nnimap-request-scan
1687             nnimap-request-newgroups
1688             nnimap-request-create-group
1689             nnimap-time-substract
1690             nnimap-date-days-ago
1691             nnimap-request-expire-articles-progress
1692             nnimap-request-expire-articles
1693             nnimap-request-move-article
1694             nnimap-request-accept-article
1695             nnimap-request-delete-group
1696             nnimap-request-rename-group
1697             gnus-group-nnimap-expunge
1698             gnus-group-nnimap-edit-acl
1699             gnus-group-nnimap-edit-acl-done
1700             nnimap-group-mode-hook
1701             nnimap-mark-to-predicate
1702             nnimap-mark-to-flag-1
1703             nnimap-mark-to-flag
1704             nnimap-mark-permanent-p
1705             )))
1706
1707 (provide 'nnimap)
1708
1709 ;;; nnimap.el ends here