1 ;;; nnimap.el --- imap backend for Gnus
2 ;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004
3 ;; Free Software Foundation, Inc.
5 ;; Author: Simon Josefsson <jas@pdc.kth.se>
6 ;; Jim Radford <radford@robby.caltech.edu>
9 ;; This file is part of GNU Emacs.
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)
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.
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.
28 ;; Todo, major things:
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)
34 ;; o MIME (partial article fetches)
35 ;; o Split to other backends, different split rules for different
38 ;; Todo, minor things:
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
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
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
63 (eval-when-compile (require 'cl))
74 (eval-when-compile (require 'cl))
78 (defconst nnimap-version "nnimap 1.0")
81 "Reading IMAP mail with Gnus."
84 (defvoo nnimap-address nil
85 "Address of physical IMAP server. If nil, use the virtual server's name.")
87 (defvoo nnimap-server-port nil
88 "Port number on physical IMAP server.
89 If nil, defaults to 993 for TLS/SSL connections and 143 otherwise.")
91 ;; Splitting variables
93 (defcustom nnimap-split-crosspost t
94 "If non-nil, do crossposting if several split methods match the mail.
95 If nil, the first match found will be used."
99 (defcustom nnimap-split-inbox nil
100 "Name of mailbox to split mail from.
102 Mail is read from this mailbox and split according to rules in
105 This can be a string or a list of strings."
107 :type '(choice (string)
110 (define-widget 'nnimap-strict-function 'function
111 "This widget only matches values that are functionp.
113 Warning: This means that a value that is the symbol of a not yet
114 loaded function will not match. Use with care."
115 :match 'nnimap-strict-function-match)
117 (defun nnimap-strict-function-match (widget value)
118 "Ignoring WIDGET, match if VALUE is a function."
121 (defcustom nnimap-split-rule nil
122 "Mail will be split according to these rules.
124 Mail is read from mailbox(es) specified in `nnimap-split-inbox'.
126 If you'd like, for instance, one mail group for mail from the
127 \"gnus-imap\" mailing list, one group for junk mail and leave
128 everything else in the incoming mailbox, you could do something like
131 \(setq nnimap-split-rule '((\"INBOX.gnus-imap\" \"From:.*gnus-imap\")
132 (\"INBOX.junk\" \"Subject:.*buy\")))
134 As you can see, `nnimap-split-rule' is a list of lists, where the
135 first element in each \"rule\" is the name of the IMAP mailbox (or the
136 symbol `junk' if you want to remove the mail), and the second is a
137 regexp that nnimap will try to match on the header to find a fit.
139 The second element can also be a function. In that case, it will be
140 called narrowed to the headers with the first element of the rule as
141 the argument. It should return a non-nil value if it thinks that the
142 mail belongs in that group.
144 This variable can also have a function as its value, the function will
145 be called with the headers narrowed and should return a group where it
146 thinks the article should be splitted to. See `nnimap-split-fancy'.
148 To allow for different split rules on different virtual servers, and
149 even different split rules in different inboxes on the same server,
150 the syntax of this variable have been extended along the lines of:
152 \(setq nnimap-split-rule
153 '((\"my1server\" (\".*\" ((\"ding\" \"ding@gnus.org\")
154 (\"junk\" \"From:.*Simon\")))
155 (\"my2server\" (\"INBOX\" nnimap-split-fancy))
156 (\"my[34]server\" (\".*\" ((\"private\" \"To:.*Simon\")
157 (\"junk\" my-junk-func)))))
159 The virtual server name is in fact a regexp, so that the same rules
160 may apply to several servers. In the example, the servers
161 \"my3server\" and \"my4server\" both use the same rules. Similarly,
162 the inbox string is also a regexp. The actual splitting rules are as
163 before, either a function, or a list with group/regexp or
164 group/function elements."
166 :type '(choice :tag "Rule type"
167 (repeat :menu-tag "Single-server"
168 :tag "Single-server list"
169 (list (string :tag "Mailbox")
170 (choice :tag "Predicate"
171 (regexp :tag "A regexp")
172 (nnimap-strict-function :tag "A function"))))
173 (choice :menu-tag "A function"
175 (function-item nnimap-split-fancy)
176 (function-item nnmail-split-fancy)
177 (nnimap-strict-function :tag "User-defined function"))
178 (repeat :menu-tag "Multi-server (extended)"
179 :tag "Multi-server list"
180 (list (regexp :tag "Server regexp")
181 (list (regexp :tag "Incoming Mailbox regexp")
182 (repeat :tag "Rules for matching server(s) and mailbox(es)"
183 (list (string :tag "Destination mailbox")
184 (choice :tag "Predicate"
185 (regexp :tag "A Regexp")
186 (nnimap-strict-function :tag "A Function")))))))))
188 (defcustom nnimap-split-predicate "UNSEEN UNDELETED"
189 "The predicate used to find articles to split.
190 If you use another IMAP client to peek on articles but always would
191 like nnimap to split them once it's started, you could change this to
192 \"UNDELETED\". Other available predicates are available in
193 RFC2060 section 6.4.4."
197 (defcustom nnimap-split-fancy nil
198 "Like the variable `nnmail-split-fancy'."
202 (defvar nnimap-split-download-body-default nil
203 "Internal variable with default value for `nnimap-split-download-body'.")
205 (defcustom nnimap-split-download-body 'default
206 "Whether to download entire articles during splitting.
207 This is generally not required, and will slow things down considerably.
208 You may need it if you want to use an advanced splitting function that
209 analyses the body before splitting the article.
210 If this variable is nil, bodies will not be downloaded; if this
211 variable is the symbol `default' the default behaviour is
212 used (which currently is nil, unless you use a statistical
213 spam.el test); if this variable is another non-nil value bodies
217 :type '(choice (const :tag "Let system decide" deault)
220 ;; Performance / bug workaround variables
222 (defcustom nnimap-close-asynchronous t
223 "Close mailboxes asynchronously in `nnimap-close-group'.
224 This means that errors caught 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."
231 (defcustom nnimap-dont-close t
232 "Never close mailboxes.
233 This increases the speed of closing mailboxes (quiting group) but may
234 decrease the speed of selecting another mailbox later. Re-selecting
235 the same mailbox will be faster though."
240 (defcustom nnimap-retrieve-groups-asynchronous t
241 "Send asynchronous STATUS commands for each mailbox before checking mail.
242 If you have mailboxes that rarely receives mail, this speeds up new
243 mail checking. It works by first sending STATUS commands for each
244 mailbox, and then only checking groups which has a modified UIDNEXT
245 more carefully for new mail.
247 In summary, the default is O((1-p)*k+p*n) and changing it to nil makes
248 it O(n). If p is small, then the default is probably faster."
253 (defvoo nnimap-need-unselect-to-notice-new-mail nil
254 "Unselect mailboxes before looking for new mail in them.
255 Some servers seem to need this under some circumstances.")
257 ;; Authorization / Privacy variables
259 (defvoo nnimap-auth-method nil
262 (defvoo nnimap-stream nil
263 "How nnimap will connect to the server.
265 The default, nil, will try to use the \"best\" method the server can
270 1) you want to connect with TLS/SSL. The TLS/SSL integration
271 with IMAP is suboptimal so you'll have to tell it
274 2) your server is more capable than your environment -- i.e. your
275 server accept Kerberos login's but you haven't installed the
276 `imtest' program or your machine isn't configured for Kerberos.
278 Possible choices: gssapi, kerberos4, starttls, tls, ssl, network, shell.
279 See also `imap-streams' and `imap-stream-alist'.")
281 (defvoo nnimap-authenticator nil
282 "How nnimap authenticate itself to the server.
284 The default, nil, will try to use the \"best\" method the server can
287 There is only one reason for fiddling with this variable, and that is
288 if your server is more capable than your environment -- i.e. you
289 connect to a server that accept Kerberos login's but you haven't
290 installed the `imtest' program or your machine isn't configured for
293 Possible choices: gssapi, kerberos4, digest-md5, cram-md5, login, anonymous.
294 See also `imap-authenticators' and `imap-authenticator-alist'")
296 (defvoo nnimap-directory (nnheader-concat gnus-directory "overview/")
297 "Directory to keep NOV cache files for nnimap groups.
298 See also `nnimap-nov-file-name'.")
300 (defvoo nnimap-nov-file-name "nnimap."
301 "NOV cache base filename.
302 The group name and `nnimap-nov-file-name-suffix' will be appended. A
303 typical complete file name would be
304 ~/News/overview/nnimap.pdc.INBOX.ding.nov, or
305 ~/News/overview/nnimap/pdc/INBOX/ding/nov if
306 `nnmail-use-long-file-names' is nil")
308 (defvoo nnimap-nov-file-name-suffix ".novcache"
309 "Suffix for NOV cache base filename.")
311 (defvoo nnimap-nov-is-evil gnus-agent
312 "If non-nil, never generate or use a local nov database for this backend.
313 Using nov databases should speed up header fetching considerably.
314 However, it will invoke a UID SEARCH UID command on the server, and
315 some servers implement this command inefficiently by opening each and
316 every message in the group, thus making it quite slow.
317 Unlike other backends, you do not need to take special care if you
318 flip this variable.")
320 (defvoo nnimap-expunge-on-close 'always ; 'ask, 'never
321 "Whether to expunge a group when it is closed.
322 When a IMAP group with articles marked for deletion is closed, this
323 variable determine if nnimap should actually remove the articles or
326 If always, nnimap always perform a expunge when closing the group.
327 If never, nnimap never expunges articles marked for deletion.
328 If ask, nnimap will ask you if you wish to expunge marked articles.
330 When setting this variable to `never', you can only expunge articles
331 by using `G x' (gnus-group-nnimap-expunge) from the Group buffer.")
333 (defvoo nnimap-list-pattern "*"
334 "A string LIMIT or list of strings with mailbox wildcards used to limit available groups.
335 See below for available wildcards.
337 The LIMIT string can be a cons cell (REFERENCE . LIMIT), where
338 REFERENCE will be passed as the first parameter to LIST/LSUB. The
339 semantics of this are server specific, on the University of Washington
340 server you can specify a directory.
343 '(\"INBOX\" \"mail/*\" (\"~friend/mail/\" . \"list/*\"))
345 There are two wildcards * and %. * matches everything, % matches
346 everything in the current hierarchy.")
348 (defvoo nnimap-news-groups nil
349 "IMAP support a news-like mode, also known as bulletin board mode,
350 where replies is sent via IMAP instead of SMTP.
352 This variable should contain a regexp matching groups where you wish
353 replies to be stored to the mailbox directly.
356 '(\"^[^I][^N][^B][^O][^X].*$\")
358 This will match all groups not beginning with \"INBOX\".
360 Note that there is nothing technically different between mail-like and
361 news-like mailboxes. If you wish to have a group with todo items or
362 similar which you wouldn't want to set up a mailing list for, you can
363 use this to make replies go directly to the group.")
365 (defvoo nnimap-expunge-search-string "UID %s NOT SINCE %s"
366 "IMAP search command to use for articles that are to be expired.
367 The first %s is replaced by a UID set of articles to search on,
368 and the second %s is replaced by a date criterium.
370 One useful (and perhaps the only useful) value to change this to would
371 be `UID %s NOT SENTSINCE %s' to make nnimap use the Date: header
372 instead of the internal date of messages. See section 6.4.4 of RFC
373 2060 for more information on valid strings.")
375 (defvoo nnimap-importantize-dormant t
376 "If non-nil, mark \"dormant\" articles as \"ticked\" for other IMAP clients.
377 Note that within Gnus, dormant articles will still (only) be
378 marked as ticked. This is to make \"dormant\" articles stand out,
379 just like \"ticked\" articles, in other IMAP clients.")
381 (defvoo nnimap-server-address nil
382 "Obsolete. Use `nnimap-address'.")
384 (defcustom nnimap-authinfo-file "~/.authinfo"
385 "Authorization information for IMAP servers. In .netrc format."
388 (repeat :tag "Entries"
391 :value ("" ("login" . "") ("password" . ""))
395 (const :format "" "login")
396 (string :format "Login: %v"))
398 (const :format "" "password")
399 (string :format "Password: %v"))))))
402 (defcustom nnimap-prune-cache t
403 "If non-nil, nnimap check whether articles still exist on server before using data stored in NOV cache."
407 (defvar nnimap-request-list-method 'imap-mailbox-list
408 "Method to use to request a list of all folders from the server.
409 If this is 'imap-mailbox-lsub, then use a server-side subscription list to
410 restrict visible folders.")
412 (defcustom nnimap-id nil
413 "Plist with client identity to send to server upon login.
414 Nil means no information is sent, symbol `no' to disable ID query
415 alltogheter, or plist with identifier-value pairs to send to
416 server. RFC 2971 describes the list as follows:
418 Any string may be sent as a field, but the following are defined to
419 describe certain values that might be sent. Implementations are free
420 to send none, any, or all of these. Strings are not case-sensitive.
421 Field strings MUST NOT be longer than 30 octets. Value strings MUST
422 NOT be longer than 1024 octets. Implementations MUST NOT send more
423 than 30 field-value pairs.
425 name Name of the program
426 version Version number of the program
427 os Name of the operating system
428 os-version Version of the operating system
429 vendor Vendor of the client/server
430 support-url URL to contact for support
431 address Postal address of contact/vendor
432 date Date program was released, specified as a date-time
434 command Command used to start the program
435 arguments Arguments supplied on the command line, if any
437 environment Description of environment, i.e., UNIX environment
438 variables or Windows registry settings
440 Implementations MUST NOT send the same field name more than once.
442 An example plist would be '(\"name\" \"Gnus\" \"version\" gnus-version-number
443 \"os\" system-configuration \"vendor\" \"GNU\")."
445 :type '(choice (const :tag "No information" nil)
446 (const :tag "Disable ID query" no)
447 (plist :key-type string :value-type string)))
449 (defcustom nnimap-debug nil
450 "If non-nil, random debug spews are placed in *nnimap-debug* buffer."
454 ;; Internal variables:
456 (defvar nnimap-debug-buffer "*nnimap-debug*")
457 (defvar nnimap-mailbox-info (gnus-make-hashtable 997))
458 (defvar nnimap-current-move-server nil)
459 (defvar nnimap-current-move-group nil)
460 (defvar nnimap-current-move-article nil)
461 (defvar nnimap-length)
462 (defvar nnimap-progress-chars '(?| ?/ ?- ?\\))
463 (defvar nnimap-progress-how-often 20)
464 (defvar nnimap-counter)
465 (defvar nnimap-server-buffer-alist nil) ;; Map server name to buffers.
466 (defvar nnimap-current-server nil) ;; Current server
467 (defvar nnimap-server-buffer nil) ;; Current servers' buffer
471 (nnoo-define-basics nnimap)
473 ;; Utility functions:
475 (defsubst nnimap-get-server-buffer (server)
476 "Return buffer for SERVER, if nil use current server."
477 (cadr (assoc (or server nnimap-current-server) nnimap-server-buffer-alist)))
479 (defun nnimap-possibly-change-server (server)
480 "Return buffer for SERVER, changing the current server as a side-effect.
481 If SERVER is nil, uses the current server."
482 (setq nnimap-current-server (or server nnimap-current-server)
483 nnimap-server-buffer (nnimap-get-server-buffer nnimap-current-server)))
485 (defun nnimap-verify-uidvalidity (group server)
486 "Verify stored uidvalidity match current one in GROUP on SERVER."
487 (let* ((gnusgroup (gnus-group-prefixed-name
488 group (gnus-server-to-method
489 (format "nnimap:%s" server))))
490 (new-uidvalidity (imap-mailbox-get 'uidvalidity))
491 (old-uidvalidity (gnus-group-get-parameter gnusgroup 'uidvalidity))
492 (dir (file-name-as-directory (expand-file-name nnimap-directory)))
493 (nameuid (nnheader-translate-file-chars
494 (concat nnimap-nov-file-name
495 (if (equal server "")
497 server) "." group "." old-uidvalidity
498 nnimap-nov-file-name-suffix) t))
499 (file (if (or nnmail-use-long-file-names
500 (file-exists-p (expand-file-name nameuid dir)))
501 (expand-file-name nameuid dir)
503 (encode-coding-string
504 (nnheader-replace-chars-in-string nameuid ?. ?/)
505 nnmail-pathname-coding-system)
508 (if (not (equal old-uidvalidity new-uidvalidity))
510 (gnus-delete-file file)
511 (gnus-group-set-parameter gnusgroup 'uidvalidity new-uidvalidity)
513 (gnus-group-add-parameter gnusgroup (cons 'uidvalidity new-uidvalidity))
516 (defun nnimap-before-find-minmax-bugworkaround ()
517 "Function called before iterating through mailboxes with
518 `nnimap-find-minmax-uid'."
519 (when nnimap-need-unselect-to-notice-new-mail
520 ;; XXX this is for UoW imapd problem, it doesn't notice new mail in
521 ;; currently selected mailbox without a re-select/examine.
522 (or (null (imap-current-mailbox nnimap-server-buffer))
523 (imap-mailbox-unselect nnimap-server-buffer))))
525 (defun nnimap-find-minmax-uid (group &optional examine)
526 "Find lowest and highest active article number in GROUP.
527 If EXAMINE is non-nil the group is selected read-only."
528 (with-current-buffer nnimap-server-buffer
529 (when (or (string= group (imap-current-mailbox))
530 (imap-mailbox-select group examine))
532 (when (> (imap-mailbox-get 'exists) 0)
533 (imap-fetch "1,*" "UID" nil 'nouidfetch)
534 (imap-message-map (lambda (uid Uid)
535 (setq minuid (if minuid (min minuid uid) uid)
536 maxuid (if maxuid (max maxuid uid) uid)))
538 (list (imap-mailbox-get 'exists) minuid maxuid)))))
540 (defun nnimap-possibly-change-group (group &optional server)
541 "Make GROUP the current group, and SERVER the current server."
542 (when (nnimap-possibly-change-server server)
543 (with-current-buffer nnimap-server-buffer
544 (if (or (null group) (imap-current-mailbox-p group))
546 (if (imap-mailbox-select group)
547 (if (or (nnimap-verify-uidvalidity
548 group (or server nnimap-current-server))
549 (zerop (imap-mailbox-get 'exists group))
550 t ;; for OGnus to see if ignoring uidvalidity
551 ;; changes has any bad effects.
554 "nnimap: Group %s is not uidvalid. Continue? " group)))
556 (imap-mailbox-unselect)
557 (error "nnimap: Group %s is not uid-valid" group))
558 (nnheader-report 'nnimap (imap-error-text)))))))
560 (defun nnimap-replace-whitespace (string)
561 "Return STRING with all whitespace replaced with space."
563 (while (string-match "[\r\n\t]+" string)
564 (setq string (replace-match " " t t string)))
567 ;; Required backend functions
569 (defun nnimap-retrieve-headers-progress ()
570 "Hook to insert NOV line for current article into `nntp-server-buffer'."
571 (and (numberp nnmail-large-newsgroup)
572 (zerop (% (incf nnimap-counter) nnimap-progress-how-often))
573 (> nnimap-length nnmail-large-newsgroup)
574 (nnheader-message 6 "nnimap: Retrieving headers... %c"
575 (nth (/ (% nnimap-counter
576 (* (length nnimap-progress-chars)
577 nnimap-progress-how-often))
578 nnimap-progress-how-often)
579 nnimap-progress-chars)))
580 (with-current-buffer nntp-server-buffer
581 (let (headers lines chars uid mbx)
582 (with-current-buffer nnimap-server-buffer
583 (setq uid imap-current-message
584 mbx imap-current-mailbox
585 headers (nnimap-demule
586 (if (imap-capability 'IMAP4rev1)
587 ;; xxx don't just use car? alist doesn't contain
588 ;; anything else now, but it might...
589 (nth 2 (car (imap-message-get uid 'BODYDETAIL)))
590 (imap-message-get uid 'RFC822.HEADER)))
591 lines (imap-body-lines (imap-message-body imap-current-message))
592 chars (imap-message-get imap-current-message 'RFC822.SIZE)))
595 (buffer-disable-undo)
597 (let ((head (nnheader-parse-naked-head uid)))
598 (mail-header-set-number head uid)
599 (mail-header-set-chars head chars)
600 (mail-header-set-lines head lines)
601 (mail-header-set-xref
602 head (format "%s %s:%d" (system-name) mbx uid))
605 (defun nnimap-retrieve-which-headers (articles fetch-old)
606 "Get a range of articles to fetch based on ARTICLES and FETCH-OLD."
607 (with-current-buffer nnimap-server-buffer
608 (if (numberp (car-safe articles))
611 (imap-range-to-message-set
612 (gnus-compress-sequence
613 (append (gnus-uncompress-sequence
615 (cons (if (numberp fetch-old)
616 (max 1 (- (car articles) fetch-old))
618 (1- (car articles)))))
620 (mapcar (lambda (msgid)
622 (format "HEADER Message-Id \"%s\"" msgid)))
625 (defun nnimap-group-overview-filename (group server)
626 "Make file name for GROUP on SERVER."
627 (let* ((dir (file-name-as-directory (expand-file-name nnimap-directory)))
628 (uidvalidity (gnus-group-get-parameter
629 (gnus-group-prefixed-name
630 group (gnus-server-to-method
631 (format "nnimap:%s" server)))
633 (name (nnheader-translate-file-chars
634 (concat nnimap-nov-file-name
635 (if (equal server "")
637 server) "." group nnimap-nov-file-name-suffix) t))
638 (nameuid (nnheader-translate-file-chars
639 (concat nnimap-nov-file-name
640 (if (equal server "")
642 server) "." group "." uidvalidity
643 nnimap-nov-file-name-suffix) t))
644 (oldfile (if (or nnmail-use-long-file-names
645 (file-exists-p (expand-file-name name dir)))
646 (expand-file-name name dir)
648 (encode-coding-string
649 (nnheader-replace-chars-in-string name ?. ?/)
650 nnmail-pathname-coding-system)
652 (newfile (if (or nnmail-use-long-file-names
653 (file-exists-p (expand-file-name nameuid dir)))
654 (expand-file-name nameuid dir)
656 (encode-coding-string
657 (nnheader-replace-chars-in-string nameuid ?. ?/)
658 nnmail-pathname-coding-system)
660 (when (and (file-exists-p oldfile) (not (file-exists-p newfile)))
661 (message "nnimap: Upgrading novcache filename...")
663 (gnus-make-directory (file-name-directory newfile))
664 (unless (ignore-errors (rename-file oldfile newfile) t)
665 (if (ignore-errors (copy-file oldfile newfile) t)
666 (delete-file oldfile)
667 (error "Can't rename `%s' to `%s'" oldfile newfile))))
670 (defun nnimap-retrieve-headers-from-file (group server)
671 (with-current-buffer nntp-server-buffer
672 (let ((nov (nnimap-group-overview-filename group server)))
673 (when (file-exists-p nov)
674 (nnheader-insert-file-contents nov)
675 (set-buffer-modified-p nil)
676 (let ((min (ignore-errors (goto-char (point-min))
677 (read (current-buffer))))
678 (max (ignore-errors (goto-char (point-max))
680 (read (current-buffer)))))
681 (if (and (numberp min) (numberp max))
683 ;; junk, remove it, it's saved later
687 (defun nnimap-retrieve-headers-from-server (articles group server)
688 (with-current-buffer nnimap-server-buffer
689 (let ((imap-fetch-data-hook '(nnimap-retrieve-headers-progress))
690 (nnimap-length (gnus-range-length articles))
692 (imap-fetch (imap-range-to-message-set articles)
693 (concat "(UID RFC822.SIZE BODY "
695 (append '(Subject From Date Message-Id
696 References In-Reply-To Xref)
698 nnmail-extra-headers))))
699 (if (imap-capability 'IMAP4rev1)
700 (format "BODY.PEEK[HEADER.FIELDS %s])" headers)
701 (format "RFC822.HEADER.LINES %s)" headers)))))
702 (and (numberp nnmail-large-newsgroup)
703 (> nnimap-length nnmail-large-newsgroup)
704 (nnheader-message 6 "nnimap: Retrieving headers...done")))))
706 (defun nnimap-dont-use-nov-p (group server)
707 (or gnus-nov-is-evil nnimap-nov-is-evil
708 (unless (and (gnus-make-directory
710 (nnimap-group-overview-filename group server)))
712 (nnimap-group-overview-filename group server)))
713 (message "nnimap: Nov cache not writable, %s"
714 (nnimap-group-overview-filename group server)))))
716 (deffoo nnimap-retrieve-headers (articles &optional group server fetch-old)
717 (when (nnimap-possibly-change-group group server)
718 (with-current-buffer nntp-server-buffer
720 (if (nnimap-dont-use-nov-p group server)
721 (nnimap-retrieve-headers-from-server
722 (gnus-compress-sequence articles) group server)
723 (let (uids cached low high)
724 (when (setq uids (nnimap-retrieve-which-headers articles fetch-old)
726 high (car (last uids)))
727 (if (setq cached (nnimap-retrieve-headers-from-file group server))
729 ;; fetch articles with uids before cache block
730 (when (< low (car cached))
731 (goto-char (point-min))
732 (nnimap-retrieve-headers-from-server
733 (cons low (1- (car cached))) group server))
734 ;; fetch articles with uids after cache block
735 (when (> high (cdr cached))
736 (goto-char (point-max))
737 (nnimap-retrieve-headers-from-server
738 (cons (1+ (cdr cached)) high) group server))
739 (when nnimap-prune-cache
740 ;; remove nov's for articles which has expired on server
741 (goto-char (point-min))
742 (dolist (uid (gnus-set-difference articles uids))
743 (when (re-search-forward (format "^%d\t" uid) nil t)
744 (gnus-delete-line)))))
745 ;; nothing cached, fetch whole range from server
746 (nnimap-retrieve-headers-from-server
747 (cons low high) group server))
748 (when (buffer-modified-p)
750 (point-min) (point-max)
751 (nnimap-group-overview-filename group server) nil 'nomesg))
752 (nnheader-nov-delete-outside-range low high))))
755 (defun nnimap-open-connection (server)
756 (if (not (imap-open nnimap-address nnimap-server-port nnimap-stream
757 nnimap-authenticator nnimap-server-buffer))
758 (nnheader-report 'nnimap "Can't open connection to server %s" server)
759 (unless (or (imap-capability 'IMAP4 nnimap-server-buffer)
760 (imap-capability 'IMAP4rev1 nnimap-server-buffer))
761 (imap-close nnimap-server-buffer)
762 (nnheader-report 'nnimap "Server %s is not IMAP4 compliant" server))
763 (let* ((list (netrc-parse nnimap-authinfo-file))
764 (port (if nnimap-server-port
765 (int-to-string nnimap-server-port)
767 (user (netrc-machine-user-or-password
771 (or nnimap-server-address
774 (list "imap" "imaps")))
775 (passwd (netrc-machine-user-or-password
779 (or nnimap-server-address
782 (list "imap" "imaps"))))
783 (if (imap-authenticate user passwd nnimap-server-buffer)
785 (push (list server nnimap-server-buffer)
786 nnimap-server-buffer-alist)
787 (imap-id nnimap-id nnimap-server-buffer)
788 (nnimap-possibly-change-server server))
789 (imap-close nnimap-server-buffer)
790 (kill-buffer nnimap-server-buffer)
791 (nnheader-report 'nnimap "Could not authenticate to %s" server)))))
793 (deffoo nnimap-open-server (server &optional defs)
794 (nnheader-init-server-buffer)
795 (if (nnimap-server-opened server)
797 (unless (assq 'nnimap-server-buffer defs)
798 (push (list 'nnimap-server-buffer (concat " *nnimap* " server)) defs))
799 ;; translate `nnimap-server-address' to `nnimap-address' in defs
800 ;; for people that configured nnimap with a very old version
801 (unless (assq 'nnimap-address defs)
802 (if (assq 'nnimap-server-address defs)
803 (push (list 'nnimap-address
804 (cadr (assq 'nnimap-server-address defs))) defs)
805 (push (list 'nnimap-address server) defs)))
806 (nnoo-change-server 'nnimap server defs)
807 (or nnimap-server-buffer
808 (setq nnimap-server-buffer (cadr (assq 'nnimap-server-buffer defs))))
809 (with-current-buffer (get-buffer-create nnimap-server-buffer)
810 (nnoo-change-server 'nnimap server defs))
811 (or (and nnimap-server-buffer
812 (imap-opened nnimap-server-buffer)
813 (if (with-current-buffer nnimap-server-buffer
814 (memq imap-state '(auth select examine)))
816 (imap-close nnimap-server-buffer)
817 (nnimap-open-connection server)))
818 (nnimap-open-connection server))))
820 (deffoo nnimap-server-opened (&optional server)
821 "Whether SERVER is opened.
822 If SERVER is the current virtual server, and the connection to the
823 physical server is alive, this function return a non-nil value. If
824 SERVER is nil, it is treated as the current server."
825 ;; clean up autologouts??
826 (and (or server nnimap-current-server)
827 (nnoo-server-opened 'nnimap (or server nnimap-current-server))
828 (imap-opened (nnimap-get-server-buffer server))))
830 (deffoo nnimap-close-server (&optional server)
831 "Close connection to server and free all resources connected to it.
832 Return nil if the server couldn't be closed for some reason."
833 (let ((server (or server nnimap-current-server)))
834 (when (or (nnimap-server-opened server)
835 (imap-opened (nnimap-get-server-buffer server)))
836 (imap-close (nnimap-get-server-buffer server))
837 (kill-buffer (nnimap-get-server-buffer server))
838 (setq nnimap-server-buffer nil
839 nnimap-current-server nil
840 nnimap-server-buffer-alist
841 (delq server nnimap-server-buffer-alist)))
842 (nnoo-close-server 'nnimap server)))
844 (deffoo nnimap-request-close ()
845 "Close connection to all servers and free all resources that the backend have reserved.
846 All buffers that have been created by that
847 backend should be killed. (Not the nntp-server-buffer, though.) This
848 function is generally only called when Gnus is shutting down."
849 (mapc (lambda (server) (nnimap-close-server (car server)))
850 nnimap-server-buffer-alist)
851 (setq nnimap-server-buffer-alist nil))
853 (deffoo nnimap-status-message (&optional server)
854 "This function returns the last error message from server."
855 (when (nnimap-possibly-change-server server)
856 (nnoo-status-message 'nnimap server)))
858 (defun nnimap-demule (string)
859 ;; BEWARE: we used to use string-as-multibyte here which is braindead
860 ;; because it will turn accidental emacs-mule-valid byte sequences
861 ;; into multibyte chars. --Stef
862 ;; Reverted, braindead got 7.5 out of 10 on imdb, so it can't be
864 (funcall (if (and (fboundp 'string-as-multibyte)
865 (subrp (symbol-function 'string-as-multibyte)))
870 (defun nnimap-make-callback (article gnus-callback buffer)
871 "Return a callback function."
873 (nnimap-callback ,article ,gnus-callback ,buffer)))
875 (defun nnimap-callback (article gnus-callback buffer)
876 (when (eq article (imap-current-message))
877 (remove-hook 'imap-fetch-data-hook
878 (nnimap-make-callback article gnus-callback buffer))
879 (with-current-buffer buffer
881 (with-current-buffer nnimap-server-buffer
883 (if (imap-capability 'IMAP4rev1)
884 ;; xxx don't just use car? alist doesn't contain
885 ;; anything else now, but it might...
886 (nth 2 (car (imap-message-get article 'BODYDETAIL)))
887 (imap-message-get article 'RFC822)))))
888 (nnheader-ms-strip-cr)
889 (funcall gnus-callback t))))
891 (defun nnimap-request-article-part (article part prop &optional
892 group server to-buffer detail)
893 (when (nnimap-possibly-change-group group server)
894 (let ((article (if (stringp article)
895 (car-safe (imap-search
896 (format "HEADER Message-Id \"%s\"" article)
897 nnimap-server-buffer))
900 (gnus-message 10 "nnimap: Fetching (part of) article %d from %s..."
901 article (or group imap-current-mailbox
902 gnus-newsgroup-name))
903 (if (not nnheader-callback-function)
904 (with-current-buffer (or to-buffer nntp-server-buffer)
906 (let ((data (imap-fetch article part prop nil
907 nnimap-server-buffer)))
909 (insert (nnimap-demule (if detail (nth 2 (car data)) data)))
910 (nnheader-ms-strip-cr)
912 10 "nnimap: Fetching (part of) article %d from %s...done"
913 article (or group imap-current-mailbox gnus-newsgroup-name))
915 (nnheader-report 'nnimap "No such article %d in %s: %s"
916 article (or group imap-current-mailbox
918 (imap-error-text nnimap-server-buffer))
919 (cons group article)))))
920 (add-hook 'imap-fetch-data-hook
921 (nnimap-make-callback article
922 nnheader-callback-function
924 (imap-fetch-asynch article part nil nnimap-server-buffer)
925 (cons group article))))))
927 (deffoo nnimap-asynchronous-p ()
930 (deffoo nnimap-request-article (article &optional group server to-buffer)
931 (if (imap-capability 'IMAP4rev1 nnimap-server-buffer)
932 (nnimap-request-article-part
933 article "BODY.PEEK[]" 'BODYDETAIL group server to-buffer 'detail)
934 (nnimap-request-article-part
935 article "RFC822.PEEK" 'RFC822 group server to-buffer)))
937 (deffoo nnimap-request-head (article &optional group server to-buffer)
938 (if (imap-capability 'IMAP4rev1 nnimap-server-buffer)
939 (nnimap-request-article-part
940 article "BODY.PEEK[HEADER]" 'BODYDETAIL group server to-buffer 'detail)
941 (nnimap-request-article-part
942 article "RFC822.HEADER" 'RFC822.HEADER group server to-buffer)))
944 (deffoo nnimap-request-body (article &optional group server to-buffer)
945 (if (imap-capability 'IMAP4rev1 nnimap-server-buffer)
946 (nnimap-request-article-part
947 article "BODY.PEEK[TEXT]" 'BODYDETAIL group server to-buffer 'detail)
948 (nnimap-request-article-part
949 article "RFC822.TEXT.PEEK" 'RFC822.TEXT group server to-buffer)))
951 (deffoo nnimap-request-group (group &optional server fast)
952 (nnimap-request-update-info-internal
954 (gnus-get-info (gnus-group-prefixed-name
955 group (gnus-server-to-method (format "nnimap:%s" server))))
957 (when (nnimap-possibly-change-group group server)
958 (nnimap-before-find-minmax-bugworkaround)
961 ((null (setq info (nnimap-find-minmax-uid group t)))
962 (nnheader-report 'nnimap "Could not get active info for %s"
965 (nnheader-insert "211 %d %d %d %s\n" (or (nth 0 info) 0)
966 (max 1 (or (nth 1 info) 1))
967 (or (nth 2 info) 0) group)
968 (nnheader-report 'nnimap "Group %s selected" group)
971 (defun nnimap-update-unseen (group &optional server)
972 "Update the unseen count in `nnimap-mailbox-info'."
974 (gnus-group-prefixed-name group server)
975 (let ((old (gnus-gethash-safe (gnus-group-prefixed-name group server)
976 nnimap-mailbox-info)))
977 (list (nth 0 old) (nth 1 old)
978 (imap-mailbox-status group 'unseen nnimap-server-buffer)
980 nnimap-mailbox-info))
982 (defun nnimap-close-group (group &optional server)
983 (with-current-buffer nnimap-server-buffer
984 (when (and (imap-opened)
985 (nnimap-possibly-change-group group server))
986 (nnimap-update-unseen group server)
987 (case nnimap-expunge-on-close
989 (imap-mailbox-expunge nnimap-close-asynchronous)
990 (unless nnimap-dont-close
991 (imap-mailbox-close nnimap-close-asynchronous))))
992 (ask (if (and (imap-search "DELETED")
993 (gnus-y-or-n-p (format "Expunge articles in group `%s'? "
994 imap-current-mailbox)))
996 (imap-mailbox-expunge nnimap-close-asynchronous)
997 (unless nnimap-dont-close
998 (imap-mailbox-close nnimap-close-asynchronous)))
999 (imap-mailbox-unselect)))
1000 (t (imap-mailbox-unselect)))
1001 (not imap-current-mailbox))))
1003 (defun nnimap-pattern-to-list-arguments (pattern)
1005 (cons (car-safe p) (or (cdr-safe p) p)))
1006 (if (and (listp pattern)
1007 (listp (cdr pattern)))
1011 (deffoo nnimap-request-list (&optional server)
1012 (when (nnimap-possibly-change-server server)
1013 (with-current-buffer nntp-server-buffer
1015 (gnus-message 5 "nnimap: Generating active list%s..."
1016 (if (> (length server) 0) (concat " for " server) ""))
1017 (nnimap-before-find-minmax-bugworkaround)
1018 (with-current-buffer nnimap-server-buffer
1019 (dolist (pattern (nnimap-pattern-to-list-arguments nnimap-list-pattern))
1020 (dolist (mbx (funcall nnimap-request-list-method
1021 (cdr pattern) (car pattern)))
1022 (or (member "\\NoSelect" (imap-mailbox-get 'list-flags mbx))
1023 (let ((info (nnimap-find-minmax-uid mbx 'examine)))
1025 (with-current-buffer nntp-server-buffer
1026 (insert (format "\"%s\" %d %d y\n"
1027 mbx (or (nth 2 info) 0)
1028 (max 1 (or (nth 1 info) 1)))))))))))
1029 (gnus-message 5 "nnimap: Generating active list%s...done"
1030 (if (> (length server) 0) (concat " for " server) ""))
1033 (deffoo nnimap-request-post (&optional server)
1035 (dolist (mbx (message-unquote-tokens
1036 (message-tokenize-header
1037 (message-fetch-field "Newsgroups") ", ")) success)
1038 (let ((to-newsgroup (gnus-group-prefixed-name mbx gnus-command-method)))
1039 (or (gnus-active to-newsgroup)
1040 (gnus-activate-group to-newsgroup)
1041 (if (gnus-y-or-n-p (format "No such group: %s. Create it? "
1043 (or (and (gnus-request-create-group
1044 to-newsgroup gnus-command-method)
1045 (gnus-activate-group to-newsgroup nil nil
1046 gnus-command-method))
1047 (error "Couldn't create group %s" to-newsgroup)))
1048 (error "No such group: %s" to-newsgroup))
1049 (unless (nnimap-request-accept-article mbx (nth 1 gnus-command-method))
1050 (setq success nil))))))
1052 ;; Optional backend functions
1054 (defun nnimap-string-lessp-numerical (s1 s2)
1055 "Return t if first arg string is less than second in numerical order."
1056 (cond ((string= s1 s2)
1058 ((> (length s1) (length s2))
1060 ((< (length s1) (length s2))
1062 ((< (string-to-number (substring s1 0 1))
1063 (string-to-number (substring s2 0 1)))
1065 ((> (string-to-number (substring s1 0 1))
1066 (string-to-number (substring s2 0 1)))
1069 (nnimap-string-lessp-numerical (substring s1 1) (substring s2 1)))))
1071 (deffoo nnimap-retrieve-groups (groups &optional server)
1072 (when (nnimap-possibly-change-server server)
1073 (gnus-message 5 "nnimap: Checking mailboxes...")
1074 (with-current-buffer nntp-server-buffer
1076 (nnimap-before-find-minmax-bugworkaround)
1077 (let (asyncgroups slowgroups)
1078 (if (null nnimap-retrieve-groups-asynchronous)
1079 (setq slowgroups groups)
1080 (dolist (group groups)
1081 (gnus-message 9 "nnimap: Quickly checking mailbox %s" group)
1082 (add-to-list (if (gnus-gethash-safe
1083 (gnus-group-prefixed-name group server)
1084 nnimap-mailbox-info)
1087 (list group (imap-mailbox-status-asynch
1088 group '(uidvalidity uidnext unseen)
1089 nnimap-server-buffer))))
1090 (dolist (asyncgroup asyncgroups)
1091 (let ((group (nth 0 asyncgroup))
1092 (tag (nth 1 asyncgroup))
1094 (when (imap-ok-p (imap-wait-for-tag tag nnimap-server-buffer))
1095 (if (or (not (string=
1096 (nth 0 (gnus-gethash (gnus-group-prefixed-name
1098 nnimap-mailbox-info))
1099 (imap-mailbox-get 'uidvalidity group
1100 nnimap-server-buffer)))
1102 (nth 1 (gnus-gethash (gnus-group-prefixed-name
1104 nnimap-mailbox-info))
1105 (imap-mailbox-get 'uidnext group
1106 nnimap-server-buffer))))
1107 (push (list group) slowgroups)
1108 (insert (nth 3 (gnus-gethash (gnus-group-prefixed-name
1110 nnimap-mailbox-info))))))))
1111 (dolist (group slowgroups)
1112 (if nnimap-retrieve-groups-asynchronous
1113 (setq group (car group)))
1114 (gnus-message 7 "nnimap: Mailbox %s modified" group)
1115 (imap-mailbox-put 'uidnext nil group nnimap-server-buffer)
1116 (or (member "\\NoSelect" (imap-mailbox-get 'list-flags group
1117 nnimap-server-buffer))
1118 (let* ((info (nnimap-find-minmax-uid group 'examine))
1119 (str (format "\"%s\" %d %d y\n" group
1121 (max 1 (or (nth 1 info) 1)))))
1122 (when (> (or (imap-mailbox-get 'recent group
1123 nnimap-server-buffer) 0)
1125 (push (list (cons group 0)) nnmail-split-history))
1127 (when nnimap-retrieve-groups-asynchronous
1129 (gnus-group-prefixed-name group server)
1130 (list (or (imap-mailbox-get
1131 'uidvalidity group nnimap-server-buffer)
1132 (imap-mailbox-status
1133 group 'uidvalidity nnimap-server-buffer))
1134 (or (imap-mailbox-get
1135 'uidnext group nnimap-server-buffer)
1136 (imap-mailbox-status
1137 group 'uidnext nnimap-server-buffer))
1138 (or (imap-mailbox-get
1139 'unseen group nnimap-server-buffer)
1140 (imap-mailbox-status
1141 group 'unseen nnimap-server-buffer))
1143 nnimap-mailbox-info)))))))
1144 (gnus-message 5 "nnimap: Checking mailboxes...done")
1147 (deffoo nnimap-request-update-info-internal (group info &optional server)
1148 (when (nnimap-possibly-change-group group server)
1149 (when info;; xxx what does this mean? should we create a info?
1150 (with-current-buffer nnimap-server-buffer
1151 (gnus-message 5 "nnimap: Updating info for %s..."
1152 (gnus-info-group info))
1154 (when (nnimap-mark-permanent-p 'read)
1156 ;; read info could contain articles marked unread by other
1157 ;; imap clients! we correct this
1158 (setq seen (gnus-uncompress-range (gnus-info-read info))
1159 unseen (imap-search "UNSEEN UNDELETED")
1160 seen (gnus-set-difference seen unseen)
1161 ;; seen might lack articles marked as read by other
1162 ;; imap clients! we correct this
1163 seen (append seen (imap-search "SEEN"))
1166 seen (gnus-compress-sequence seen t)
1167 ;; we can't return '(1) since this isn't a "list of ranges",
1168 ;; and we can't return '((1)) since g-list-of-unread-articles
1169 ;; is buggy so we return '((1 . 1)).
1170 seen (if (and (integerp (car seen))
1172 (list (cons (car seen) (car seen)))
1174 (gnus-info-set-read info seen)))
1176 (mapcar (lambda (pred)
1177 (when (or (eq (cdr pred) 'recent)
1178 (and (nnimap-mark-permanent-p (cdr pred))
1179 (member (nnimap-mark-to-flag (cdr pred))
1180 (imap-mailbox-get 'flags))))
1181 (gnus-info-set-marks
1183 (gnus-update-alist-soft
1185 (gnus-compress-sequence
1186 (imap-search (nnimap-mark-to-predicate (cdr pred))))
1187 (gnus-info-marks info))
1189 gnus-article-mark-lists)
1191 (when nnimap-importantize-dormant
1192 ;; nnimap mark dormant article as ticked too (for other clients)
1193 ;; so we remove that mark for gnus since we support dormant
1194 (gnus-info-set-marks
1196 (gnus-update-alist-soft
1198 (gnus-remove-from-range
1199 (cdr-safe (assoc 'tick (gnus-info-marks info)))
1200 (cdr-safe (assoc 'dormant (gnus-info-marks info))))
1201 (gnus-info-marks info))
1204 (gnus-message 5 "nnimap: Updating info for %s...done"
1205 (gnus-info-group info))
1209 (deffoo nnimap-request-type (group &optional article)
1210 (if (and nnimap-news-groups (string-match nnimap-news-groups group))
1214 (deffoo nnimap-request-set-mark (group actions &optional server)
1215 (when (nnimap-possibly-change-group group server)
1216 (with-current-buffer nnimap-server-buffer
1218 (gnus-message 7 "nnimap: Setting marks in %s..." group)
1219 (while (setq action (pop actions))
1220 (let ((range (nth 0 action))
1221 (what (nth 1 action))
1222 (cmdmarks (nth 2 action))
1224 ;; bookmark can't be stored (not list/range
1225 (setq cmdmarks (delq 'bookmark cmdmarks))
1226 ;; killed can't be stored (not list/range
1227 (setq cmdmarks (delq 'killed cmdmarks))
1228 ;; unsent are for nndraft groups only
1229 (setq cmdmarks (delq 'unsent cmdmarks))
1230 ;; cache flags are pointless on the server
1231 (setq cmdmarks (delq 'cache cmdmarks))
1232 ;; seen flags are local to each gnus
1233 (setq cmdmarks (delq 'seen cmdmarks))
1234 ;; recent marks can't be set
1235 (setq cmdmarks (delq 'recent cmdmarks))
1236 (when nnimap-importantize-dormant
1237 ;; flag dormant articles as ticked
1238 (if (memq 'dormant cmdmarks)
1239 (setq cmdmarks (cons 'tick cmdmarks))))
1240 ;; remove stuff we are forbidden to store
1241 (mapc (lambda (mark)
1242 (if (imap-message-flag-permanent-p
1243 (nnimap-mark-to-flag mark))
1244 (setq marks (cons mark marks))))
1246 (when (and range marks)
1247 (cond ((eq what 'del)
1248 (imap-message-flags-del
1249 (imap-range-to-message-set range)
1250 (nnimap-mark-to-flag marks nil t)))
1252 (imap-message-flags-add
1253 (imap-range-to-message-set range)
1254 (nnimap-mark-to-flag marks nil t)))
1256 (imap-message-flags-set
1257 (imap-range-to-message-set range)
1258 (nnimap-mark-to-flag marks nil t)))))))
1259 (gnus-message 7 "nnimap: Setting marks in %s...done" group))))
1262 (defun nnimap-split-fancy ()
1263 "Like the function `nnmail-split-fancy', but uses `nnimap-split-fancy'."
1264 (let ((nnmail-split-fancy nnimap-split-fancy))
1265 (nnmail-split-fancy)))
1267 (defun nnimap-split-to-groups (rules)
1268 ;; tries to match all rules in nnimap-split-rule against content of
1269 ;; nntp-server-buffer, returns a list of groups that matched.
1270 (with-current-buffer nntp-server-buffer
1271 ;; Fold continuation lines.
1272 (goto-char (point-min))
1273 (while (re-search-forward "\\(\r?\n[ \t]+\\)+" nil t)
1274 (replace-match " " t t))
1275 (if (functionp rules)
1277 (let (to-groups regrepp)
1279 (dolist (rule rules to-groups)
1280 (let ((group (car rule))
1281 (regexp (cadr rule)))
1282 (goto-char (point-min))
1283 (when (and (if (stringp regexp)
1285 (if (not (stringp group))
1286 (setq group (eval group))
1288 (string-match "\\\\[0-9&]" group)))
1289 (re-search-forward regexp nil t))
1290 (funcall regexp group))
1291 ;; Don't enter the article into the same group twice.
1292 (not (assoc group to-groups)))
1294 (nnmail-expand-newtext group)
1297 (or nnimap-split-crosspost
1298 (throw 'split-done to-groups))))))))))
1300 (defun nnimap-assoc-match (key alist)
1302 (while (and alist (not element))
1303 (if (string-match (car (car alist)) key)
1304 (setq element (car alist)))
1305 (setq alist (cdr alist)))
1308 (defun nnimap-split-find-rule (server inbox)
1309 (if (and (listp nnimap-split-rule) (listp (car nnimap-split-rule))
1310 (list (cdar nnimap-split-rule)) (listp (cadar nnimap-split-rule)))
1312 (cadr (nnimap-assoc-match inbox (cdr (nnimap-assoc-match
1313 server nnimap-split-rule))))
1316 (defun nnimap-split-find-inbox (server)
1317 (if (listp nnimap-split-inbox)
1319 (list nnimap-split-inbox)))
1321 (defun nnimap-split-articles (&optional group server)
1322 (when (nnimap-possibly-change-server server)
1323 (with-current-buffer nnimap-server-buffer
1324 (let (rule inbox removeorig (inboxes (nnimap-split-find-inbox server)))
1325 ;; iterate over inboxes
1326 (while (and (setq inbox (pop inboxes))
1327 (nnimap-possibly-change-group inbox));; SELECT
1328 ;; find split rule for this server / inbox
1329 (when (setq rule (nnimap-split-find-rule server inbox))
1330 ;; iterate over articles
1331 (dolist (article (imap-search nnimap-split-predicate))
1332 (when (if (if (eq nnimap-split-download-body 'default)
1333 nnimap-split-download-body-default
1334 nnimap-split-download-body)
1335 (and (nnimap-request-article article)
1336 (with-current-buffer nntp-server-buffer (mail-narrow-to-head)))
1337 (nnimap-request-head article))
1338 ;; copy article to right group(s)
1339 (setq removeorig nil)
1340 (dolist (to-group (nnimap-split-to-groups rule))
1341 (cond ((eq to-group 'junk)
1342 (message "IMAP split removed %s:%s:%d" server inbox
1344 (setq removeorig t))
1345 ((imap-message-copy (number-to-string article)
1346 to-group nil 'nocopyuid)
1347 (message "IMAP split moved %s:%s:%d to %s" server
1348 inbox article to-group)
1350 (when nnmail-cache-accepted-message-ids
1351 (with-current-buffer nntp-server-buffer
1354 (nnmail-fetch-field "message-id"))
1355 (nnmail-cache-insert msgid
1357 (nnmail-fetch-field "subject"))))))
1358 ;; Add the group-art list to the history list.
1359 (push (list (cons to-group 0)) nnmail-split-history))
1361 (message "IMAP split failed to move %s:%s:%d to %s"
1362 server inbox article to-group))))
1363 (if (if (eq nnimap-split-download-body 'default)
1364 nnimap-split-download-body-default
1365 nnimap-split-download-body)
1367 ;; remove article if it was successfully copied somewhere
1369 (imap-message-flags-add (format "%d" article)
1370 "\\Seen \\Deleted")))))
1371 (when (imap-mailbox-select inbox);; just in case
1372 ;; todo: UID EXPUNGE (if available) to remove splitted articles
1373 (imap-mailbox-expunge)
1374 (imap-mailbox-close)))
1375 (when nnmail-cache-accepted-message-ids
1376 (nnmail-cache-close))
1379 (deffoo nnimap-request-scan (&optional group server)
1380 (nnimap-split-articles group server))
1382 (deffoo nnimap-request-newgroups (date &optional server)
1383 (when (nnimap-possibly-change-server server)
1384 (with-current-buffer nntp-server-buffer
1385 (gnus-message 5 "nnimap: Listing subscribed mailboxes%s%s..."
1386 (if (> (length server) 0) " on " "") server)
1388 (nnimap-before-find-minmax-bugworkaround)
1389 (dolist (pattern (nnimap-pattern-to-list-arguments
1390 nnimap-list-pattern))
1391 (dolist (mbx (imap-mailbox-lsub (cdr pattern) (car pattern) nil
1392 nnimap-server-buffer))
1394 (dolist (mailbox (imap-mailbox-get 'list-flags mbx
1395 nnimap-server-buffer))
1396 (if (string= (downcase mailbox) "\\noselect")
1399 (let ((info (nnimap-find-minmax-uid mbx 'examine)))
1401 (insert (format "\"%s\" %d %d y\n"
1402 mbx (or (nth 2 info) 0)
1403 (max 1 (or (nth 1 info) 1)))))))))
1404 (gnus-message 5 "nnimap: Listing subscribed mailboxes%s%s...done"
1405 (if (> (length server) 0) " on " "") server))
1408 (deffoo nnimap-request-create-group (group &optional server args)
1409 (when (nnimap-possibly-change-server server)
1410 (or (imap-mailbox-status group 'uidvalidity nnimap-server-buffer)
1411 (imap-mailbox-create group nnimap-server-buffer)
1412 (nnheader-report 'nnimap "%S"
1413 (imap-error-text nnimap-server-buffer)))))
1415 (defun nnimap-time-substract (time1 time2)
1416 "Return TIME for TIME1 - TIME2."
1417 (let* ((ms (- (car time1) (car time2)))
1418 (ls (- (nth 1 time1) (nth 1 time2))))
1420 (list (- ms 1) (+ (expt 2 16) ls))
1423 (defun nnimap-date-days-ago (daysago)
1424 "Return date, in format \"3-Aug-1998\", for DAYSAGO days ago."
1425 (let* ((time (nnimap-time-substract (current-time) (days-to-time daysago)))
1426 (date (format-time-string
1427 (format "%%d-%s-%%Y"
1428 (capitalize (car (rassoc (nth 4 (decode-time time))
1429 parse-time-months))))
1431 (if (eq ?0 (string-to-char date))
1435 (defun nnimap-request-expire-articles-progress ()
1436 (gnus-message 5 "nnimap: Marking article %d for deletion..."
1437 imap-current-message))
1439 (defun nnimap-expiry-target (arts group server)
1440 (unless (eq nnmail-expiry-target 'delete)
1443 (nnimap-request-article art group server (current-buffer))
1444 ;; hints for optimization in `nnimap-request-accept-article'
1445 (let ((nnimap-current-move-article art)
1446 (nnimap-current-move-group group)
1447 (nnimap-current-move-server server))
1448 (nnmail-expiry-target-group nnmail-expiry-target group))))
1449 ;; It is not clear if `nnmail-expiry-target' somehow cause the
1450 ;; current group to be changed or not, so we make sure here.
1451 (nnimap-possibly-change-group group server)))
1453 ;; Notice that we don't actually delete anything, we just mark them deleted.
1454 (deffoo nnimap-request-expire-articles (articles group &optional server force)
1455 (let ((artseq (gnus-compress-sequence articles)))
1456 (when (and artseq (nnimap-possibly-change-group group server))
1457 (with-current-buffer nnimap-server-buffer
1458 (let ((days (or (and nnmail-expiry-wait-function
1459 (funcall nnmail-expiry-wait-function group))
1460 nnmail-expiry-wait)))
1461 (cond ((or force (eq days 'immediate))
1462 (let ((oldarts (imap-search
1464 (imap-range-to-message-set artseq)))))
1466 (nnimap-expiry-target oldarts group server)
1467 (when (imap-message-flags-add
1468 (imap-range-to-message-set
1469 (gnus-compress-sequence oldarts)) "\\Deleted")
1470 (setq articles (gnus-set-difference
1471 articles oldarts))))))
1473 (let ((oldarts (imap-search
1474 (format nnimap-expunge-search-string
1475 (imap-range-to-message-set artseq)
1476 (nnimap-date-days-ago days))))
1477 (imap-fetch-data-hook
1478 '(nnimap-request-expire-articles-progress)))
1480 (nnimap-expiry-target oldarts group server)
1481 (when (imap-message-flags-add
1482 (imap-range-to-message-set
1483 (gnus-compress-sequence oldarts)) "\\Deleted")
1484 (setq articles (gnus-set-difference
1485 articles oldarts)))))))))))
1486 ;; return articles not deleted
1489 (deffoo nnimap-request-move-article (article group server
1490 accept-form &optional last)
1491 (when (nnimap-possibly-change-server server)
1493 (let ((buf (get-buffer-create " *nnimap move*"))
1494 (nnimap-current-move-article article)
1495 (nnimap-current-move-group group)
1496 (nnimap-current-move-server nnimap-current-server)
1498 (and (nnimap-request-article article group server)
1501 (buffer-disable-undo (current-buffer))
1502 (insert-buffer-substring nntp-server-buffer)
1503 (setq result (eval accept-form))
1506 (imap-message-flags-add
1507 (imap-range-to-message-set (list article))
1508 "\\Deleted" 'silent nnimap-server-buffer))
1511 (deffoo nnimap-request-accept-article (group &optional server last)
1512 (when (nnimap-possibly-change-server server)
1515 (if (string= nnimap-current-server nnimap-current-move-server)
1516 ;; moving article within same server, speed it up...
1517 (and (nnimap-possibly-change-group
1518 nnimap-current-move-group)
1519 (imap-message-copy (number-to-string
1520 nnimap-current-move-article)
1521 group 'dontcreate nil
1522 nnimap-server-buffer))
1523 (with-current-buffer (current-buffer)
1524 (goto-char (point-min))
1525 ;; remove any 'From blabla' lines, some IMAP servers
1526 ;; reject the entire message otherwise.
1527 (when (looking-at "^From[^:]")
1528 (delete-region (point) (progn (forward-line) (point))))
1529 ;; turn into rfc822 format (\r\n eol's)
1530 (while (search-forward "\n" nil t)
1531 (replace-match "\r\n"))
1532 (when nnmail-cache-accepted-message-ids
1533 (nnmail-cache-insert (nnmail-fetch-field "message-id")
1535 (nnmail-fetch-field "subject"))))
1536 (when (and last nnmail-cache-accepted-message-ids)
1537 (nnmail-cache-close))
1538 ;; this 'or' is for Cyrus server bug
1539 (or (null (imap-current-mailbox nnimap-server-buffer))
1540 (imap-mailbox-unselect nnimap-server-buffer))
1541 (imap-message-append group (current-buffer) nil nil
1542 nnimap-server-buffer)))
1543 (cons group (nth 1 uid))
1544 (nnheader-report 'nnimap (imap-error-text nnimap-server-buffer))))))
1546 (deffoo nnimap-request-delete-group (group force &optional server)
1547 (when (nnimap-possibly-change-server server)
1548 (with-current-buffer nnimap-server-buffer
1550 (or (null (imap-mailbox-status group 'uidvalidity))
1551 (imap-mailbox-delete group))
1555 (deffoo nnimap-request-rename-group (group new-name &optional server)
1556 (when (nnimap-possibly-change-server server)
1557 (imap-mailbox-rename group new-name nnimap-server-buffer)))
1559 (defun nnimap-expunge (mailbox server)
1560 (when (nnimap-possibly-change-group mailbox server)
1561 (imap-mailbox-expunge nil nnimap-server-buffer)))
1563 (defun nnimap-acl-get (mailbox server)
1564 (when (nnimap-possibly-change-server server)
1565 (and (imap-capability 'ACL nnimap-server-buffer)
1566 (imap-mailbox-acl-get mailbox nnimap-server-buffer))))
1568 (defun nnimap-acl-edit (mailbox method old-acls new-acls)
1569 (when (nnimap-possibly-change-server (cadr method))
1570 (unless (imap-capability 'ACL nnimap-server-buffer)
1571 (error "Your server does not support ACL editing"))
1572 (with-current-buffer nnimap-server-buffer
1573 ;; delete all removed identifiers
1574 (mapc (lambda (old-acl)
1575 (unless (assoc (car old-acl) new-acls)
1576 (or (imap-mailbox-acl-delete (car old-acl) mailbox)
1577 (error "Can't delete ACL for %s" (car old-acl)))))
1579 ;; set all changed acl's
1580 (mapc (lambda (new-acl)
1581 (let ((new-rights (cdr new-acl))
1582 (old-rights (cdr (assoc (car new-acl) old-acls))))
1583 (unless (and old-rights new-rights
1584 (string= old-rights new-rights))
1585 (or (imap-mailbox-acl-set (car new-acl) new-rights mailbox)
1586 (error "Can't set ACL for %s to %s" (car new-acl)
1592 ;;; Internal functions
1595 ;; This is confusing.
1597 ;; mark => read, tick, draft, reply etc
1598 ;; flag => "\\Seen", "\\Flagged", "\\Draft", "gnus-expire" etc
1599 ;; predicate => "SEEN", "FLAGGED", "DRAFT", "KEYWORD gnus-expire" etc
1601 ;; Mark should not really contain 'read since it's not a "mark" in the Gnus
1602 ;; world, but we cheat. Mark == gnus-article-mark-lists + '(read . read).
1605 (defconst nnimap-mark-to-predicate-alist
1607 (lambda (pair) ; cdr is the mark
1608 (or (assoc (cdr pair)
1613 (reply . "ANSWERED")))
1615 (format "KEYWORD gnus-%s" (symbol-name (cdr pair))))))
1616 (cons '(read . read) gnus-article-mark-lists)))
1618 (defun nnimap-mark-to-predicate (pred)
1619 "Convert a Gnus mark (a symbol such as read, tick, expire) to a IMAP predicate.
1620 This is a string such as \"SEEN\", \"FLAGGED\", \"KEYWORD gnus-expire\",
1621 to be used within a IMAP SEARCH query."
1622 (cdr (assq pred nnimap-mark-to-predicate-alist)))
1624 (defconst nnimap-mark-to-flag-alist
1627 (or (assoc (cdr pair)
1629 (tick . "\\Flagged")
1631 (recent . "\\Recent")
1632 (reply . "\\Answered")))
1634 (format "gnus-%s" (symbol-name (cdr pair))))))
1635 (cons '(read . read) gnus-article-mark-lists)))
1637 (defun nnimap-mark-to-flag-1 (preds)
1638 (if (and (not (null preds)) (listp preds))
1639 (cons (nnimap-mark-to-flag (car preds))
1640 (nnimap-mark-to-flag (cdr preds)))
1641 (cdr (assoc preds nnimap-mark-to-flag-alist))))
1643 (defun nnimap-mark-to-flag (preds &optional always-list make-string)
1644 "Convert a Gnus mark (a symbol such as read, tick, expire) to a IMAP flag.
1645 This is a string such as \"\\Seen\", \"\\Flagged\", \"gnus-expire\", to
1646 be used in a STORE FLAGS command."
1647 (let ((result (nnimap-mark-to-flag-1 preds)))
1648 (setq result (if (and (or make-string always-list)
1649 (not (listp result)))
1653 (mapconcat (lambda (flag)
1655 (mapconcat 'identity flag " ")
1660 (defun nnimap-mark-permanent-p (mark &optional group)
1661 "Return t iff MARK can be permanently (between IMAP sessions) saved on articles, in GROUP."
1662 (imap-message-flag-permanent-p (nnimap-mark-to-flag mark)))
1666 (buffer-disable-undo (get-buffer-create nnimap-debug-buffer))
1667 (mapcar (lambda (f) (trace-function-background f nnimap-debug-buffer))
1669 nnimap-possibly-change-server
1670 nnimap-verify-uidvalidity
1671 nnimap-find-minmax-uid
1672 nnimap-before-find-minmax-bugworkaround
1673 nnimap-possibly-change-group
1674 ;;nnimap-replace-whitespace
1675 nnimap-retrieve-headers-progress
1676 nnimap-retrieve-which-headers
1677 nnimap-group-overview-filename
1678 nnimap-retrieve-headers-from-file
1679 nnimap-retrieve-headers-from-server
1680 nnimap-retrieve-headers
1681 nnimap-open-connection
1683 nnimap-server-opened
1685 nnimap-request-close
1686 nnimap-status-message
1688 nnimap-request-article-part
1689 nnimap-request-article
1692 nnimap-request-group
1694 nnimap-pattern-to-list-arguments
1697 nnimap-retrieve-groups
1698 nnimap-request-update-info-internal
1700 nnimap-request-set-mark
1701 nnimap-split-to-groups
1702 nnimap-split-find-rule
1703 nnimap-split-find-inbox
1704 nnimap-split-articles
1706 nnimap-request-newgroups
1707 nnimap-request-create-group
1708 nnimap-time-substract
1709 nnimap-date-days-ago
1710 nnimap-request-expire-articles-progress
1711 nnimap-request-expire-articles
1712 nnimap-request-move-article
1713 nnimap-request-accept-article
1714 nnimap-request-delete-group
1715 nnimap-request-rename-group
1716 gnus-group-nnimap-expunge
1717 gnus-group-nnimap-edit-acl
1718 gnus-group-nnimap-edit-acl-done
1719 nnimap-group-mode-hook
1720 nnimap-mark-to-predicate
1721 nnimap-mark-to-flag-1
1723 nnimap-mark-permanent-p
1728 ;;; nnimap.el ends here