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
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 cought 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."
229 (defcustom nnimap-dont-close t
230 "Never close mailboxes.
231 This increases the speed of closing mailboxes (quiting group) but may
232 decrease the speed of selecting another mailbox later. Re-selecting
233 the same mailbox will be faster though."
237 (defcustom nnimap-retrieve-groups-asynchronous t
238 "Send asynchronous STATUS commands for each mailbox before checking mail.
239 If you have mailboxes that rarely receives mail, this speeds up new
240 mail checking. It works by first sending STATUS commands for each
241 mailbox, and then only checking groups which has a modified UIDNEXT
242 more carefully for new mail.
244 In summary, the default is O((1-p)*k+p*n) and changing it to nil makes
245 it O(n). If p is small, then the default is probably faster."
249 (defvoo nnimap-need-unselect-to-notice-new-mail nil
250 "Unselect mailboxes before looking for new mail in them.
251 Some servers seem to need this under some circumstances.")
253 ;; Authorization / Privacy variables
255 (defvoo nnimap-auth-method nil
258 (defvoo nnimap-stream nil
259 "How nnimap will connect to the server.
261 The default, nil, will try to use the \"best\" method the server can
266 1) you want to connect with TLS/SSL. The TLS/SSL integration
267 with IMAP is suboptimal so you'll have to tell it
270 2) your server is more capable than your environment -- i.e. your
271 server accept Kerberos login's but you haven't installed the
272 `imtest' program or your machine isn't configured for Kerberos.
274 Possible choices: gssapi, kerberos4, starttls, tls, ssl, network, shell.
275 See also `imap-streams' and `imap-stream-alist'.")
277 (defvoo nnimap-authenticator nil
278 "How nnimap authenticate itself to the server.
280 The default, nil, will try to use the \"best\" method the server can
283 There is only one reason for fiddling with this variable, and that is
284 if your server is more capable than your environment -- i.e. you
285 connect to a server that accept Kerberos login's but you haven't
286 installed the `imtest' program or your machine isn't configured for
289 Possible choices: gssapi, kerberos4, digest-md5, cram-md5, login, anonymous.
290 See also `imap-authenticators' and `imap-authenticator-alist'")
292 (defvoo nnimap-directory (nnheader-concat gnus-directory "overview/")
293 "Directory to keep NOV cache files for nnimap groups.
294 See also `nnimap-nov-file-name'.")
296 (defvoo nnimap-nov-file-name "nnimap."
297 "NOV cache base filename.
298 The group name and `nnimap-nov-file-name-suffix' will be appended. A
299 typical complete file name would be
300 ~/News/overview/nnimap.pdc.INBOX.ding.nov, or
301 ~/News/overview/nnimap/pdc/INBOX/ding/nov if
302 `nnmail-use-long-file-names' is nil")
304 (defvoo nnimap-nov-file-name-suffix ".novcache"
305 "Suffix for NOV cache base filename.")
307 (defvoo nnimap-nov-is-evil gnus-agent
308 "If non-nil, never generate or use a local nov database for this backend.
309 Using nov databases should speed up header fetching considerably.
310 However, it will invoke a UID SEARCH UID command on the server, and
311 some servers implement this command inefficiently by opening each and
312 every message in the group, thus making it quite slow.
313 Unlike other backends, you do not need to take special care if you
314 flip this variable.")
316 (defvoo nnimap-expunge-on-close 'always ; 'ask, 'never
317 "Whether to expunge a group when it is closed.
318 When a IMAP group with articles marked for deletion is closed, this
319 variable determine if nnimap should actually remove the articles or
322 If always, nnimap always perform a expunge when closing the group.
323 If never, nnimap never expunges articles marked for deletion.
324 If ask, nnimap will ask you if you wish to expunge marked articles.
326 When setting this variable to `never', you can only expunge articles
327 by using `G x' (gnus-group-nnimap-expunge) from the Group buffer.")
329 (defvoo nnimap-list-pattern "*"
330 "A string LIMIT or list of strings with mailbox wildcards used to limit available groups.
331 See below for available wildcards.
333 The LIMIT string can be a cons cell (REFERENCE . LIMIT), where
334 REFERENCE will be passed as the first parameter to LIST/LSUB. The
335 semantics of this are server specific, on the University of Washington
336 server you can specify a directory.
339 '(\"INBOX\" \"mail/*\" (\"~friend/mail/\" . \"list/*\"))
341 There are two wildcards * and %. * matches everything, % matches
342 everything in the current hierarchy.")
344 (defvoo nnimap-news-groups nil
345 "IMAP support a news-like mode, also known as bulletin board mode,
346 where replies is sent via IMAP instead of SMTP.
348 This variable should contain a regexp matching groups where you wish
349 replies to be stored to the mailbox directly.
352 '(\"^[^I][^N][^B][^O][^X].*$\")
354 This will match all groups not beginning with \"INBOX\".
356 Note that there is nothing technically different between mail-like and
357 news-like mailboxes. If you wish to have a group with todo items or
358 similar which you wouldn't want to set up a mailing list for, you can
359 use this to make replies go directly to the group.")
361 (defvoo nnimap-expunge-search-string "UID %s NOT SINCE %s"
362 "IMAP search command to use for articles that are to be expired.
363 The first %s is replaced by a UID set of articles to search on,
364 and the second %s is replaced by a date criterium.
366 One useful (and perhaps the only useful) value to change this to would
367 be `UID %s NOT SENTSINCE %s' to make nnimap use the Date: header
368 instead of the internal date of messages. See section 6.4.4 of RFC
369 2060 for more information on valid strings.")
371 (defvoo nnimap-importantize-dormant t
372 "If non-nil, mark \"dormant\" articles as \"ticked\" for other IMAP clients.
373 Note that within Gnus, dormant articles will still (only) be
374 marked as ticked. This is to make \"dormant\" articles stand out,
375 just like \"ticked\" articles, in other IMAP clients.")
377 (defvoo nnimap-server-address nil
378 "Obsolete. Use `nnimap-address'.")
380 (defcustom nnimap-authinfo-file "~/.authinfo"
381 "Authorization information for IMAP servers. In .netrc format."
384 (repeat :tag "Entries"
387 :value ("" ("login" . "") ("password" . ""))
391 (const :format "" "login")
392 (string :format "Login: %v"))
394 (const :format "" "password")
395 (string :format "Password: %v"))))))
398 (defcustom nnimap-prune-cache t
399 "If non-nil, nnimap check whether articles still exist on server before using data stored in NOV cache."
403 (defvar nnimap-request-list-method 'imap-mailbox-list
404 "Method to use to request a list of all folders from the server.
405 If this is 'imap-mailbox-lsub, then use a server-side subscription list to
406 restrict visible folders.")
408 (defcustom nnimap-id nil
409 "Plist with client identity to send to server upon login.
410 Nil means no information is sent, symbol `no' to disable ID query
411 alltogheter, or plist with identifier-value pairs to send to
412 server. RFC 2971 describes the list as follows:
414 Any string may be sent as a field, but the following are defined to
415 describe certain values that might be sent. Implementations are free
416 to send none, any, or all of these. Strings are not case-sensitive.
417 Field strings MUST NOT be longer than 30 octets. Value strings MUST
418 NOT be longer than 1024 octets. Implementations MUST NOT send more
419 than 30 field-value pairs.
421 name Name of the program
422 version Version number of the program
423 os Name of the operating system
424 os-version Version of the operating system
425 vendor Vendor of the client/server
426 support-url URL to contact for support
427 address Postal address of contact/vendor
428 date Date program was released, specified as a date-time
430 command Command used to start the program
431 arguments Arguments supplied on the command line, if any
433 environment Description of environment, i.e., UNIX environment
434 variables or Windows registry settings
436 Implementations MUST NOT send the same field name more than once.
438 An example plist would be '(\"name\" \"Gnus\" \"version\" gnus-version-number
439 \"os\" system-configuration \"vendor\" \"GNU\")."
441 :type '(choice (const :tag "No information" nil)
442 (const :tag "Disable ID query" no)
443 (plist :key-type string :value-type string)))
445 (defcustom nnimap-debug nil
446 "If non-nil, random debug spews are placed in *nnimap-debug* buffer."
450 ;; Internal variables:
452 (defvar nnimap-debug-buffer "*nnimap-debug*")
453 (defvar nnimap-mailbox-info (gnus-make-hashtable 997))
454 (defvar nnimap-current-move-server nil)
455 (defvar nnimap-current-move-group nil)
456 (defvar nnimap-current-move-article nil)
457 (defvar nnimap-length)
458 (defvar nnimap-progress-chars '(?| ?/ ?- ?\\))
459 (defvar nnimap-progress-how-often 20)
460 (defvar nnimap-counter)
461 (defvar nnimap-server-buffer-alist nil) ;; Map server name to buffers.
462 (defvar nnimap-current-server nil) ;; Current server
463 (defvar nnimap-server-buffer nil) ;; Current servers' buffer
467 (nnoo-define-basics nnimap)
469 ;; Utility functions:
471 (defsubst nnimap-get-server-buffer (server)
472 "Return buffer for SERVER, if nil use current server."
473 (cadr (assoc (or server nnimap-current-server) nnimap-server-buffer-alist)))
475 (defun nnimap-possibly-change-server (server)
476 "Return buffer for SERVER, changing the current server as a side-effect.
477 If SERVER is nil, uses the current server."
478 (setq nnimap-current-server (or server nnimap-current-server)
479 nnimap-server-buffer (nnimap-get-server-buffer nnimap-current-server)))
481 (defun nnimap-verify-uidvalidity (group server)
482 "Verify stored uidvalidity match current one in GROUP on SERVER."
483 (let* ((gnusgroup (gnus-group-prefixed-name
484 group (gnus-server-to-method
485 (format "nnimap:%s" server))))
486 (new-uidvalidity (imap-mailbox-get 'uidvalidity))
487 (old-uidvalidity (gnus-group-get-parameter gnusgroup 'uidvalidity))
488 (dir (file-name-as-directory (expand-file-name nnimap-directory)))
489 (nameuid (nnheader-translate-file-chars
490 (concat nnimap-nov-file-name
491 (if (equal server "")
493 server) "." group "." old-uidvalidity
494 nnimap-nov-file-name-suffix) t))
495 (file (if (or nnmail-use-long-file-names
496 (file-exists-p (expand-file-name nameuid dir)))
497 (expand-file-name nameuid dir)
499 (encode-coding-string
500 (nnheader-replace-chars-in-string nameuid ?. ?/)
501 nnmail-pathname-coding-system)
504 (if (not (equal old-uidvalidity new-uidvalidity))
506 (gnus-delete-file file)
507 (gnus-group-set-parameter gnusgroup 'uidvalidity new-uidvalidity)
509 (gnus-group-add-parameter gnusgroup (cons 'uidvalidity new-uidvalidity))
512 (defun nnimap-before-find-minmax-bugworkaround ()
513 "Function called before iterating through mailboxes with
514 `nnimap-find-minmax-uid'."
515 (when nnimap-need-unselect-to-notice-new-mail
516 ;; XXX this is for UoW imapd problem, it doesn't notice new mail in
517 ;; currently selected mailbox without a re-select/examine.
518 (or (null (imap-current-mailbox nnimap-server-buffer))
519 (imap-mailbox-unselect nnimap-server-buffer))))
521 (defun nnimap-find-minmax-uid (group &optional examine)
522 "Find lowest and highest active article number in GROUP.
523 If EXAMINE is non-nil the group is selected read-only."
524 (with-current-buffer nnimap-server-buffer
525 (when (or (string= group (imap-current-mailbox))
526 (imap-mailbox-select group examine))
528 (when (> (imap-mailbox-get 'exists) 0)
529 (imap-fetch "1,*" "UID" nil 'nouidfetch)
530 (imap-message-map (lambda (uid Uid)
531 (setq minuid (if minuid (min minuid uid) uid)
532 maxuid (if maxuid (max maxuid uid) uid)))
534 (list (imap-mailbox-get 'exists) minuid maxuid)))))
536 (defun nnimap-possibly-change-group (group &optional server)
537 "Make GROUP the current group, and SERVER the current server."
538 (when (nnimap-possibly-change-server server)
539 (with-current-buffer nnimap-server-buffer
540 (if (or (null group) (imap-current-mailbox-p group))
542 (if (imap-mailbox-select group)
543 (if (or (nnimap-verify-uidvalidity
544 group (or server nnimap-current-server))
545 (zerop (imap-mailbox-get 'exists group))
546 t ;; for OGnus to see if ignoring uidvalidity
547 ;; changes has any bad effects.
550 "nnimap: Group %s is not uidvalid. Continue? " group)))
552 (imap-mailbox-unselect)
553 (error "nnimap: Group %s is not uid-valid" group))
554 (nnheader-report 'nnimap (imap-error-text)))))))
556 (defun nnimap-replace-whitespace (string)
557 "Return STRING with all whitespace replaced with space."
559 (while (string-match "[\r\n\t]+" string)
560 (setq string (replace-match " " t t string)))
563 ;; Required backend functions
565 (defun nnimap-retrieve-headers-progress ()
566 "Hook to insert NOV line for current article into `nntp-server-buffer'."
567 (and (numberp nnmail-large-newsgroup)
568 (zerop (% (incf nnimap-counter) nnimap-progress-how-often))
569 (> nnimap-length nnmail-large-newsgroup)
570 (nnheader-message 6 "nnimap: Retrieving headers... %c"
571 (nth (/ (% nnimap-counter
572 (* (length nnimap-progress-chars)
573 nnimap-progress-how-often))
574 nnimap-progress-how-often)
575 nnimap-progress-chars)))
576 (with-current-buffer nntp-server-buffer
577 (let (headers lines chars uid mbx)
578 (with-current-buffer nnimap-server-buffer
579 (setq uid imap-current-message
580 mbx imap-current-mailbox
581 headers (nnimap-demule
582 (if (imap-capability 'IMAP4rev1)
583 ;; xxx don't just use car? alist doesn't contain
584 ;; anything else now, but it might...
585 (nth 2 (car (imap-message-get uid 'BODYDETAIL)))
586 (imap-message-get uid 'RFC822.HEADER)))
587 lines (imap-body-lines (imap-message-body imap-current-message))
588 chars (imap-message-get imap-current-message 'RFC822.SIZE)))
591 (buffer-disable-undo)
593 (let ((head (nnheader-parse-naked-head uid)))
594 (mail-header-set-number head uid)
595 (mail-header-set-chars head chars)
596 (mail-header-set-lines head lines)
597 (mail-header-set-xref
598 head (format "%s %s:%d" (system-name) mbx uid))
601 (defun nnimap-retrieve-which-headers (articles fetch-old)
602 "Get a range of articles to fetch based on ARTICLES and FETCH-OLD."
603 (with-current-buffer nnimap-server-buffer
604 (if (numberp (car-safe articles))
607 (imap-range-to-message-set
608 (gnus-compress-sequence
609 (append (gnus-uncompress-sequence
611 (cons (if (numberp fetch-old)
612 (max 1 (- (car articles) fetch-old))
614 (1- (car articles)))))
616 (mapcar (lambda (msgid)
618 (format "HEADER Message-Id \"%s\"" msgid)))
621 (defun nnimap-group-overview-filename (group server)
622 "Make file name for GROUP on SERVER."
623 (let* ((dir (file-name-as-directory (expand-file-name nnimap-directory)))
624 (uidvalidity (gnus-group-get-parameter
625 (gnus-group-prefixed-name
626 group (gnus-server-to-method
627 (format "nnimap:%s" server)))
629 (name (nnheader-translate-file-chars
630 (concat nnimap-nov-file-name
631 (if (equal server "")
633 server) "." group nnimap-nov-file-name-suffix) t))
634 (nameuid (nnheader-translate-file-chars
635 (concat nnimap-nov-file-name
636 (if (equal server "")
638 server) "." group "." uidvalidity
639 nnimap-nov-file-name-suffix) t))
640 (oldfile (if (or nnmail-use-long-file-names
641 (file-exists-p (expand-file-name name dir)))
642 (expand-file-name name dir)
644 (encode-coding-string
645 (nnheader-replace-chars-in-string name ?. ?/)
646 nnmail-pathname-coding-system)
648 (newfile (if (or nnmail-use-long-file-names
649 (file-exists-p (expand-file-name nameuid dir)))
650 (expand-file-name nameuid dir)
652 (encode-coding-string
653 (nnheader-replace-chars-in-string nameuid ?. ?/)
654 nnmail-pathname-coding-system)
656 (when (and (file-exists-p oldfile) (not (file-exists-p newfile)))
657 (message "nnimap: Upgrading novcache filename...")
659 (gnus-make-directory (file-name-directory newfile))
660 (unless (ignore-errors (rename-file oldfile newfile) t)
661 (if (ignore-errors (copy-file oldfile newfile) t)
662 (delete-file oldfile)
663 (error "Can't rename `%s' to `%s'" oldfile newfile))))
666 (defun nnimap-retrieve-headers-from-file (group server)
667 (with-current-buffer nntp-server-buffer
668 (let ((nov (nnimap-group-overview-filename group server)))
669 (when (file-exists-p nov)
670 (nnheader-insert-file-contents nov)
671 (set-buffer-modified-p nil)
672 (let ((min (ignore-errors (goto-char (point-min))
673 (read (current-buffer))))
674 (max (ignore-errors (goto-char (point-max))
676 (read (current-buffer)))))
677 (if (and (numberp min) (numberp max))
679 ;; junk, remove it, it's saved later
683 (defun nnimap-retrieve-headers-from-server (articles group server)
684 (with-current-buffer nnimap-server-buffer
685 (let ((imap-fetch-data-hook '(nnimap-retrieve-headers-progress))
686 (nnimap-length (gnus-range-length articles))
688 (imap-fetch (imap-range-to-message-set articles)
689 (concat "(UID RFC822.SIZE BODY "
691 (append '(Subject From Date Message-Id
692 References In-Reply-To Xref)
694 nnmail-extra-headers))))
695 (if (imap-capability 'IMAP4rev1)
696 (format "BODY.PEEK[HEADER.FIELDS %s])" headers)
697 (format "RFC822.HEADER.LINES %s)" headers)))))
698 (and (numberp nnmail-large-newsgroup)
699 (> nnimap-length nnmail-large-newsgroup)
700 (nnheader-message 6 "nnimap: Retrieving headers...done")))))
702 (defun nnimap-dont-use-nov-p (group server)
703 (or gnus-nov-is-evil nnimap-nov-is-evil
704 (unless (and (gnus-make-directory
706 (nnimap-group-overview-filename group server)))
708 (nnimap-group-overview-filename group server)))
709 (message "nnimap: Nov cache not writable, %s"
710 (nnimap-group-overview-filename group server)))))
712 (deffoo nnimap-retrieve-headers (articles &optional group server fetch-old)
713 (when (nnimap-possibly-change-group group server)
714 (with-current-buffer nntp-server-buffer
716 (if (nnimap-dont-use-nov-p group server)
717 (nnimap-retrieve-headers-from-server
718 (gnus-compress-sequence articles) group server)
719 (let (uids cached low high)
720 (when (setq uids (nnimap-retrieve-which-headers articles fetch-old)
722 high (car (last uids)))
723 (if (setq cached (nnimap-retrieve-headers-from-file group server))
725 ;; fetch articles with uids before cache block
726 (when (< low (car cached))
727 (goto-char (point-min))
728 (nnimap-retrieve-headers-from-server
729 (cons low (1- (car cached))) group server))
730 ;; fetch articles with uids after cache block
731 (when (> high (cdr cached))
732 (goto-char (point-max))
733 (nnimap-retrieve-headers-from-server
734 (cons (1+ (cdr cached)) high) group server))
735 (when nnimap-prune-cache
736 ;; remove nov's for articles which has expired on server
737 (goto-char (point-min))
738 (dolist (uid (gnus-set-difference articles uids))
739 (when (re-search-forward (format "^%d\t" uid) nil t)
740 (gnus-delete-line)))))
741 ;; nothing cached, fetch whole range from server
742 (nnimap-retrieve-headers-from-server
743 (cons low high) group server))
744 (when (buffer-modified-p)
746 (point-min) (point-max)
747 (nnimap-group-overview-filename group server) nil 'nomesg))
748 (nnheader-nov-delete-outside-range low high))))
751 (defun nnimap-open-connection (server)
752 (if (not (imap-open nnimap-address nnimap-server-port nnimap-stream
753 nnimap-authenticator nnimap-server-buffer))
754 (nnheader-report 'nnimap "Can't open connection to server %s" server)
755 (unless (or (imap-capability 'IMAP4 nnimap-server-buffer)
756 (imap-capability 'IMAP4rev1 nnimap-server-buffer))
757 (imap-close nnimap-server-buffer)
758 (nnheader-report 'nnimap "Server %s is not IMAP4 compliant" server))
759 (let* ((list (netrc-parse nnimap-authinfo-file))
760 (port (if nnimap-server-port
761 (int-to-string nnimap-server-port)
763 (alist (or (netrc-machine list server port "imap")
765 (or nnimap-server-address
768 (netrc-machine list server port "imaps")
770 (or nnimap-server-address
773 (user (netrc-get alist "login"))
774 (passwd (netrc-get alist "password")))
775 (if (imap-authenticate user passwd nnimap-server-buffer)
777 (push (list server nnimap-server-buffer)
778 nnimap-server-buffer-alist)
779 (imap-id nnimap-id nnimap-server-buffer)
780 (nnimap-possibly-change-server server))
781 (imap-close nnimap-server-buffer)
782 (kill-buffer nnimap-server-buffer)
783 (nnheader-report 'nnimap "Could not authenticate to %s" server)))))
785 (deffoo nnimap-open-server (server &optional defs)
786 (nnheader-init-server-buffer)
787 (if (nnimap-server-opened server)
789 (unless (assq 'nnimap-server-buffer defs)
790 (push (list 'nnimap-server-buffer (concat " *nnimap* " server)) defs))
791 ;; translate `nnimap-server-address' to `nnimap-address' in defs
792 ;; for people that configured nnimap with a very old version
793 (unless (assq 'nnimap-address defs)
794 (if (assq 'nnimap-server-address defs)
795 (push (list 'nnimap-address
796 (cadr (assq 'nnimap-server-address defs))) defs)
797 (push (list 'nnimap-address server) defs)))
798 (nnoo-change-server 'nnimap server defs)
799 (or nnimap-server-buffer
800 (setq nnimap-server-buffer (cadr (assq 'nnimap-server-buffer defs))))
801 (with-current-buffer (get-buffer-create nnimap-server-buffer)
802 (nnoo-change-server 'nnimap server defs))
803 (or (and nnimap-server-buffer
804 (imap-opened nnimap-server-buffer)
805 (if (with-current-buffer nnimap-server-buffer
806 (memq imap-state '(auth select examine)))
808 (imap-close nnimap-server-buffer)
809 (nnimap-open-connection server)))
810 (nnimap-open-connection server))))
812 (deffoo nnimap-server-opened (&optional server)
813 "Whether SERVER is opened.
814 If SERVER is the current virtual server, and the connection to the
815 physical server is alive, this function return a non-nil value. If
816 SERVER is nil, it is treated as the current server."
817 ;; clean up autologouts??
818 (and (or server nnimap-current-server)
819 (nnoo-server-opened 'nnimap (or server nnimap-current-server))
820 (imap-opened (nnimap-get-server-buffer server))))
822 (deffoo nnimap-close-server (&optional server)
823 "Close connection to server and free all resources connected to it.
824 Return nil if the server couldn't be closed for some reason."
825 (let ((server (or server nnimap-current-server)))
826 (when (or (nnimap-server-opened server)
827 (imap-opened (nnimap-get-server-buffer server)))
828 (imap-close (nnimap-get-server-buffer server))
829 (kill-buffer (nnimap-get-server-buffer server))
830 (setq nnimap-server-buffer nil
831 nnimap-current-server nil
832 nnimap-server-buffer-alist
833 (delq server nnimap-server-buffer-alist)))
834 (nnoo-close-server 'nnimap server)))
836 (deffoo nnimap-request-close ()
837 "Close connection to all servers and free all resources that the backend have reserved.
838 All buffers that have been created by that
839 backend should be killed. (Not the nntp-server-buffer, though.) This
840 function is generally only called when Gnus is shutting down."
841 (mapc (lambda (server) (nnimap-close-server (car server)))
842 nnimap-server-buffer-alist)
843 (setq nnimap-server-buffer-alist nil))
845 (deffoo nnimap-status-message (&optional server)
846 "This function returns the last error message from server."
847 (when (nnimap-possibly-change-server server)
848 (nnoo-status-message 'nnimap server)))
850 (defun nnimap-demule (string)
851 ;; BEWARE: we used to use string-as-multibyte here which is braindead
852 ;; because it will turn accidental emacs-mule-valid byte sequences
853 ;; into multibyte chars. --Stef
854 ;; Reverted, braindead got 7.5 out of 10 on imdb, so it can't be
856 (funcall (if (and (fboundp 'string-as-multibyte)
857 (subrp (symbol-function 'string-as-multibyte)))
862 (defun nnimap-make-callback (article gnus-callback buffer)
863 "Return a callback function."
865 (nnimap-callback ,article ,gnus-callback ,buffer)))
867 (defun nnimap-callback (article gnus-callback buffer)
868 (when (eq article (imap-current-message))
869 (remove-hook 'imap-fetch-data-hook
870 (nnimap-make-callback article gnus-callback buffer))
871 (with-current-buffer buffer
873 (with-current-buffer nnimap-server-buffer
875 (if (imap-capability 'IMAP4rev1)
876 ;; xxx don't just use car? alist doesn't contain
877 ;; anything else now, but it might...
878 (nth 2 (car (imap-message-get article 'BODYDETAIL)))
879 (imap-message-get article 'RFC822)))))
880 (nnheader-ms-strip-cr)
881 (funcall gnus-callback t))))
883 (defun nnimap-request-article-part (article part prop &optional
884 group server to-buffer detail)
885 (when (nnimap-possibly-change-group group server)
886 (let ((article (if (stringp article)
887 (car-safe (imap-search
888 (format "HEADER Message-Id \"%s\"" article)
889 nnimap-server-buffer))
892 (gnus-message 10 "nnimap: Fetching (part of) article %d from %s..."
893 article (or group imap-current-mailbox
894 gnus-newsgroup-name))
895 (if (not nnheader-callback-function)
896 (with-current-buffer (or to-buffer nntp-server-buffer)
898 (let ((data (imap-fetch article part prop nil
899 nnimap-server-buffer)))
901 (insert (nnimap-demule (if detail (nth 2 (car data)) data)))
902 (nnheader-ms-strip-cr)
904 10 "nnimap: Fetching (part of) article %d from %s...done"
905 article (or group imap-current-mailbox gnus-newsgroup-name))
907 (nnheader-report 'nnimap "No such article %d in %s: %s"
908 article (or group imap-current-mailbox
910 (imap-error-text nnimap-server-buffer))
911 (cons group article)))))
912 (add-hook 'imap-fetch-data-hook
913 (nnimap-make-callback article
914 nnheader-callback-function
916 (imap-fetch-asynch article part nil nnimap-server-buffer)
917 (cons group article))))))
919 (deffoo nnimap-asynchronous-p ()
922 (deffoo nnimap-request-article (article &optional group server to-buffer)
923 (if (imap-capability 'IMAP4rev1 nnimap-server-buffer)
924 (nnimap-request-article-part
925 article "BODY.PEEK[]" 'BODYDETAIL group server to-buffer 'detail)
926 (nnimap-request-article-part
927 article "RFC822.PEEK" 'RFC822 group server to-buffer)))
929 (deffoo nnimap-request-head (article &optional group server to-buffer)
930 (if (imap-capability 'IMAP4rev1 nnimap-server-buffer)
931 (nnimap-request-article-part
932 article "BODY.PEEK[HEADER]" 'BODYDETAIL group server to-buffer 'detail)
933 (nnimap-request-article-part
934 article "RFC822.HEADER" 'RFC822.HEADER group server to-buffer)))
936 (deffoo nnimap-request-body (article &optional group server to-buffer)
937 (if (imap-capability 'IMAP4rev1 nnimap-server-buffer)
938 (nnimap-request-article-part
939 article "BODY.PEEK[TEXT]" 'BODYDETAIL group server to-buffer 'detail)
940 (nnimap-request-article-part
941 article "RFC822.TEXT.PEEK" 'RFC822.TEXT group server to-buffer)))
943 (deffoo nnimap-request-group (group &optional server fast)
944 (nnimap-request-update-info-internal
946 (gnus-get-info (gnus-group-prefixed-name
947 group (gnus-server-to-method (format "nnimap:%s" server))))
949 (when (nnimap-possibly-change-group group server)
950 (nnimap-before-find-minmax-bugworkaround)
953 ((null (setq info (nnimap-find-minmax-uid group t)))
954 (nnheader-report 'nnimap "Could not get active info for %s"
957 (nnheader-insert "211 %d %d %d %s\n" (or (nth 0 info) 0)
958 (max 1 (or (nth 1 info) 1))
959 (or (nth 2 info) 0) group)
960 (nnheader-report 'nnimap "Group %s selected" group)
963 (defun nnimap-update-unseen (group &optional server)
964 "Update the unseen count in `nnimap-mailbox-info'."
966 (gnus-group-prefixed-name group server)
967 (let ((old (gnus-gethash-safe (gnus-group-prefixed-name group server)
968 nnimap-mailbox-info)))
969 (list (nth 0 old) (nth 1 old)
970 (imap-mailbox-status group 'unseen nnimap-server-buffer)
972 nnimap-mailbox-info))
974 (defun nnimap-close-group (group &optional server)
975 (with-current-buffer nnimap-server-buffer
976 (when (and (imap-opened)
977 (nnimap-possibly-change-group group server))
978 (nnimap-update-unseen group server)
979 (case nnimap-expunge-on-close
981 (imap-mailbox-expunge nnimap-close-asynchronous)
982 (unless nnimap-dont-close
983 (imap-mailbox-close nnimap-close-asynchronous))))
984 (ask (if (and (imap-search "DELETED")
985 (gnus-y-or-n-p (format "Expunge articles in group `%s'? "
986 imap-current-mailbox)))
988 (imap-mailbox-expunge nnimap-close-asynchronous)
989 (unless nnimap-dont-close
990 (imap-mailbox-close nnimap-close-asynchronous)))
991 (imap-mailbox-unselect)))
992 (t (imap-mailbox-unselect)))
993 (not imap-current-mailbox))))
995 (defun nnimap-pattern-to-list-arguments (pattern)
997 (cons (car-safe p) (or (cdr-safe p) p)))
998 (if (and (listp pattern)
999 (listp (cdr pattern)))
1003 (deffoo nnimap-request-list (&optional server)
1004 (when (nnimap-possibly-change-server server)
1005 (with-current-buffer nntp-server-buffer
1007 (gnus-message 5 "nnimap: Generating active list%s..."
1008 (if (> (length server) 0) (concat " for " server) ""))
1009 (nnimap-before-find-minmax-bugworkaround)
1010 (with-current-buffer nnimap-server-buffer
1011 (dolist (pattern (nnimap-pattern-to-list-arguments nnimap-list-pattern))
1012 (dolist (mbx (funcall nnimap-request-list-method
1013 (cdr pattern) (car pattern)))
1014 (or (member "\\NoSelect" (imap-mailbox-get 'list-flags mbx))
1015 (let ((info (nnimap-find-minmax-uid mbx 'examine)))
1017 (with-current-buffer nntp-server-buffer
1018 (insert (format "\"%s\" %d %d y\n"
1019 mbx (or (nth 2 info) 0)
1020 (max 1 (or (nth 1 info) 1)))))))))))
1021 (gnus-message 5 "nnimap: Generating active list%s...done"
1022 (if (> (length server) 0) (concat " for " server) ""))
1025 (deffoo nnimap-request-post (&optional server)
1027 (dolist (mbx (message-unquote-tokens
1028 (message-tokenize-header
1029 (message-fetch-field "Newsgroups") ", ")) success)
1030 (let ((to-newsgroup (gnus-group-prefixed-name mbx gnus-command-method)))
1031 (or (gnus-active to-newsgroup)
1032 (gnus-activate-group to-newsgroup)
1033 (if (gnus-y-or-n-p (format "No such group: %s. Create it? "
1035 (or (and (gnus-request-create-group
1036 to-newsgroup gnus-command-method)
1037 (gnus-activate-group to-newsgroup nil nil
1038 gnus-command-method))
1039 (error "Couldn't create group %s" to-newsgroup)))
1040 (error "No such group: %s" to-newsgroup))
1041 (unless (nnimap-request-accept-article mbx (nth 1 gnus-command-method))
1042 (setq success nil))))))
1044 ;; Optional backend functions
1046 (defun nnimap-string-lessp-numerical (s1 s2)
1047 "Return t if first arg string is less than second in numerical order."
1048 (cond ((string= s1 s2)
1050 ((> (length s1) (length s2))
1052 ((< (length s1) (length s2))
1054 ((< (string-to-number (substring s1 0 1))
1055 (string-to-number (substring s2 0 1)))
1057 ((> (string-to-number (substring s1 0 1))
1058 (string-to-number (substring s2 0 1)))
1061 (nnimap-string-lessp-numerical (substring s1 1) (substring s2 1)))))
1063 (deffoo nnimap-retrieve-groups (groups &optional server)
1064 (when (nnimap-possibly-change-server server)
1065 (gnus-message 5 "nnimap: Checking mailboxes...")
1066 (with-current-buffer nntp-server-buffer
1068 (nnimap-before-find-minmax-bugworkaround)
1069 (let (asyncgroups slowgroups)
1070 (if (null nnimap-retrieve-groups-asynchronous)
1071 (setq slowgroups groups)
1072 (dolist (group groups)
1073 (gnus-message 9 "nnimap: Quickly checking mailbox %s" group)
1074 (add-to-list (if (gnus-gethash-safe
1075 (gnus-group-prefixed-name group server)
1076 nnimap-mailbox-info)
1079 (list group (imap-mailbox-status-asynch
1080 group '(uidvalidity uidnext unseen)
1081 nnimap-server-buffer))))
1082 (dolist (asyncgroup asyncgroups)
1083 (let ((group (nth 0 asyncgroup))
1084 (tag (nth 1 asyncgroup))
1086 (when (imap-ok-p (imap-wait-for-tag tag nnimap-server-buffer))
1087 (if (or (not (string=
1088 (nth 0 (gnus-gethash (gnus-group-prefixed-name
1090 nnimap-mailbox-info))
1091 (imap-mailbox-get 'uidvalidity group
1092 nnimap-server-buffer)))
1094 (nth 1 (gnus-gethash (gnus-group-prefixed-name
1096 nnimap-mailbox-info))
1097 (imap-mailbox-get 'uidnext group
1098 nnimap-server-buffer))))
1099 (push (list group) slowgroups)
1100 (insert (nth 3 (gnus-gethash (gnus-group-prefixed-name
1102 nnimap-mailbox-info))))))))
1103 (dolist (group slowgroups)
1104 (if nnimap-retrieve-groups-asynchronous
1105 (setq group (car group)))
1106 (gnus-message 7 "nnimap: Mailbox %s modified" group)
1107 (imap-mailbox-put 'uidnext nil group nnimap-server-buffer)
1108 (or (member "\\NoSelect" (imap-mailbox-get 'list-flags group
1109 nnimap-server-buffer))
1110 (let* ((info (nnimap-find-minmax-uid group 'examine))
1111 (str (format "\"%s\" %d %d y\n" group
1113 (max 1 (or (nth 1 info) 1)))))
1114 (when (> (or (imap-mailbox-get 'recent group
1115 nnimap-server-buffer) 0)
1117 (push (list (cons group 0)) nnmail-split-history))
1119 (when nnimap-retrieve-groups-asynchronous
1121 (gnus-group-prefixed-name group server)
1122 (list (or (imap-mailbox-get
1123 'uidvalidity group nnimap-server-buffer)
1124 (imap-mailbox-status
1125 group 'uidvalidity nnimap-server-buffer))
1126 (or (imap-mailbox-get
1127 'uidnext group nnimap-server-buffer)
1128 (imap-mailbox-status
1129 group 'uidnext nnimap-server-buffer))
1130 (or (imap-mailbox-get
1131 'unseen group nnimap-server-buffer)
1132 (imap-mailbox-status
1133 group 'unseen nnimap-server-buffer))
1135 nnimap-mailbox-info)))))))
1136 (gnus-message 5 "nnimap: Checking mailboxes...done")
1139 (deffoo nnimap-request-update-info-internal (group info &optional server)
1140 (when (nnimap-possibly-change-group group server)
1141 (when info;; xxx what does this mean? should we create a info?
1142 (with-current-buffer nnimap-server-buffer
1143 (gnus-message 5 "nnimap: Updating info for %s..."
1144 (gnus-info-group info))
1146 (when (nnimap-mark-permanent-p 'read)
1148 ;; read info could contain articles marked unread by other
1149 ;; imap clients! we correct this
1150 (setq seen (gnus-uncompress-range (gnus-info-read info))
1151 unseen (imap-search "UNSEEN UNDELETED")
1152 seen (gnus-set-difference seen unseen)
1153 ;; seen might lack articles marked as read by other
1154 ;; imap clients! we correct this
1155 seen (append seen (imap-search "SEEN"))
1158 seen (gnus-compress-sequence seen t)
1159 ;; we can't return '(1) since this isn't a "list of ranges",
1160 ;; and we can't return '((1)) since g-list-of-unread-articles
1161 ;; is buggy so we return '((1 . 1)).
1162 seen (if (and (integerp (car seen))
1164 (list (cons (car seen) (car seen)))
1166 (gnus-info-set-read info seen)))
1168 (mapcar (lambda (pred)
1169 (when (or (eq (cdr pred) 'recent)
1170 (and (nnimap-mark-permanent-p (cdr pred))
1171 (member (nnimap-mark-to-flag (cdr pred))
1172 (imap-mailbox-get 'flags))))
1173 (gnus-info-set-marks
1175 (gnus-update-alist-soft
1177 (gnus-compress-sequence
1178 (imap-search (nnimap-mark-to-predicate (cdr pred))))
1179 (gnus-info-marks info))
1181 gnus-article-mark-lists)
1183 (when nnimap-importantize-dormant
1184 ;; nnimap mark dormant article as ticked too (for other clients)
1185 ;; so we remove that mark for gnus since we support dormant
1186 (gnus-info-set-marks
1188 (gnus-update-alist-soft
1190 (gnus-remove-from-range
1191 (cdr-safe (assoc 'tick (gnus-info-marks info)))
1192 (cdr-safe (assoc 'dormant (gnus-info-marks info))))
1193 (gnus-info-marks info))
1196 (gnus-message 5 "nnimap: Updating info for %s...done"
1197 (gnus-info-group info))
1201 (deffoo nnimap-request-type (group &optional article)
1202 (if (and nnimap-news-groups (string-match nnimap-news-groups group))
1206 (deffoo nnimap-request-set-mark (group actions &optional server)
1207 (when (nnimap-possibly-change-group group server)
1208 (with-current-buffer nnimap-server-buffer
1210 (gnus-message 7 "nnimap: Setting marks in %s..." group)
1211 (while (setq action (pop actions))
1212 (let ((range (nth 0 action))
1213 (what (nth 1 action))
1214 (cmdmarks (nth 2 action))
1216 ;; bookmark can't be stored (not list/range
1217 (setq cmdmarks (delq 'bookmark cmdmarks))
1218 ;; killed can't be stored (not list/range
1219 (setq cmdmarks (delq 'killed cmdmarks))
1220 ;; unsent are for nndraft groups only
1221 (setq cmdmarks (delq 'unsent cmdmarks))
1222 ;; cache flags are pointless on the server
1223 (setq cmdmarks (delq 'cache cmdmarks))
1224 ;; seen flags are local to each gnus
1225 (setq cmdmarks (delq 'seen cmdmarks))
1226 ;; recent marks can't be set
1227 (setq cmdmarks (delq 'recent cmdmarks))
1228 (when nnimap-importantize-dormant
1229 ;; flag dormant articles as ticked
1230 (if (memq 'dormant cmdmarks)
1231 (setq cmdmarks (cons 'tick cmdmarks))))
1232 ;; remove stuff we are forbidden to store
1233 (mapc (lambda (mark)
1234 (if (imap-message-flag-permanent-p
1235 (nnimap-mark-to-flag mark))
1236 (setq marks (cons mark marks))))
1238 (when (and range marks)
1239 (cond ((eq what 'del)
1240 (imap-message-flags-del
1241 (imap-range-to-message-set range)
1242 (nnimap-mark-to-flag marks nil t)))
1244 (imap-message-flags-add
1245 (imap-range-to-message-set range)
1246 (nnimap-mark-to-flag marks nil t)))
1248 (imap-message-flags-set
1249 (imap-range-to-message-set range)
1250 (nnimap-mark-to-flag marks nil t)))))))
1251 (gnus-message 7 "nnimap: Setting marks in %s...done" group))))
1254 (defun nnimap-split-fancy ()
1255 "Like the function `nnmail-split-fancy', but uses `nnimap-split-fancy'."
1256 (let ((nnmail-split-fancy nnimap-split-fancy))
1257 (nnmail-split-fancy)))
1259 (defun nnimap-split-to-groups (rules)
1260 ;; tries to match all rules in nnimap-split-rule against content of
1261 ;; nntp-server-buffer, returns a list of groups that matched.
1262 (with-current-buffer nntp-server-buffer
1263 ;; Fold continuation lines.
1264 (goto-char (point-min))
1265 (while (re-search-forward "\\(\r?\n[ \t]+\\)+" nil t)
1266 (replace-match " " t t))
1267 (if (functionp rules)
1269 (let (to-groups regrepp)
1271 (dolist (rule rules to-groups)
1272 (let ((group (car rule))
1273 (regexp (cadr rule)))
1274 (goto-char (point-min))
1275 (when (and (if (stringp regexp)
1277 (if (not (stringp group))
1278 (setq group (eval group))
1280 (string-match "\\\\[0-9&]" group)))
1281 (re-search-forward regexp nil t))
1282 (funcall regexp group))
1283 ;; Don't enter the article into the same group twice.
1284 (not (assoc group to-groups)))
1286 (nnmail-expand-newtext group)
1289 (or nnimap-split-crosspost
1290 (throw 'split-done to-groups))))))))))
1292 (defun nnimap-assoc-match (key alist)
1294 (while (and alist (not element))
1295 (if (string-match (car (car alist)) key)
1296 (setq element (car alist)))
1297 (setq alist (cdr alist)))
1300 (defun nnimap-split-find-rule (server inbox)
1301 (if (and (listp nnimap-split-rule) (listp (car nnimap-split-rule))
1302 (list (cdar nnimap-split-rule)) (listp (cadar nnimap-split-rule)))
1304 (cadr (nnimap-assoc-match inbox (cdr (nnimap-assoc-match
1305 server nnimap-split-rule))))
1308 (defun nnimap-split-find-inbox (server)
1309 (if (listp nnimap-split-inbox)
1311 (list nnimap-split-inbox)))
1313 (defun nnimap-split-articles (&optional group server)
1314 (when (nnimap-possibly-change-server server)
1315 (with-current-buffer nnimap-server-buffer
1316 (let (rule inbox removeorig (inboxes (nnimap-split-find-inbox server)))
1317 ;; iterate over inboxes
1318 (while (and (setq inbox (pop inboxes))
1319 (nnimap-possibly-change-group inbox));; SELECT
1320 ;; find split rule for this server / inbox
1321 (when (setq rule (nnimap-split-find-rule server inbox))
1322 ;; iterate over articles
1323 (dolist (article (imap-search nnimap-split-predicate))
1324 (when (if (if (eq nnimap-split-download-body 'default)
1325 nnimap-split-download-body-default
1326 nnimap-split-download-body)
1327 (and (nnimap-request-article article)
1328 (with-current-buffer nntp-server-buffer (mail-narrow-to-head)))
1329 (nnimap-request-head article))
1330 ;; copy article to right group(s)
1331 (setq removeorig nil)
1332 (dolist (to-group (nnimap-split-to-groups rule))
1333 (cond ((eq to-group 'junk)
1334 (message "IMAP split removed %s:%s:%d" server inbox
1336 (setq removeorig t))
1337 ((imap-message-copy (number-to-string article)
1338 to-group nil 'nocopyuid)
1339 (message "IMAP split moved %s:%s:%d to %s" server
1340 inbox article to-group)
1342 (when nnmail-cache-accepted-message-ids
1343 (with-current-buffer nntp-server-buffer
1346 (nnmail-fetch-field "message-id"))
1347 (nnmail-cache-insert msgid
1349 (nnmail-fetch-field "subject"))))))
1350 ;; Add the group-art list to the history list.
1351 (push (list (cons to-group 0)) nnmail-split-history))
1353 (message "IMAP split failed to move %s:%s:%d to %s"
1354 server inbox article to-group))))
1355 (if (if (eq nnimap-split-download-body 'default)
1356 nnimap-split-download-body-default
1357 nnimap-split-download-body)
1359 ;; remove article if it was successfully copied somewhere
1361 (imap-message-flags-add (format "%d" article)
1362 "\\Seen \\Deleted")))))
1363 (when (imap-mailbox-select inbox);; just in case
1364 ;; todo: UID EXPUNGE (if available) to remove splitted articles
1365 (imap-mailbox-expunge)
1366 (imap-mailbox-close)))
1367 (when nnmail-cache-accepted-message-ids
1368 (nnmail-cache-close))
1371 (deffoo nnimap-request-scan (&optional group server)
1372 (nnimap-split-articles group server))
1374 (deffoo nnimap-request-newgroups (date &optional server)
1375 (when (nnimap-possibly-change-server server)
1376 (with-current-buffer nntp-server-buffer
1377 (gnus-message 5 "nnimap: Listing subscribed mailboxes%s%s..."
1378 (if (> (length server) 0) " on " "") server)
1380 (nnimap-before-find-minmax-bugworkaround)
1381 (dolist (pattern (nnimap-pattern-to-list-arguments
1382 nnimap-list-pattern))
1383 (dolist (mbx (imap-mailbox-lsub (cdr pattern) (car pattern) nil
1384 nnimap-server-buffer))
1386 (dolist (mailbox (imap-mailbox-get 'list-flags mbx
1387 nnimap-server-buffer))
1388 (if (string= (downcase mailbox) "\\noselect")
1391 (let ((info (nnimap-find-minmax-uid mbx 'examine)))
1393 (insert (format "\"%s\" %d %d y\n"
1394 mbx (or (nth 2 info) 0)
1395 (max 1 (or (nth 1 info) 1)))))))))
1396 (gnus-message 5 "nnimap: Listing subscribed mailboxes%s%s...done"
1397 (if (> (length server) 0) " on " "") server))
1400 (deffoo nnimap-request-create-group (group &optional server args)
1401 (when (nnimap-possibly-change-server server)
1402 (or (imap-mailbox-status group 'uidvalidity nnimap-server-buffer)
1403 (imap-mailbox-create group nnimap-server-buffer)
1404 (nnheader-report 'nnimap "%S"
1405 (imap-error-text nnimap-server-buffer)))))
1407 (defun nnimap-time-substract (time1 time2)
1408 "Return TIME for TIME1 - TIME2."
1409 (let* ((ms (- (car time1) (car time2)))
1410 (ls (- (nth 1 time1) (nth 1 time2))))
1412 (list (- ms 1) (+ (expt 2 16) ls))
1415 (defun nnimap-date-days-ago (daysago)
1416 "Return date, in format \"3-Aug-1998\", for DAYSAGO days ago."
1417 (let* ((time (nnimap-time-substract (current-time) (days-to-time daysago)))
1418 (date (format-time-string
1419 (format "%%d-%s-%%Y"
1420 (capitalize (car (rassoc (nth 4 (decode-time time))
1421 parse-time-months))))
1423 (if (eq ?0 (string-to-char date))
1427 (defun nnimap-request-expire-articles-progress ()
1428 (gnus-message 5 "nnimap: Marking article %d for deletion..."
1429 imap-current-message))
1431 (defun nnimap-expiry-target (arts group server)
1432 (unless (eq nnmail-expiry-target 'delete)
1435 (nnimap-request-article art group server (current-buffer))
1436 ;; hints for optimization in `nnimap-request-accept-article'
1437 (let ((nnimap-current-move-article art)
1438 (nnimap-current-move-group group)
1439 (nnimap-current-move-server server))
1440 (nnmail-expiry-target-group nnmail-expiry-target group))))
1441 ;; It is not clear if `nnmail-expiry-target' somehow cause the
1442 ;; current group to be changed or not, so we make sure here.
1443 (nnimap-possibly-change-group group server)))
1445 ;; Notice that we don't actually delete anything, we just mark them deleted.
1446 (deffoo nnimap-request-expire-articles (articles group &optional server force)
1447 (let ((artseq (gnus-compress-sequence articles)))
1448 (when (and artseq (nnimap-possibly-change-group group server))
1449 (with-current-buffer nnimap-server-buffer
1450 (let ((days (or (and nnmail-expiry-wait-function
1451 (funcall nnmail-expiry-wait-function group))
1452 nnmail-expiry-wait)))
1453 (cond ((or force (eq days 'immediate))
1454 (let ((oldarts (imap-search
1456 (imap-range-to-message-set artseq)))))
1458 (nnimap-expiry-target oldarts group server)
1459 (when (imap-message-flags-add
1460 (imap-range-to-message-set
1461 (gnus-compress-sequence oldarts)) "\\Deleted")
1462 (setq articles (gnus-set-difference
1463 articles oldarts))))))
1465 (let ((oldarts (imap-search
1466 (format nnimap-expunge-search-string
1467 (imap-range-to-message-set artseq)
1468 (nnimap-date-days-ago days))))
1469 (imap-fetch-data-hook
1470 '(nnimap-request-expire-articles-progress)))
1472 (nnimap-expiry-target oldarts group server)
1473 (when (imap-message-flags-add
1474 (imap-range-to-message-set
1475 (gnus-compress-sequence oldarts)) "\\Deleted")
1476 (setq articles (gnus-set-difference
1477 articles oldarts)))))))))))
1478 ;; return articles not deleted
1481 (deffoo nnimap-request-move-article (article group server
1482 accept-form &optional last)
1483 (when (nnimap-possibly-change-server server)
1485 (let ((buf (get-buffer-create " *nnimap move*"))
1486 (nnimap-current-move-article article)
1487 (nnimap-current-move-group group)
1488 (nnimap-current-move-server nnimap-current-server)
1490 (and (nnimap-request-article article group server)
1493 (buffer-disable-undo (current-buffer))
1494 (insert-buffer-substring nntp-server-buffer)
1495 (setq result (eval accept-form))
1498 (imap-message-flags-add
1499 (imap-range-to-message-set (list article))
1500 "\\Deleted" 'silent nnimap-server-buffer))
1503 (deffoo nnimap-request-accept-article (group &optional server last)
1504 (when (nnimap-possibly-change-server server)
1507 (if (string= nnimap-current-server nnimap-current-move-server)
1508 ;; moving article within same server, speed it up...
1509 (and (nnimap-possibly-change-group
1510 nnimap-current-move-group)
1511 (imap-message-copy (number-to-string
1512 nnimap-current-move-article)
1513 group 'dontcreate nil
1514 nnimap-server-buffer))
1515 (with-current-buffer (current-buffer)
1516 (goto-char (point-min))
1517 ;; remove any 'From blabla' lines, some IMAP servers
1518 ;; reject the entire message otherwise.
1519 (when (looking-at "^From[^:]")
1520 (delete-region (point) (progn (forward-line) (point))))
1521 ;; turn into rfc822 format (\r\n eol's)
1522 (while (search-forward "\n" nil t)
1523 (replace-match "\r\n"))
1524 (when nnmail-cache-accepted-message-ids
1525 (nnmail-cache-insert (nnmail-fetch-field "message-id")
1527 (nnmail-fetch-field "subject"))))
1528 (when (and last nnmail-cache-accepted-message-ids)
1529 (nnmail-cache-close))
1530 ;; this 'or' is for Cyrus server bug
1531 (or (null (imap-current-mailbox nnimap-server-buffer))
1532 (imap-mailbox-unselect nnimap-server-buffer))
1533 (imap-message-append group (current-buffer) nil nil
1534 nnimap-server-buffer)))
1535 (cons group (nth 1 uid))
1536 (nnheader-report 'nnimap (imap-error-text nnimap-server-buffer))))))
1538 (deffoo nnimap-request-delete-group (group force &optional server)
1539 (when (nnimap-possibly-change-server server)
1540 (with-current-buffer nnimap-server-buffer
1542 (or (null (imap-mailbox-status group 'uidvalidity))
1543 (imap-mailbox-delete group))
1547 (deffoo nnimap-request-rename-group (group new-name &optional server)
1548 (when (nnimap-possibly-change-server server)
1549 (imap-mailbox-rename group new-name nnimap-server-buffer)))
1551 (defun nnimap-expunge (mailbox server)
1552 (when (nnimap-possibly-change-group mailbox server)
1553 (imap-mailbox-expunge nil nnimap-server-buffer)))
1555 (defun nnimap-acl-get (mailbox server)
1556 (when (nnimap-possibly-change-server server)
1557 (and (imap-capability 'ACL nnimap-server-buffer)
1558 (imap-mailbox-acl-get mailbox nnimap-server-buffer))))
1560 (defun nnimap-acl-edit (mailbox method old-acls new-acls)
1561 (when (nnimap-possibly-change-server (cadr method))
1562 (unless (imap-capability 'ACL nnimap-server-buffer)
1563 (error "Your server does not support ACL editing"))
1564 (with-current-buffer nnimap-server-buffer
1565 ;; delete all removed identifiers
1566 (mapc (lambda (old-acl)
1567 (unless (assoc (car old-acl) new-acls)
1568 (or (imap-mailbox-acl-delete (car old-acl) mailbox)
1569 (error "Can't delete ACL for %s" (car old-acl)))))
1571 ;; set all changed acl's
1572 (mapc (lambda (new-acl)
1573 (let ((new-rights (cdr new-acl))
1574 (old-rights (cdr (assoc (car new-acl) old-acls))))
1575 (unless (and old-rights new-rights
1576 (string= old-rights new-rights))
1577 (or (imap-mailbox-acl-set (car new-acl) new-rights mailbox)
1578 (error "Can't set ACL for %s to %s" (car new-acl)
1584 ;;; Internal functions
1587 ;; This is confusing.
1589 ;; mark => read, tick, draft, reply etc
1590 ;; flag => "\\Seen", "\\Flagged", "\\Draft", "gnus-expire" etc
1591 ;; predicate => "SEEN", "FLAGGED", "DRAFT", "KEYWORD gnus-expire" etc
1593 ;; Mark should not really contain 'read since it's not a "mark" in the Gnus
1594 ;; world, but we cheat. Mark == gnus-article-mark-lists + '(read . read).
1597 (defconst nnimap-mark-to-predicate-alist
1599 (lambda (pair) ; cdr is the mark
1600 (or (assoc (cdr pair)
1605 (reply . "ANSWERED")))
1607 (format "KEYWORD gnus-%s" (symbol-name (cdr pair))))))
1608 (cons '(read . read) gnus-article-mark-lists)))
1610 (defun nnimap-mark-to-predicate (pred)
1611 "Convert a Gnus mark (a symbol such as read, tick, expire) to a IMAP predicate.
1612 This is a string such as \"SEEN\", \"FLAGGED\", \"KEYWORD gnus-expire\",
1613 to be used within a IMAP SEARCH query."
1614 (cdr (assq pred nnimap-mark-to-predicate-alist)))
1616 (defconst nnimap-mark-to-flag-alist
1619 (or (assoc (cdr pair)
1621 (tick . "\\Flagged")
1623 (recent . "\\Recent")
1624 (reply . "\\Answered")))
1626 (format "gnus-%s" (symbol-name (cdr pair))))))
1627 (cons '(read . read) gnus-article-mark-lists)))
1629 (defun nnimap-mark-to-flag-1 (preds)
1630 (if (and (not (null preds)) (listp preds))
1631 (cons (nnimap-mark-to-flag (car preds))
1632 (nnimap-mark-to-flag (cdr preds)))
1633 (cdr (assoc preds nnimap-mark-to-flag-alist))))
1635 (defun nnimap-mark-to-flag (preds &optional always-list make-string)
1636 "Convert a Gnus mark (a symbol such as read, tick, expire) to a IMAP flag.
1637 This is a string such as \"\\Seen\", \"\\Flagged\", \"gnus-expire\", to
1638 be used in a STORE FLAGS command."
1639 (let ((result (nnimap-mark-to-flag-1 preds)))
1640 (setq result (if (and (or make-string always-list)
1641 (not (listp result)))
1645 (mapconcat (lambda (flag)
1647 (mapconcat 'identity flag " ")
1652 (defun nnimap-mark-permanent-p (mark &optional group)
1653 "Return t iff MARK can be permanently (between IMAP sessions) saved on articles, in GROUP."
1654 (imap-message-flag-permanent-p (nnimap-mark-to-flag mark)))
1658 (buffer-disable-undo (get-buffer-create nnimap-debug-buffer))
1659 (mapcar (lambda (f) (trace-function-background f nnimap-debug-buffer))
1661 nnimap-possibly-change-server
1662 nnimap-verify-uidvalidity
1663 nnimap-find-minmax-uid
1664 nnimap-before-find-minmax-bugworkaround
1665 nnimap-possibly-change-group
1666 ;;nnimap-replace-whitespace
1667 nnimap-retrieve-headers-progress
1668 nnimap-retrieve-which-headers
1669 nnimap-group-overview-filename
1670 nnimap-retrieve-headers-from-file
1671 nnimap-retrieve-headers-from-server
1672 nnimap-retrieve-headers
1673 nnimap-open-connection
1675 nnimap-server-opened
1677 nnimap-request-close
1678 nnimap-status-message
1680 nnimap-request-article-part
1681 nnimap-request-article
1684 nnimap-request-group
1686 nnimap-pattern-to-list-arguments
1689 nnimap-retrieve-groups
1690 nnimap-request-update-info-internal
1692 nnimap-request-set-mark
1693 nnimap-split-to-groups
1694 nnimap-split-find-rule
1695 nnimap-split-find-inbox
1696 nnimap-split-articles
1698 nnimap-request-newgroups
1699 nnimap-request-create-group
1700 nnimap-time-substract
1701 nnimap-date-days-ago
1702 nnimap-request-expire-articles-progress
1703 nnimap-request-expire-articles
1704 nnimap-request-move-article
1705 nnimap-request-accept-article
1706 nnimap-request-delete-group
1707 nnimap-request-rename-group
1708 gnus-group-nnimap-expunge
1709 gnus-group-nnimap-edit-acl
1710 gnus-group-nnimap-edit-acl-done
1711 nnimap-group-mode-hook
1712 nnimap-mark-to-predicate
1713 nnimap-mark-to-flag-1
1715 nnimap-mark-permanent-p
1720 ;;; nnimap.el ends here