1 ;;; nnimap.el --- imap backend for Gnus
3 ;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005 Free Software Foundation, Inc.
6 ;; Author: Simon Josefsson <jas@pdc.kth.se>
7 ;; Jim Radford <radford@robby.caltech.edu>
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, USA.
29 ;; Todo, major things:
31 ;; o Fix Gnus to view correct number of unread/total articles in group buffer
32 ;; o Fix Gnus to handle leading '.' in group names (fixed?)
33 ;; o Finish disconnected mode (moving articles between mailboxes unplugged)
35 ;; o MIME (partial article fetches)
36 ;; o Split to other backends, different split rules for different
39 ;; Todo, minor things:
41 ;; o Don't require half of Gnus -- backends should be standalone
42 ;; o Verify that we don't use IMAP4rev1 specific things (RFC2060 App B)
43 ;; o Dont uid fetch 1,* in nnimap-retrive-groups (slow)
44 ;; o Split up big fetches (1,* header especially) in smaller chunks
45 ;; o What do I do with gnus-newsgroup-*?
46 ;; o Tell Gnus about new groups (how can we tell?)
47 ;; o Respooling (fix Gnus?) (unnecessary?)
48 ;; o Add support for the following: (if applicable)
49 ;; request-list-newsgroups, request-regenerate
51 ;; request-associate-buffer, request-restore-buffer,
52 ;; o Do The Right Thing when UIDVALIDITY changes (what's the right thing?)
53 ;; o Support RFC2221 (Login referrals)
54 ;; o IMAP2BIS compatibility? (RFC2061)
55 ;; o ACAP stuff (perhaps a different project, would be nice to ACAPify
57 ;; o What about Gnus's article editing, can we support it? NO!
58 ;; o Use \Draft to support the draft group??
59 ;; o Duplicate suppression
60 ;; o Rewrite UID SEARCH UID X as UID FETCH X (UID) for those with slow servers
64 (eval-when-compile (require 'cl))
75 (eval-when-compile (require 'cl))
79 (defconst nnimap-version "nnimap 1.0")
82 "Reading IMAP mail with Gnus."
85 (defvoo nnimap-address nil
86 "Address of physical IMAP server. If nil, use the virtual server's name.")
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.")
92 ;; Splitting variables
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."
100 (defcustom nnimap-split-inbox nil
101 "Name of mailbox to split mail from.
103 Mail is read from this mailbox and split according to rules in
106 This can be a string or a list of strings."
108 :type '(choice (string)
111 (define-widget 'nnimap-strict-function 'function
112 "This widget only matches values that are functionp.
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)
118 (defun nnimap-strict-function-match (widget value)
119 "Ignoring WIDGET, match if VALUE is a function."
122 (defcustom nnimap-split-rule nil
123 "Mail will be split according to these rules.
125 Mail is read from mailbox(es) specified in `nnimap-split-inbox'.
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
132 \(setq nnimap-split-rule '((\"INBOX.gnus-imap\" \"From:.*gnus-imap\")
133 (\"INBOX.junk\" \"Subject:.*buy\")))
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.
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.
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'.
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:
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)))))
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."
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"
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")))))))))
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."
198 (defcustom nnimap-split-fancy nil
199 "Like the variable `nnmail-split-fancy'."
203 (defvar nnimap-split-download-body-default nil
204 "Internal variable with default value for `nnimap-split-download-body'.")
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 analyzes 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
218 :type '(choice (const :tag "Let system decide" deault)
221 ;; Performance / bug workaround variables
223 (defcustom nnimap-close-asynchronous t
224 "Close mailboxes asynchronously in `nnimap-close-group'.
225 This means that errors caught by nnimap when closing the mailbox will
226 not prevent Gnus from updating the group status, which may be harmful.
227 However, it increases speed."
232 (defcustom nnimap-dont-close t
233 "Never close mailboxes.
234 This increases the speed of closing mailboxes (quiting group) but may
235 decrease the speed of selecting another mailbox later. Re-selecting
236 the same mailbox will be faster though."
241 (defcustom nnimap-retrieve-groups-asynchronous t
242 "Send asynchronous STATUS commands for each mailbox before checking mail.
243 If you have mailboxes that rarely receives mail, this speeds up new
244 mail checking. It works by first sending STATUS commands for each
245 mailbox, and then only checking groups which has a modified UIDNEXT
246 more carefully for new mail.
248 In summary, the default is O((1-p)*k+p*n) and changing it to nil makes
249 it O(n). If p is small, then the default is probably faster."
254 (defvoo nnimap-need-unselect-to-notice-new-mail nil
255 "Unselect mailboxes before looking for new mail in them.
256 Some servers seem to need this under some circumstances.")
258 ;; Authorization / Privacy variables
260 (defvoo nnimap-auth-method nil
263 (defvoo nnimap-stream nil
264 "How nnimap will connect to the server.
266 The default, nil, will try to use the \"best\" method the server can
271 1) you want to connect with TLS/SSL. The TLS/SSL integration
272 with IMAP is suboptimal so you'll have to tell it
275 2) your server is more capable than your environment -- i.e. your
276 server accept Kerberos login's but you haven't installed the
277 `imtest' program or your machine isn't configured for Kerberos.
279 Possible choices: gssapi, kerberos4, starttls, tls, ssl, network, shell.
280 See also `imap-streams' and `imap-stream-alist'.")
282 (defvoo nnimap-authenticator nil
283 "How nnimap authenticate itself to the server.
285 The default, nil, will try to use the \"best\" method the server can
288 There is only one reason for fiddling with this variable, and that is
289 if your server is more capable than your environment -- i.e. you
290 connect to a server that accept Kerberos login's but you haven't
291 installed the `imtest' program or your machine isn't configured for
294 Possible choices: gssapi, kerberos4, digest-md5, cram-md5, login, anonymous.
295 See also `imap-authenticators' and `imap-authenticator-alist'")
297 (defvoo nnimap-directory (nnheader-concat gnus-directory "overview/")
298 "Directory to keep NOV cache files for nnimap groups.
299 See also `nnimap-nov-file-name'.")
301 (defvoo nnimap-nov-file-name "nnimap."
302 "NOV cache base filename.
303 The group name and `nnimap-nov-file-name-suffix' will be appended. A
304 typical complete file name would be
305 ~/News/overview/nnimap.pdc.INBOX.ding.nov, or
306 ~/News/overview/nnimap/pdc/INBOX/ding/nov if
307 `nnmail-use-long-file-names' is nil")
309 (defvoo nnimap-nov-file-name-suffix ".novcache"
310 "Suffix for NOV cache base filename.")
312 (defvoo nnimap-nov-is-evil gnus-agent
313 "If non-nil, never generate or use a local nov database for this backend.
314 Using nov databases should speed up header fetching considerably.
315 However, it will invoke a UID SEARCH UID command on the server, and
316 some servers implement this command inefficiently by opening each and
317 every message in the group, thus making it quite slow.
318 Unlike other backends, you do not need to take special care if you
319 flip this variable.")
321 (defvoo nnimap-search-uids-not-since-is-evil nil
322 "If non-nil, avoid \"UID SEARCH UID ... NOT SINCE\" queries when expiring.
323 Instead, use \"UID SEARCH SINCE\" to prune the list of expirable
324 articles within Gnus. This seems to be faster on Courier in some cases.")
326 (defvoo nnimap-expunge-on-close 'always ; 'ask, 'never
327 "Whether to expunge a group when it is closed.
328 When a IMAP group with articles marked for deletion is closed, this
329 variable determine if nnimap should actually remove the articles or
332 If always, nnimap always perform a expunge when closing the group.
333 If never, nnimap never expunges articles marked for deletion.
334 If ask, nnimap will ask you if you wish to expunge marked articles.
336 When setting this variable to `never', you can only expunge articles
337 by using `G x' (gnus-group-nnimap-expunge) from the Group buffer.")
339 (defvoo nnimap-list-pattern "*"
340 "A string LIMIT or list of strings with mailbox wildcards used to limit available groups.
341 See below for available wildcards.
343 The LIMIT string can be a cons cell (REFERENCE . LIMIT), where
344 REFERENCE will be passed as the first parameter to LIST/LSUB. The
345 semantics of this are server specific, on the University of Washington
346 server you can specify a directory.
349 '(\"INBOX\" \"mail/*\" (\"~friend/mail/\" . \"list/*\"))
351 There are two wildcards * and %. * matches everything, % matches
352 everything in the current hierarchy.")
354 (defvoo nnimap-news-groups nil
355 "IMAP support a news-like mode, also known as bulletin board mode,
356 where replies is sent via IMAP instead of SMTP.
358 This variable should contain a regexp matching groups where you wish
359 replies to be stored to the mailbox directly.
362 '(\"^[^I][^N][^B][^O][^X].*$\")
364 This will match all groups not beginning with \"INBOX\".
366 Note that there is nothing technically different between mail-like and
367 news-like mailboxes. If you wish to have a group with todo items or
368 similar which you wouldn't want to set up a mailing list for, you can
369 use this to make replies go directly to the group.")
371 (defvoo nnimap-expunge-search-string "UID %s NOT SINCE %s"
372 "IMAP search command to use for articles that are to be expired.
373 The first %s is replaced by a UID set of articles to search on,
374 and the second %s is replaced by a date criterium.
376 One useful (and perhaps the only useful) value to change this to would
377 be `UID %s NOT SENTSINCE %s' to make nnimap use the Date: header
378 instead of the internal date of messages. See section 6.4.4 of RFC
379 2060 for more information on valid strings.")
381 (defvoo nnimap-importantize-dormant t
382 "If non-nil, mark \"dormant\" articles as \"ticked\" for other IMAP clients.
383 Note that within Gnus, dormant articles will still (only) be
384 marked as ticked. This is to make \"dormant\" articles stand out,
385 just like \"ticked\" articles, in other IMAP clients.")
387 (defvoo nnimap-server-address nil
388 "Obsolete. Use `nnimap-address'.")
390 (defcustom nnimap-authinfo-file "~/.authinfo"
391 "Authorization information for IMAP servers. In .netrc format."
394 (repeat :tag "Entries"
397 :value ("" ("login" . "") ("password" . ""))
401 (const :format "" "login")
402 (string :format "Login: %v"))
404 (const :format "" "password")
405 (string :format "Password: %v"))))))
408 (defcustom nnimap-prune-cache t
409 "If non-nil, nnimap check whether articles still exist on server before using data stored in NOV cache."
413 (defvar nnimap-request-list-method 'imap-mailbox-list
414 "Method to use to request a list of all folders from the server.
415 If this is 'imap-mailbox-lsub, then use a server-side subscription list to
416 restrict visible folders.")
418 (defcustom nnimap-id nil
419 "Plist with client identity to send to server upon login.
420 Nil means no information is sent, symbol `no' to disable ID query
421 alltogheter, or plist with identifier-value pairs to send to
422 server. RFC 2971 describes the list as follows:
424 Any string may be sent as a field, but the following are defined to
425 describe certain values that might be sent. Implementations are free
426 to send none, any, or all of these. Strings are not case-sensitive.
427 Field strings MUST NOT be longer than 30 octets. Value strings MUST
428 NOT be longer than 1024 octets. Implementations MUST NOT send more
429 than 30 field-value pairs.
431 name Name of the program
432 version Version number of the program
433 os Name of the operating system
434 os-version Version of the operating system
435 vendor Vendor of the client/server
436 support-url URL to contact for support
437 address Postal address of contact/vendor
438 date Date program was released, specified as a date-time
440 command Command used to start the program
441 arguments Arguments supplied on the command line, if any
443 environment Description of environment, i.e., UNIX environment
444 variables or Windows registry settings
446 Implementations MUST NOT send the same field name more than once.
448 An example plist would be '(\"name\" \"Gnus\" \"version\" gnus-version-number
449 \"os\" system-configuration \"vendor\" \"GNU\")."
451 :type '(choice (const :tag "No information" nil)
452 (const :tag "Disable ID query" no)
453 (plist :key-type string :value-type string)))
455 (defcustom nnimap-debug nil
456 "If non-nil, random debug spews are placed in *nnimap-debug* buffer.
457 Note that username, passwords and other privacy sensitive
458 information (such as e-mail) may be stored in the *nnimap-debug*
459 buffer. It is not written to disk, however. Do not enable this
460 variable unless you are comfortable with that."
464 ;; Internal variables:
466 (defvar nnimap-debug-buffer "*nnimap-debug*")
467 (defvar nnimap-mailbox-info (gnus-make-hashtable 997))
468 (defvar nnimap-current-move-server nil)
469 (defvar nnimap-current-move-group nil)
470 (defvar nnimap-current-move-article nil)
471 (defvar nnimap-length)
472 (defvar nnimap-progress-chars '(?| ?/ ?- ?\\))
473 (defvar nnimap-progress-how-often 20)
474 (defvar nnimap-counter)
475 (defvar nnimap-server-buffer-alist nil) ;; Map server name to buffers.
476 (defvar nnimap-current-server nil) ;; Current server
477 (defvar nnimap-server-buffer nil) ;; Current servers' buffer
481 (nnoo-define-basics nnimap)
483 ;; Utility functions:
485 (defsubst nnimap-get-server-buffer (server)
486 "Return buffer for SERVER, if nil use current server."
487 (cadr (assoc (or server nnimap-current-server) nnimap-server-buffer-alist)))
489 (defun nnimap-remove-server-from-buffer-alist (server list)
490 "Remove SERVER from LIST."
493 (unless (equal server (car-safe e))
497 (defun nnimap-possibly-change-server (server)
498 "Return buffer for SERVER, changing the current server as a side-effect.
499 If SERVER is nil, uses the current server."
500 (setq nnimap-current-server (or server nnimap-current-server)
501 nnimap-server-buffer (nnimap-get-server-buffer nnimap-current-server)))
503 (defun nnimap-verify-uidvalidity (group server)
504 "Verify stored uidvalidity match current one in GROUP on SERVER."
505 (let* ((gnusgroup (gnus-group-prefixed-name
506 group (gnus-server-to-method
507 (format "nnimap:%s" server))))
508 (new-uidvalidity (imap-mailbox-get 'uidvalidity))
509 (old-uidvalidity (gnus-group-get-parameter gnusgroup 'uidvalidity))
510 (dir (file-name-as-directory (expand-file-name nnimap-directory)))
511 (nameuid (nnheader-translate-file-chars
512 (concat nnimap-nov-file-name
513 (if (equal server "")
515 server) "." group "." old-uidvalidity
516 nnimap-nov-file-name-suffix) t))
517 (file (if (or nnmail-use-long-file-names
518 (file-exists-p (expand-file-name nameuid dir)))
519 (expand-file-name nameuid dir)
521 (encode-coding-string
522 (nnheader-replace-chars-in-string nameuid ?. ?/)
523 nnmail-pathname-coding-system)
526 (if (not (equal old-uidvalidity new-uidvalidity))
528 (gnus-delete-file file)
529 (gnus-group-set-parameter gnusgroup 'uidvalidity new-uidvalidity)
531 (gnus-group-add-parameter gnusgroup (cons 'uidvalidity new-uidvalidity))
534 (defun nnimap-before-find-minmax-bugworkaround ()
535 "Function called before iterating through mailboxes with
536 `nnimap-find-minmax-uid'."
537 (when nnimap-need-unselect-to-notice-new-mail
538 ;; XXX this is for UoW imapd problem, it doesn't notice new mail in
539 ;; currently selected mailbox without a re-select/examine.
540 (or (null (imap-current-mailbox nnimap-server-buffer))
541 (imap-mailbox-unselect nnimap-server-buffer))))
543 (defun nnimap-find-minmax-uid (group &optional examine)
544 "Find lowest and highest active article number in GROUP.
545 If EXAMINE is non-nil the group is selected read-only."
546 (with-current-buffer nnimap-server-buffer
547 (when (or (string= group (imap-current-mailbox))
548 (imap-mailbox-select group examine))
550 (when (> (imap-mailbox-get 'exists) 0)
551 (imap-fetch "1,*" "UID" nil 'nouidfetch)
552 (imap-message-map (lambda (uid Uid)
553 (setq minuid (if minuid (min minuid uid) uid)
554 maxuid (if maxuid (max maxuid uid) uid)))
556 (list (imap-mailbox-get 'exists) minuid maxuid)))))
558 (defun nnimap-possibly-change-group (group &optional server)
559 "Make GROUP the current group, and SERVER the current server."
560 (when (nnimap-possibly-change-server server)
561 (with-current-buffer nnimap-server-buffer
562 (if (or (null group) (imap-current-mailbox-p group))
564 (if (imap-mailbox-select group)
565 (if (or (nnimap-verify-uidvalidity
566 group (or server nnimap-current-server))
567 (zerop (imap-mailbox-get 'exists group))
568 t ;; for OGnus to see if ignoring uidvalidity
569 ;; changes has any bad effects.
572 "nnimap: Group %s is not uidvalid. Continue? " group)))
574 (imap-mailbox-unselect)
575 (error "nnimap: Group %s is not uid-valid" group))
576 (nnheader-report 'nnimap (imap-error-text)))))))
578 (defun nnimap-replace-whitespace (string)
579 "Return STRING with all whitespace replaced with space."
581 (while (string-match "[\r\n\t]+" string)
582 (setq string (replace-match " " t t string)))
585 ;; Required backend functions
587 (defun nnimap-retrieve-headers-progress ()
588 "Hook to insert NOV line for current article into `nntp-server-buffer'."
589 (and (numberp nnmail-large-newsgroup)
590 (zerop (% (incf nnimap-counter) nnimap-progress-how-often))
591 (> nnimap-length nnmail-large-newsgroup)
592 (nnheader-message 6 "nnimap: Retrieving headers... %c"
593 (nth (/ (% nnimap-counter
594 (* (length nnimap-progress-chars)
595 nnimap-progress-how-often))
596 nnimap-progress-how-often)
597 nnimap-progress-chars)))
598 (with-current-buffer nntp-server-buffer
599 (let (headers lines chars uid mbx)
600 (with-current-buffer nnimap-server-buffer
601 (setq uid imap-current-message
602 mbx imap-current-mailbox
603 headers (nnimap-demule
604 (if (imap-capability 'IMAP4rev1)
605 ;; xxx don't just use car? alist doesn't contain
606 ;; anything else now, but it might...
607 (nth 2 (car (imap-message-get uid 'BODYDETAIL)))
608 (imap-message-get uid 'RFC822.HEADER)))
609 lines (imap-body-lines (imap-message-body imap-current-message))
610 chars (imap-message-get imap-current-message 'RFC822.SIZE)))
613 (buffer-disable-undo)
615 (let ((head (nnheader-parse-naked-head uid)))
616 (mail-header-set-number head uid)
617 (mail-header-set-chars head chars)
618 (mail-header-set-lines head lines)
619 (mail-header-set-xref
620 head (format "%s %s:%d" (system-name) mbx uid))
623 (defun nnimap-retrieve-which-headers (articles fetch-old)
624 "Get a range of articles to fetch based on ARTICLES and FETCH-OLD."
625 (with-current-buffer nnimap-server-buffer
626 (if (numberp (car-safe articles))
629 (imap-range-to-message-set
630 (gnus-compress-sequence
631 (append (gnus-uncompress-sequence
633 (cons (if (numberp fetch-old)
634 (max 1 (- (car articles) fetch-old))
636 (1- (car articles)))))
638 (mapcar (lambda (msgid)
640 (format "HEADER Message-Id \"%s\"" msgid)))
643 (defun nnimap-group-overview-filename (group server)
644 "Make file name for GROUP on SERVER."
645 (let* ((dir (file-name-as-directory (expand-file-name nnimap-directory)))
646 (uidvalidity (gnus-group-get-parameter
647 (gnus-group-prefixed-name
648 group (gnus-server-to-method
649 (format "nnimap:%s" server)))
651 (name (nnheader-translate-file-chars
652 (concat nnimap-nov-file-name
653 (if (equal server "")
655 server) "." group nnimap-nov-file-name-suffix) t))
656 (nameuid (nnheader-translate-file-chars
657 (concat nnimap-nov-file-name
658 (if (equal server "")
660 server) "." group "." uidvalidity
661 nnimap-nov-file-name-suffix) t))
662 (oldfile (if (or nnmail-use-long-file-names
663 (file-exists-p (expand-file-name name dir)))
664 (expand-file-name name dir)
666 (encode-coding-string
667 (nnheader-replace-chars-in-string name ?. ?/)
668 nnmail-pathname-coding-system)
670 (newfile (if (or nnmail-use-long-file-names
671 (file-exists-p (expand-file-name nameuid dir)))
672 (expand-file-name nameuid dir)
674 (encode-coding-string
675 (nnheader-replace-chars-in-string nameuid ?. ?/)
676 nnmail-pathname-coding-system)
678 (when (and (file-exists-p oldfile) (not (file-exists-p newfile)))
679 (message "nnimap: Upgrading novcache filename...")
681 (gnus-make-directory (file-name-directory newfile))
682 (unless (ignore-errors (rename-file oldfile newfile) t)
683 (if (ignore-errors (copy-file oldfile newfile) t)
684 (delete-file oldfile)
685 (error "Can't rename `%s' to `%s'" oldfile newfile))))
688 (defun nnimap-retrieve-headers-from-file (group server)
689 (with-current-buffer nntp-server-buffer
690 (let ((nov (nnimap-group-overview-filename group server)))
691 (when (file-exists-p nov)
692 (nnheader-insert-file-contents nov)
693 (set-buffer-modified-p nil)
694 (let ((min (ignore-errors (goto-char (point-min))
695 (read (current-buffer))))
696 (max (ignore-errors (goto-char (point-max))
698 (read (current-buffer)))))
699 (if (and (numberp min) (numberp max))
701 ;; junk, remove it, it's saved later
705 (defun nnimap-retrieve-headers-from-server (articles group server)
706 (with-current-buffer nnimap-server-buffer
707 (let ((imap-fetch-data-hook '(nnimap-retrieve-headers-progress))
708 (nnimap-length (gnus-range-length articles))
710 (imap-fetch (imap-range-to-message-set articles)
711 (concat "(UID RFC822.SIZE BODY "
713 (append '(Subject From Date Message-Id
714 References In-Reply-To Xref)
716 nnmail-extra-headers))))
717 (if (imap-capability 'IMAP4rev1)
718 (format "BODY.PEEK[HEADER.FIELDS %s])" headers)
719 (format "RFC822.HEADER.LINES %s)" headers)))))
720 (with-current-buffer nntp-server-buffer
721 (sort-numeric-fields 1 (point-min) (point-max)))
722 (and (numberp nnmail-large-newsgroup)
723 (> nnimap-length nnmail-large-newsgroup)
724 (nnheader-message 6 "nnimap: Retrieving headers...done")))))
726 (defun nnimap-dont-use-nov-p (group server)
727 (or gnus-nov-is-evil nnimap-nov-is-evil
728 (unless (and (gnus-make-directory
730 (nnimap-group-overview-filename group server)))
732 (nnimap-group-overview-filename group server)))
733 (message "nnimap: Nov cache not writable, %s"
734 (nnimap-group-overview-filename group server)))))
736 (deffoo nnimap-retrieve-headers (articles &optional group server fetch-old)
737 (when (nnimap-possibly-change-group group server)
738 (with-current-buffer nntp-server-buffer
740 (if (nnimap-dont-use-nov-p group server)
741 (nnimap-retrieve-headers-from-server
742 (gnus-compress-sequence articles) group server)
743 (let (uids cached low high)
744 (when (setq uids (nnimap-retrieve-which-headers articles fetch-old)
746 high (car (last uids)))
747 (if (setq cached (nnimap-retrieve-headers-from-file group server))
749 ;; fetch articles with uids before cache block
750 (when (< low (car cached))
751 (goto-char (point-min))
752 (nnimap-retrieve-headers-from-server
753 (cons low (1- (car cached))) group server))
754 ;; fetch articles with uids after cache block
755 (when (> high (cdr cached))
756 (goto-char (point-max))
757 (nnimap-retrieve-headers-from-server
758 (cons (1+ (cdr cached)) high) group server))
759 (when nnimap-prune-cache
760 ;; remove nov's for articles which has expired on server
761 (goto-char (point-min))
762 (dolist (uid (gnus-set-difference articles uids))
763 (when (re-search-forward (format "^%d\t" uid) nil t)
764 (gnus-delete-line)))))
765 ;; nothing cached, fetch whole range from server
766 (nnimap-retrieve-headers-from-server
767 (cons low high) group server))
768 (when (buffer-modified-p)
770 (point-min) (point-max)
771 (nnimap-group-overview-filename group server) nil 'nomesg))
772 (nnheader-nov-delete-outside-range low high))))
775 (defun nnimap-open-connection (server)
776 (if (not (imap-open nnimap-address nnimap-server-port nnimap-stream
777 nnimap-authenticator nnimap-server-buffer))
778 (nnheader-report 'nnimap "Can't open connection to server %s" server)
779 (unless (or (imap-capability 'IMAP4 nnimap-server-buffer)
780 (imap-capability 'IMAP4rev1 nnimap-server-buffer))
781 (imap-close nnimap-server-buffer)
782 (nnheader-report 'nnimap "Server %s is not IMAP4 compliant" server))
783 (let* ((list (progn (gnus-message 7 "Parsing authinfo file `%s'."
784 nnimap-authinfo-file)
785 (netrc-parse nnimap-authinfo-file)))
786 (port (if nnimap-server-port
787 (int-to-string nnimap-server-port)
789 (user (netrc-machine-user-or-password
793 (or nnimap-server-address
796 (list "imap" "imaps")))
797 (passwd (netrc-machine-user-or-password
801 (or nnimap-server-address
804 (list "imap" "imaps"))))
805 (if (imap-authenticate user passwd nnimap-server-buffer)
807 (setq nnimap-server-buffer-alist
808 (nnimap-remove-server-from-buffer-alist
810 nnimap-server-buffer-alist))
811 (push (list server nnimap-server-buffer)
812 nnimap-server-buffer-alist)
813 (imap-id nnimap-id nnimap-server-buffer)
814 (nnimap-possibly-change-server server))
815 (imap-close nnimap-server-buffer)
816 (kill-buffer nnimap-server-buffer)
817 (nnheader-report 'nnimap "Could not authenticate to %s" server)))))
819 (deffoo nnimap-open-server (server &optional defs)
820 (nnheader-init-server-buffer)
821 (if (nnimap-server-opened server)
823 (unless (assq 'nnimap-server-buffer defs)
824 (push (list 'nnimap-server-buffer (concat " *nnimap* " server)) defs))
825 ;; translate `nnimap-server-address' to `nnimap-address' in defs
826 ;; for people that configured nnimap with a very old version
827 (unless (assq 'nnimap-address defs)
828 (if (assq 'nnimap-server-address defs)
829 (push (list 'nnimap-address
830 (cadr (assq 'nnimap-server-address defs))) defs)
831 (push (list 'nnimap-address server) defs)))
832 (nnoo-change-server 'nnimap server defs)
833 (or nnimap-server-buffer
834 (setq nnimap-server-buffer (cadr (assq 'nnimap-server-buffer defs))))
835 (with-current-buffer (get-buffer-create nnimap-server-buffer)
836 (nnoo-change-server 'nnimap server defs))
837 (or (and nnimap-server-buffer
838 (imap-opened nnimap-server-buffer)
839 (if (with-current-buffer nnimap-server-buffer
840 (memq imap-state '(auth selected examine)))
842 (imap-close nnimap-server-buffer)
843 (nnimap-open-connection server)))
844 (nnimap-open-connection server))))
846 (deffoo nnimap-server-opened (&optional server)
847 "Whether SERVER is opened.
848 If SERVER is the current virtual server, and the connection to the
849 physical server is alive, this function return a non-nil value. If
850 SERVER is nil, it is treated as the current server."
851 ;; clean up autologouts??
852 (and (or server nnimap-current-server)
853 (nnoo-server-opened 'nnimap (or server nnimap-current-server))
854 (imap-opened (nnimap-get-server-buffer server))))
856 (deffoo nnimap-close-server (&optional server)
857 "Close connection to server and free all resources connected to it.
858 Return nil if the server couldn't be closed for some reason."
859 (let ((server (or server nnimap-current-server)))
860 (when (or (nnimap-server-opened server)
861 (imap-opened (nnimap-get-server-buffer server)))
862 (imap-close (nnimap-get-server-buffer server))
863 (kill-buffer (nnimap-get-server-buffer server))
864 (setq nnimap-server-buffer nil
865 nnimap-current-server nil
866 nnimap-server-buffer-alist
867 (nnimap-remove-server-from-buffer-alist
869 nnimap-server-buffer-alist)))
870 (nnoo-close-server 'nnimap server)))
872 (deffoo nnimap-request-close ()
873 "Close connection to all servers and free all resources that the backend have reserved.
874 All buffers that have been created by that
875 backend should be killed. (Not the nntp-server-buffer, though.) This
876 function is generally only called when Gnus is shutting down."
877 (mapc (lambda (server) (nnimap-close-server (car server)))
878 nnimap-server-buffer-alist)
879 (setq nnimap-server-buffer-alist nil))
881 (deffoo nnimap-status-message (&optional server)
882 "This function returns the last error message from server."
883 (when (nnimap-possibly-change-server server)
884 (nnoo-status-message 'nnimap server)))
886 (defun nnimap-demule (string)
887 ;; BEWARE: we used to use string-as-multibyte here which is braindead
888 ;; because it will turn accidental emacs-mule-valid byte sequences
889 ;; into multibyte chars. --Stef
890 ;; Reverted, braindead got 7.5 out of 10 on imdb, so it can't be
892 (funcall (if (and (fboundp 'string-as-multibyte)
893 (subrp (symbol-function 'string-as-multibyte)))
898 (defun nnimap-make-callback (article gnus-callback buffer)
899 "Return a callback function."
901 (nnimap-callback ,article ,gnus-callback ,buffer)))
903 (defun nnimap-callback (article gnus-callback buffer)
904 (when (eq article (imap-current-message))
905 (remove-hook 'imap-fetch-data-hook
906 (nnimap-make-callback article gnus-callback buffer))
907 (with-current-buffer buffer
909 (with-current-buffer nnimap-server-buffer
911 (if (imap-capability 'IMAP4rev1)
912 ;; xxx don't just use car? alist doesn't contain
913 ;; anything else now, but it might...
914 (nth 2 (car (imap-message-get article 'BODYDETAIL)))
915 (imap-message-get article 'RFC822)))))
916 (nnheader-ms-strip-cr)
917 (funcall gnus-callback t))))
919 (defun nnimap-request-article-part (article part prop &optional
920 group server to-buffer detail)
921 (when (nnimap-possibly-change-group group server)
922 (let ((article (if (stringp article)
923 (car-safe (imap-search
924 (format "HEADER Message-Id \"%s\"" article)
925 nnimap-server-buffer))
928 (gnus-message 10 "nnimap: Fetching (part of) article %d from %s..."
929 article (or group imap-current-mailbox
930 gnus-newsgroup-name))
931 (if (not nnheader-callback-function)
932 (with-current-buffer (or to-buffer nntp-server-buffer)
934 (let ((data (imap-fetch article part prop nil
935 nnimap-server-buffer)))
937 (insert (nnimap-demule (if detail (nth 2 (car data)) data)))
938 (nnheader-ms-strip-cr)
940 10 "nnimap: Fetching (part of) article %d from %s...done"
941 article (or group imap-current-mailbox gnus-newsgroup-name))
943 (nnheader-report 'nnimap "No such article %d in %s: %s"
944 article (or group imap-current-mailbox
946 (imap-error-text nnimap-server-buffer))
947 (cons group article)))))
948 (add-hook 'imap-fetch-data-hook
949 (nnimap-make-callback article
950 nnheader-callback-function
952 (imap-fetch-asynch article part nil nnimap-server-buffer)
953 (cons group article))))))
955 (deffoo nnimap-asynchronous-p ()
958 (deffoo nnimap-request-article (article &optional group server to-buffer)
959 (if (imap-capability 'IMAP4rev1 nnimap-server-buffer)
960 (nnimap-request-article-part
961 article "BODY.PEEK[]" 'BODYDETAIL group server to-buffer 'detail)
962 (nnimap-request-article-part
963 article "RFC822.PEEK" 'RFC822 group server to-buffer)))
965 (deffoo nnimap-request-head (article &optional group server to-buffer)
966 (if (imap-capability 'IMAP4rev1 nnimap-server-buffer)
967 (nnimap-request-article-part
968 article "BODY.PEEK[HEADER]" 'BODYDETAIL group server to-buffer 'detail)
969 (nnimap-request-article-part
970 article "RFC822.HEADER" 'RFC822.HEADER group server to-buffer)))
972 (deffoo nnimap-request-body (article &optional group server to-buffer)
973 (if (imap-capability 'IMAP4rev1 nnimap-server-buffer)
974 (nnimap-request-article-part
975 article "BODY.PEEK[TEXT]" 'BODYDETAIL group server to-buffer 'detail)
976 (nnimap-request-article-part
977 article "RFC822.TEXT.PEEK" 'RFC822.TEXT group server to-buffer)))
979 (deffoo nnimap-request-group (group &optional server fast)
980 (nnimap-request-update-info-internal
982 (gnus-get-info (gnus-group-prefixed-name
983 group (gnus-server-to-method (format "nnimap:%s" server))))
985 (when (nnimap-possibly-change-group group server)
986 (nnimap-before-find-minmax-bugworkaround)
989 ((null (setq info (nnimap-find-minmax-uid group t)))
990 (nnheader-report 'nnimap "Could not get active info for %s"
993 (nnheader-insert "211 %d %d %d %s\n" (or (nth 0 info) 0)
994 (max 1 (or (nth 1 info) 1))
995 (or (nth 2 info) 0) group)
996 (nnheader-report 'nnimap "Group %s selected" group)
999 (defun nnimap-update-unseen (group &optional server)
1000 "Update the unseen count in `nnimap-mailbox-info'."
1002 (gnus-group-prefixed-name group server)
1003 (let ((old (gnus-gethash-safe (gnus-group-prefixed-name group server)
1004 nnimap-mailbox-info)))
1005 (list (nth 0 old) (nth 1 old)
1006 (imap-mailbox-status group 'unseen nnimap-server-buffer)
1008 nnimap-mailbox-info))
1010 (defun nnimap-close-group (group &optional server)
1011 (with-current-buffer nnimap-server-buffer
1012 (when (and (imap-opened)
1013 (nnimap-possibly-change-group group server))
1014 (nnimap-update-unseen group server)
1015 (case nnimap-expunge-on-close
1017 (imap-mailbox-expunge nnimap-close-asynchronous)
1018 (unless nnimap-dont-close
1019 (imap-mailbox-close nnimap-close-asynchronous))))
1020 (ask (if (and (imap-search "DELETED")
1021 (gnus-y-or-n-p (format "Expunge articles in group `%s'? "
1022 imap-current-mailbox)))
1024 (imap-mailbox-expunge nnimap-close-asynchronous)
1025 (unless nnimap-dont-close
1026 (imap-mailbox-close nnimap-close-asynchronous)))
1027 (imap-mailbox-unselect)))
1028 (t (imap-mailbox-unselect)))
1029 (not imap-current-mailbox))))
1031 (defun nnimap-pattern-to-list-arguments (pattern)
1033 (cons (car-safe p) (or (cdr-safe p) p)))
1034 (if (and (listp pattern)
1035 (listp (cdr pattern)))
1039 (deffoo nnimap-request-list (&optional server)
1040 (when (nnimap-possibly-change-server server)
1041 (with-current-buffer nntp-server-buffer
1043 (gnus-message 5 "nnimap: Generating active list%s..."
1044 (if (> (length server) 0) (concat " for " server) ""))
1045 (nnimap-before-find-minmax-bugworkaround)
1046 (with-current-buffer nnimap-server-buffer
1047 (dolist (pattern (nnimap-pattern-to-list-arguments nnimap-list-pattern))
1048 (dolist (mbx (funcall nnimap-request-list-method
1049 (cdr pattern) (car pattern)))
1050 (or (member "\\NoSelect" (imap-mailbox-get 'list-flags mbx))
1051 (let ((info (nnimap-find-minmax-uid mbx 'examine)))
1053 (with-current-buffer nntp-server-buffer
1054 (insert (format "\"%s\" %d %d y\n"
1055 mbx (or (nth 2 info) 0)
1056 (max 1 (or (nth 1 info) 1)))))))))))
1057 (gnus-message 5 "nnimap: Generating active list%s...done"
1058 (if (> (length server) 0) (concat " for " server) ""))
1061 (deffoo nnimap-request-post (&optional server)
1063 (dolist (mbx (message-unquote-tokens
1064 (message-tokenize-header
1065 (message-fetch-field "Newsgroups") ", ")) success)
1066 (let ((to-newsgroup (gnus-group-prefixed-name mbx gnus-command-method)))
1067 (or (gnus-active to-newsgroup)
1068 (gnus-activate-group to-newsgroup)
1069 (if (gnus-y-or-n-p (format "No such group: %s. Create it? "
1071 (or (and (gnus-request-create-group
1072 to-newsgroup gnus-command-method)
1073 (gnus-activate-group to-newsgroup nil nil
1074 gnus-command-method))
1075 (error "Couldn't create group %s" to-newsgroup)))
1076 (error "No such group: %s" to-newsgroup))
1077 (unless (nnimap-request-accept-article mbx (nth 1 gnus-command-method))
1078 (setq success nil))))))
1080 ;; Optional backend functions
1082 (defun nnimap-string-lessp-numerical (s1 s2)
1083 "Return t if first arg string is less than second in numerical order."
1084 (cond ((string= s1 s2)
1086 ((> (length s1) (length s2))
1088 ((< (length s1) (length s2))
1090 ((< (string-to-number (substring s1 0 1))
1091 (string-to-number (substring s2 0 1)))
1093 ((> (string-to-number (substring s1 0 1))
1094 (string-to-number (substring s2 0 1)))
1097 (nnimap-string-lessp-numerical (substring s1 1) (substring s2 1)))))
1099 (deffoo nnimap-retrieve-groups (groups &optional server)
1100 (when (nnimap-possibly-change-server server)
1101 (gnus-message 5 "nnimap: Checking mailboxes...")
1102 (with-current-buffer nntp-server-buffer
1104 (nnimap-before-find-minmax-bugworkaround)
1105 (let (asyncgroups slowgroups)
1106 (if (null nnimap-retrieve-groups-asynchronous)
1107 (setq slowgroups groups)
1108 (dolist (group groups)
1109 (gnus-message 9 "nnimap: Quickly checking mailbox %s" group)
1110 (add-to-list (if (gnus-gethash-safe
1111 (gnus-group-prefixed-name group server)
1112 nnimap-mailbox-info)
1115 (list group (imap-mailbox-status-asynch
1116 group '(uidvalidity uidnext unseen)
1117 nnimap-server-buffer))))
1118 (dolist (asyncgroup asyncgroups)
1119 (let ((group (nth 0 asyncgroup))
1120 (tag (nth 1 asyncgroup))
1122 (when (imap-ok-p (imap-wait-for-tag tag nnimap-server-buffer))
1123 (if (or (not (string=
1124 (nth 0 (gnus-gethash (gnus-group-prefixed-name
1126 nnimap-mailbox-info))
1127 (imap-mailbox-get 'uidvalidity group
1128 nnimap-server-buffer)))
1130 (nth 1 (gnus-gethash (gnus-group-prefixed-name
1132 nnimap-mailbox-info))
1133 (imap-mailbox-get 'uidnext group
1134 nnimap-server-buffer))))
1135 (push (list group) slowgroups)
1136 (insert (nth 3 (gnus-gethash (gnus-group-prefixed-name
1138 nnimap-mailbox-info))))))))
1139 (dolist (group slowgroups)
1140 (if nnimap-retrieve-groups-asynchronous
1141 (setq group (car group)))
1142 (gnus-message 7 "nnimap: Mailbox %s modified" group)
1143 (imap-mailbox-put 'uidnext nil group nnimap-server-buffer)
1144 (or (member "\\NoSelect" (imap-mailbox-get 'list-flags group
1145 nnimap-server-buffer))
1146 (let* ((info (nnimap-find-minmax-uid group 'examine))
1147 (str (format "\"%s\" %d %d y\n" group
1149 (max 1 (or (nth 1 info) 1)))))
1150 (when (> (or (imap-mailbox-get 'recent group
1151 nnimap-server-buffer) 0)
1153 (push (list (cons group 0)) nnmail-split-history))
1155 (when nnimap-retrieve-groups-asynchronous
1157 (gnus-group-prefixed-name group server)
1158 (list (or (imap-mailbox-get
1159 'uidvalidity group nnimap-server-buffer)
1160 (imap-mailbox-status
1161 group 'uidvalidity nnimap-server-buffer))
1162 (or (imap-mailbox-get
1163 'uidnext group nnimap-server-buffer)
1164 (imap-mailbox-status
1165 group 'uidnext nnimap-server-buffer))
1166 (or (imap-mailbox-get
1167 'unseen group nnimap-server-buffer)
1168 (imap-mailbox-status
1169 group 'unseen nnimap-server-buffer))
1171 nnimap-mailbox-info)))))))
1172 (gnus-message 5 "nnimap: Checking mailboxes...done")
1175 (deffoo nnimap-request-update-info-internal (group info &optional server)
1176 (when (nnimap-possibly-change-group group server)
1177 (when info;; xxx what does this mean? should we create a info?
1178 (with-current-buffer nnimap-server-buffer
1179 (gnus-message 5 "nnimap: Updating info for %s..."
1180 (gnus-info-group info))
1182 (when (nnimap-mark-permanent-p 'read)
1184 ;; read info could contain articles marked unread by other
1185 ;; imap clients! we correct this
1186 (setq seen (gnus-uncompress-range (gnus-info-read info))
1187 unseen (imap-search "UNSEEN UNDELETED")
1188 seen (gnus-set-difference seen unseen)
1189 ;; seen might lack articles marked as read by other
1190 ;; imap clients! we correct this
1191 seen (append seen (imap-search "SEEN"))
1194 seen (gnus-compress-sequence seen t)
1195 ;; we can't return '(1) since this isn't a "list of ranges",
1196 ;; and we can't return '((1)) since g-list-of-unread-articles
1197 ;; is buggy so we return '((1 . 1)).
1198 seen (if (and (integerp (car seen))
1200 (list (cons (car seen) (car seen)))
1202 (gnus-info-set-read info seen)))
1204 (mapcar (lambda (pred)
1205 (when (or (eq (cdr pred) 'recent)
1206 (and (nnimap-mark-permanent-p (cdr pred))
1207 (member (nnimap-mark-to-flag (cdr pred))
1208 (imap-mailbox-get 'flags))))
1209 (gnus-info-set-marks
1211 (gnus-update-alist-soft
1213 (gnus-compress-sequence
1214 (imap-search (nnimap-mark-to-predicate (cdr pred))))
1215 (gnus-info-marks info))
1217 gnus-article-mark-lists)
1219 (when nnimap-importantize-dormant
1220 ;; nnimap mark dormant article as ticked too (for other clients)
1221 ;; so we remove that mark for gnus since we support dormant
1222 (gnus-info-set-marks
1224 (gnus-update-alist-soft
1226 (gnus-remove-from-range
1227 (cdr-safe (assoc 'tick (gnus-info-marks info)))
1228 (cdr-safe (assoc 'dormant (gnus-info-marks info))))
1229 (gnus-info-marks info))
1232 (gnus-message 5 "nnimap: Updating info for %s...done"
1233 (gnus-info-group info))
1237 (deffoo nnimap-request-type (group &optional article)
1238 (if (and nnimap-news-groups (string-match nnimap-news-groups group))
1242 (deffoo nnimap-request-set-mark (group actions &optional server)
1243 (when (nnimap-possibly-change-group group server)
1244 (with-current-buffer nnimap-server-buffer
1246 (gnus-message 7 "nnimap: Setting marks in %s..." group)
1247 (while (setq action (pop actions))
1248 (let ((range (nth 0 action))
1249 (what (nth 1 action))
1250 (cmdmarks (nth 2 action))
1252 ;; bookmark can't be stored (not list/range
1253 (setq cmdmarks (delq 'bookmark cmdmarks))
1254 ;; killed can't be stored (not list/range
1255 (setq cmdmarks (delq 'killed cmdmarks))
1256 ;; unsent are for nndraft groups only
1257 (setq cmdmarks (delq 'unsent cmdmarks))
1258 ;; cache flags are pointless on the server
1259 (setq cmdmarks (delq 'cache cmdmarks))
1260 ;; seen flags are local to each gnus
1261 (setq cmdmarks (delq 'seen cmdmarks))
1262 ;; recent marks can't be set
1263 (setq cmdmarks (delq 'recent cmdmarks))
1264 (when nnimap-importantize-dormant
1265 ;; flag dormant articles as ticked
1266 (if (memq 'dormant cmdmarks)
1267 (setq cmdmarks (cons 'tick cmdmarks))))
1268 ;; remove stuff we are forbidden to store
1269 (mapc (lambda (mark)
1270 (if (imap-message-flag-permanent-p
1271 (nnimap-mark-to-flag mark))
1272 (setq marks (cons mark marks))))
1274 (when (and range marks)
1275 (cond ((eq what 'del)
1276 (imap-message-flags-del
1277 (imap-range-to-message-set range)
1278 (nnimap-mark-to-flag marks nil t)))
1280 (imap-message-flags-add
1281 (imap-range-to-message-set range)
1282 (nnimap-mark-to-flag marks nil t)))
1284 (imap-message-flags-set
1285 (imap-range-to-message-set range)
1286 (nnimap-mark-to-flag marks nil t)))))))
1287 (gnus-message 7 "nnimap: Setting marks in %s...done" group))))
1290 (defun nnimap-split-fancy ()
1291 "Like the function `nnmail-split-fancy', but uses `nnimap-split-fancy'."
1292 (let ((nnmail-split-fancy nnimap-split-fancy))
1293 (nnmail-split-fancy)))
1295 (defun nnimap-split-to-groups (rules)
1296 ;; tries to match all rules in nnimap-split-rule against content of
1297 ;; nntp-server-buffer, returns a list of groups that matched.
1298 (with-current-buffer nntp-server-buffer
1299 ;; Fold continuation lines.
1300 (goto-char (point-min))
1301 (while (re-search-forward "\\(\r?\n[ \t]+\\)+" nil t)
1302 (replace-match " " t t))
1303 (if (functionp rules)
1305 (let (to-groups regrepp)
1307 (dolist (rule rules to-groups)
1308 (let ((group (car rule))
1309 (regexp (cadr rule)))
1310 (goto-char (point-min))
1311 (when (and (if (stringp regexp)
1313 (if (not (stringp group))
1314 (setq group (eval group))
1316 (string-match "\\\\[0-9&]" group)))
1317 (re-search-forward regexp nil t))
1318 (funcall regexp group))
1319 ;; Don't enter the article into the same group twice.
1320 (not (assoc group to-groups)))
1322 (nnmail-expand-newtext group)
1325 (or nnimap-split-crosspost
1326 (throw 'split-done to-groups))))))))))
1328 (defun nnimap-assoc-match (key alist)
1330 (while (and alist (not element))
1331 (if (string-match (car (car alist)) key)
1332 (setq element (car alist)))
1333 (setq alist (cdr alist)))
1336 (defun nnimap-split-find-rule (server inbox)
1337 (if (and (listp nnimap-split-rule) (listp (car nnimap-split-rule))
1338 (list (cdar nnimap-split-rule)) (listp (cadar nnimap-split-rule)))
1340 (cadr (nnimap-assoc-match inbox (cdr (nnimap-assoc-match
1341 server nnimap-split-rule))))
1344 (defun nnimap-split-find-inbox (server)
1345 (if (listp nnimap-split-inbox)
1347 (list nnimap-split-inbox)))
1349 (defun nnimap-split-articles (&optional group server)
1350 (when (nnimap-possibly-change-server server)
1351 (with-current-buffer nnimap-server-buffer
1352 (let (rule inbox removeorig (inboxes (nnimap-split-find-inbox server)))
1353 ;; iterate over inboxes
1354 (while (and (setq inbox (pop inboxes))
1355 (nnimap-possibly-change-group inbox));; SELECT
1356 ;; find split rule for this server / inbox
1357 (when (setq rule (nnimap-split-find-rule server inbox))
1358 ;; iterate over articles
1359 (dolist (article (imap-search nnimap-split-predicate))
1360 (when (if (if (eq nnimap-split-download-body 'default)
1361 nnimap-split-download-body-default
1362 nnimap-split-download-body)
1363 (and (nnimap-request-article article)
1364 (with-current-buffer nntp-server-buffer (mail-narrow-to-head)))
1365 (nnimap-request-head article))
1366 ;; copy article to right group(s)
1367 (setq removeorig nil)
1368 (dolist (to-group (nnimap-split-to-groups rule))
1369 (cond ((eq to-group 'junk)
1370 (message "IMAP split removed %s:%s:%d" server inbox
1372 (setq removeorig t))
1373 ((imap-message-copy (number-to-string article)
1374 to-group nil 'nocopyuid)
1375 (message "IMAP split moved %s:%s:%d to %s" server
1376 inbox article to-group)
1378 (when nnmail-cache-accepted-message-ids
1379 (with-current-buffer nntp-server-buffer
1382 (nnmail-fetch-field "message-id"))
1383 (nnmail-cache-insert msgid
1385 (nnmail-fetch-field "subject"))))))
1386 ;; Add the group-art list to the history list.
1387 (push (list (cons to-group 0)) nnmail-split-history))
1389 (message "IMAP split failed to move %s:%s:%d to %s"
1390 server inbox article to-group))))
1391 (if (if (eq nnimap-split-download-body 'default)
1392 nnimap-split-download-body-default
1393 nnimap-split-download-body)
1395 ;; remove article if it was successfully copied somewhere
1397 (imap-message-flags-add (format "%d" article)
1398 "\\Seen \\Deleted")))))
1399 (when (imap-mailbox-select inbox);; just in case
1400 ;; todo: UID EXPUNGE (if available) to remove splitted articles
1401 (imap-mailbox-expunge)
1402 (imap-mailbox-close)))
1403 (when nnmail-cache-accepted-message-ids
1404 (nnmail-cache-close))
1407 (deffoo nnimap-request-scan (&optional group server)
1408 (nnimap-split-articles group server))
1410 (deffoo nnimap-request-newgroups (date &optional server)
1411 (when (nnimap-possibly-change-server server)
1412 (with-current-buffer nntp-server-buffer
1413 (gnus-message 5 "nnimap: Listing subscribed mailboxes%s%s..."
1414 (if (> (length server) 0) " on " "") server)
1416 (nnimap-before-find-minmax-bugworkaround)
1417 (dolist (pattern (nnimap-pattern-to-list-arguments
1418 nnimap-list-pattern))
1419 (dolist (mbx (imap-mailbox-lsub (cdr pattern) (car pattern) nil
1420 nnimap-server-buffer))
1422 (dolist (mailbox (imap-mailbox-get 'list-flags mbx
1423 nnimap-server-buffer))
1424 (if (string= (downcase mailbox) "\\noselect")
1427 (let ((info (nnimap-find-minmax-uid mbx 'examine)))
1429 (insert (format "\"%s\" %d %d y\n"
1430 mbx (or (nth 2 info) 0)
1431 (max 1 (or (nth 1 info) 1)))))))))
1432 (gnus-message 5 "nnimap: Listing subscribed mailboxes%s%s...done"
1433 (if (> (length server) 0) " on " "") server))
1436 (deffoo nnimap-request-create-group (group &optional server args)
1437 (when (nnimap-possibly-change-server server)
1438 (or (imap-mailbox-status group 'uidvalidity nnimap-server-buffer)
1439 (imap-mailbox-create group nnimap-server-buffer)
1440 (nnheader-report 'nnimap "%S"
1441 (imap-error-text nnimap-server-buffer)))))
1443 (defun nnimap-time-substract (time1 time2)
1444 "Return TIME for TIME1 - TIME2."
1445 (let* ((ms (- (car time1) (car time2)))
1446 (ls (- (nth 1 time1) (nth 1 time2))))
1448 (list (- ms 1) (+ (expt 2 16) ls))
1451 (eval-when-compile (require 'parse-time))
1452 (defun nnimap-date-days-ago (daysago)
1453 "Return date, in format \"3-Aug-1998\", for DAYSAGO days ago."
1454 (require 'parse-time)
1455 (let* ((time (nnimap-time-substract (current-time) (days-to-time daysago)))
1456 (date (format-time-string
1457 (format "%%d-%s-%%Y"
1458 (capitalize (car (rassoc (nth 4 (decode-time time))
1459 parse-time-months))))
1461 (if (eq ?0 (string-to-char date))
1465 (defun nnimap-request-expire-articles-progress ()
1466 (gnus-message 5 "nnimap: Marking article %d for deletion..."
1467 imap-current-message))
1469 (defun nnimap-expiry-target (arts group server)
1470 (unless (eq nnmail-expiry-target 'delete)
1473 (nnimap-request-article art group server (current-buffer))
1474 ;; hints for optimization in `nnimap-request-accept-article'
1475 (let ((nnimap-current-move-article art)
1476 (nnimap-current-move-group group)
1477 (nnimap-current-move-server server))
1478 (nnmail-expiry-target-group nnmail-expiry-target group))))
1479 ;; It is not clear if `nnmail-expiry-target' somehow cause the
1480 ;; current group to be changed or not, so we make sure here.
1481 (nnimap-possibly-change-group group server)))
1483 ;; Notice that we don't actually delete anything, we just mark them deleted.
1484 (deffoo nnimap-request-expire-articles (articles group &optional server force)
1485 (let ((artseq (gnus-compress-sequence articles)))
1486 (when (and artseq (nnimap-possibly-change-group group server))
1487 (with-current-buffer nnimap-server-buffer
1488 (let ((days (or (and nnmail-expiry-wait-function
1489 (funcall nnmail-expiry-wait-function group))
1490 nnmail-expiry-wait)))
1491 (cond ((or force (eq days 'immediate))
1492 (let ((oldarts (imap-search
1494 (imap-range-to-message-set artseq)))))
1496 (nnimap-expiry-target oldarts group server)
1497 (when (imap-message-flags-add
1498 (imap-range-to-message-set
1499 (gnus-compress-sequence oldarts)) "\\Deleted")
1500 (setq articles (gnus-set-difference
1501 articles oldarts))))))
1502 ((and nnimap-search-uids-not-since-is-evil (numberp days))
1503 (let* ((all-new-articles
1504 (gnus-compress-sequence
1505 (imap-search (format "SINCE %s"
1506 (nnimap-date-days-ago days)))))
1508 (gnus-range-difference artseq all-new-articles))
1509 (oldarts (gnus-uncompress-range oldartseq)))
1511 (nnimap-expiry-target oldarts group server)
1512 (when (imap-message-flags-add
1513 (imap-range-to-message-set oldartseq)
1515 (setq articles (gnus-set-difference
1516 articles oldarts))))))
1518 (let ((oldarts (imap-search
1519 (format nnimap-expunge-search-string
1520 (imap-range-to-message-set artseq)
1521 (nnimap-date-days-ago days))))
1522 (imap-fetch-data-hook
1523 '(nnimap-request-expire-articles-progress)))
1525 (nnimap-expiry-target oldarts group server)
1526 (when (imap-message-flags-add
1527 (imap-range-to-message-set
1528 (gnus-compress-sequence oldarts)) "\\Deleted")
1529 (setq articles (gnus-set-difference
1530 articles oldarts)))))))))))
1531 ;; return articles not deleted
1534 (deffoo nnimap-request-move-article (article group server accept-form
1535 &optional last move-is-internal)
1536 (when (nnimap-possibly-change-server server)
1538 (let ((buf (get-buffer-create " *nnimap move*"))
1539 (nnimap-current-move-article article)
1540 (nnimap-current-move-group group)
1541 (nnimap-current-move-server nnimap-current-server)
1543 (gnus-message 10 "nnimap-request-move-article: this is an %s move"
1544 (if move-is-internal
1547 ;; request the article only when the move is NOT internal
1548 (and (or move-is-internal
1549 (nnimap-request-article article group server))
1552 (buffer-disable-undo (current-buffer))
1553 (insert-buffer-substring nntp-server-buffer)
1554 (setq result (eval accept-form))
1557 (imap-message-flags-add
1558 (imap-range-to-message-set (list article))
1559 "\\Deleted" 'silent nnimap-server-buffer))
1562 (deffoo nnimap-request-accept-article (group &optional server last)
1563 (when (nnimap-possibly-change-server server)
1566 (if (string= nnimap-current-server nnimap-current-move-server)
1567 ;; moving article within same server, speed it up...
1568 (and (nnimap-possibly-change-group
1569 nnimap-current-move-group)
1570 (imap-message-copy (number-to-string
1571 nnimap-current-move-article)
1572 group 'dontcreate nil
1573 nnimap-server-buffer))
1574 (with-current-buffer (current-buffer)
1575 (goto-char (point-min))
1576 ;; remove any 'From blabla' lines, some IMAP servers
1577 ;; reject the entire message otherwise.
1578 (when (looking-at "^From[^:]")
1579 (delete-region (point) (progn (forward-line) (point))))
1580 ;; turn into rfc822 format (\r\n eol's)
1581 (while (search-forward "\n" nil t)
1582 (replace-match "\r\n"))
1583 (when nnmail-cache-accepted-message-ids
1584 (nnmail-cache-insert (nnmail-fetch-field "message-id")
1586 (nnmail-fetch-field "subject"))))
1587 (when (and last nnmail-cache-accepted-message-ids)
1588 (nnmail-cache-close))
1589 ;; this 'or' is for Cyrus server bug
1590 (or (null (imap-current-mailbox nnimap-server-buffer))
1591 (imap-mailbox-unselect nnimap-server-buffer))
1592 (imap-message-append group (current-buffer) nil nil
1593 nnimap-server-buffer)))
1594 (cons group (nth 1 uid))
1595 (nnheader-report 'nnimap (imap-error-text nnimap-server-buffer))))))
1597 (deffoo nnimap-request-delete-group (group force &optional server)
1598 (when (nnimap-possibly-change-server server)
1599 (with-current-buffer nnimap-server-buffer
1601 (or (null (imap-mailbox-status group 'uidvalidity))
1602 (imap-mailbox-delete group))
1606 (deffoo nnimap-request-rename-group (group new-name &optional server)
1607 (when (nnimap-possibly-change-server server)
1608 (imap-mailbox-rename group new-name nnimap-server-buffer)))
1610 (defun nnimap-expunge (mailbox server)
1611 (when (nnimap-possibly-change-group mailbox server)
1612 (imap-mailbox-expunge nil nnimap-server-buffer)))
1614 (defun nnimap-acl-get (mailbox server)
1615 (when (nnimap-possibly-change-server server)
1616 (and (imap-capability 'ACL nnimap-server-buffer)
1617 (imap-mailbox-acl-get mailbox nnimap-server-buffer))))
1619 (defun nnimap-acl-edit (mailbox method old-acls new-acls)
1620 (when (nnimap-possibly-change-server (cadr method))
1621 (unless (imap-capability 'ACL nnimap-server-buffer)
1622 (error "Your server does not support ACL editing"))
1623 (with-current-buffer nnimap-server-buffer
1624 ;; delete all removed identifiers
1625 (mapc (lambda (old-acl)
1626 (unless (assoc (car old-acl) new-acls)
1627 (or (imap-mailbox-acl-delete (car old-acl) mailbox)
1628 (error "Can't delete ACL for %s" (car old-acl)))))
1630 ;; set all changed acl's
1631 (mapc (lambda (new-acl)
1632 (let ((new-rights (cdr new-acl))
1633 (old-rights (cdr (assoc (car new-acl) old-acls))))
1634 (unless (and old-rights new-rights
1635 (string= old-rights new-rights))
1636 (or (imap-mailbox-acl-set (car new-acl) new-rights mailbox)
1637 (error "Can't set ACL for %s to %s" (car new-acl)
1643 ;;; Internal functions
1646 ;; This is confusing.
1648 ;; mark => read, tick, draft, reply etc
1649 ;; flag => "\\Seen", "\\Flagged", "\\Draft", "gnus-expire" etc
1650 ;; predicate => "SEEN", "FLAGGED", "DRAFT", "KEYWORD gnus-expire" etc
1652 ;; Mark should not really contain 'read since it's not a "mark" in the Gnus
1653 ;; world, but we cheat. Mark == gnus-article-mark-lists + '(read . read).
1656 (defconst nnimap-mark-to-predicate-alist
1658 (lambda (pair) ; cdr is the mark
1659 (or (assoc (cdr pair)
1664 (reply . "ANSWERED")))
1666 (format "KEYWORD gnus-%s" (symbol-name (cdr pair))))))
1667 (cons '(read . read) gnus-article-mark-lists)))
1669 (defun nnimap-mark-to-predicate (pred)
1670 "Convert a Gnus mark (a symbol such as read, tick, expire) to a IMAP predicate.
1671 This is a string such as \"SEEN\", \"FLAGGED\", \"KEYWORD gnus-expire\",
1672 to be used within a IMAP SEARCH query."
1673 (cdr (assq pred nnimap-mark-to-predicate-alist)))
1675 (defconst nnimap-mark-to-flag-alist
1678 (or (assoc (cdr pair)
1680 (tick . "\\Flagged")
1682 (recent . "\\Recent")
1683 (reply . "\\Answered")))
1685 (format "gnus-%s" (symbol-name (cdr pair))))))
1686 (cons '(read . read) gnus-article-mark-lists)))
1688 (defun nnimap-mark-to-flag-1 (preds)
1689 (if (and (not (null preds)) (listp preds))
1690 (cons (nnimap-mark-to-flag (car preds))
1691 (nnimap-mark-to-flag (cdr preds)))
1692 (cdr (assoc preds nnimap-mark-to-flag-alist))))
1694 (defun nnimap-mark-to-flag (preds &optional always-list make-string)
1695 "Convert a Gnus mark (a symbol such as read, tick, expire) to a IMAP flag.
1696 This is a string such as \"\\Seen\", \"\\Flagged\", \"gnus-expire\", to
1697 be used in a STORE FLAGS command."
1698 (let ((result (nnimap-mark-to-flag-1 preds)))
1699 (setq result (if (and (or make-string always-list)
1700 (not (listp result)))
1704 (mapconcat (lambda (flag)
1706 (mapconcat 'identity flag " ")
1711 (defun nnimap-mark-permanent-p (mark &optional group)
1712 "Return t iff MARK can be permanently (between IMAP sessions) saved on articles, in GROUP."
1713 (imap-message-flag-permanent-p (nnimap-mark-to-flag mark)))
1717 (buffer-disable-undo (get-buffer-create nnimap-debug-buffer))
1718 (mapcar (lambda (f) (trace-function-background f nnimap-debug-buffer))
1720 nnimap-possibly-change-server
1721 nnimap-verify-uidvalidity
1722 nnimap-find-minmax-uid
1723 nnimap-before-find-minmax-bugworkaround
1724 nnimap-possibly-change-group
1725 ;;nnimap-replace-whitespace
1726 nnimap-retrieve-headers-progress
1727 nnimap-retrieve-which-headers
1728 nnimap-group-overview-filename
1729 nnimap-retrieve-headers-from-file
1730 nnimap-retrieve-headers-from-server
1731 nnimap-retrieve-headers
1732 nnimap-open-connection
1734 nnimap-server-opened
1736 nnimap-request-close
1737 nnimap-status-message
1739 nnimap-request-article-part
1740 nnimap-request-article
1743 nnimap-request-group
1745 nnimap-pattern-to-list-arguments
1748 nnimap-retrieve-groups
1749 nnimap-request-update-info-internal
1751 nnimap-request-set-mark
1752 nnimap-split-to-groups
1753 nnimap-split-find-rule
1754 nnimap-split-find-inbox
1755 nnimap-split-articles
1757 nnimap-request-newgroups
1758 nnimap-request-create-group
1759 nnimap-time-substract
1760 nnimap-date-days-ago
1761 nnimap-request-expire-articles-progress
1762 nnimap-request-expire-articles
1763 nnimap-request-move-article
1764 nnimap-request-accept-article
1765 nnimap-request-delete-group
1766 nnimap-request-rename-group
1767 gnus-group-nnimap-expunge
1768 gnus-group-nnimap-edit-acl
1769 gnus-group-nnimap-edit-acl-done
1770 nnimap-group-mode-hook
1771 nnimap-mark-to-predicate
1772 nnimap-mark-to-flag-1
1774 nnimap-mark-permanent-p
1779 ;;; nnimap.el ends here