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
73 (eval-when-compile (require 'cl))
77 (defconst nnimap-version "nnimap 1.0")
80 "Reading IMAP mail with Gnus."
83 (defvoo nnimap-address nil
84 "Address of physical IMAP server. If nil, use the virtual server's name.")
86 (defvoo nnimap-server-port nil
87 "Port number on physical IMAP server.
88 If nil, defaults to 993 for TLS/SSL connections and 143 otherwise.")
90 ;; Splitting variables
92 (defcustom nnimap-split-crosspost t
93 "If non-nil, do crossposting if several split methods match the mail.
94 If nil, the first match found will be used."
98 (defcustom nnimap-split-inbox nil
99 "Name of mailbox to split mail from.
101 Mail is read from this mailbox and split according to rules in
104 This can be a string or a list of strings."
106 :type '(choice (string)
109 (define-widget 'nnimap-strict-function 'function
110 "This widget only matches values that are functionp.
112 Warning: This means that a value that is the symbol of a not yet
113 loaded function will not match. Use with care."
114 :match 'nnimap-strict-function-match)
116 (defun nnimap-strict-function-match (widget value)
117 "Ignoring WIDGET, match if VALUE is a function."
120 (defcustom nnimap-split-rule nil
121 "Mail will be split according to these rules.
123 Mail is read from mailbox(es) specified in `nnimap-split-inbox'.
125 If you'd like, for instance, one mail group for mail from the
126 \"gnus-imap\" mailing list, one group for junk mail and leave
127 everything else in the incoming mailbox, you could do something like
130 \(setq nnimap-split-rule '((\"INBOX.gnus-imap\" \"From:.*gnus-imap\")
131 (\"INBOX.junk\" \"Subject:.*buy\")))
133 As you can see, `nnimap-split-rule' is a list of lists, where the
134 first element in each \"rule\" is the name of the IMAP mailbox (or the
135 symbol `junk' if you want to remove the mail), and the second is a
136 regexp that nnimap will try to match on the header to find a fit.
138 The second element can also be a function. In that case, it will be
139 called narrowed to the headers with the first element of the rule as
140 the argument. It should return a non-nil value if it thinks that the
141 mail belongs in that group.
143 This variable can also have a function as its value, the function will
144 be called with the headers narrowed and should return a group where it
145 thinks the article should be splitted to. See `nnimap-split-fancy'.
147 To allow for different split rules on different virtual servers, and
148 even different split rules in different inboxes on the same server,
149 the syntax of this variable have been extended along the lines of:
151 \(setq nnimap-split-rule
152 '((\"my1server\" (\".*\" ((\"ding\" \"ding@gnus.org\")
153 (\"junk\" \"From:.*Simon\")))
154 (\"my2server\" (\"INBOX\" nnimap-split-fancy))
155 (\"my[34]server\" (\".*\" ((\"private\" \"To:.*Simon\")
156 (\"junk\" my-junk-func)))))
158 The virtual server name is in fact a regexp, so that the same rules
159 may apply to several servers. In the example, the servers
160 \"my3server\" and \"my4server\" both use the same rules. Similarly,
161 the inbox string is also a regexp. The actual splitting rules are as
162 before, either a function, or a list with group/regexp or
163 group/function elements."
165 :type '(choice :tag "Rule type"
166 (repeat :menu-tag "Single-server"
167 :tag "Single-server list"
168 (list (string :tag "Mailbox")
169 (choice :tag "Predicate"
170 (regexp :tag "A regexp")
171 (nnimap-strict-function :tag "A function"))))
172 (choice :menu-tag "A function"
174 (function-item nnimap-split-fancy)
175 (function-item nnmail-split-fancy)
176 (nnimap-strict-function :tag "User-defined function"))
177 (repeat :menu-tag "Multi-server (extended)"
178 :tag "Multi-server list"
179 (list (regexp :tag "Server regexp")
180 (list (regexp :tag "Incoming Mailbox regexp")
181 (repeat :tag "Rules for matching server(s) and mailbox(es)"
182 (list (string :tag "Destination mailbox")
183 (choice :tag "Predicate"
184 (regexp :tag "A Regexp")
185 (nnimap-strict-function :tag "A Function")))))))))
187 (defcustom nnimap-split-predicate "UNSEEN UNDELETED"
188 "The predicate used to find articles to split.
189 If you use another IMAP client to peek on articles but always would
190 like nnimap to split them once it's started, you could change this to
191 \"UNDELETED\". Other available predicates are available in
192 RFC2060 section 6.4.4."
196 (defcustom nnimap-split-fancy nil
197 "Like the variable `nnmail-split-fancy'."
201 (defvar nnimap-split-download-body-default nil
202 "Internal variable with default value for `nnimap-split-download-body'.")
204 (defcustom nnimap-split-download-body 'default
205 "Whether to download entire articles during splitting.
206 This is generally not required, and will slow things down considerably.
207 You may need it if you want to use an advanced splitting function that
208 analyses the body before splitting the article.
209 If this variable is nil, bodies will not be downloaded; if this
210 variable is the symbol `default' the default behaviour is
211 used (which currently is nil, unless you use a statistical
212 spam.el test); if this variable is another non-nil value bodies
216 :type '(choice (const :tag "Let system decide" deault)
219 ;; Performance / bug workaround variables
221 (defcustom nnimap-close-asynchronous t
222 "Close mailboxes asynchronously in `nnimap-close-group'.
223 This means that errors caught by nnimap when closing the mailbox will
224 not prevent Gnus from updating the group status, which may be harmful.
225 However, it increases speed."
230 (defcustom nnimap-dont-close t
231 "Never close mailboxes.
232 This increases the speed of closing mailboxes (quiting group) but may
233 decrease the speed of selecting another mailbox later. Re-selecting
234 the same mailbox will be faster though."
239 (defcustom nnimap-retrieve-groups-asynchronous t
240 "Send asynchronous STATUS commands for each mailbox before checking mail.
241 If you have mailboxes that rarely receives mail, this speeds up new
242 mail checking. It works by first sending STATUS commands for each
243 mailbox, and then only checking groups which has a modified UIDNEXT
244 more carefully for new mail.
246 In summary, the default is O((1-p)*k+p*n) and changing it to nil makes
247 it O(n). If p is small, then the default is probably faster."
252 (defvoo nnimap-need-unselect-to-notice-new-mail nil
253 "Unselect mailboxes before looking for new mail in them.
254 Some servers seem to need this under some circumstances.")
256 ;; Authorization / Privacy variables
258 (defvoo nnimap-auth-method nil
261 (defvoo nnimap-stream nil
262 "How nnimap will connect to the server.
264 The default, nil, will try to use the \"best\" method the server can
269 1) you want to connect with TLS/SSL. The TLS/SSL integration
270 with IMAP is suboptimal so you'll have to tell it
273 2) your server is more capable than your environment -- i.e. your
274 server accept Kerberos login's but you haven't installed the
275 `imtest' program or your machine isn't configured for Kerberos.
277 Possible choices: gssapi, kerberos4, starttls, tls, ssl, network, shell.
278 See also `imap-streams' and `imap-stream-alist'.")
280 (defvoo nnimap-authenticator nil
281 "How nnimap authenticate itself to the server.
283 The default, nil, will try to use the \"best\" method the server can
286 There is only one reason for fiddling with this variable, and that is
287 if your server is more capable than your environment -- i.e. you
288 connect to a server that accept Kerberos login's but you haven't
289 installed the `imtest' program or your machine isn't configured for
292 Possible choices: gssapi, kerberos4, digest-md5, cram-md5, login, anonymous.
293 See also `imap-authenticators' and `imap-authenticator-alist'")
295 (defvoo nnimap-directory (nnheader-concat gnus-directory "overview/")
296 "Directory to keep NOV cache files for nnimap groups.
297 See also `nnimap-nov-file-name'.")
299 (defvoo nnimap-nov-file-name "nnimap."
300 "NOV cache base filename.
301 The group name and `nnimap-nov-file-name-suffix' will be appended. A
302 typical complete file name would be
303 ~/News/overview/nnimap.pdc.INBOX.ding.nov, or
304 ~/News/overview/nnimap/pdc/INBOX/ding/nov if
305 `nnmail-use-long-file-names' is nil")
307 (defvoo nnimap-nov-file-name-suffix ".novcache"
308 "Suffix for NOV cache base filename.")
310 (defvoo nnimap-nov-is-evil gnus-agent
311 "If non-nil, never generate or use a local nov database for this backend.
312 Using nov databases should speed up header fetching considerably.
313 However, it will invoke a UID SEARCH UID command on the server, and
314 some servers implement this command inefficiently by opening each and
315 every message in the group, thus making it quite slow.
316 Unlike other backends, you do not need to take special care if you
317 flip this variable.")
319 (defvoo nnimap-expunge-on-close 'always ; 'ask, 'never
320 "Whether to expunge a group when it is closed.
321 When a IMAP group with articles marked for deletion is closed, this
322 variable determine if nnimap should actually remove the articles or
325 If always, nnimap always perform a expunge when closing the group.
326 If never, nnimap never expunges articles marked for deletion.
327 If ask, nnimap will ask you if you wish to expunge marked articles.
329 When setting this variable to `never', you can only expunge articles
330 by using `G x' (gnus-group-nnimap-expunge) from the Group buffer.")
332 (defvoo nnimap-list-pattern "*"
333 "A string LIMIT or list of strings with mailbox wildcards used to limit available groups.
334 See below for available wildcards.
336 The LIMIT string can be a cons cell (REFERENCE . LIMIT), where
337 REFERENCE will be passed as the first parameter to LIST/LSUB. The
338 semantics of this are server specific, on the University of Washington
339 server you can specify a directory.
342 '(\"INBOX\" \"mail/*\" (\"~friend/mail/\" . \"list/*\"))
344 There are two wildcards * and %. * matches everything, % matches
345 everything in the current hierarchy.")
347 (defvoo nnimap-news-groups nil
348 "IMAP support a news-like mode, also known as bulletin board mode,
349 where replies is sent via IMAP instead of SMTP.
351 This variable should contain a regexp matching groups where you wish
352 replies to be stored to the mailbox directly.
355 '(\"^[^I][^N][^B][^O][^X].*$\")
357 This will match all groups not beginning with \"INBOX\".
359 Note that there is nothing technically different between mail-like and
360 news-like mailboxes. If you wish to have a group with todo items or
361 similar which you wouldn't want to set up a mailing list for, you can
362 use this to make replies go directly to the group.")
364 (defvoo nnimap-expunge-search-string "UID %s NOT SINCE %s"
365 "IMAP search command to use for articles that are to be expired.
366 The first %s is replaced by a UID set of articles to search on,
367 and the second %s is replaced by a date criterium.
369 One useful (and perhaps the only useful) value to change this to would
370 be `UID %s NOT SENTSINCE %s' to make nnimap use the Date: header
371 instead of the internal date of messages. See section 6.4.4 of RFC
372 2060 for more information on valid strings.")
374 (defvoo nnimap-importantize-dormant t
375 "If non-nil, mark \"dormant\" articles as \"ticked\" for other IMAP clients.
376 Note that within Gnus, dormant articles will still (only) be
377 marked as ticked. This is to make \"dormant\" articles stand out,
378 just like \"ticked\" articles, in other IMAP clients.")
380 (defvoo nnimap-server-address nil
381 "Obsolete. Use `nnimap-address'.")
383 (defcustom nnimap-authinfo-file "~/.authinfo"
384 "Authorization information for IMAP servers. In .netrc format."
387 (repeat :tag "Entries"
390 :value ("" ("login" . "") ("password" . ""))
394 (const :format "" "login")
395 (string :format "Login: %v"))
397 (const :format "" "password")
398 (string :format "Password: %v"))))))
401 (defcustom nnimap-prune-cache t
402 "If non-nil, nnimap check whether articles still exist on server before using data stored in NOV cache."
406 (defvar nnimap-request-list-method 'imap-mailbox-list
407 "Method to use to request a list of all folders from the server.
408 If this is 'imap-mailbox-lsub, then use a server-side subscription list to
409 restrict visible folders.")
411 (defcustom nnimap-id nil
412 "Plist with client identity to send to server upon login.
413 Nil means no information is sent, symbol `no' to disable ID query
414 alltogheter, or plist with identifier-value pairs to send to
415 server. RFC 2971 describes the list as follows:
417 Any string may be sent as a field, but the following are defined to
418 describe certain values that might be sent. Implementations are free
419 to send none, any, or all of these. Strings are not case-sensitive.
420 Field strings MUST NOT be longer than 30 octets. Value strings MUST
421 NOT be longer than 1024 octets. Implementations MUST NOT send more
422 than 30 field-value pairs.
424 name Name of the program
425 version Version number of the program
426 os Name of the operating system
427 os-version Version of the operating system
428 vendor Vendor of the client/server
429 support-url URL to contact for support
430 address Postal address of contact/vendor
431 date Date program was released, specified as a date-time
433 command Command used to start the program
434 arguments Arguments supplied on the command line, if any
436 environment Description of environment, i.e., UNIX environment
437 variables or Windows registry settings
439 Implementations MUST NOT send the same field name more than once.
441 An example plist would be '(\"name\" \"Gnus\" \"version\" gnus-version-number
442 \"os\" system-configuration \"vendor\" \"GNU\")."
444 :type '(choice (const :tag "No information" nil)
445 (const :tag "Disable ID query" no)
446 (plist :key-type string :value-type string)))
448 (defcustom nnimap-debug nil
449 "If non-nil, random debug spews are placed in *nnimap-debug* buffer."
453 ;; Internal variables:
455 (defvar nnimap-debug-buffer "*nnimap-debug*")
456 (defvar nnimap-mailbox-info (gnus-make-hashtable 997))
457 (defvar nnimap-current-move-server nil)
458 (defvar nnimap-current-move-group nil)
459 (defvar nnimap-current-move-article nil)
460 (defvar nnimap-length)
461 (defvar nnimap-progress-chars '(?| ?/ ?- ?\\))
462 (defvar nnimap-progress-how-often 20)
463 (defvar nnimap-counter)
464 (defvar nnimap-server-buffer-alist nil) ;; Map server name to buffers.
465 (defvar nnimap-current-server nil) ;; Current server
466 (defvar nnimap-server-buffer nil) ;; Current servers' buffer
470 (nnoo-define-basics nnimap)
472 ;; Utility functions:
474 (defsubst nnimap-get-server-buffer (server)
475 "Return buffer for SERVER, if nil use current server."
476 (cadr (assoc (or server nnimap-current-server) nnimap-server-buffer-alist)))
478 (defun nnimap-remove-server-from-buffer-alist (server list)
479 "Remove SERVER from LIST."
482 (unless (equal server (car-safe e))
486 (defun nnimap-possibly-change-server (server)
487 "Return buffer for SERVER, changing the current server as a side-effect.
488 If SERVER is nil, uses the current server."
489 (setq nnimap-current-server (or server nnimap-current-server)
490 nnimap-server-buffer (nnimap-get-server-buffer nnimap-current-server)))
492 (defun nnimap-verify-uidvalidity (group server)
493 "Verify stored uidvalidity match current one in GROUP on SERVER."
494 (let* ((gnusgroup (gnus-group-prefixed-name
495 group (gnus-server-to-method
496 (format "nnimap:%s" server))))
497 (new-uidvalidity (imap-mailbox-get 'uidvalidity))
498 (old-uidvalidity (gnus-group-get-parameter gnusgroup 'uidvalidity))
499 (dir (file-name-as-directory (expand-file-name nnimap-directory)))
500 (nameuid (nnheader-translate-file-chars
501 (concat nnimap-nov-file-name
502 (if (equal server "")
504 server) "." group "." old-uidvalidity
505 nnimap-nov-file-name-suffix) t))
506 (file (if (or nnmail-use-long-file-names
507 (file-exists-p (expand-file-name nameuid dir)))
508 (expand-file-name nameuid dir)
510 (mm-encode-coding-string
511 (nnheader-replace-chars-in-string nameuid ?. ?/)
512 nnmail-pathname-coding-system)
515 (if (not (equal old-uidvalidity new-uidvalidity))
517 (gnus-delete-file file)
518 (gnus-group-set-parameter gnusgroup 'uidvalidity new-uidvalidity)
520 (gnus-group-add-parameter gnusgroup (cons 'uidvalidity new-uidvalidity))
523 (defun nnimap-before-find-minmax-bugworkaround ()
524 "Function called before iterating through mailboxes with
525 `nnimap-find-minmax-uid'."
526 (when nnimap-need-unselect-to-notice-new-mail
527 ;; XXX this is for UoW imapd problem, it doesn't notice new mail in
528 ;; currently selected mailbox without a re-select/examine.
529 (or (null (imap-current-mailbox nnimap-server-buffer))
530 (imap-mailbox-unselect nnimap-server-buffer))))
532 (defun nnimap-find-minmax-uid (group &optional examine)
533 "Find lowest and highest active article number in GROUP.
534 If EXAMINE is non-nil the group is selected read-only."
535 (with-current-buffer nnimap-server-buffer
536 (when (or (string= group (imap-current-mailbox))
537 (imap-mailbox-select group examine))
539 (when (> (imap-mailbox-get 'exists) 0)
540 (imap-fetch "1,*" "UID" nil 'nouidfetch)
541 (imap-message-map (lambda (uid Uid)
542 (setq minuid (if minuid (min minuid uid) uid)
543 maxuid (if maxuid (max maxuid uid) uid)))
545 (list (imap-mailbox-get 'exists) minuid maxuid)))))
547 (defun nnimap-possibly-change-group (group &optional server)
548 "Make GROUP the current group, and SERVER the current server."
549 (when (nnimap-possibly-change-server server)
550 (with-current-buffer nnimap-server-buffer
551 (if (or (null group) (imap-current-mailbox-p group))
553 (if (imap-mailbox-select group)
554 (if (or (nnimap-verify-uidvalidity
555 group (or server nnimap-current-server))
556 (zerop (imap-mailbox-get 'exists group))
557 t ;; for OGnus to see if ignoring uidvalidity
558 ;; changes has any bad effects.
561 "nnimap: Group %s is not uidvalid. Continue? " group)))
563 (imap-mailbox-unselect)
564 (error "nnimap: Group %s is not uid-valid" group))
565 (nnheader-report 'nnimap (imap-error-text)))))))
567 (defun nnimap-replace-whitespace (string)
568 "Return STRING with all whitespace replaced with space."
570 (while (string-match "[\r\n\t]+" string)
571 (setq string (replace-match " " t t string)))
574 ;; Required backend functions
576 (defun nnimap-retrieve-headers-progress ()
577 "Hook to insert NOV line for current article into `nntp-server-buffer'."
578 (and (numberp nnmail-large-newsgroup)
579 (zerop (% (incf nnimap-counter) nnimap-progress-how-often))
580 (> nnimap-length nnmail-large-newsgroup)
581 (nnheader-message 6 "nnimap: Retrieving headers... %c"
582 (nth (/ (% nnimap-counter
583 (* (length nnimap-progress-chars)
584 nnimap-progress-how-often))
585 nnimap-progress-how-often)
586 nnimap-progress-chars)))
587 (with-current-buffer nntp-server-buffer
588 (let (headers lines chars uid mbx)
589 (with-current-buffer nnimap-server-buffer
590 (setq uid imap-current-message
591 mbx imap-current-mailbox
592 headers (nnimap-demule
593 (if (imap-capability 'IMAP4rev1)
594 ;; xxx don't just use car? alist doesn't contain
595 ;; anything else now, but it might...
596 (nth 2 (car (imap-message-get uid 'BODYDETAIL)))
597 (imap-message-get uid 'RFC822.HEADER)))
598 lines (imap-body-lines (imap-message-body imap-current-message))
599 chars (imap-message-get imap-current-message 'RFC822.SIZE)))
602 (buffer-disable-undo)
604 (let ((head (nnheader-parse-naked-head uid)))
605 (mail-header-set-number head uid)
606 (mail-header-set-chars head chars)
607 (mail-header-set-lines head lines)
608 (mail-header-set-xref
609 head (format "%s %s:%d" (system-name) mbx uid))
612 (defun nnimap-retrieve-which-headers (articles fetch-old)
613 "Get a range of articles to fetch based on ARTICLES and FETCH-OLD."
614 (with-current-buffer nnimap-server-buffer
615 (if (numberp (car-safe articles))
618 (imap-range-to-message-set
619 (gnus-compress-sequence
620 (append (gnus-uncompress-sequence
622 (cons (if (numberp fetch-old)
623 (max 1 (- (car articles) fetch-old))
625 (1- (car articles)))))
627 (mapcar (lambda (msgid)
629 (format "HEADER Message-Id \"%s\"" msgid)))
632 (defun nnimap-group-overview-filename (group server)
633 "Make file name for GROUP on SERVER."
634 (let* ((dir (file-name-as-directory (expand-file-name nnimap-directory)))
635 (uidvalidity (gnus-group-get-parameter
636 (gnus-group-prefixed-name
637 group (gnus-server-to-method
638 (format "nnimap:%s" server)))
640 (name (nnheader-translate-file-chars
641 (concat nnimap-nov-file-name
642 (if (equal server "")
644 server) "." group nnimap-nov-file-name-suffix) t))
645 (nameuid (nnheader-translate-file-chars
646 (concat nnimap-nov-file-name
647 (if (equal server "")
649 server) "." group "." uidvalidity
650 nnimap-nov-file-name-suffix) t))
651 (oldfile (if (or nnmail-use-long-file-names
652 (file-exists-p (expand-file-name name dir)))
653 (expand-file-name name dir)
655 (mm-encode-coding-string
656 (nnheader-replace-chars-in-string name ?. ?/)
657 nnmail-pathname-coding-system)
659 (newfile (if (or nnmail-use-long-file-names
660 (file-exists-p (expand-file-name nameuid dir)))
661 (expand-file-name nameuid dir)
663 (mm-encode-coding-string
664 (nnheader-replace-chars-in-string nameuid ?. ?/)
665 nnmail-pathname-coding-system)
667 (when (and (file-exists-p oldfile) (not (file-exists-p newfile)))
668 (message "nnimap: Upgrading novcache filename...")
670 (gnus-make-directory (file-name-directory newfile))
671 (unless (ignore-errors (rename-file oldfile newfile) t)
672 (if (ignore-errors (copy-file oldfile newfile) t)
673 (delete-file oldfile)
674 (error "Can't rename `%s' to `%s'" oldfile newfile))))
677 (defun nnimap-retrieve-headers-from-file (group server)
678 (with-current-buffer nntp-server-buffer
679 (let ((nov (nnimap-group-overview-filename group server)))
680 (when (file-exists-p nov)
681 (mm-insert-file-contents nov)
682 (set-buffer-modified-p nil)
683 (let ((min (ignore-errors (goto-char (point-min))
684 (read (current-buffer))))
685 (max (ignore-errors (goto-char (point-max))
687 (read (current-buffer)))))
688 (if (and (numberp min) (numberp max))
690 ;; junk, remove it, it's saved later
694 (defun nnimap-retrieve-headers-from-server (articles group server)
695 (with-current-buffer nnimap-server-buffer
696 (let ((imap-fetch-data-hook '(nnimap-retrieve-headers-progress))
697 (nnimap-length (gnus-range-length articles))
699 (imap-fetch (imap-range-to-message-set articles)
700 (concat "(UID RFC822.SIZE BODY "
702 (append '(Subject From Date Message-Id
703 References In-Reply-To Xref)
705 nnmail-extra-headers))))
706 (if (imap-capability 'IMAP4rev1)
707 (format "BODY.PEEK[HEADER.FIELDS %s])" headers)
708 (format "RFC822.HEADER.LINES %s)" headers)))))
709 (and (numberp nnmail-large-newsgroup)
710 (> nnimap-length nnmail-large-newsgroup)
711 (nnheader-message 6 "nnimap: Retrieving headers...done")))))
713 (defun nnimap-dont-use-nov-p (group server)
714 (or gnus-nov-is-evil nnimap-nov-is-evil
715 (unless (and (gnus-make-directory
717 (nnimap-group-overview-filename group server)))
719 (nnimap-group-overview-filename group server)))
720 (message "nnimap: Nov cache not writable, %s"
721 (nnimap-group-overview-filename group server)))))
723 (deffoo nnimap-retrieve-headers (articles &optional group server fetch-old)
724 (when (nnimap-possibly-change-group group server)
725 (with-current-buffer nntp-server-buffer
727 (if (nnimap-dont-use-nov-p group server)
728 (nnimap-retrieve-headers-from-server
729 (gnus-compress-sequence articles) group server)
730 (let (uids cached low high)
731 (when (setq uids (nnimap-retrieve-which-headers articles fetch-old)
733 high (car (last uids)))
734 (if (setq cached (nnimap-retrieve-headers-from-file group server))
736 ;; fetch articles with uids before cache block
737 (when (< low (car cached))
738 (goto-char (point-min))
739 (nnimap-retrieve-headers-from-server
740 (cons low (1- (car cached))) group server))
741 ;; fetch articles with uids after cache block
742 (when (> high (cdr cached))
743 (goto-char (point-max))
744 (nnimap-retrieve-headers-from-server
745 (cons (1+ (cdr cached)) high) group server))
746 (when nnimap-prune-cache
747 ;; remove nov's for articles which has expired on server
748 (goto-char (point-min))
749 (dolist (uid (gnus-set-difference articles uids))
750 (when (re-search-forward (format "^%d\t" uid) nil t)
751 (gnus-delete-line)))))
752 ;; nothing cached, fetch whole range from server
753 (nnimap-retrieve-headers-from-server
754 (cons low high) group server))
755 (when (buffer-modified-p)
757 (point-min) (point-max)
758 (nnimap-group-overview-filename group server) nil 'nomesg))
759 (nnheader-nov-delete-outside-range low high))))
762 (defun nnimap-open-connection (server)
763 (if (not (imap-open nnimap-address nnimap-server-port nnimap-stream
764 nnimap-authenticator nnimap-server-buffer))
765 (nnheader-report 'nnimap "Can't open connection to server %s" server)
766 (unless (or (imap-capability 'IMAP4 nnimap-server-buffer)
767 (imap-capability 'IMAP4rev1 nnimap-server-buffer))
768 (imap-close nnimap-server-buffer)
769 (nnheader-report 'nnimap "Server %s is not IMAP4 compliant" server))
770 (let* ((list (netrc-parse nnimap-authinfo-file))
771 (port (if nnimap-server-port
772 (int-to-string nnimap-server-port)
774 (user (netrc-machine-user-or-password
778 (or nnimap-server-address
781 (list "imap" "imaps")))
782 (passwd (netrc-machine-user-or-password
786 (or nnimap-server-address
789 (list "imap" "imaps"))))
790 (if (imap-authenticate user passwd nnimap-server-buffer)
792 (setq nnimap-server-buffer-alist
793 (nnimap-remove-server-from-buffer-alist
795 nnimap-server-buffer-alist))
796 (push (list server nnimap-server-buffer)
797 nnimap-server-buffer-alist)
798 (imap-id nnimap-id nnimap-server-buffer)
799 (nnimap-possibly-change-server server))
800 (imap-close nnimap-server-buffer)
801 (kill-buffer nnimap-server-buffer)
802 (nnheader-report 'nnimap "Could not authenticate to %s" server)))))
804 (deffoo nnimap-open-server (server &optional defs)
805 (nnheader-init-server-buffer)
806 (if (nnimap-server-opened server)
808 (unless (assq 'nnimap-server-buffer defs)
809 (push (list 'nnimap-server-buffer (concat " *nnimap* " server)) defs))
810 ;; translate `nnimap-server-address' to `nnimap-address' in defs
811 ;; for people that configured nnimap with a very old version
812 (unless (assq 'nnimap-address defs)
813 (if (assq 'nnimap-server-address defs)
814 (push (list 'nnimap-address
815 (cadr (assq 'nnimap-server-address defs))) defs)
816 (push (list 'nnimap-address server) defs)))
817 (nnoo-change-server 'nnimap server defs)
818 (or nnimap-server-buffer
819 (setq nnimap-server-buffer (cadr (assq 'nnimap-server-buffer defs))))
820 (with-current-buffer (get-buffer-create nnimap-server-buffer)
821 (nnoo-change-server 'nnimap server defs))
822 (or (and nnimap-server-buffer
823 (imap-opened nnimap-server-buffer)
824 (if (with-current-buffer nnimap-server-buffer
825 (memq imap-state '(auth select examine)))
827 (imap-close nnimap-server-buffer)
828 (nnimap-open-connection server)))
829 (nnimap-open-connection server))))
831 (deffoo nnimap-server-opened (&optional server)
832 "Whether SERVER is opened.
833 If SERVER is the current virtual server, and the connection to the
834 physical server is alive, this function return a non-nil value. If
835 SERVER is nil, it is treated as the current server."
836 ;; clean up autologouts??
837 (and (or server nnimap-current-server)
838 (nnoo-server-opened 'nnimap (or server nnimap-current-server))
839 (imap-opened (nnimap-get-server-buffer server))))
841 (deffoo nnimap-close-server (&optional server)
842 "Close connection to server and free all resources connected to it.
843 Return nil if the server couldn't be closed for some reason."
844 (let ((server (or server nnimap-current-server)))
845 (when (or (nnimap-server-opened server)
846 (imap-opened (nnimap-get-server-buffer server)))
847 (imap-close (nnimap-get-server-buffer server))
848 (kill-buffer (nnimap-get-server-buffer server))
849 (setq nnimap-server-buffer nil
850 nnimap-current-server nil
851 nnimap-server-buffer-alist
852 (nnimap-remove-server-from-buffer-alist
854 nnimap-server-buffer-alist)))
855 (nnoo-close-server 'nnimap server)))
857 (deffoo nnimap-request-close ()
858 "Close connection to all servers and free all resources that the backend have reserved.
859 All buffers that have been created by that
860 backend should be killed. (Not the nntp-server-buffer, though.) This
861 function is generally only called when Gnus is shutting down."
862 (mapc (lambda (server) (nnimap-close-server (car server)))
863 nnimap-server-buffer-alist)
864 (setq nnimap-server-buffer-alist nil))
866 (deffoo nnimap-status-message (&optional server)
867 "This function returns the last error message from server."
868 (when (nnimap-possibly-change-server server)
869 (nnoo-status-message 'nnimap server)))
871 (defun nnimap-demule (string)
872 ;; BEWARE: we used to use string-as-multibyte here which is braindead
873 ;; because it will turn accidental emacs-mule-valid byte sequences
874 ;; into multibyte chars. --Stef
875 ;; Reverted, braindead got 7.5 out of 10 on imdb, so it can't be
877 (funcall (if (and (fboundp 'string-as-multibyte)
878 (subrp (symbol-function 'string-as-multibyte)))
883 (defun nnimap-make-callback (article gnus-callback buffer)
884 "Return a callback function."
886 (nnimap-callback ,article ,gnus-callback ,buffer)))
888 (defun nnimap-callback (article gnus-callback buffer)
889 (when (eq article (imap-current-message))
890 (remove-hook 'imap-fetch-data-hook
891 (nnimap-make-callback article gnus-callback buffer))
892 (with-current-buffer buffer
894 (with-current-buffer nnimap-server-buffer
896 (if (imap-capability 'IMAP4rev1)
897 ;; xxx don't just use car? alist doesn't contain
898 ;; anything else now, but it might...
899 (nth 2 (car (imap-message-get article 'BODYDETAIL)))
900 (imap-message-get article 'RFC822)))))
901 (nnheader-ms-strip-cr)
902 (funcall gnus-callback t))))
904 (defun nnimap-request-article-part (article part prop &optional
905 group server to-buffer detail)
906 (when (nnimap-possibly-change-group group server)
907 (let ((article (if (stringp article)
908 (car-safe (imap-search
909 (format "HEADER Message-Id \"%s\"" article)
910 nnimap-server-buffer))
913 (gnus-message 10 "nnimap: Fetching (part of) article %d from %s..."
914 article (or group imap-current-mailbox
915 gnus-newsgroup-name))
916 (if (not nnheader-callback-function)
917 (with-current-buffer (or to-buffer nntp-server-buffer)
919 (let ((data (imap-fetch article part prop nil
920 nnimap-server-buffer)))
921 (insert (nnimap-demule (if detail
924 (nnheader-ms-strip-cr)
926 10 "nnimap: Fetching (part of) article %d from %s...done"
927 article (or group imap-current-mailbox gnus-newsgroup-name))
929 (nnheader-report 'nnimap "No such article %d in %s: %s"
930 article (or group imap-current-mailbox
932 (imap-error-text nnimap-server-buffer))
933 (cons group article)))
934 (add-hook 'imap-fetch-data-hook
935 (nnimap-make-callback article
936 nnheader-callback-function
938 (imap-fetch-asynch article part nil nnimap-server-buffer)
939 (cons group article))))))
941 (deffoo nnimap-asynchronous-p ()
944 (deffoo nnimap-request-article (article &optional group server to-buffer)
945 (if (imap-capability 'IMAP4rev1 nnimap-server-buffer)
946 (nnimap-request-article-part
947 article "BODY.PEEK[]" 'BODYDETAIL group server to-buffer 'detail)
948 (nnimap-request-article-part
949 article "RFC822.PEEK" 'RFC822 group server to-buffer)))
951 (deffoo nnimap-request-head (article &optional group server to-buffer)
952 (if (imap-capability 'IMAP4rev1 nnimap-server-buffer)
953 (nnimap-request-article-part
954 article "BODY.PEEK[HEADER]" 'BODYDETAIL group server to-buffer 'detail)
955 (nnimap-request-article-part
956 article "RFC822.HEADER" 'RFC822.HEADER group server to-buffer)))
958 (deffoo nnimap-request-body (article &optional group server to-buffer)
959 (if (imap-capability 'IMAP4rev1 nnimap-server-buffer)
960 (nnimap-request-article-part
961 article "BODY.PEEK[TEXT]" 'BODYDETAIL group server to-buffer 'detail)
962 (nnimap-request-article-part
963 article "RFC822.TEXT.PEEK" 'RFC822.TEXT group server to-buffer)))
965 (deffoo nnimap-request-group (group &optional server fast)
966 (nnimap-request-update-info-internal
968 (gnus-get-info (gnus-group-prefixed-name
969 group (gnus-server-to-method (format "nnimap:%s" server))))
971 (when (nnimap-possibly-change-group group server)
972 (nnimap-before-find-minmax-bugworkaround)
975 ((null (setq info (nnimap-find-minmax-uid group t)))
976 (nnheader-report 'nnimap "Could not get active info for %s"
979 (nnheader-insert "211 %d %d %d %s\n" (or (nth 0 info) 0)
980 (max 1 (or (nth 1 info) 1))
981 (or (nth 2 info) 0) group)
982 (nnheader-report 'nnimap "Group %s selected" group)
985 (defun nnimap-update-unseen (group &optional server)
986 "Update the unseen count in `nnimap-mailbox-info'."
988 (gnus-group-prefixed-name group server)
989 (let ((old (gnus-gethash-safe (gnus-group-prefixed-name group server)
990 nnimap-mailbox-info)))
991 (list (nth 0 old) (nth 1 old)
992 (imap-mailbox-status group 'unseen nnimap-server-buffer)
994 nnimap-mailbox-info))
996 (defun nnimap-close-group (group &optional server)
997 (with-current-buffer nnimap-server-buffer
998 (when (and (imap-opened)
999 (nnimap-possibly-change-group group server))
1000 (nnimap-update-unseen group server)
1001 (case nnimap-expunge-on-close
1003 (imap-mailbox-expunge nnimap-close-asynchronous)
1004 (unless nnimap-dont-close
1005 (imap-mailbox-close nnimap-close-asynchronous))))
1006 (ask (if (and (imap-search "DELETED")
1007 (gnus-y-or-n-p (format "Expunge articles in group `%s'? "
1008 imap-current-mailbox)))
1010 (imap-mailbox-expunge nnimap-close-asynchronous)
1011 (unless nnimap-dont-close
1012 (imap-mailbox-close nnimap-close-asynchronous)))
1013 (imap-mailbox-unselect)))
1014 (t (imap-mailbox-unselect)))
1015 (not imap-current-mailbox))))
1017 (defun nnimap-pattern-to-list-arguments (pattern)
1019 (cons (car-safe p) (or (cdr-safe p) p)))
1020 (if (and (listp pattern)
1021 (listp (cdr pattern)))
1025 (deffoo nnimap-request-list (&optional server)
1026 (when (nnimap-possibly-change-server server)
1027 (with-current-buffer nntp-server-buffer
1029 (gnus-message 5 "nnimap: Generating active list%s..."
1030 (if (> (length server) 0) (concat " for " server) ""))
1031 (nnimap-before-find-minmax-bugworkaround)
1032 (with-current-buffer nnimap-server-buffer
1033 (dolist (pattern (nnimap-pattern-to-list-arguments nnimap-list-pattern))
1034 (dolist (mbx (funcall nnimap-request-list-method
1035 (cdr pattern) (car pattern)))
1036 (or (member "\\NoSelect" (imap-mailbox-get 'list-flags mbx))
1037 (let ((info (nnimap-find-minmax-uid mbx 'examine)))
1039 (with-current-buffer nntp-server-buffer
1040 (insert (format "\"%s\" %d %d y\n"
1041 mbx (or (nth 2 info) 0)
1042 (max 1 (or (nth 1 info) 1)))))))))))
1043 (gnus-message 5 "nnimap: Generating active list%s...done"
1044 (if (> (length server) 0) (concat " for " server) ""))
1047 (deffoo nnimap-request-post (&optional server)
1049 (dolist (mbx (message-unquote-tokens
1050 (message-tokenize-header
1051 (message-fetch-field "Newsgroups") ", ")) success)
1052 (let ((to-newsgroup (gnus-group-prefixed-name mbx gnus-command-method)))
1053 (or (gnus-active to-newsgroup)
1054 (gnus-activate-group to-newsgroup)
1055 (if (gnus-y-or-n-p (format "No such group: %s. Create it? "
1057 (or (and (gnus-request-create-group
1058 to-newsgroup gnus-command-method)
1059 (gnus-activate-group to-newsgroup nil nil
1060 gnus-command-method))
1061 (error "Couldn't create group %s" to-newsgroup)))
1062 (error "No such group: %s" to-newsgroup))
1063 (unless (nnimap-request-accept-article mbx (nth 1 gnus-command-method))
1064 (setq success nil))))))
1066 ;; Optional backend functions
1068 (defun nnimap-string-lessp-numerical (s1 s2)
1069 "Return t if first arg string is less than second in numerical order."
1070 (cond ((string= s1 s2)
1072 ((> (length s1) (length s2))
1074 ((< (length s1) (length s2))
1076 ((< (string-to-number (substring s1 0 1))
1077 (string-to-number (substring s2 0 1)))
1079 ((> (string-to-number (substring s1 0 1))
1080 (string-to-number (substring s2 0 1)))
1083 (nnimap-string-lessp-numerical (substring s1 1) (substring s2 1)))))
1085 (deffoo nnimap-retrieve-groups (groups &optional server)
1086 (when (nnimap-possibly-change-server server)
1087 (gnus-message 5 "nnimap: Checking mailboxes...")
1088 (with-current-buffer nntp-server-buffer
1090 (nnimap-before-find-minmax-bugworkaround)
1091 (let (asyncgroups slowgroups)
1092 (if (null nnimap-retrieve-groups-asynchronous)
1093 (setq slowgroups groups)
1094 (dolist (group groups)
1095 (gnus-message 9 "nnimap: Quickly checking mailbox %s" group)
1096 (add-to-list (if (gnus-gethash-safe
1097 (gnus-group-prefixed-name group server)
1098 nnimap-mailbox-info)
1101 (list group (imap-mailbox-status-asynch
1102 group '(uidvalidity uidnext unseen)
1103 nnimap-server-buffer))))
1104 (dolist (asyncgroup asyncgroups)
1105 (let ((group (nth 0 asyncgroup))
1106 (tag (nth 1 asyncgroup))
1108 (when (imap-ok-p (imap-wait-for-tag tag nnimap-server-buffer))
1109 (if (or (not (string=
1110 (nth 0 (gnus-gethash (gnus-group-prefixed-name
1112 nnimap-mailbox-info))
1113 (imap-mailbox-get 'uidvalidity group
1114 nnimap-server-buffer)))
1116 (nth 1 (gnus-gethash (gnus-group-prefixed-name
1118 nnimap-mailbox-info))
1119 (imap-mailbox-get 'uidnext group
1120 nnimap-server-buffer))))
1121 (push (list group) slowgroups)
1122 (insert (nth 3 (gnus-gethash (gnus-group-prefixed-name
1124 nnimap-mailbox-info))))))))
1125 (dolist (group slowgroups)
1126 (if nnimap-retrieve-groups-asynchronous
1127 (setq group (car group)))
1128 (gnus-message 7 "nnimap: Mailbox %s modified" group)
1129 (imap-mailbox-put 'uidnext nil group nnimap-server-buffer)
1130 (or (member "\\NoSelect" (imap-mailbox-get 'list-flags group
1131 nnimap-server-buffer))
1132 (let* ((info (nnimap-find-minmax-uid group 'examine))
1133 (str (format "\"%s\" %d %d y\n" group
1135 (max 1 (or (nth 1 info) 1)))))
1136 (when (> (or (imap-mailbox-get 'recent group
1137 nnimap-server-buffer) 0)
1139 (push (list (cons group 0)) nnmail-split-history))
1141 (when nnimap-retrieve-groups-asynchronous
1143 (gnus-group-prefixed-name group server)
1144 (list (or (imap-mailbox-get
1145 'uidvalidity group nnimap-server-buffer)
1146 (imap-mailbox-status
1147 group 'uidvalidity nnimap-server-buffer))
1148 (or (imap-mailbox-get
1149 'uidnext group nnimap-server-buffer)
1150 (imap-mailbox-status
1151 group 'uidnext nnimap-server-buffer))
1152 (or (imap-mailbox-get
1153 'unseen group nnimap-server-buffer)
1154 (imap-mailbox-status
1155 group 'unseen nnimap-server-buffer))
1157 nnimap-mailbox-info)))))))
1158 (gnus-message 5 "nnimap: Checking mailboxes...done")
1161 (deffoo nnimap-request-update-info-internal (group info &optional server)
1162 (when (nnimap-possibly-change-group group server)
1163 (when info ;; xxx what does this mean? should we create a info?
1164 (with-current-buffer nnimap-server-buffer
1165 (gnus-message 5 "nnimap: Updating info for %s..."
1166 (gnus-info-group info))
1168 (when (nnimap-mark-permanent-p 'read)
1170 ;; read info could contain articles marked unread by other
1171 ;; imap clients! we correct this
1172 (setq seen (gnus-uncompress-range (gnus-info-read info))
1173 unseen (imap-search "UNSEEN UNDELETED")
1174 seen (gnus-set-difference seen unseen)
1175 ;; seen might lack articles marked as read by other
1176 ;; imap clients! we correct this
1177 seen (append seen (imap-search "SEEN"))
1180 seen (gnus-compress-sequence seen t)
1181 ;; we can't return '(1) since this isn't a "list of ranges",
1182 ;; and we can't return '((1)) since g-list-of-unread-articles
1183 ;; is buggy so we return '((1 . 1)).
1184 seen (if (and (integerp (car seen))
1186 (list (cons (car seen) (car seen)))
1188 (gnus-info-set-read info seen)))
1190 (mapcar (lambda (pred)
1191 (when (or (eq (cdr pred) 'recent)
1192 (and (nnimap-mark-permanent-p (cdr pred))
1193 (member (nnimap-mark-to-flag (cdr pred))
1194 (imap-mailbox-get 'flags))))
1195 (gnus-info-set-marks
1197 (gnus-update-alist-soft
1199 (gnus-compress-sequence
1200 (imap-search (nnimap-mark-to-predicate (cdr pred))))
1201 (gnus-info-marks info))
1203 gnus-article-mark-lists)
1205 (when nnimap-importantize-dormant
1206 ;; nnimap mark dormant article as ticked too (for other clients)
1207 ;; so we remove that mark for gnus since we support dormant
1208 (gnus-info-set-marks
1210 (gnus-update-alist-soft
1212 (gnus-remove-from-range
1213 (cdr-safe (assoc 'tick (gnus-info-marks info)))
1214 (cdr-safe (assoc 'dormant (gnus-info-marks info))))
1215 (gnus-info-marks info))
1218 (gnus-message 5 "nnimap: Updating info for %s...done"
1219 (gnus-info-group info))
1223 (deffoo nnimap-request-type (group &optional article)
1224 (if (and nnimap-news-groups (string-match nnimap-news-groups group))
1228 (deffoo nnimap-request-set-mark (group actions &optional server)
1229 (when (nnimap-possibly-change-group group server)
1230 (with-current-buffer nnimap-server-buffer
1232 (gnus-message 7 "nnimap: Setting marks in %s..." group)
1233 (while (setq action (pop actions))
1234 (let ((range (nth 0 action))
1235 (what (nth 1 action))
1236 (cmdmarks (nth 2 action))
1238 ;; bookmark can't be stored (not list/range
1239 (setq cmdmarks (delq 'bookmark cmdmarks))
1240 ;; killed can't be stored (not list/range
1241 (setq cmdmarks (delq 'killed cmdmarks))
1242 ;; unsent are for nndraft groups only
1243 (setq cmdmarks (delq 'unsent cmdmarks))
1244 ;; cache flags are pointless on the server
1245 (setq cmdmarks (delq 'cache cmdmarks))
1246 ;; seen flags are local to each gnus
1247 (setq cmdmarks (delq 'seen cmdmarks))
1248 ;; recent marks can't be set
1249 (setq cmdmarks (delq 'recent cmdmarks))
1250 (when nnimap-importantize-dormant
1251 ;; flag dormant articles as ticked
1252 (if (memq 'dormant cmdmarks)
1253 (setq cmdmarks (cons 'tick cmdmarks))))
1254 ;; remove stuff we are forbidden to store
1255 (mapc (lambda (mark)
1256 (if (imap-message-flag-permanent-p
1257 (nnimap-mark-to-flag mark))
1258 (setq marks (cons mark marks))))
1260 (when (and range marks)
1261 (cond ((eq what 'del)
1262 (imap-message-flags-del
1263 (imap-range-to-message-set range)
1264 (nnimap-mark-to-flag marks nil t)))
1266 (imap-message-flags-add
1267 (imap-range-to-message-set range)
1268 (nnimap-mark-to-flag marks nil t)))
1270 (imap-message-flags-set
1271 (imap-range-to-message-set range)
1272 (nnimap-mark-to-flag marks nil t)))))))
1273 (gnus-message 7 "nnimap: Setting marks in %s...done" group))))
1276 (defun nnimap-split-fancy ()
1277 "Like the function `nnmail-split-fancy', but uses `nnimap-split-fancy'."
1278 (let ((nnmail-split-fancy nnimap-split-fancy))
1279 (nnmail-split-fancy)))
1281 (defun nnimap-split-to-groups (rules)
1282 ;; tries to match all rules in nnimap-split-rule against content of
1283 ;; nntp-server-buffer, returns a list of groups that matched.
1284 (with-current-buffer nntp-server-buffer
1285 ;; Fold continuation lines.
1286 (goto-char (point-min))
1287 (while (re-search-forward "\\(\r?\n[ \t]+\\)+" nil t)
1288 (replace-match " " t t))
1289 (if (functionp rules)
1291 (let (to-groups regrepp)
1293 (dolist (rule rules to-groups)
1294 (let ((group (car rule))
1295 (regexp (cadr rule)))
1296 (goto-char (point-min))
1297 (when (and (if (stringp regexp)
1299 (if (not (stringp group))
1300 (setq group (eval group))
1302 (string-match "\\\\[0-9&]" group)))
1303 (re-search-forward regexp nil t))
1304 (funcall regexp group))
1305 ;; Don't enter the article into the same group twice.
1306 (not (assoc group to-groups)))
1308 (nnmail-expand-newtext group)
1311 (or nnimap-split-crosspost
1312 (throw 'split-done to-groups))))))))))
1314 (defun nnimap-assoc-match (key alist)
1316 (while (and alist (not element))
1317 (if (string-match (car (car alist)) key)
1318 (setq element (car alist)))
1319 (setq alist (cdr alist)))
1322 (defun nnimap-split-find-rule (server inbox)
1323 (if (and (listp nnimap-split-rule) (listp (car nnimap-split-rule))
1324 (list (cdar nnimap-split-rule)) (listp (cadar nnimap-split-rule)))
1326 (cadr (nnimap-assoc-match inbox (cdr (nnimap-assoc-match
1327 server nnimap-split-rule))))
1330 (defun nnimap-split-find-inbox (server)
1331 (if (listp nnimap-split-inbox)
1333 (list nnimap-split-inbox)))
1335 (defun nnimap-split-articles (&optional group server)
1336 (when (nnimap-possibly-change-server server)
1337 (with-current-buffer nnimap-server-buffer
1338 (let (rule inbox removeorig (inboxes (nnimap-split-find-inbox server)))
1339 ;; iterate over inboxes
1340 (while (and (setq inbox (pop inboxes))
1341 (nnimap-possibly-change-group inbox)) ;; SELECT
1342 ;; find split rule for this server / inbox
1343 (when (setq rule (nnimap-split-find-rule server inbox))
1344 ;; iterate over articles
1345 (dolist (article (imap-search nnimap-split-predicate))
1346 (when (if (if (eq nnimap-split-download-body 'default)
1347 nnimap-split-download-body-default
1348 nnimap-split-download-body)
1349 (and (nnimap-request-article article)
1350 (with-current-buffer nntp-server-buffer (mail-narrow-to-head)))
1351 (nnimap-request-head article))
1352 ;; copy article to right group(s)
1353 (setq removeorig nil)
1354 (dolist (to-group (nnimap-split-to-groups rule))
1355 (cond ((eq to-group 'junk)
1356 (message "IMAP split removed %s:%s:%d" server inbox
1358 (setq removeorig t))
1359 ((imap-message-copy (number-to-string article)
1360 to-group nil 'nocopyuid)
1361 (message "IMAP split moved %s:%s:%d to %s" server
1362 inbox article to-group)
1364 (when nnmail-cache-accepted-message-ids
1365 (with-current-buffer nntp-server-buffer
1368 (nnmail-fetch-field "message-id"))
1369 (nnmail-cache-insert msgid
1371 (nnmail-fetch-field "subject"))))))
1372 ;; Add the group-art list to the history list.
1373 (push (list (cons to-group 0)) nnmail-split-history))
1375 (message "IMAP split failed to move %s:%s:%d to %s"
1376 server inbox article to-group))))
1377 (if (if (eq nnimap-split-download-body 'default)
1378 nnimap-split-download-body-default
1379 nnimap-split-download-body)
1381 ;; remove article if it was successfully copied somewhere
1383 (imap-message-flags-add (format "%d" article)
1384 "\\Seen \\Deleted")))))
1385 (when (imap-mailbox-select inbox) ;; just in case
1386 ;; todo: UID EXPUNGE (if available) to remove splitted articles
1387 (imap-mailbox-expunge)
1388 (imap-mailbox-close)))
1389 (when nnmail-cache-accepted-message-ids
1390 (nnmail-cache-close))
1393 (deffoo nnimap-request-scan (&optional group server)
1394 (nnimap-split-articles group server))
1396 (deffoo nnimap-request-newgroups (date &optional server)
1397 (when (nnimap-possibly-change-server server)
1398 (with-current-buffer nntp-server-buffer
1399 (gnus-message 5 "nnimap: Listing subscribed mailboxes%s%s..."
1400 (if (> (length server) 0) " on " "") server)
1402 (nnimap-before-find-minmax-bugworkaround)
1403 (dolist (pattern (nnimap-pattern-to-list-arguments
1404 nnimap-list-pattern))
1405 (dolist (mbx (imap-mailbox-lsub (cdr pattern) (car pattern) nil
1406 nnimap-server-buffer))
1408 (dolist (mailbox (imap-mailbox-get 'list-flags mbx
1409 nnimap-server-buffer))
1410 (if (string= (downcase mailbox) "\\noselect")
1413 (let ((info (nnimap-find-minmax-uid mbx 'examine)))
1415 (insert (format "\"%s\" %d %d y\n"
1416 mbx (or (nth 2 info) 0)
1417 (max 1 (or (nth 1 info) 1)))))))))
1418 (gnus-message 5 "nnimap: Listing subscribed mailboxes%s%s...done"
1419 (if (> (length server) 0) " on " "") server))
1422 (deffoo nnimap-request-create-group (group &optional server args)
1423 (when (nnimap-possibly-change-server server)
1424 (or (imap-mailbox-status group 'uidvalidity nnimap-server-buffer)
1425 (imap-mailbox-create group nnimap-server-buffer)
1426 (nnheader-report 'nnimap "%S"
1427 (imap-error-text nnimap-server-buffer)))))
1429 (defun nnimap-time-substract (time1 time2)
1430 "Return TIME for TIME1 - TIME2."
1431 (let* ((ms (- (car time1) (car time2)))
1432 (ls (- (nth 1 time1) (nth 1 time2))))
1434 (list (- ms 1) (+ (expt 2 16) ls))
1437 (defun nnimap-date-days-ago (daysago)
1438 "Return date, in format \"3-Aug-1998\", for DAYSAGO days ago."
1439 (let* ((time (nnimap-time-substract (current-time) (days-to-time daysago)))
1440 (date (format-time-string
1441 (format "%%d-%s-%%Y"
1442 (capitalize (car (rassoc (nth 4 (decode-time time))
1443 parse-time-months))))
1445 (if (eq ?0 (string-to-char date))
1449 (defun nnimap-request-expire-articles-progress ()
1450 (gnus-message 5 "nnimap: Marking article %d for deletion..."
1451 imap-current-message))
1453 (defun nnimap-expiry-target (arts group server)
1454 (unless (eq nnmail-expiry-target 'delete)
1457 (nnimap-request-article art group server (current-buffer))
1458 ;; hints for optimization in `nnimap-request-accept-article'
1459 (let ((nnimap-current-move-article art)
1460 (nnimap-current-move-group group)
1461 (nnimap-current-move-server server))
1462 (nnmail-expiry-target-group nnmail-expiry-target group))))
1463 ;; It is not clear if `nnmail-expiry-target' somehow cause the
1464 ;; current group to be changed or not, so we make sure here.
1465 (nnimap-possibly-change-group group server)))
1467 ;; Notice that we don't actually delete anything, we just mark them deleted.
1468 (deffoo nnimap-request-expire-articles (articles group &optional server force)
1469 (let ((artseq (gnus-compress-sequence articles)))
1470 (when (and artseq (nnimap-possibly-change-group group server))
1471 (with-current-buffer nnimap-server-buffer
1472 (let ((days (or (and nnmail-expiry-wait-function
1473 (funcall nnmail-expiry-wait-function group))
1474 nnmail-expiry-wait)))
1475 (cond ((or force (eq days 'immediate))
1476 (let ((oldarts (imap-search
1478 (imap-range-to-message-set artseq)))))
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))))))
1487 (let ((oldarts (imap-search
1488 (format nnimap-expunge-search-string
1489 (imap-range-to-message-set artseq)
1490 (nnimap-date-days-ago days))))
1491 (imap-fetch-data-hook
1492 '(nnimap-request-expire-articles-progress)))
1494 (nnimap-expiry-target oldarts group server)
1495 (when (imap-message-flags-add
1496 (imap-range-to-message-set
1497 (gnus-compress-sequence oldarts)) "\\Deleted")
1498 (setq articles (gnus-set-difference
1499 articles oldarts)))))))))))
1500 ;; return articles not deleted
1503 (deffoo nnimap-request-move-article (article group server
1504 accept-form &optional last)
1505 (when (nnimap-possibly-change-server server)
1507 (let ((buf (get-buffer-create " *nnimap move*"))
1508 (nnimap-current-move-article article)
1509 (nnimap-current-move-group group)
1510 (nnimap-current-move-server nnimap-current-server)
1512 (and (nnimap-request-article article group server)
1515 (buffer-disable-undo (current-buffer))
1516 (insert-buffer-substring nntp-server-buffer)
1517 (setq result (eval accept-form))
1520 (imap-message-flags-add
1521 (imap-range-to-message-set (list article))
1522 "\\Deleted" 'silent nnimap-server-buffer))
1525 (deffoo nnimap-request-accept-article (group &optional server last)
1526 (when (nnimap-possibly-change-server server)
1529 (if (string= nnimap-current-server nnimap-current-move-server)
1530 ;; moving article within same server, speed it up...
1531 (and (nnimap-possibly-change-group
1532 nnimap-current-move-group)
1533 (imap-message-copy (number-to-string
1534 nnimap-current-move-article)
1535 group 'dontcreate nil
1536 nnimap-server-buffer))
1537 (with-current-buffer (current-buffer)
1538 (goto-char (point-min))
1539 ;; remove any 'From blabla' lines, some IMAP servers
1540 ;; reject the entire message otherwise.
1541 (when (looking-at "^From[^:]")
1542 (delete-region (point) (progn (forward-line) (point))))
1543 ;; turn into rfc822 format (\r\n eol's)
1544 (while (search-forward "\n" nil t)
1545 (replace-match "\r\n"))
1546 (when nnmail-cache-accepted-message-ids
1547 (nnmail-cache-insert (nnmail-fetch-field "message-id")
1549 (nnmail-fetch-field "subject"))))
1550 (when (and last nnmail-cache-accepted-message-ids)
1551 (nnmail-cache-close))
1552 ;; this 'or' is for Cyrus server bug
1553 (or (null (imap-current-mailbox nnimap-server-buffer))
1554 (imap-mailbox-unselect nnimap-server-buffer))
1555 (imap-message-append group (current-buffer) nil nil
1556 nnimap-server-buffer)))
1557 (cons group (nth 1 uid))
1558 (nnheader-report 'nnimap (imap-error-text nnimap-server-buffer))))))
1560 (deffoo nnimap-request-delete-group (group force &optional server)
1561 (when (nnimap-possibly-change-server server)
1562 (with-current-buffer nnimap-server-buffer
1564 (or (null (imap-mailbox-status group 'uidvalidity))
1565 (imap-mailbox-delete group))
1569 (deffoo nnimap-request-rename-group (group new-name &optional server)
1570 (when (nnimap-possibly-change-server server)
1571 (imap-mailbox-rename group new-name nnimap-server-buffer)))
1573 (defun nnimap-expunge (mailbox server)
1574 (when (nnimap-possibly-change-group mailbox server)
1575 (imap-mailbox-expunge nil nnimap-server-buffer)))
1577 (defun nnimap-acl-get (mailbox server)
1578 (when (nnimap-possibly-change-server server)
1579 (and (imap-capability 'ACL nnimap-server-buffer)
1580 (imap-mailbox-acl-get mailbox nnimap-server-buffer))))
1582 (defun nnimap-acl-edit (mailbox method old-acls new-acls)
1583 (when (nnimap-possibly-change-server (cadr method))
1584 (unless (imap-capability 'ACL nnimap-server-buffer)
1585 (error "Your server does not support ACL editing"))
1586 (with-current-buffer nnimap-server-buffer
1587 ;; delete all removed identifiers
1588 (mapc (lambda (old-acl)
1589 (unless (assoc (car old-acl) new-acls)
1590 (or (imap-mailbox-acl-delete (car old-acl) mailbox)
1591 (error "Can't delete ACL for %s" (car old-acl)))))
1593 ;; set all changed acl's
1594 (mapc (lambda (new-acl)
1595 (let ((new-rights (cdr new-acl))
1596 (old-rights (cdr (assoc (car new-acl) old-acls))))
1597 (unless (and old-rights new-rights
1598 (string= old-rights new-rights))
1599 (or (imap-mailbox-acl-set (car new-acl) new-rights mailbox)
1600 (error "Can't set ACL for %s to %s" (car new-acl)
1606 ;;; Internal functions
1609 ;; This is confusing.
1611 ;; mark => read, tick, draft, reply etc
1612 ;; flag => "\\Seen", "\\Flagged", "\\Draft", "gnus-expire" etc
1613 ;; predicate => "SEEN", "FLAGGED", "DRAFT", "KEYWORD gnus-expire" etc
1615 ;; Mark should not really contain 'read since it's not a "mark" in the Gnus
1616 ;; world, but we cheat. Mark == gnus-article-mark-lists + '(read . read).
1619 (defconst nnimap-mark-to-predicate-alist
1621 (lambda (pair) ; cdr is the mark
1622 (or (assoc (cdr pair)
1627 (reply . "ANSWERED")))
1629 (format "KEYWORD gnus-%s" (symbol-name (cdr pair))))))
1630 (cons '(read . read) gnus-article-mark-lists)))
1632 (defun nnimap-mark-to-predicate (pred)
1633 "Convert a Gnus mark (a symbol such as read, tick, expire) to a IMAP predicate.
1634 This is a string such as \"SEEN\", \"FLAGGED\", \"KEYWORD gnus-expire\",
1635 to be used within a IMAP SEARCH query."
1636 (cdr (assq pred nnimap-mark-to-predicate-alist)))
1638 (defconst nnimap-mark-to-flag-alist
1641 (or (assoc (cdr pair)
1643 (tick . "\\Flagged")
1645 (recent . "\\Recent")
1646 (reply . "\\Answered")))
1648 (format "gnus-%s" (symbol-name (cdr pair))))))
1649 (cons '(read . read) gnus-article-mark-lists)))
1651 (defun nnimap-mark-to-flag-1 (preds)
1652 (if (and (not (null preds)) (listp preds))
1653 (cons (nnimap-mark-to-flag (car preds))
1654 (nnimap-mark-to-flag (cdr preds)))
1655 (cdr (assoc preds nnimap-mark-to-flag-alist))))
1657 (defun nnimap-mark-to-flag (preds &optional always-list make-string)
1658 "Convert a Gnus mark (a symbol such as read, tick, expire) to a IMAP flag.
1659 This is a string such as \"\\Seen\", \"\\Flagged\", \"gnus-expire\", to
1660 be used in a STORE FLAGS command."
1661 (let ((result (nnimap-mark-to-flag-1 preds)))
1662 (setq result (if (and (or make-string always-list)
1663 (not (listp result)))
1667 (mapconcat (lambda (flag)
1669 (mapconcat 'identity flag " ")
1674 (defun nnimap-mark-permanent-p (mark &optional group)
1675 "Return t iff MARK can be permanently (between IMAP sessions) saved on articles, in GROUP."
1676 (imap-message-flag-permanent-p (nnimap-mark-to-flag mark)))
1680 (buffer-disable-undo (get-buffer-create nnimap-debug-buffer))
1681 (mapcar (lambda (f) (trace-function-background f nnimap-debug-buffer))
1683 nnimap-possibly-change-server
1684 nnimap-verify-uidvalidity
1685 nnimap-find-minmax-uid
1686 nnimap-before-find-minmax-bugworkaround
1687 nnimap-possibly-change-group
1688 ;;nnimap-replace-whitespace
1689 nnimap-retrieve-headers-progress
1690 nnimap-retrieve-which-headers
1691 nnimap-group-overview-filename
1692 nnimap-retrieve-headers-from-file
1693 nnimap-retrieve-headers-from-server
1694 nnimap-retrieve-headers
1695 nnimap-open-connection
1697 nnimap-server-opened
1699 nnimap-request-close
1700 nnimap-status-message
1702 nnimap-request-article-part
1703 nnimap-request-article
1706 nnimap-request-group
1708 nnimap-pattern-to-list-arguments
1711 nnimap-retrieve-groups
1712 nnimap-request-update-info-internal
1714 nnimap-request-set-mark
1715 nnimap-split-to-groups
1716 nnimap-split-find-rule
1717 nnimap-split-find-inbox
1718 nnimap-split-articles
1720 nnimap-request-newgroups
1721 nnimap-request-create-group
1722 nnimap-time-substract
1723 nnimap-date-days-ago
1724 nnimap-request-expire-articles-progress
1725 nnimap-request-expire-articles
1726 nnimap-request-move-article
1727 nnimap-request-accept-article
1728 nnimap-request-delete-group
1729 nnimap-request-rename-group
1730 gnus-group-nnimap-expunge
1731 gnus-group-nnimap-edit-acl
1732 gnus-group-nnimap-edit-acl-done
1733 nnimap-group-mode-hook
1734 nnimap-mark-to-predicate
1735 nnimap-mark-to-flag-1
1737 nnimap-mark-permanent-p
1742 ;; arch-tag: 2b001f20-3ff9-4094-a0ad-46807c1ba70b
1743 ;;; nnimap.el ends here