1 ;;; nnimap.el --- imap backend for Gnus
2 ;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003
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))
64 (eval-when-compile (require 'gnus-clfns))
75 (eval-when-compile (require 'cl))
79 (defconst nnimap-version "nnimap 1.0")
82 "Reading IMAP mail with Gnus."
85 (defvoo nnimap-address nil
86 "Address of physical IMAP server. If nil, use the virtual server's name.")
88 (defvoo nnimap-server-port nil
89 "Port number on physical IMAP server.
90 If nil, defaults to 993 for TLS/SSL connections and 143 otherwise.")
92 ;; Splitting variables
94 (defcustom nnimap-split-crosspost t
95 "If non-nil, do crossposting if several split methods match the mail.
96 If nil, the first match found will be used."
100 (defcustom nnimap-split-inbox nil
101 "Name of mailbox to split mail from.
103 Mail is read from this mailbox and split according to rules in
106 This can be a string or a list of strings."
108 :type '(choice (string)
111 (define-widget 'nnimap-strict-function 'function
112 "This widget only matches values that are functionp.
114 Warning: This means that a value that is the symbol of a not yet
115 loaded function will not match. Use with care."
116 :match 'nnimap-strict-function-match)
118 (defun nnimap-strict-function-match (widget value)
119 "Ignoring WIDGET, match if VALUE is a function."
122 (defcustom nnimap-split-rule nil
123 "Mail will be split according to these rules.
125 Mail is read from mailbox(es) specified in `nnimap-split-inbox'.
127 If you'd like, for instance, one mail group for mail from the
128 \"gnus-imap\" mailing list, one group for junk mail and leave
129 everything else in the incoming mailbox, you could do something like
132 \(setq nnimap-split-rule '((\"INBOX.gnus-imap\" \"From:.*gnus-imap\")
133 (\"INBOX.junk\" \"Subject:.*buy\")))
135 As you can see, `nnimap-split-rule' is a list of lists, where the
136 first element in each \"rule\" is the name of the IMAP mailbox (or the
137 symbol `junk' if you want to remove the mail), and the second is a
138 regexp that nnimap will try to match on the header to find a fit.
140 The second element can also be a function. In that case, it will be
141 called narrowed to the headers with the first element of the rule as
142 the argument. It should return a non-nil value if it thinks that the
143 mail belongs in that group.
145 This variable can also have a function as its value, the function will
146 be called with the headers narrowed and should return a group where it
147 thinks the article should be splitted to. See `nnimap-split-fancy'.
149 To allow for different split rules on different virtual servers, and
150 even different split rules in different inboxes on the same server,
151 the syntax of this variable have been extended along the lines of:
153 \(setq nnimap-split-rule
154 '((\"my1server\" (\".*\" ((\"ding\" \"ding@gnus.org\")
155 (\"junk\" \"From:.*Simon\")))
156 (\"my2server\" (\"INBOX\" nnimap-split-fancy))
157 (\"my[34]server\" (\".*\" ((\"private\" \"To:.*Simon\")
158 (\"junk\" my-junk-func)))))
160 The virtual server name is in fact a regexp, so that the same rules
161 may apply to several servers. In the example, the servers
162 \"my3server\" and \"my4server\" both use the same rules. Similarly,
163 the inbox string is also a regexp. The actual splitting rules are as
164 before, either a function, or a list with group/regexp or
165 group/function elements."
167 :type '(choice :tag "Rule type"
168 (repeat :menu-tag "Single-server"
169 :tag "Single-server list"
170 (list (string :tag "Mailbox")
171 (choice :tag "Predicate"
172 (regexp :tag "A regexp")
173 (nnimap-strict-function :tag "A function"))))
174 (choice :menu-tag "A function"
176 (function-item nnimap-split-fancy)
177 (function-item nnmail-split-fancy)
178 (nnimap-strict-function :tag "User-defined function"))
179 (repeat :menu-tag "Multi-server (extended)"
180 :tag "Multi-server list"
181 (list (regexp :tag "Server regexp")
182 (list (regexp :tag "Incoming Mailbox regexp")
183 (repeat :tag "Rules for matching server(s) and mailbox(es)"
184 (list (string :tag "Destination mailbox")
185 (choice :tag "Predicate"
186 (regexp :tag "A Regexp")
187 (nnimap-strict-function :tag "A Function")))))))))
189 (defcustom nnimap-split-predicate "UNSEEN UNDELETED"
190 "The predicate used to find articles to split.
191 If you use another IMAP client to peek on articles but always would
192 like nnimap to split them once it's started, you could change this to
193 \"UNDELETED\". Other available predicates are available in
194 RFC2060 section 6.4.4."
198 (defcustom nnimap-split-fancy nil
199 "Like the variable `nnmail-split-fancy'."
203 (defvar nnimap-split-download-body-default nil
204 "Internal variable with default value for `nnimap-split-download-body'.")
206 (defcustom nnimap-split-download-body 'default
207 "Whether to download entire articles during splitting.
208 This is generally not required, and will slow things down considerably.
209 You may need it if you want to use an advanced splitting function that
210 analyses the body before splitting the article.
211 If this variable is nil, bodies will not be downloaded; if this
212 variable is the symbol `default' the default behaviour is
213 used (which currently is nil, unless you use a statistical
214 spam.el test); if this variable is another non-nil value bodies
217 :type '(choice (const :tag "Let system decide" deault)
220 ;; Performance / bug workaround variables
222 (defcustom nnimap-close-asynchronous t
223 "Close mailboxes asynchronously in `nnimap-close-group'.
224 This means that errors cought by nnimap when closing the mailbox will
225 not prevent Gnus from updating the group status, which may be harmful.
226 However, it increases speed."
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."
238 (defcustom nnimap-retrieve-groups-asynchronous t
239 "Send asynchronous STATUS commands for each mailbox before checking mail.
240 If you have mailboxes that rarely receives mail, this speeds up new
241 mail checking. It works by first sending STATUS commands for each
242 mailbox, and then only checking groups which has a modified UIDNEXT
243 more carefully for new mail.
245 In summary, the default is O((1-p)*k+p*n) and changing it to nil makes
246 it O(n). If p is small, then the default is probably faster."
250 (defvoo nnimap-need-unselect-to-notice-new-mail nil
251 "Unselect mailboxes before looking for new mail in them.
252 Some servers seem to need this under some circumstances.")
254 ;; Authorization / Privacy variables
256 (defvoo nnimap-auth-method nil
259 (defvoo nnimap-stream nil
260 "How nnimap will connect to the server.
262 The default, nil, will try to use the \"best\" method the server can
267 1) you want to connect with TLS/SSL. The TLS/SSL integration
268 with IMAP is suboptimal so you'll have to tell it
271 2) your server is more capable than your environment -- i.e. your
272 server accept Kerberos login's but you haven't installed the
273 `imtest' program or your machine isn't configured for Kerberos.
275 Possible choices: gssapi, kerberos4, starttls, tls, ssl, network, shell.
276 See also `imap-streams' and `imap-stream-alist'.")
278 (defvoo nnimap-authenticator nil
279 "How nnimap authenticate itself to the server.
281 The default, nil, will try to use the \"best\" method the server can
284 There is only one reason for fiddling with this variable, and that is
285 if your server is more capable than your environment -- i.e. you
286 connect to a server that accept Kerberos login's but you haven't
287 installed the `imtest' program or your machine isn't configured for
290 Possible choices: gssapi, kerberos4, digest-md5, cram-md5, login, anonymous.
291 See also `imap-authenticators' and `imap-authenticator-alist'")
293 (defvoo nnimap-directory (nnheader-concat gnus-directory "overview/")
294 "Directory to keep NOV cache files for nnimap groups.
295 See also `nnimap-nov-file-name'.")
297 (defvoo nnimap-nov-file-name "nnimap."
298 "NOV cache base filename.
299 The group name and `nnimap-nov-file-name-suffix' will be appended. A
300 typical complete file name would be
301 ~/News/overview/nnimap.pdc.INBOX.ding.nov, or
302 ~/News/overview/nnimap/pdc/INBOX/ding/nov if
303 `nnmail-use-long-file-names' is nil")
305 (defvoo nnimap-nov-file-name-suffix ".novcache"
306 "Suffix for NOV cache base filename.")
308 (defvoo nnimap-nov-is-evil gnus-agent
309 "If non-nil, never generate or use a local nov database for this backend.
310 Using nov databases should speed up header fetching considerably.
311 However, it will invoke a UID SEARCH UID command on the server, and
312 some servers implement this command inefficiently by opening each and
313 every message in the group, thus making it quite slow.
314 Unlike other backends, you do not need to take special care if you
315 flip this variable.")
317 (defvoo nnimap-expunge-on-close 'always ; 'ask, 'never
318 "Whether to expunge a group when it is closed.
319 When a IMAP group with articles marked for deletion is closed, this
320 variable determine if nnimap should actually remove the articles or
323 If always, nnimap always perform a expunge when closing the group.
324 If never, nnimap never expunges articles marked for deletion.
325 If ask, nnimap will ask you if you wish to expunge marked articles.
327 When setting this variable to `never', you can only expunge articles
328 by using `G x' (gnus-group-nnimap-expunge) from the Group buffer.")
330 (defvoo nnimap-list-pattern "*"
331 "A string LIMIT or list of strings with mailbox wildcards used to limit available groups.
332 See below for available wildcards.
334 The LIMIT string can be a cons cell (REFERENCE . LIMIT), where
335 REFERENCE will be passed as the first parameter to LIST/LSUB. The
336 semantics of this are server specific, on the University of Washington
337 server you can specify a directory.
340 '(\"INBOX\" \"mail/*\" (\"~friend/mail/\" . \"list/*\"))
342 There are two wildcards * and %. * matches everything, % matches
343 everything in the current hierarchy.")
345 (defvoo nnimap-news-groups nil
346 "IMAP support a news-like mode, also known as bulletin board mode,
347 where replies is sent via IMAP instead of SMTP.
349 This variable should contain a regexp matching groups where you wish
350 replies to be stored to the mailbox directly.
353 '(\"^[^I][^N][^B][^O][^X].*$\")
355 This will match all groups not beginning with \"INBOX\".
357 Note that there is nothing technically different between mail-like and
358 news-like mailboxes. If you wish to have a group with todo items or
359 similar which you wouldn't want to set up a mailing list for, you can
360 use this to make replies go directly to the group.")
362 (defvoo nnimap-expunge-search-string "UID %s NOT SINCE %s"
363 "IMAP search command to use for articles that are to be expired.
364 The first %s is replaced by a UID set of articles to search on,
365 and the second %s is replaced by a date criterium.
367 One useful (and perhaps the only useful) value to change this to would
368 be `UID %s NOT SENTSINCE %s' to make nnimap use the Date: header
369 instead of the internal date of messages. See section 6.4.4 of RFC
370 2060 for more information on valid strings.")
372 (defvoo nnimap-importantize-dormant t
373 "If non-nil, mark \"dormant\" articles as \"ticked\" for other IMAP clients.
374 Note that within Gnus, dormant articles will still (only) be
375 marked as ticked. This is to make \"dormant\" articles stand out,
376 just like \"ticked\" articles, in other IMAP clients.")
378 (defvoo nnimap-server-address nil
379 "Obsolete. Use `nnimap-address'.")
381 (defcustom nnimap-authinfo-file "~/.authinfo"
382 "Authorization information for IMAP servers. In .netrc format."
385 (repeat :tag "Entries"
388 :value ("" ("login" . "") ("password" . ""))
392 (const :format "" "login")
393 (string :format "Login: %v"))
395 (const :format "" "password")
396 (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."
402 (defvar nnimap-request-list-method 'imap-mailbox-list
403 "Method to use to request a list of all folders from the server.
404 If this is 'imap-mailbox-lsub, then use a server-side subscription list to
405 restrict visible folders.")
407 (defcustom nnimap-debug nil
408 "If non-nil, random debug spews are placed in *nnimap-debug* buffer."
412 ;; Internal variables:
414 (defvar nnimap-debug-buffer "*nnimap-debug*")
415 (defvar nnimap-mailbox-info (gnus-make-hashtable 997))
416 (defvar nnimap-current-move-server nil)
417 (defvar nnimap-current-move-group nil)
418 (defvar nnimap-current-move-article nil)
419 (defvar nnimap-length)
420 (defvar nnimap-progress-chars '(?| ?/ ?- ?\\))
421 (defvar nnimap-progress-how-often 20)
422 (defvar nnimap-counter)
423 (defvar nnimap-server-buffer-alist nil) ;; Map server name to buffers.
424 (defvar nnimap-current-server nil) ;; Current server
425 (defvar nnimap-server-buffer nil) ;; Current servers' buffer
429 (nnoo-define-basics nnimap)
431 ;; Utility functions:
433 (defsubst nnimap-get-server-buffer (server)
434 "Return buffer for SERVER, if nil use current server."
435 (cadr (assoc (or server nnimap-current-server) nnimap-server-buffer-alist)))
437 (defun nnimap-possibly-change-server (server)
438 "Return buffer for SERVER, changing the current server as a side-effect.
439 If SERVER is nil, uses the current server."
440 (setq nnimap-current-server (or server nnimap-current-server)
441 nnimap-server-buffer (nnimap-get-server-buffer nnimap-current-server)))
443 (defun nnimap-verify-uidvalidity (group server)
444 "Verify stored uidvalidity match current one in GROUP on SERVER."
445 (let* ((gnusgroup (gnus-group-prefixed-name
446 group (gnus-server-to-method
447 (format "nnimap:%s" server))))
448 (new-uidvalidity (imap-mailbox-get 'uidvalidity))
449 (old-uidvalidity (gnus-group-get-parameter gnusgroup 'uidvalidity))
450 (dir (file-name-as-directory (expand-file-name nnimap-directory)))
451 (nameuid (nnheader-translate-file-chars
452 (concat nnimap-nov-file-name
453 (if (equal server "")
455 server) "." group "." old-uidvalidity
456 nnimap-nov-file-name-suffix) t))
457 (file (if (or nnmail-use-long-file-names
458 (file-exists-p (expand-file-name nameuid dir)))
459 (expand-file-name nameuid dir)
461 (encode-coding-string
462 (nnheader-replace-chars-in-string nameuid ?. ?/)
463 nnmail-pathname-coding-system)
466 (if (not (equal old-uidvalidity new-uidvalidity))
468 (gnus-delete-file file)
469 (gnus-group-set-parameter gnusgroup 'uidvalidity new-uidvalidity)
471 (gnus-group-add-parameter gnusgroup (cons 'uidvalidity new-uidvalidity))
474 (defun nnimap-before-find-minmax-bugworkaround ()
475 "Function called before iterating through mailboxes with
476 `nnimap-find-minmax-uid'."
477 (when nnimap-need-unselect-to-notice-new-mail
478 ;; XXX this is for UoW imapd problem, it doesn't notice new mail in
479 ;; currently selected mailbox without a re-select/examine.
480 (or (null (imap-current-mailbox nnimap-server-buffer))
481 (imap-mailbox-unselect nnimap-server-buffer))))
483 (defun nnimap-find-minmax-uid (group &optional examine)
484 "Find lowest and highest active article number in GROUP.
485 If EXAMINE is non-nil the group is selected read-only."
486 (with-current-buffer nnimap-server-buffer
487 (when (or (string= group (imap-current-mailbox))
488 (imap-mailbox-select group examine))
490 (when (> (imap-mailbox-get 'exists) 0)
491 (imap-fetch "1,*" "UID" nil 'nouidfetch)
492 (imap-message-map (lambda (uid Uid)
493 (setq minuid (if minuid (min minuid uid) uid)
494 maxuid (if maxuid (max maxuid uid) uid)))
496 (list (imap-mailbox-get 'exists) minuid maxuid)))))
498 (defun nnimap-possibly-change-group (group &optional server)
499 "Make GROUP the current group, and SERVER the current server."
500 (when (nnimap-possibly-change-server server)
501 (with-current-buffer nnimap-server-buffer
502 (if (or (null group) (imap-current-mailbox-p group))
504 (if (imap-mailbox-select group)
505 (if (or (nnimap-verify-uidvalidity
506 group (or server nnimap-current-server))
507 (zerop (imap-mailbox-get 'exists group))
508 t ;; for OGnus to see if ignoring uidvalidity
509 ;; changes has any bad effects.
512 "nnimap: Group %s is not uidvalid. Continue? " group)))
514 (imap-mailbox-unselect)
515 (error "nnimap: Group %s is not uid-valid" group))
516 (nnheader-report 'nnimap (imap-error-text)))))))
518 (defun nnimap-replace-whitespace (string)
519 "Return STRING with all whitespace replaced with space."
521 (while (string-match "[\r\n\t]+" string)
522 (setq string (replace-match " " t t string)))
525 ;; Required backend functions
527 (defun nnimap-retrieve-headers-progress ()
528 "Hook to insert NOV line for current article into `nntp-server-buffer'."
529 (and (numberp nnmail-large-newsgroup)
530 (zerop (% (incf nnimap-counter) nnimap-progress-how-often))
531 (> nnimap-length nnmail-large-newsgroup)
532 (nnheader-message 6 "nnimap: Retrieving headers... %c"
533 (nth (/ (% nnimap-counter
534 (* (length nnimap-progress-chars)
535 nnimap-progress-how-often))
536 nnimap-progress-how-often)
537 nnimap-progress-chars)))
538 (with-current-buffer nntp-server-buffer
539 (let (headers lines chars uid mbx)
540 (with-current-buffer nnimap-server-buffer
541 (setq uid imap-current-message
542 mbx imap-current-mailbox
543 headers (nnimap-demule
544 (if (imap-capability 'IMAP4rev1)
545 ;; xxx don't just use car? alist doesn't contain
546 ;; anything else now, but it might...
547 (nth 2 (car (imap-message-get uid 'BODYDETAIL)))
548 (imap-message-get uid 'RFC822.HEADER)))
549 lines (imap-body-lines (imap-message-body imap-current-message))
550 chars (imap-message-get imap-current-message 'RFC822.SIZE)))
553 (buffer-disable-undo)
555 (let ((head (nnheader-parse-naked-head)))
556 (mail-header-set-number head uid)
557 (mail-header-set-chars head chars)
558 (mail-header-set-lines head lines)
559 (mail-header-set-xref
560 head (format "%s %s:%d" (system-name) mbx uid))
563 (defun nnimap-retrieve-which-headers (articles fetch-old)
564 "Get a range of articles to fetch based on ARTICLES and FETCH-OLD."
565 (with-current-buffer nnimap-server-buffer
566 (if (numberp (car-safe articles))
569 (imap-range-to-message-set
570 (gnus-compress-sequence
571 (append (gnus-uncompress-sequence
573 (cons (if (numberp fetch-old)
574 (max 1 (- (car articles) fetch-old))
576 (1- (car articles)))))
578 (mapcar (lambda (msgid)
580 (format "HEADER Message-Id \"%s\"" msgid)))
583 (defun nnimap-group-overview-filename (group server)
584 "Make file name for GROUP on SERVER."
585 (let* ((dir (file-name-as-directory (expand-file-name nnimap-directory)))
586 (uidvalidity (gnus-group-get-parameter
587 (gnus-group-prefixed-name
588 group (gnus-server-to-method
589 (format "nnimap:%s" server)))
591 (name (nnheader-translate-file-chars
592 (concat nnimap-nov-file-name
593 (if (equal server "")
595 server) "." group nnimap-nov-file-name-suffix) t))
596 (nameuid (nnheader-translate-file-chars
597 (concat nnimap-nov-file-name
598 (if (equal server "")
600 server) "." group "." uidvalidity
601 nnimap-nov-file-name-suffix) t))
602 (oldfile (if (or nnmail-use-long-file-names
603 (file-exists-p (expand-file-name name dir)))
604 (expand-file-name name dir)
606 (encode-coding-string
607 (nnheader-replace-chars-in-string name ?. ?/)
608 nnmail-pathname-coding-system)
610 (newfile (if (or nnmail-use-long-file-names
611 (file-exists-p (expand-file-name nameuid dir)))
612 (expand-file-name nameuid dir)
614 (encode-coding-string
615 (nnheader-replace-chars-in-string nameuid ?. ?/)
616 nnmail-pathname-coding-system)
618 (when (and (file-exists-p oldfile) (not (file-exists-p newfile)))
619 (message "nnimap: Upgrading novcache filename...")
621 (gnus-make-directory (file-name-directory newfile))
622 (unless (ignore-errors (rename-file oldfile newfile) t)
623 (if (ignore-errors (copy-file oldfile newfile) t)
624 (delete-file oldfile)
625 (error "Can't rename `%s' to `%s'" oldfile newfile))))
628 (defun nnimap-retrieve-headers-from-file (group server)
629 (with-current-buffer nntp-server-buffer
630 (let ((nov (nnimap-group-overview-filename group server)))
631 (when (file-exists-p nov)
632 (nnheader-insert-file-contents nov)
633 (set-buffer-modified-p nil)
634 (let ((min (ignore-errors (goto-char (point-min))
635 (read (current-buffer))))
636 (max (ignore-errors (goto-char (point-max))
638 (read (current-buffer)))))
639 (if (and (numberp min) (numberp max))
641 ;; junk, remove it, it's saved later
645 (defun nnimap-retrieve-headers-from-server (articles group server)
646 (with-current-buffer nnimap-server-buffer
647 (let ((imap-fetch-data-hook '(nnimap-retrieve-headers-progress))
648 (nnimap-length (gnus-range-length articles))
650 (imap-fetch (imap-range-to-message-set articles)
651 (concat "(UID RFC822.SIZE BODY "
653 (append '(Subject From Date Message-Id
654 References In-Reply-To Xref)
656 nnmail-extra-headers))))
657 (if (imap-capability 'IMAP4rev1)
658 (format "BODY.PEEK[HEADER.FIELDS %s])" headers)
659 (format "RFC822.HEADER.LINES %s)" headers)))))
660 (and (numberp nnmail-large-newsgroup)
661 (> nnimap-length nnmail-large-newsgroup)
662 (nnheader-message 6 "nnimap: Retrieving headers...done")))))
664 (defun nnimap-dont-use-nov-p (group server)
665 (or gnus-nov-is-evil nnimap-nov-is-evil
666 (unless (and (gnus-make-directory
668 (nnimap-group-overview-filename group server)))
670 (nnimap-group-overview-filename group server)))
671 (message "nnimap: Nov cache not writable, %s"
672 (nnimap-group-overview-filename group server)))))
674 (deffoo nnimap-retrieve-headers (articles &optional group server fetch-old)
675 (when (nnimap-possibly-change-group group server)
676 (with-current-buffer nntp-server-buffer
678 (if (nnimap-dont-use-nov-p group server)
679 (nnimap-retrieve-headers-from-server
680 (gnus-compress-sequence articles) group server)
681 (let (uids cached low high)
682 (when (setq uids (nnimap-retrieve-which-headers articles fetch-old)
684 high (car (last uids)))
685 (if (setq cached (nnimap-retrieve-headers-from-file group server))
687 ;; fetch articles with uids before cache block
688 (when (< low (car cached))
689 (goto-char (point-min))
690 (nnimap-retrieve-headers-from-server
691 (cons low (1- (car cached))) group server))
692 ;; fetch articles with uids after cache block
693 (when (> high (cdr cached))
694 (goto-char (point-max))
695 (nnimap-retrieve-headers-from-server
696 (cons (1+ (cdr cached)) high) group server))
697 (when nnimap-prune-cache
698 ;; remove nov's for articles which has expired on server
699 (goto-char (point-min))
700 (dolist (uid (gnus-set-difference articles uids))
701 (when (re-search-forward (format "^%d\t" uid) nil t)
702 (gnus-delete-line)))))
703 ;; nothing cached, fetch whole range from server
704 (nnimap-retrieve-headers-from-server
705 (cons low high) group server))
706 (when (buffer-modified-p)
708 (point-min) (point-max)
709 (nnimap-group-overview-filename group server) nil 'nomesg))
710 (nnheader-nov-delete-outside-range low high))))
713 (defun nnimap-open-connection (server)
714 (if (not (imap-open nnimap-address nnimap-server-port nnimap-stream
715 nnimap-authenticator nnimap-server-buffer))
716 (nnheader-report 'nnimap "Can't open connection to server %s" server)
717 (unless (or (imap-capability 'IMAP4 nnimap-server-buffer)
718 (imap-capability 'IMAP4rev1 nnimap-server-buffer))
719 (imap-close nnimap-server-buffer)
720 (nnheader-report 'nnimap "Server %s is not IMAP4 compliant" server))
721 (let* ((list (gnus-parse-netrc nnimap-authinfo-file))
722 (port (if nnimap-server-port
723 (int-to-string nnimap-server-port)
725 (alist (or (gnus-netrc-machine list server port "imap")
726 (gnus-netrc-machine list
727 (or nnimap-server-address
730 (user (gnus-netrc-get alist "login"))
731 (passwd (gnus-netrc-get alist "password")))
732 (if (imap-authenticate user passwd nnimap-server-buffer)
734 (push (list server nnimap-server-buffer)
735 nnimap-server-buffer-alist)
736 (nnimap-possibly-change-server server))
737 (imap-close nnimap-server-buffer)
738 (kill-buffer nnimap-server-buffer)
739 (nnheader-report 'nnimap "Could not authenticate to %s" server)))))
741 (deffoo nnimap-open-server (server &optional defs)
742 (nnheader-init-server-buffer)
743 (if (nnimap-server-opened server)
745 (unless (assq 'nnimap-server-buffer defs)
746 (push (list 'nnimap-server-buffer (concat " *nnimap* " server)) defs))
747 ;; translate `nnimap-server-address' to `nnimap-address' in defs
748 ;; for people that configured nnimap with a very old version
749 (unless (assq 'nnimap-address defs)
750 (if (assq 'nnimap-server-address defs)
751 (push (list 'nnimap-address
752 (cadr (assq 'nnimap-server-address defs))) defs)
753 (push (list 'nnimap-address server) defs)))
754 (nnoo-change-server 'nnimap server defs)
755 (or nnimap-server-buffer
756 (setq nnimap-server-buffer (cadr (assq 'nnimap-server-buffer defs))))
757 (with-current-buffer (get-buffer-create nnimap-server-buffer)
758 (nnoo-change-server 'nnimap server defs))
759 (or (and nnimap-server-buffer
760 (imap-opened nnimap-server-buffer)
761 (if (with-current-buffer nnimap-server-buffer
762 (memq imap-state '(auth select examine)))
764 (imap-close nnimap-server-buffer)
765 (nnimap-open-connection server)))
766 (nnimap-open-connection server))))
768 (deffoo nnimap-server-opened (&optional server)
769 "Whether SERVER is opened.
770 If SERVER is the current virtual server, and the connection to the
771 physical server is alive, this function return a non-nil value. If
772 SERVER is nil, it is treated as the current server."
773 ;; clean up autologouts??
774 (and (or server nnimap-current-server)
775 (nnoo-server-opened 'nnimap (or server nnimap-current-server))
776 (imap-opened (nnimap-get-server-buffer server))))
778 (deffoo nnimap-close-server (&optional server)
779 "Close connection to server and free all resources connected to it.
780 Return nil if the server couldn't be closed for some reason."
781 (let ((server (or server nnimap-current-server)))
782 (when (or (nnimap-server-opened server)
783 (imap-opened (nnimap-get-server-buffer server)))
784 (imap-close (nnimap-get-server-buffer server))
785 (kill-buffer (nnimap-get-server-buffer server))
786 (setq nnimap-server-buffer nil
787 nnimap-current-server nil
788 nnimap-server-buffer-alist
789 (delq server nnimap-server-buffer-alist)))
790 (nnoo-close-server 'nnimap server)))
792 (deffoo nnimap-request-close ()
793 "Close connection to all servers and free all resources that the backend have reserved.
794 All buffers that have been created by that
795 backend should be killed. (Not the nntp-server-buffer, though.) This
796 function is generally only called when Gnus is shutting down."
797 (mapcar (lambda (server) (nnimap-close-server (car server)))
798 nnimap-server-buffer-alist)
799 (setq nnimap-server-buffer-alist nil))
801 (deffoo nnimap-status-message (&optional server)
802 "This function returns the last error message from server."
803 (when (nnimap-possibly-change-server server)
804 (nnoo-status-message 'nnimap server)))
806 (defun nnimap-demule (string)
807 (funcall (if (and (fboundp 'string-as-multibyte)
808 (subrp (symbol-function 'string-as-multibyte)))
813 (defun nnimap-make-callback (article gnus-callback buffer)
814 "Return a callback function."
816 (nnimap-callback ,article ,gnus-callback ,buffer)))
818 (defun nnimap-callback (article gnus-callback buffer)
819 (when (eq article (imap-current-message))
820 (remove-hook 'imap-fetch-data-hook
821 (nnimap-make-callback article gnus-callback buffer))
822 (with-current-buffer buffer
824 (with-current-buffer nnimap-server-buffer
826 (if (imap-capability 'IMAP4rev1)
827 ;; xxx don't just use car? alist doesn't contain
828 ;; anything else now, but it might...
829 (nth 2 (car (imap-message-get article 'BODYDETAIL)))
830 (imap-message-get article 'RFC822)))))
831 (nnheader-ms-strip-cr)
832 (funcall gnus-callback t))))
834 (defun nnimap-request-article-part (article part prop &optional
835 group server to-buffer detail)
836 (when (nnimap-possibly-change-group group server)
837 (let ((article (if (stringp article)
838 (car-safe (imap-search
839 (format "HEADER Message-Id \"%s\"" article)
840 nnimap-server-buffer))
843 (gnus-message 10 "nnimap: Fetching (part of) article %d from %s..."
844 article (or group imap-current-mailbox
845 gnus-newsgroup-name))
846 (if (not nnheader-callback-function)
847 (with-current-buffer (or to-buffer nntp-server-buffer)
849 (let ((data (imap-fetch article part prop nil
850 nnimap-server-buffer)))
852 (insert (nnimap-demule (if detail (nth 2 (car data)) data)))
853 (nnheader-ms-strip-cr)
855 10 "nnimap: Fetching (part of) article %d from %s...done"
856 article (or group imap-current-mailbox gnus-newsgroup-name))
858 (nnheader-report 'nnimap "No such article %d in %s: %s"
859 article (or group imap-current-mailbox
861 (imap-error-text nnimap-server-buffer))
862 (cons group article)))))
863 (add-hook 'imap-fetch-data-hook
864 (nnimap-make-callback article
865 nnheader-callback-function
867 (imap-fetch-asynch article part nil nnimap-server-buffer)
868 (cons group article))))))
870 (deffoo nnimap-asynchronous-p ()
873 (deffoo nnimap-request-article (article &optional group server to-buffer)
874 (if (imap-capability 'IMAP4rev1 nnimap-server-buffer)
875 (nnimap-request-article-part
876 article "BODY.PEEK[]" 'BODYDETAIL group server to-buffer 'detail)
877 (nnimap-request-article-part
878 article "RFC822.PEEK" 'RFC822 group server to-buffer)))
880 (deffoo nnimap-request-head (article &optional group server to-buffer)
881 (if (imap-capability 'IMAP4rev1 nnimap-server-buffer)
882 (nnimap-request-article-part
883 article "BODY.PEEK[HEADER]" 'BODYDETAIL group server to-buffer 'detail)
884 (nnimap-request-article-part
885 article "RFC822.HEADER" 'RFC822.HEADER group server to-buffer)))
887 (deffoo nnimap-request-body (article &optional group server to-buffer)
888 (if (imap-capability 'IMAP4rev1 nnimap-server-buffer)
889 (nnimap-request-article-part
890 article "BODY.PEEK[TEXT]" 'BODYDETAIL group server to-buffer 'detail)
891 (nnimap-request-article-part
892 article "RFC822.TEXT.PEEK" 'RFC822.TEXT group server to-buffer)))
894 (deffoo nnimap-request-group (group &optional server fast)
895 (nnimap-request-update-info-internal
897 (gnus-get-info (gnus-group-prefixed-name
898 group (gnus-server-to-method (format "nnimap:%s" server))))
900 (when (nnimap-possibly-change-group group server)
901 (nnimap-before-find-minmax-bugworkaround)
904 ((null (setq info (nnimap-find-minmax-uid group t)))
905 (nnheader-report 'nnimap "Could not get active info for %s"
908 (nnheader-insert "211 %d %d %d %s\n" (or (nth 0 info) 0)
909 (max 1 (or (nth 1 info) 1))
910 (or (nth 2 info) 0) group)
911 (nnheader-report 'nnimap "Group %s selected" group)
914 (defun nnimap-update-unseen (group &optional server)
915 "Update the unseen count in `nnimap-mailbox-info'."
917 (gnus-group-prefixed-name group server)
918 (let ((old (gnus-gethash-safe (gnus-group-prefixed-name group server)
919 nnimap-mailbox-info)))
920 (list (nth 0 old) (nth 1 old)
921 (imap-mailbox-status group 'unseen nnimap-server-buffer)
923 nnimap-mailbox-info))
925 (defun nnimap-close-group (group &optional server)
926 (with-current-buffer nnimap-server-buffer
927 (when (and (imap-opened)
928 (nnimap-possibly-change-group group server))
929 (nnimap-update-unseen group server)
930 (case nnimap-expunge-on-close
932 (imap-mailbox-expunge nnimap-close-asynchronous)
933 (unless nnimap-dont-close
934 (imap-mailbox-close nnimap-close-asynchronous))))
935 (ask (if (and (imap-search "DELETED")
936 (gnus-y-or-n-p (format "Expunge articles in group `%s'? "
937 imap-current-mailbox)))
939 (imap-mailbox-expunge nnimap-close-asynchronous)
940 (unless nnimap-dont-close
941 (imap-mailbox-close nnimap-close-asynchronous)))
942 (imap-mailbox-unselect)))
943 (t (imap-mailbox-unselect)))
944 (not imap-current-mailbox))))
946 (defun nnimap-pattern-to-list-arguments (pattern)
948 (cons (car-safe p) (or (cdr-safe p) p)))
949 (if (and (listp pattern)
950 (listp (cdr pattern)))
954 (deffoo nnimap-request-list (&optional server)
955 (when (nnimap-possibly-change-server server)
956 (with-current-buffer nntp-server-buffer
958 (gnus-message 5 "nnimap: Generating active list%s..."
959 (if (> (length server) 0) (concat " for " server) ""))
960 (nnimap-before-find-minmax-bugworkaround)
961 (with-current-buffer nnimap-server-buffer
962 (dolist (pattern (nnimap-pattern-to-list-arguments nnimap-list-pattern))
963 (dolist (mbx (funcall nnimap-request-list-method
964 (cdr pattern) (car pattern)))
965 (or (member "\\NoSelect" (imap-mailbox-get 'list-flags mbx))
966 (let ((info (nnimap-find-minmax-uid mbx 'examine)))
968 (with-current-buffer nntp-server-buffer
969 (insert (format "\"%s\" %d %d y\n"
970 mbx (or (nth 2 info) 0)
971 (max 1 (or (nth 1 info) 1)))))))))))
972 (gnus-message 5 "nnimap: Generating active list%s...done"
973 (if (> (length server) 0) (concat " for " server) ""))
976 (deffoo nnimap-request-post (&optional server)
978 (dolist (mbx (message-unquote-tokens
979 (message-tokenize-header
980 (message-fetch-field "Newsgroups") ", ")) success)
981 (let ((to-newsgroup (gnus-group-prefixed-name mbx gnus-command-method)))
982 (or (gnus-active to-newsgroup)
983 (gnus-activate-group to-newsgroup)
984 (if (gnus-y-or-n-p (format "No such group: %s. Create it? "
986 (or (and (gnus-request-create-group
987 to-newsgroup gnus-command-method)
988 (gnus-activate-group to-newsgroup nil nil
989 gnus-command-method))
990 (error "Couldn't create group %s" to-newsgroup)))
991 (error "No such group: %s" to-newsgroup))
992 (unless (nnimap-request-accept-article mbx (nth 1 gnus-command-method))
993 (setq success nil))))))
995 ;; Optional backend functions
997 (defun nnimap-string-lessp-numerical (s1 s2)
998 "Return t if first arg string is less than second in numerical order."
999 (cond ((string= s1 s2)
1001 ((> (length s1) (length s2))
1003 ((< (length s1) (length s2))
1005 ((< (string-to-number (substring s1 0 1))
1006 (string-to-number (substring s2 0 1)))
1008 ((> (string-to-number (substring s1 0 1))
1009 (string-to-number (substring s2 0 1)))
1012 (nnimap-string-lessp-numerical (substring s1 1) (substring s2 1)))))
1014 (deffoo nnimap-retrieve-groups (groups &optional server)
1015 (when (nnimap-possibly-change-server server)
1016 (gnus-message 5 "nnimap: Checking mailboxes...")
1017 (with-current-buffer nntp-server-buffer
1019 (nnimap-before-find-minmax-bugworkaround)
1020 (let (asyncgroups slowgroups)
1021 (if (null nnimap-retrieve-groups-asynchronous)
1022 (setq slowgroups groups)
1023 (dolist (group groups)
1024 (gnus-message 9 "nnimap: Quickly checking mailbox %s" group)
1025 (add-to-list (if (gnus-gethash-safe
1026 (gnus-group-prefixed-name group server)
1027 nnimap-mailbox-info)
1030 (list group (imap-mailbox-status-asynch
1031 group '(uidvalidity uidnext unseen)
1032 nnimap-server-buffer))))
1033 (dolist (asyncgroup asyncgroups)
1034 (let ((group (nth 0 asyncgroup))
1035 (tag (nth 1 asyncgroup))
1037 (when (imap-ok-p (imap-wait-for-tag tag nnimap-server-buffer))
1038 (if (or (not (string=
1039 (nth 0 (gnus-gethash (gnus-group-prefixed-name
1041 nnimap-mailbox-info))
1042 (imap-mailbox-get 'uidvalidity group
1043 nnimap-server-buffer)))
1045 (nth 1 (gnus-gethash (gnus-group-prefixed-name
1047 nnimap-mailbox-info))
1048 (imap-mailbox-get 'uidnext group
1049 nnimap-server-buffer))))
1050 (push (list group) slowgroups)
1051 (insert (nth 3 (gnus-gethash (gnus-group-prefixed-name
1053 nnimap-mailbox-info))))))))
1054 (dolist (group slowgroups)
1055 (if nnimap-retrieve-groups-asynchronous
1056 (setq group (car group)))
1057 (gnus-message 7 "nnimap: Mailbox %s modified" group)
1058 (imap-mailbox-put 'uidnext nil group nnimap-server-buffer)
1059 (or (member "\\NoSelect" (imap-mailbox-get 'list-flags group
1060 nnimap-server-buffer))
1061 (let* ((info (nnimap-find-minmax-uid group 'examine))
1062 (str (format "\"%s\" %d %d y\n" group
1064 (max 1 (or (nth 1 info) 1)))))
1065 (when (> (or (imap-mailbox-get 'recent group
1066 nnimap-server-buffer) 0)
1068 (push (list (cons group 0)) nnmail-split-history))
1070 (when nnimap-retrieve-groups-asynchronous
1072 (gnus-group-prefixed-name group server)
1073 (list (or (imap-mailbox-get
1074 'uidvalidity group nnimap-server-buffer)
1075 (imap-mailbox-status
1076 group 'uidvalidity nnimap-server-buffer))
1077 (or (imap-mailbox-get
1078 'uidnext group nnimap-server-buffer)
1079 (imap-mailbox-status
1080 group 'uidnext nnimap-server-buffer))
1081 (or (imap-mailbox-get
1082 'unseen group nnimap-server-buffer)
1083 (imap-mailbox-status
1084 group 'unseen nnimap-server-buffer))
1086 nnimap-mailbox-info)))))))
1087 (gnus-message 5 "nnimap: Checking mailboxes...done")
1090 (deffoo nnimap-request-update-info-internal (group info &optional server)
1091 (when (nnimap-possibly-change-group group server)
1092 (when info;; xxx what does this mean? should we create a info?
1093 (with-current-buffer nnimap-server-buffer
1094 (gnus-message 5 "nnimap: Updating info for %s..."
1095 (gnus-info-group info))
1097 (when (nnimap-mark-permanent-p 'read)
1099 ;; read info could contain articles marked unread by other
1100 ;; imap clients! we correct this
1101 (setq seen (gnus-uncompress-range (gnus-info-read info))
1102 unseen (imap-search "UNSEEN UNDELETED")
1103 seen (gnus-set-difference seen unseen)
1104 ;; seen might lack articles marked as read by other
1105 ;; imap clients! we correct this
1106 seen (append seen (imap-search "SEEN"))
1109 seen (gnus-compress-sequence seen t)
1110 ;; we can't return '(1) since this isn't a "list of ranges",
1111 ;; and we can't return '((1)) since g-list-of-unread-articles
1112 ;; is buggy so we return '((1 . 1)).
1113 seen (if (and (integerp (car seen))
1115 (list (cons (car seen) (car seen)))
1117 (gnus-info-set-read info seen)))
1119 (mapcar (lambda (pred)
1120 (when (or (eq (cdr pred) 'recent)
1121 (and (nnimap-mark-permanent-p (cdr pred))
1122 (member (nnimap-mark-to-flag (cdr pred))
1123 (imap-mailbox-get 'flags))))
1124 (gnus-info-set-marks
1126 (gnus-update-alist-soft
1128 (gnus-compress-sequence
1129 (imap-search (nnimap-mark-to-predicate (cdr pred))))
1130 (gnus-info-marks info))
1132 gnus-article-mark-lists)
1134 (when nnimap-importantize-dormant
1135 ;; nnimap mark dormant article as ticked too (for other clients)
1136 ;; so we remove that mark for gnus since we support dormant
1137 (gnus-info-set-marks
1139 (gnus-update-alist-soft
1141 (gnus-remove-from-range
1142 (cdr-safe (assoc 'tick (gnus-info-marks info)))
1143 (cdr-safe (assoc 'dormant (gnus-info-marks info))))
1144 (gnus-info-marks info))
1147 (gnus-message 5 "nnimap: Updating info for %s...done"
1148 (gnus-info-group info))
1152 (deffoo nnimap-request-type (group &optional article)
1153 (if (and nnimap-news-groups (string-match nnimap-news-groups group))
1157 (deffoo nnimap-request-set-mark (group actions &optional server)
1158 (when (nnimap-possibly-change-group group server)
1159 (with-current-buffer nnimap-server-buffer
1161 (gnus-message 7 "nnimap: Setting marks in %s..." group)
1162 (while (setq action (pop actions))
1163 (let ((range (nth 0 action))
1164 (what (nth 1 action))
1165 (cmdmarks (nth 2 action))
1167 ;; bookmark can't be stored (not list/range
1168 (setq cmdmarks (delq 'bookmark cmdmarks))
1169 ;; killed can't be stored (not list/range
1170 (setq cmdmarks (delq 'killed cmdmarks))
1171 ;; unsent are for nndraft groups only
1172 (setq cmdmarks (delq 'unsent cmdmarks))
1173 ;; cache flags are pointless on the server
1174 (setq cmdmarks (delq 'cache cmdmarks))
1175 ;; seen flags are local to each gnus
1176 (setq cmdmarks (delq 'seen cmdmarks))
1177 ;; recent marks can't be set
1178 (setq cmdmarks (delq 'recent cmdmarks))
1179 (when nnimap-importantize-dormant
1180 ;; flag dormant articles as ticked
1181 (if (memq 'dormant cmdmarks)
1182 (setq cmdmarks (cons 'tick cmdmarks))))
1183 ;; remove stuff we are forbidden to store
1184 (mapcar (lambda (mark)
1185 (if (imap-message-flag-permanent-p
1186 (nnimap-mark-to-flag mark))
1187 (setq marks (cons mark marks))))
1189 (when (and range marks)
1190 (cond ((eq what 'del)
1191 (imap-message-flags-del
1192 (imap-range-to-message-set range)
1193 (nnimap-mark-to-flag marks nil t)))
1195 (imap-message-flags-add
1196 (imap-range-to-message-set range)
1197 (nnimap-mark-to-flag marks nil t)))
1199 (imap-message-flags-set
1200 (imap-range-to-message-set range)
1201 (nnimap-mark-to-flag marks nil t)))))))
1202 (gnus-message 7 "nnimap: Setting marks in %s...done" group))))
1205 (defun nnimap-split-fancy ()
1206 "Like the function `nnmail-split-fancy', but uses `nnimap-split-fancy'."
1207 (let ((nnmail-split-fancy nnimap-split-fancy))
1208 (nnmail-split-fancy)))
1210 (defun nnimap-split-to-groups (rules)
1211 ;; tries to match all rules in nnimap-split-rule against content of
1212 ;; nntp-server-buffer, returns a list of groups that matched.
1213 (with-current-buffer nntp-server-buffer
1214 ;; Fold continuation lines.
1215 (goto-char (point-min))
1216 (while (re-search-forward "\\(\r?\n[ \t]+\\)+" nil t)
1217 (replace-match " " t t))
1218 (if (functionp rules)
1220 (let (to-groups regrepp)
1222 (dolist (rule rules to-groups)
1223 (let ((group (car rule))
1224 (regexp (cadr rule)))
1225 (goto-char (point-min))
1226 (when (and (if (stringp regexp)
1228 (if (not (stringp group))
1229 (setq group (eval group))
1231 (string-match "\\\\[0-9&]" group)))
1232 (re-search-forward regexp nil t))
1233 (funcall regexp group))
1234 ;; Don't enter the article into the same group twice.
1235 (not (assoc group to-groups)))
1237 (nnmail-expand-newtext group)
1240 (or nnimap-split-crosspost
1241 (throw 'split-done to-groups))))))))))
1243 (defun nnimap-assoc-match (key alist)
1245 (while (and alist (not element))
1246 (if (string-match (car (car alist)) key)
1247 (setq element (car alist)))
1248 (setq alist (cdr alist)))
1251 (defun nnimap-split-find-rule (server inbox)
1252 (if (and (listp nnimap-split-rule) (listp (car nnimap-split-rule))
1253 (list (cdar nnimap-split-rule)) (listp (cadar nnimap-split-rule)))
1255 (cadr (nnimap-assoc-match inbox (cdr (nnimap-assoc-match
1256 server nnimap-split-rule))))
1259 (defun nnimap-split-find-inbox (server)
1260 (if (listp nnimap-split-inbox)
1262 (list nnimap-split-inbox)))
1264 (defun nnimap-split-articles (&optional group server)
1265 (when (nnimap-possibly-change-server server)
1266 (with-current-buffer nnimap-server-buffer
1267 (let (rule inbox removeorig (inboxes (nnimap-split-find-inbox server)))
1268 ;; iterate over inboxes
1269 (while (and (setq inbox (pop inboxes))
1270 (nnimap-possibly-change-group inbox));; SELECT
1271 ;; find split rule for this server / inbox
1272 (when (setq rule (nnimap-split-find-rule server inbox))
1273 ;; iterate over articles
1274 (dolist (article (imap-search nnimap-split-predicate))
1275 (when (if (if (eq nnimap-split-download-body 'default)
1276 nnimap-split-download-body-default
1277 nnimap-split-download-body)
1278 (and (nnimap-request-article article)
1279 (with-current-buffer nntp-server-buffer (mail-narrow-to-head)))
1280 (nnimap-request-head article))
1281 ;; copy article to right group(s)
1282 (setq removeorig nil)
1283 (dolist (to-group (nnimap-split-to-groups rule))
1284 (cond ((eq to-group 'junk)
1285 (message "IMAP split removed %s:%s:%d" server inbox
1287 (setq removeorig t))
1288 ((imap-message-copy (number-to-string article)
1289 to-group nil 'nocopyuid)
1290 (message "IMAP split moved %s:%s:%d to %s" server
1291 inbox article to-group)
1293 (when nnmail-cache-accepted-message-ids
1294 (with-current-buffer nntp-server-buffer
1297 (nnmail-fetch-field "message-id"))
1298 (nnmail-cache-insert msgid
1300 (nnmail-fetch-field "subject"))))))
1301 ;; Add the group-art list to the history list.
1302 (push (list (cons to-group 0)) nnmail-split-history))
1304 (message "IMAP split failed to move %s:%s:%d to %s"
1305 server inbox article to-group))))
1306 (if (if (eq nnimap-split-download-body 'default)
1307 nnimap-split-download-body-default
1308 nnimap-split-download-body)
1310 ;; remove article if it was successfully copied somewhere
1312 (imap-message-flags-add (format "%d" article)
1313 "\\Seen \\Deleted")))))
1314 (when (imap-mailbox-select inbox);; just in case
1315 ;; todo: UID EXPUNGE (if available) to remove splitted articles
1316 (imap-mailbox-expunge)
1317 (imap-mailbox-close)))
1318 (when nnmail-cache-accepted-message-ids
1319 (nnmail-cache-close))
1322 (deffoo nnimap-request-scan (&optional group server)
1323 (nnimap-split-articles group server))
1325 (deffoo nnimap-request-newgroups (date &optional server)
1326 (when (nnimap-possibly-change-server server)
1327 (with-current-buffer nntp-server-buffer
1328 (gnus-message 5 "nnimap: Listing subscribed mailboxes%s%s..."
1329 (if (> (length server) 0) " on " "") server)
1331 (nnimap-before-find-minmax-bugworkaround)
1332 (dolist (pattern (nnimap-pattern-to-list-arguments
1333 nnimap-list-pattern))
1334 (dolist (mbx (imap-mailbox-lsub (cdr pattern) (car pattern) nil
1335 nnimap-server-buffer))
1337 (dolist (mailbox (imap-mailbox-get 'list-flags mbx
1338 nnimap-server-buffer))
1339 (if (string= (downcase mailbox) "\\noselect")
1342 (let ((info (nnimap-find-minmax-uid mbx 'examine)))
1344 (insert (format "\"%s\" %d %d y\n"
1345 mbx (or (nth 2 info) 0)
1346 (max 1 (or (nth 1 info) 1)))))))))
1347 (gnus-message 5 "nnimap: Listing subscribed mailboxes%s%s...done"
1348 (if (> (length server) 0) " on " "") server))
1351 (deffoo nnimap-request-create-group (group &optional server args)
1352 (when (nnimap-possibly-change-server server)
1353 (or (imap-mailbox-status group 'uidvalidity nnimap-server-buffer)
1354 (imap-mailbox-create group nnimap-server-buffer)
1355 (nnheader-report 'nnimap "%S"
1356 (imap-error-text nnimap-server-buffer)))))
1358 (defun nnimap-time-substract (time1 time2)
1359 "Return TIME for TIME1 - TIME2."
1360 (let* ((ms (- (car time1) (car time2)))
1361 (ls (- (nth 1 time1) (nth 1 time2))))
1363 (list (- ms 1) (+ (expt 2 16) ls))
1366 (defun nnimap-date-days-ago (daysago)
1367 "Return date, in format \"3-Aug-1998\", for DAYSAGO days ago."
1368 (let* ((time (nnimap-time-substract (current-time) (days-to-time daysago)))
1369 (date (format-time-string
1370 (format "%%d-%s-%%Y"
1371 (capitalize (car (rassoc (nth 4 (decode-time time))
1372 parse-time-months))))
1374 (if (eq ?0 (string-to-char date))
1378 (defun nnimap-request-expire-articles-progress ()
1379 (gnus-message 5 "nnimap: Marking article %d for deletion..."
1380 imap-current-message))
1382 (defun nnimap-expiry-target (arts group server)
1383 (unless (eq nnmail-expiry-target 'delete)
1386 (nnimap-request-article art group server (current-buffer))
1387 ;; hints for optimization in `nnimap-request-accept-article'
1388 (let ((nnimap-current-move-article art)
1389 (nnimap-current-move-group group)
1390 (nnimap-current-move-server server))
1391 (nnmail-expiry-target-group nnmail-expiry-target group))))
1392 ;; It is not clear if `nnmail-expiry-target' somehow cause the
1393 ;; current group to be changed or not, so we make sure here.
1394 (nnimap-possibly-change-group group server)))
1396 ;; Notice that we don't actually delete anything, we just mark them deleted.
1397 (deffoo nnimap-request-expire-articles (articles group &optional server force)
1398 (let ((artseq (gnus-compress-sequence articles)))
1399 (when (and artseq (nnimap-possibly-change-group group server))
1400 (with-current-buffer nnimap-server-buffer
1401 (let ((days (or (and nnmail-expiry-wait-function
1402 (funcall nnmail-expiry-wait-function group))
1403 nnmail-expiry-wait)))
1404 (cond ((or force (eq days 'immediate))
1405 (let ((oldarts (imap-search
1407 (imap-range-to-message-set artseq)))))
1409 (nnimap-expiry-target oldarts group server)
1410 (when (imap-message-flags-add
1411 (imap-range-to-message-set
1412 (gnus-compress-sequence oldarts)) "\\Deleted")
1413 (setq articles (gnus-set-difference
1414 articles oldarts))))))
1416 (let ((oldarts (imap-search
1417 (format nnimap-expunge-search-string
1418 (imap-range-to-message-set artseq)
1419 (nnimap-date-days-ago days))))
1420 (imap-fetch-data-hook
1421 '(nnimap-request-expire-articles-progress)))
1423 (nnimap-expiry-target oldarts group server)
1424 (when (imap-message-flags-add
1425 (imap-range-to-message-set
1426 (gnus-compress-sequence oldarts)) "\\Deleted")
1427 (setq articles (gnus-set-difference
1428 articles oldarts)))))))))))
1429 ;; return articles not deleted
1432 (deffoo nnimap-request-move-article (article group server
1433 accept-form &optional last)
1434 (when (nnimap-possibly-change-server server)
1436 (let ((buf (get-buffer-create " *nnimap move*"))
1437 (nnimap-current-move-article article)
1438 (nnimap-current-move-group group)
1439 (nnimap-current-move-server nnimap-current-server)
1441 (and (nnimap-request-article article group server)
1444 (buffer-disable-undo (current-buffer))
1445 (insert-buffer-substring nntp-server-buffer)
1446 (setq result (eval accept-form))
1449 (imap-message-flags-add
1450 (imap-range-to-message-set (list article))
1451 "\\Deleted" 'silent nnimap-server-buffer))
1454 (deffoo nnimap-request-accept-article (group &optional server last)
1455 (when (nnimap-possibly-change-server server)
1458 (if (string= nnimap-current-server nnimap-current-move-server)
1459 ;; moving article within same server, speed it up...
1460 (and (nnimap-possibly-change-group
1461 nnimap-current-move-group)
1462 (imap-message-copy (number-to-string
1463 nnimap-current-move-article)
1464 group 'dontcreate nil
1465 nnimap-server-buffer))
1466 (with-current-buffer (current-buffer)
1467 (goto-char (point-min))
1468 ;; remove any 'From blabla' lines, some IMAP servers
1469 ;; reject the entire message otherwise.
1470 (when (looking-at "^From[^:]")
1471 (delete-region (point) (progn (forward-line) (point))))
1472 ;; turn into rfc822 format (\r\n eol's)
1473 (while (search-forward "\n" nil t)
1474 (replace-match "\r\n"))
1475 (when nnmail-cache-accepted-message-ids
1476 (nnmail-cache-insert (nnmail-fetch-field "message-id")
1478 (nnmail-fetch-field "subject"))))
1479 (when (and last nnmail-cache-accepted-message-ids)
1480 (nnmail-cache-close))
1481 ;; this 'or' is for Cyrus server bug
1482 (or (null (imap-current-mailbox nnimap-server-buffer))
1483 (imap-mailbox-unselect nnimap-server-buffer))
1484 (imap-message-append group (current-buffer) nil nil
1485 nnimap-server-buffer)))
1486 (cons group (nth 1 uid))
1487 (nnheader-report 'nnimap (imap-error-text nnimap-server-buffer))))))
1489 (deffoo nnimap-request-delete-group (group force &optional server)
1490 (when (nnimap-possibly-change-server server)
1491 (with-current-buffer nnimap-server-buffer
1493 (or (null (imap-mailbox-status group 'uidvalidity))
1494 (imap-mailbox-delete group))
1498 (deffoo nnimap-request-rename-group (group new-name &optional server)
1499 (when (nnimap-possibly-change-server server)
1500 (imap-mailbox-rename group new-name nnimap-server-buffer)))
1502 (defun nnimap-expunge (mailbox server)
1503 (when (nnimap-possibly-change-group mailbox server)
1504 (imap-mailbox-expunge nil nnimap-server-buffer)))
1506 (defun nnimap-acl-get (mailbox server)
1507 (when (nnimap-possibly-change-server server)
1508 (and (imap-capability 'ACL nnimap-server-buffer)
1509 (imap-mailbox-acl-get mailbox nnimap-server-buffer))))
1511 (defun nnimap-acl-edit (mailbox method old-acls new-acls)
1512 (when (nnimap-possibly-change-server (cadr method))
1513 (unless (imap-capability 'ACL nnimap-server-buffer)
1514 (error "Your server does not support ACL editing"))
1515 (with-current-buffer nnimap-server-buffer
1516 ;; delete all removed identifiers
1517 (mapcar (lambda (old-acl)
1518 (unless (assoc (car old-acl) new-acls)
1519 (or (imap-mailbox-acl-delete (car old-acl) mailbox)
1520 (error "Can't delete ACL for %s" (car old-acl)))))
1522 ;; set all changed acl's
1523 (mapcar (lambda (new-acl)
1524 (let ((new-rights (cdr new-acl))
1525 (old-rights (cdr (assoc (car new-acl) old-acls))))
1526 (unless (and old-rights new-rights
1527 (string= old-rights new-rights))
1528 (or (imap-mailbox-acl-set (car new-acl) new-rights mailbox)
1529 (error "Can't set ACL for %s to %s" (car new-acl)
1535 ;;; Internal functions
1538 ;; This is confusing.
1540 ;; mark => read, tick, draft, reply etc
1541 ;; flag => "\\Seen", "\\Flagged", "\\Draft", "gnus-expire" etc
1542 ;; predicate => "SEEN", "FLAGGED", "DRAFT", "KEYWORD gnus-expire" etc
1544 ;; Mark should not really contain 'read since it's not a "mark" in the Gnus
1545 ;; world, but we cheat. Mark == gnus-article-mark-lists + '(read . read).
1548 (defconst nnimap-mark-to-predicate-alist
1550 (lambda (pair) ; cdr is the mark
1551 (or (assoc (cdr pair)
1556 (reply . "ANSWERED")))
1558 (format "KEYWORD gnus-%s" (symbol-name (cdr pair))))))
1559 (cons '(read . read) gnus-article-mark-lists)))
1561 (defun nnimap-mark-to-predicate (pred)
1562 "Convert a Gnus mark (a symbol such as read, tick, expire) to a IMAP predicate.
1563 This is a string such as \"SEEN\", \"FLAGGED\", \"KEYWORD gnus-expire\",
1564 to be used within a IMAP SEARCH query."
1565 (cdr (assq pred nnimap-mark-to-predicate-alist)))
1567 (defconst nnimap-mark-to-flag-alist
1570 (or (assoc (cdr pair)
1572 (tick . "\\Flagged")
1574 (recent . "\\Recent")
1575 (reply . "\\Answered")))
1577 (format "gnus-%s" (symbol-name (cdr pair))))))
1578 (cons '(read . read) gnus-article-mark-lists)))
1580 (defun nnimap-mark-to-flag-1 (preds)
1581 (if (and (not (null preds)) (listp preds))
1582 (cons (nnimap-mark-to-flag (car preds))
1583 (nnimap-mark-to-flag (cdr preds)))
1584 (cdr (assoc preds nnimap-mark-to-flag-alist))))
1586 (defun nnimap-mark-to-flag (preds &optional always-list make-string)
1587 "Convert a Gnus mark (a symbol such as read, tick, expire) to a IMAP flag.
1588 This is a string such as \"\\Seen\", \"\\Flagged\", \"gnus-expire\", to
1589 be used in a STORE FLAGS command."
1590 (let ((result (nnimap-mark-to-flag-1 preds)))
1591 (setq result (if (and (or make-string always-list)
1592 (not (listp result)))
1596 (mapconcat (lambda (flag)
1598 (mapconcat 'identity flag " ")
1603 (defun nnimap-mark-permanent-p (mark &optional group)
1604 "Return t iff MARK can be permanently (between IMAP sessions) saved on articles, in GROUP."
1605 (imap-message-flag-permanent-p (nnimap-mark-to-flag mark)))
1609 (buffer-disable-undo (get-buffer-create nnimap-debug-buffer))
1610 (mapcar (lambda (f) (trace-function-background f nnimap-debug-buffer))
1612 nnimap-possibly-change-server
1613 nnimap-verify-uidvalidity
1614 nnimap-find-minmax-uid
1615 nnimap-before-find-minmax-bugworkaround
1616 nnimap-possibly-change-group
1617 ;;nnimap-replace-whitespace
1618 nnimap-retrieve-headers-progress
1619 nnimap-retrieve-which-headers
1620 nnimap-group-overview-filename
1621 nnimap-retrieve-headers-from-file
1622 nnimap-retrieve-headers-from-server
1623 nnimap-retrieve-headers
1624 nnimap-open-connection
1626 nnimap-server-opened
1628 nnimap-request-close
1629 nnimap-status-message
1631 nnimap-request-article-part
1632 nnimap-request-article
1635 nnimap-request-group
1637 nnimap-pattern-to-list-arguments
1640 nnimap-retrieve-groups
1641 nnimap-request-update-info-internal
1643 nnimap-request-set-mark
1644 nnimap-split-to-groups
1645 nnimap-split-find-rule
1646 nnimap-split-find-inbox
1647 nnimap-split-articles
1649 nnimap-request-newgroups
1650 nnimap-request-create-group
1651 nnimap-time-substract
1652 nnimap-date-days-ago
1653 nnimap-request-expire-articles-progress
1654 nnimap-request-expire-articles
1655 nnimap-request-move-article
1656 nnimap-request-accept-article
1657 nnimap-request-delete-group
1658 nnimap-request-rename-group
1659 gnus-group-nnimap-expunge
1660 gnus-group-nnimap-edit-acl
1661 gnus-group-nnimap-edit-acl-done
1662 nnimap-group-mode-hook
1663 nnimap-mark-to-predicate
1664 nnimap-mark-to-flag-1
1666 nnimap-mark-permanent-p
1671 ;;; nnimap.el ends here