1 ;;; nnimap.el --- imap backend for Gnus
2 ;; Copyright (C) 1998, 1999, 2000 Free Software Foundation, Inc.
4 ;; Author: Simon Josefsson <jas@pdc.kth.se>
5 ;; Jim Radford <radford@robby.caltech.edu>
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
27 ;; Todo, major things:
29 ;; o Fix Gnus to view correct number of unread/total articles in group buffer
30 ;; o Fix Gnus to handle leading '.' in group names (fixed?)
31 ;; o Finish disconnected mode (moving articles between mailboxes unplugged)
33 ;; o MIME (partial article fetches)
34 ;; o Split to other backends, different split rules for different
37 ;; Todo, minor things:
39 ;; o Don't require half of Gnus -- backends should be standalone
40 ;; o Verify that we don't use IMAP4rev1 specific things (RFC2060 App B)
41 ;; o Dont uid fetch 1,* in nnimap-retrive-groups (slow)
42 ;; o Split up big fetches (1,* header especially) in smaller chunks
43 ;; o What do I do with gnus-newsgroup-*?
44 ;; o Tell Gnus about new groups (how can we tell?)
45 ;; o Respooling (fix Gnus?) (unnecessery?)
46 ;; o Add support for the following: (if applicable)
47 ;; request-list-newsgroups, request-regenerate
49 ;; request-associate-buffer, request-restore-buffer,
50 ;; o Do The Right Thing when UIDVALIDITY changes (what's the right thing?)
51 ;; o Support RFC2221 (Login referrals)
52 ;; o IMAP2BIS compatibility? (RFC2061)
53 ;; o ACAP stuff (perhaps a different project, would be nice to ACAPify
55 ;; o What about Gnus's article editing, can we support it? NO!
56 ;; o Use \Draft to support the draft group??
57 ;; o Duplicate suppression
58 ;; o Rewrite UID SEARCH UID X as UID FETCH X (UID) for those with slow servers
74 (defconst nnimap-version "nnimap 1.0")
77 "Reading IMAP mail with Gnus."
80 (defvoo nnimap-address nil
81 "Address of physical IMAP server. If nil, use the virtual server's name.")
83 (defvoo nnimap-server-port nil
84 "Port number on physical IMAP server.
85 If nil, defaults to 993 for SSL connections and 143 otherwise.")
87 ;; Splitting variables
89 (defcustom nnimap-split-crosspost t
90 "If non-nil, do crossposting if several split methods match the mail.
91 If nil, the first match found will be used."
95 (defcustom nnimap-split-inbox nil
96 "Name of mailbox to split mail from.
98 Mail is read from this mailbox and split according to rules in
101 This can be a string or a list of strings."
103 :type '(choice (string)
106 (define-widget 'nnimap-strict-function 'function
107 "This widget only matches values that are functionp.
109 Warning: This means that a value that is the symbol of a not yet
110 loaded function will not match. Use with care."
111 :match 'nnimap-strict-function-match)
113 (defun nnimap-strict-function-match (widget value)
114 "Ignoring WIDGET, match if VALUE is a function."
117 (defcustom nnimap-split-rule nil
118 "Mail will be split according to theese rules.
120 Mail is read from mailbox(es) specified in `nnimap-split-inbox'.
122 If you'd like, for instance, one mail group for mail from the
123 \"gnus-imap\" mailing list, one group for junk mail and leave
124 everything else in the incoming mailbox, you could do something like
127 \(setq nnimap-split-rule '((\"INBOX.gnus-imap\" \"From:.*gnus-imap\")
128 (\"INBOX.junk\" \"Subject:.*buy\")))
130 As you can see, `nnimap-split-rule' is a list of lists, where the
131 first element in each \"rule\" is the name of the IMAP mailbox (or the
132 symbol `junk' if you want to remove the mail), and the second is a
133 regexp that nnimap will try to match on the header to find a fit.
135 The second element can also be a function. In that case, it will be
136 called narrowed to the headers with the first element of the rule as
137 the argument. It should return a non-nil value if it thinks that the
138 mail belongs in that group.
140 This variable can also have a function as its value, the function will
141 be called with the headers narrowed and should return a group where it
142 thinks the article should be splitted to. See `nnimap-split-fancy'.
144 To allow for different split rules on different virtual servers, and
145 even different split rules in different inboxes on the same server,
146 the syntax of this variable have been extended along the lines of:
148 \(setq nnimap-split-rule
149 '((\"my1server\" (\".*\" ((\"ding\" \"ding@gnus.org\")
150 (\"junk\" \"From:.*Simon\")))
151 (\"my2server\" (\"INBOX\" nnimap-split-fancy))
152 (\"my[34]server\" (\".*\" ((\"private\" \"To:.*Simon\")
153 (\"junk\" my-junk-func)))))
155 The virtual server name is in fact a regexp, so that the same rules
156 may apply to several servers. In the example, the servers
157 \"my3server\" and \"my4server\" both use the same rules. Similarly,
158 the inbox string is also a regexp. The actual splitting rules are as
159 before, either a function, or a list with group/regexp or
160 group/function elements."
162 :type '(choice :tag "Rule type"
163 (repeat :menu-tag "Single-server"
164 :tag "Single-server list"
165 (list (string :tag "Mailbox")
166 (choice :tag "Predicate"
167 (regexp :tag "A regexp")
168 (nnimap-strict-function :tag "A function"))))
169 (choice :menu-tag "A function"
171 (function-item nnimap-split-fancy)
172 (function-item nnmail-split-fancy)
173 (nnimap-strict-function :tag "User-defined function"))
174 (repeat :menu-tag "Multi-server (extended)"
175 :tag "Multi-server list"
176 (list (regexp :tag "Server regexp")
177 (list (regexp :tag "Incoming Mailbox regexp")
178 (repeat :tag "Rules for matching server(s) and mailbox(es)"
179 (list (string :tag "Destination mailbox")
180 (choice :tag "Predicate"
181 (regexp :tag "A Regexp")
182 (nnimap-strict-function :tag "A Function")))))))))
184 (defcustom nnimap-split-predicate "UNSEEN UNDELETED"
185 "The predicate used to find articles to split.
186 If you use another IMAP client to peek on articles but always would
187 like nnimap to split them once it's started, you could change this to
188 \"UNDELETED\". Other available predicates are available in
189 RFC2060 section 6.4.4."
193 (defcustom nnimap-split-fancy nil
194 "Like the variable `nnmail-split-fancy', which see."
198 ;; Performance / bug workaround variables
200 (defcustom nnimap-close-asynchronous t
201 "Close mailboxes asynchronously in `nnimap-close-group'.
202 This means that errors cought by nnimap when closing the mailbox will
203 not prevent Gnus from updating the group status, which may be harmful.
204 However, it increases speed."
208 (defcustom nnimap-dont-close t
209 "Never close mailboxes.
210 This increases the speed of closing mailboxes (quiting group) but may
211 decrease the speed of selecting another mailbox later. Re-selecting
212 the same mailbox will be faster though."
216 (defcustom nnimap-retrieve-groups-asynchronous t
217 "Send asynchronous STATUS commands for each mailbox before checking mail.
218 If you have mailboxes that rarely receives mail, this speeds up new
219 mail checking. It works by first sending STATUS commands for each
220 mailbox, and then only checking groups which has a modified UIDNEXT
221 more carefully for new mail.
223 In summary, the default is O((1-p)*k+p*n) and changing it to nil makes
224 it O(n). If p is small, then the default is probably faster."
228 (defvoo nnimap-need-unselect-to-notice-new-mail nil
229 "Unselect mailboxes before looking for new mail in them.
230 Some servers seem to need this under some circumstances.")
232 ;; Authorization / Privacy variables
234 (defvoo nnimap-auth-method nil
237 (defvoo nnimap-stream nil
238 "How nnimap will connect to the server.
240 The default, nil, will try to use the \"best\" method the server can
245 1) you want to connect with SSL. The SSL integration with IMAP is
246 brain-dead so you'll have to tell it specifically.
248 2) your server is more capable than your environment -- i.e. your
249 server accept Kerberos login's but you haven't installed the
250 `imtest' program or your machine isn't configured for Kerberos.
252 Possible choices: kerberos4, ssl, network")
254 (defvoo nnimap-authenticator nil
255 "How nnimap authenticate itself to the server.
257 The default, nil, will try to use the \"best\" method the server can
260 There is only one reason for fiddling with this variable, and that is
261 if your server is more capable than your environment -- i.e. you
262 connect to a server that accept Kerberos login's but you haven't
263 installed the `imtest' program or your machine isn't configured for
266 Possible choices: kerberos4, cram-md5, login, anonymous.")
268 (defvoo nnimap-directory (nnheader-concat gnus-directory "overview/")
269 "Directory to keep NOV cache files for nnimap groups.
270 See also `nnimap-nov-file-name'.")
272 (defvoo nnimap-nov-file-name "nnimap."
273 "NOV cache base filename.
274 The group name and `nnimap-nov-file-name-suffix' will be appended. A
275 typical complete file name would be
276 ~/News/overview/nnimap.pdc.INBOX.ding.nov, or
277 ~/News/overview/nnimap/pdc/INBOX/ding/nov if
278 `nnmail-use-long-file-names' is nil")
280 (defvoo nnimap-nov-file-name-suffix ".novcache"
281 "Suffix for NOV cache base filename.")
283 (defvoo nnimap-nov-is-evil gnus-agent
284 "If non-nil, never generate or use a local nov database for this backend.
285 Using nov databases should speed up header fetching considerably.
286 However, it will invoke a UID SEARCH UID command on the server, and
287 some servers implement this command inefficiently by opening each and
288 every message in the group, thus making it quite slow.
289 Unlike other backends, you do not need to take special care if you
290 flip this variable.")
292 (defvoo nnimap-expunge-on-close 'always ; 'ask, 'never
293 "Whether to expunge a group when it is closed.
294 When a IMAP group with articles marked for deletion is closed, this
295 variable determine if nnimap should actually remove the articles or
298 If always, nnimap always perform a expunge when closing the group.
299 If never, nnimap never expunges articles marked for deletion.
300 If ask, nnimap will ask you if you wish to expunge marked articles.
302 When setting this variable to `never', you can only expunge articles
303 by using `G x' (gnus-group-nnimap-expunge) from the Group buffer.")
305 (defvoo nnimap-list-pattern "*"
306 "A string LIMIT or list of strings with mailbox wildcards used to limit available groups.
307 See below for available wildcards.
309 The LIMIT string can be a cons cell (REFERENCE . LIMIT), where
310 REFERENCE will be passed as the first parameter to LIST/LSUB. The
311 semantics of this are server specific, on the University of Washington
312 server you can specify a directory.
315 '(\"INBOX\" \"mail/*\" (\"~friend/mail/\" . \"list/*\"))
317 There are two wildcards * and %. * matches everything, % matches
318 everything in the current hierarchy.")
320 (defvoo nnimap-news-groups nil
321 "IMAP support a news-like mode, also known as bulletin board mode,
322 where replies is sent via IMAP instead of SMTP.
324 This variable should contain a regexp matching groups where you wish
325 replies to be stored to the mailbox directly.
328 '(\"^[^I][^N][^B][^O][^X].*$\")
330 This will match all groups not beginning with \"INBOX\".
332 Note that there is nothing technically different between mail-like and
333 news-like mailboxes. If you wish to have a group with todo items or
334 similar which you wouldn't want to set up a mailing list for, you can
335 use this to make replies go directly to the group.")
337 (defvoo nnimap-expunge-search-string "UID %s NOT SINCE %s"
338 "IMAP search command to use for articles that are to be expired.
339 The first %s is replaced by a UID set of articles to search on,
340 and the second %s is replaced by a date criterium.
342 One useful (and perhaps the only useful) value to change this to would
343 be `UID %s NOT SENTSINCE %s' to make nnimap use the Date: header
344 instead of the internal date of messages. See section 6.4.4 of RFC
345 2060 for more information on valid strings.")
347 (defvoo nnimap-importantize-dormant t
348 "If non-nil, mark \"dormant\" articles as \"ticked\" for other IMAP clients.
349 Note that within Gnus, dormant articles will still (only) be
350 marked as ticked. This is to make \"dormant\" articles stand out,
351 just like \"ticked\" articles, in other IMAP clients.")
353 (defvoo nnimap-server-address nil
354 "Obsolete. Use `nnimap-address'.")
356 (defcustom nnimap-authinfo-file "~/.authinfo"
357 "Authorization information for IMAP servers. In .netrc format."
360 (repeat :tag "Entries"
363 :value ("" ("login" . "") ("password" . ""))
367 (const :format "" "login")
368 (string :format "Login: %v"))
370 (const :format "" "password")
371 (string :format "Password: %v")))))))
373 (defcustom nnimap-prune-cache t
374 "If non-nil, nnimap check whether articles still exist on server before using data stored in NOV cache."
377 (defvar nnimap-request-list-method 'imap-mailbox-list
378 "Method to use to request a list of all folders from the server.
379 If this is 'imap-mailbox-lsub, then use a server-side subscription list to
380 restrict visible folders.")
382 ;; Internal variables:
384 (defvar nnimap-mailbox-info (gnus-make-hashtable 997))
385 (defvar nnimap-debug nil
386 "Name of buffer to record debugging info.
387 For example: (setq nnimap-debug \"*nnimap-debug*\")")
388 (defvar nnimap-current-move-server nil)
389 (defvar nnimap-current-move-group nil)
390 (defvar nnimap-current-move-article nil)
391 (defvar nnimap-length)
392 (defvar nnimap-progress-chars '(?| ?/ ?- ?\\))
393 (defvar nnimap-progress-how-often 20)
394 (defvar nnimap-counter)
395 (defvar nnimap-callback-callback-function nil
396 "Gnus callback the nnimap asynchronous callback should call.")
397 (defvar nnimap-callback-buffer nil
398 "Which buffer the asynchronous article prefetch callback should work in.")
399 (defvar nnimap-server-buffer-alist nil) ;; Map server name to buffers.
400 (defvar nnimap-current-server nil) ;; Current server
401 (defvar nnimap-server-buffer nil) ;; Current servers' buffer
405 (nnoo-define-basics nnimap)
407 ;; Utility functions:
409 (defsubst nnimap-get-server-buffer (server)
410 "Return buffer for SERVER, if nil use current server."
411 (cadr (assoc (or server nnimap-current-server) nnimap-server-buffer-alist)))
413 (defun nnimap-possibly-change-server (server)
414 "Return buffer for SERVER, changing the current server as a side-effect.
415 If SERVER is nil, uses the current server."
416 (setq nnimap-current-server (or server nnimap-current-server)
417 nnimap-server-buffer (nnimap-get-server-buffer nnimap-current-server)))
419 (defun nnimap-verify-uidvalidity (group server)
420 "Verify stored uidvalidity match current one in GROUP on SERVER."
421 (let* ((gnusgroup (gnus-group-prefixed-name
422 group (gnus-server-to-method
423 (format "nnimap:%s" server))))
424 (new-uidvalidity (imap-mailbox-get 'uidvalidity))
425 (old-uidvalidity (gnus-group-get-parameter gnusgroup 'uidvalidity))
426 (dir (file-name-as-directory (expand-file-name nnimap-directory)))
427 (nameuid (nnheader-translate-file-chars
428 (concat nnimap-nov-file-name
429 (if (equal server "")
431 server) "." group "." old-uidvalidity
432 nnimap-nov-file-name-suffix) t))
433 (file (if (or nnmail-use-long-file-names
434 (file-exists-p (expand-file-name nameuid dir)))
435 (expand-file-name nameuid dir)
437 (mm-encode-coding-string
438 (nnheader-replace-chars-in-string nameuid ?. ?/)
439 nnmail-pathname-coding-system)
442 (if (not (equal old-uidvalidity new-uidvalidity))
444 (gnus-delete-file file)
445 (gnus-group-set-parameter gnusgroup 'uidvalidity new-uidvalidity)
447 (gnus-group-add-parameter gnusgroup (cons 'uidvalidity new-uidvalidity))
450 (defun nnimap-before-find-minmax-bugworkaround ()
451 "Function called before iterating through mailboxes with
452 `nnimap-find-minmax-uid'."
453 (when nnimap-need-unselect-to-notice-new-mail
454 ;; XXX this is for UoW imapd problem, it doesn't notice new mail in
455 ;; currently selected mailbox without a re-select/examine.
456 (or (null (imap-current-mailbox nnimap-server-buffer))
457 (imap-mailbox-unselect nnimap-server-buffer))))
459 (defun nnimap-find-minmax-uid (group &optional examine)
460 "Find lowest and highest active article nummber in GROUP.
461 If EXAMINE is non-nil the group is selected read-only."
462 (with-current-buffer nnimap-server-buffer
463 (when (or (string= group (imap-current-mailbox))
464 (imap-mailbox-select group examine))
466 (when (> (imap-mailbox-get 'exists) 0)
467 (imap-fetch "1,*" "UID" nil 'nouidfetch)
468 (imap-message-map (lambda (uid Uid)
469 (setq minuid (if minuid (min minuid uid) uid)
470 maxuid (if maxuid (max maxuid uid) uid)))
472 (list (imap-mailbox-get 'exists) minuid maxuid)))))
474 (defun nnimap-possibly-change-group (group &optional server)
475 "Make GROUP the current group, and SERVER the current server."
476 (when (nnimap-possibly-change-server server)
477 (with-current-buffer nnimap-server-buffer
478 (if (or (null group) (imap-current-mailbox-p group))
480 (if (imap-mailbox-select group)
481 (if (or (nnimap-verify-uidvalidity
482 group (or server nnimap-current-server))
483 (zerop (imap-mailbox-get 'exists group))
484 t ;; for OGnus to see if ignoring uidvalidity
485 ;; changes has any bad effects.
488 "nnimap: Group %s is not uidvalid. Continue? " group)))
490 (imap-mailbox-unselect)
491 (error "nnimap: Group %s is not uid-valid" group))
492 (nnheader-report 'nnimap (imap-error-text)))))))
494 (defun nnimap-replace-whitespace (string)
495 "Return STRING with all whitespace replaced with space."
497 (while (string-match "[\r\n\t]+" string)
498 (setq string (replace-match " " t t string)))
501 ;; Required backend functions
503 (defun nnimap-retrieve-headers-progress ()
504 "Hook to insert NOV line for current article into `nntp-server-buffer'."
505 (and (numberp nnmail-large-newsgroup)
506 (zerop (% (incf nnimap-counter) nnimap-progress-how-often))
507 (> nnimap-length nnmail-large-newsgroup)
508 (nnheader-message 6 "nnimap: Retrieving headers... %c"
509 (nth (/ (% nnimap-counter
510 (* (length nnimap-progress-chars)
511 nnimap-progress-how-often))
512 nnimap-progress-how-often)
513 nnimap-progress-chars)))
514 (with-current-buffer nntp-server-buffer
515 (let (headers lines chars uid mbx)
516 (with-current-buffer nnimap-server-buffer
517 (setq uid imap-current-message
518 mbx imap-current-mailbox
519 headers (nnimap-demule
520 (if (imap-capability 'IMAP4rev1)
521 ;; xxx don't just use car? alist doesn't contain
522 ;; anything else now, but it might...
523 (nth 2 (car (imap-message-get uid 'BODYDETAIL)))
524 (imap-message-get uid 'RFC822.HEADER)))
525 lines (imap-body-lines (imap-message-body imap-current-message))
526 chars (imap-message-get imap-current-message 'RFC822.SIZE)))
529 (buffer-disable-undo)
531 (nnheader-ms-strip-cr)
532 (nnheader-fold-continuation-lines)
533 (subst-char-in-region (point-min) (point-max) ?\t ? )
534 (let ((head (nnheader-parse-head 'naked)))
535 (mail-header-set-number head uid)
536 (mail-header-set-chars head chars)
537 (mail-header-set-lines head lines)
538 (mail-header-set-xref
539 head (format "%s %s:%d" (system-name) mbx uid))
542 (defun nnimap-retrieve-which-headers (articles fetch-old)
543 "Get a range of articles to fetch based on ARTICLES and FETCH-OLD."
544 (with-current-buffer nnimap-server-buffer
545 (if (numberp (car-safe articles))
548 (imap-range-to-message-set
549 (gnus-compress-sequence
550 (append (gnus-uncompress-sequence
552 (cons (if (numberp fetch-old)
553 (max 1 (- (car articles) fetch-old))
555 (1- (car articles)))))
557 (mapcar (lambda (msgid)
559 (format "HEADER Message-Id \"%s\"" msgid)))
562 (defun nnimap-group-overview-filename (group server)
563 "Make pathname for GROUP on SERVER."
564 (let* ((dir (file-name-as-directory (expand-file-name nnimap-directory)))
565 (uidvalidity (gnus-group-get-parameter
566 (gnus-group-prefixed-name
567 group (gnus-server-to-method
568 (format "nnimap:%s" server)))
570 (name (nnheader-translate-file-chars
571 (concat nnimap-nov-file-name
572 (if (equal server "")
574 server) "." group nnimap-nov-file-name-suffix) t))
575 (nameuid (nnheader-translate-file-chars
576 (concat nnimap-nov-file-name
577 (if (equal server "")
579 server) "." group "." uidvalidity
580 nnimap-nov-file-name-suffix) t))
581 (oldfile (if (or nnmail-use-long-file-names
582 (file-exists-p (expand-file-name name dir)))
583 (expand-file-name name dir)
585 (mm-encode-coding-string
586 (nnheader-replace-chars-in-string name ?. ?/)
587 nnmail-pathname-coding-system)
589 (newfile (if (or nnmail-use-long-file-names
590 (file-exists-p (expand-file-name nameuid dir)))
591 (expand-file-name nameuid dir)
593 (mm-encode-coding-string
594 (nnheader-replace-chars-in-string nameuid ?. ?/)
595 nnmail-pathname-coding-system)
597 (when (and (file-exists-p oldfile) (not (file-exists-p newfile)))
598 (message "nnimap: Upgrading novcache filename...")
600 (gnus-make-directory (file-name-directory newfile))
601 (unless (ignore-errors (rename-file oldfile newfile) t)
602 (if (ignore-errors (copy-file oldfile newfile) t)
603 (delete-file oldfile)
604 (error "Can't rename `%s' to `%s'" oldfile newfile))))
607 (defun nnimap-retrieve-headers-from-file (group server)
608 (with-current-buffer nntp-server-buffer
609 (let ((nov (nnimap-group-overview-filename group server)))
610 (when (file-exists-p nov)
611 (mm-insert-file-contents nov)
612 (set-buffer-modified-p nil)
613 (let ((min (ignore-errors (goto-char (point-min))
614 (read (current-buffer))))
615 (max (ignore-errors (goto-char (point-max))
617 (read (current-buffer)))))
618 (if (and (numberp min) (numberp max))
620 ;; junk, remove it, it's saved later
624 (defun nnimap-retrieve-headers-from-server (articles group server)
625 (with-current-buffer nnimap-server-buffer
626 (let ((imap-fetch-data-hook '(nnimap-retrieve-headers-progress))
627 (nnimap-length (gnus-range-length articles))
629 (imap-fetch (imap-range-to-message-set articles)
630 (concat "(UID RFC822.SIZE BODY "
632 (append '(Subject From Date Message-Id
633 References In-Reply-To Xref)
635 nnmail-extra-headers))))
636 (if (imap-capability 'IMAP4rev1)
637 (format "BODY.PEEK[HEADER.FIELDS %s])" headers)
638 (format "RFC822.HEADER.LINES %s)" headers)))))
639 (and (numberp nnmail-large-newsgroup)
640 (> nnimap-length nnmail-large-newsgroup)
641 (nnheader-message 6 "nnimap: Retrieving headers...done")))))
643 (defun nnimap-dont-use-nov-p (group server)
644 (or gnus-nov-is-evil nnimap-nov-is-evil
645 (unless (and (gnus-make-directory
647 (nnimap-group-overview-filename group server)))
649 (nnimap-group-overview-filename group server)))
650 (message "nnimap: Nov cache not writable, %s"
651 (nnimap-group-overview-filename group server)))))
653 (deffoo nnimap-retrieve-headers (articles &optional group server fetch-old)
654 (when (nnimap-possibly-change-group group server)
655 (with-current-buffer nntp-server-buffer
657 (if (nnimap-dont-use-nov-p group server)
658 (nnimap-retrieve-headers-from-server
659 (gnus-compress-sequence articles) group server)
660 (let (uids cached low high)
661 (when (setq uids (nnimap-retrieve-which-headers articles fetch-old)
663 high (car (last uids)))
664 (if (setq cached (nnimap-retrieve-headers-from-file group server))
666 ;; fetch articles with uids before cache block
667 (when (< low (car cached))
668 (goto-char (point-min))
669 (nnimap-retrieve-headers-from-server
670 (cons low (1- (car cached))) group server))
671 ;; fetch articles with uids after cache block
672 (when (> high (cdr cached))
673 (goto-char (point-max))
674 (nnimap-retrieve-headers-from-server
675 (cons (1+ (cdr cached)) high) group server))
676 (when nnimap-prune-cache
677 ;; remove nov's for articles which has expired on server
678 (goto-char (point-min))
679 (dolist (uid (gnus-set-difference articles uids))
680 (when (re-search-forward (format "^%d\t" uid) nil t)
681 (gnus-delete-line)))))
682 ;; nothing cached, fetch whole range from server
683 (nnimap-retrieve-headers-from-server
684 (cons low high) group server))
685 (when (buffer-modified-p)
687 (point-min) (point-max)
688 (nnimap-group-overview-filename group server) nil 'nomesg))
689 (nnheader-nov-delete-outside-range low high))))
692 (defun nnimap-open-connection (server)
693 (if (not (imap-open nnimap-address nnimap-server-port nnimap-stream
694 nnimap-authenticator nnimap-server-buffer))
695 (nnheader-report 'nnimap "Can't open connection to server %s" server)
696 (unless (or (imap-capability 'IMAP4 nnimap-server-buffer)
697 (imap-capability 'IMAP4rev1 nnimap-server-buffer))
698 (imap-close nnimap-server-buffer)
699 (nnheader-report 'nnimap "Server %s is not IMAP4 compliant" server))
700 (let* ((list (gnus-parse-netrc nnimap-authinfo-file))
701 (port (if nnimap-server-port
702 (int-to-string nnimap-server-port)
704 (alist (gnus-netrc-machine list (or nnimap-server-address
705 nnimap-address server)
707 (user (gnus-netrc-get alist "login"))
708 (passwd (gnus-netrc-get alist "password")))
709 (if (imap-authenticate user passwd nnimap-server-buffer)
711 (push (list server nnimap-server-buffer)
712 nnimap-server-buffer-alist)
713 (nnimap-possibly-change-server server))
714 (imap-close nnimap-server-buffer)
715 (kill-buffer nnimap-server-buffer)
716 (nnheader-report 'nnimap "Could not authenticate to %s" server)))))
718 (deffoo nnimap-open-server (server &optional defs)
719 (nnheader-init-server-buffer)
720 (if (nnimap-server-opened server)
722 (unless (assq 'nnimap-server-buffer defs)
723 (push (list 'nnimap-server-buffer (concat " *nnimap* " server)) defs))
724 ;; translate `nnimap-server-address' to `nnimap-address' in defs
725 ;; for people that configured nnimap with a very old version
726 (unless (assq 'nnimap-address defs)
727 (if (assq 'nnimap-server-address defs)
728 (push (list 'nnimap-address
729 (cadr (assq 'nnimap-server-address defs))) defs)
730 (push (list 'nnimap-address server) defs)))
731 (nnoo-change-server 'nnimap server defs)
732 (or nnimap-server-buffer
733 (setq nnimap-server-buffer (cadr (assq 'nnimap-server-buffer defs))))
734 (with-current-buffer (get-buffer-create nnimap-server-buffer)
735 (nnoo-change-server 'nnimap server defs))
736 (or (and nnimap-server-buffer
737 (imap-opened nnimap-server-buffer))
738 (nnimap-open-connection server))))
740 (deffoo nnimap-server-opened (&optional server)
741 "Whether SERVER is opened.
742 If SERVER is the current virtual server, and the connection to the
743 physical server is alive, this function return a non-nil value. If
744 SERVER is nil, it is treated as the current server."
745 ;; clean up autologouts??
746 (and (or server nnimap-current-server)
747 (nnoo-server-opened 'nnimap (or server nnimap-current-server))
748 (imap-opened (nnimap-get-server-buffer server))))
750 (deffoo nnimap-close-server (&optional server)
751 "Close connection to server and free all resources connected to it.
752 Return nil if the server couldn't be closed for some reason."
753 (let ((server (or server nnimap-current-server)))
754 (when (or (nnimap-server-opened server)
755 (imap-opened (nnimap-get-server-buffer server)))
756 (imap-close (nnimap-get-server-buffer server))
757 (kill-buffer (nnimap-get-server-buffer server))
758 (setq nnimap-server-buffer nil
759 nnimap-current-server nil
760 nnimap-server-buffer-alist
761 (delq server nnimap-server-buffer-alist)))
762 (nnoo-close-server 'nnimap server)))
764 (deffoo nnimap-request-close ()
765 "Close connection to all servers and free all resources that the backend have reserved.
766 All buffers that have been created by that
767 backend should be killed. (Not the nntp-server-buffer, though.) This
768 function is generally only called when Gnus is shutting down."
769 (mapcar (lambda (server) (nnimap-close-server (car server)))
770 nnimap-server-buffer-alist)
771 (setq nnimap-server-buffer-alist nil))
773 (deffoo nnimap-status-message (&optional server)
774 "This function returns the last error message from server."
775 (when (nnimap-possibly-change-server server)
776 (nnoo-status-message 'nnimap server)))
778 (defun nnimap-demule (string)
779 (funcall (if (and (fboundp 'string-as-multibyte)
780 (subrp (symbol-function 'string-as-multibyte)))
785 (defun nnimap-callback ()
786 (remove-hook 'imap-fetch-data-hook 'nnimap-callback)
787 (with-current-buffer nnimap-callback-buffer
789 (with-current-buffer nnimap-server-buffer
791 (if (imap-capability 'IMAP4rev1)
792 ;; xxx don't just use car? alist doesn't contain
793 ;; anything else now, but it might...
794 (nth 2 (car (imap-message-get (imap-current-message) 'BODYDETAIL)))
795 (imap-message-get (imap-current-message) 'RFC822)))))
796 (nnheader-ms-strip-cr)
797 (funcall nnimap-callback-callback-function t)))
799 (defun nnimap-request-article-part (article part prop &optional
800 group server to-buffer detail)
801 (when (nnimap-possibly-change-group group server)
802 (let ((article (if (stringp article)
803 (car-safe (imap-search
804 (format "HEADER Message-Id \"%s\"" article)
805 nnimap-server-buffer))
808 (gnus-message 10 "nnimap: Fetching (part of) article %d..." article)
809 (if (not nnheader-callback-function)
810 (with-current-buffer (or to-buffer nntp-server-buffer)
812 (let ((data (imap-fetch article part prop nil
813 nnimap-server-buffer)))
814 (insert (nnimap-demule (if detail
817 (nnheader-ms-strip-cr)
818 (gnus-message 10 "nnimap: Fetching (part of) article %d...done"
821 (nnheader-report 'nnimap "No such article: %s"
822 (imap-error-text nnimap-server-buffer))
823 (cons group article)))
824 (add-hook 'imap-fetch-data-hook 'nnimap-callback)
825 (setq nnimap-callback-callback-function nnheader-callback-function
826 nnimap-callback-buffer nntp-server-buffer)
827 (imap-fetch-asynch article part nil nnimap-server-buffer)
828 (cons group article))))))
830 (deffoo nnimap-asynchronous-p ()
833 (deffoo nnimap-request-article (article &optional group server to-buffer)
834 (if (imap-capability 'IMAP4rev1 nnimap-server-buffer)
835 (nnimap-request-article-part
836 article "BODY.PEEK[]" 'BODYDETAIL group server to-buffer 'detail)
837 (nnimap-request-article-part
838 article "RFC822.PEEK" 'RFC822 group server to-buffer)))
840 (deffoo nnimap-request-head (article &optional group server to-buffer)
841 (if (imap-capability 'IMAP4rev1 nnimap-server-buffer)
842 (nnimap-request-article-part
843 article "BODY.PEEK[HEADER]" 'BODYDETAIL group server to-buffer 'detail)
844 (nnimap-request-article-part
845 article "RFC822.HEADER" 'RFC822.HEADER group server to-buffer)))
847 (deffoo nnimap-request-body (article &optional group server to-buffer)
848 (if (imap-capability 'IMAP4rev1 nnimap-server-buffer)
849 (nnimap-request-article-part
850 article "BODY.PEEK[TEXT]" 'BODYDETAIL group server to-buffer 'detail)
851 (nnimap-request-article-part
852 article "RFC822.TEXT.PEEK" 'RFC822.TEXT group server to-buffer)))
854 (deffoo nnimap-request-group (group &optional server fast)
855 (nnimap-request-update-info-internal
857 (gnus-get-info (gnus-group-prefixed-name
858 group (gnus-server-to-method (format "nnimap:%s" server))))
860 (when (nnimap-possibly-change-group group server)
861 (nnimap-before-find-minmax-bugworkaround)
864 ((null (setq info (nnimap-find-minmax-uid group t)))
865 (nnheader-report 'nnimap "Could not get active info for %s"
868 (nnheader-insert "211 %d %d %d %s\n" (or (nth 0 info) 0)
869 (max 1 (or (nth 1 info) 1))
870 (or (nth 2 info) 0) group)
871 (nnheader-report 'nnimap "Group %s selected" group)
874 (defun nnimap-update-unseen (group &optional server)
875 "Update the unseen count in `nnimap-mailbox-info'."
877 (gnus-group-prefixed-name group server)
878 (let ((old (gnus-gethash-safe (gnus-group-prefixed-name group server)
879 nnimap-mailbox-info)))
880 (list (nth 0 old) (nth 1 old)
881 (imap-mailbox-status group 'unseen nnimap-server-buffer)
883 nnimap-mailbox-info))
885 (defun nnimap-close-group (group &optional server)
886 (with-current-buffer nnimap-server-buffer
887 (when (and (imap-opened)
888 (nnimap-possibly-change-group group server))
889 (nnimap-update-unseen group server)
890 (case nnimap-expunge-on-close
892 (imap-mailbox-expunge nnimap-close-asynchronous)
893 (unless nnimap-dont-close
894 (imap-mailbox-close nnimap-close-asynchronous))))
895 (ask (if (and (imap-search "DELETED")
896 (gnus-y-or-n-p (format "Expunge articles in group `%s'? "
897 imap-current-mailbox)))
899 (imap-mailbox-expunge nnimap-close-asynchronous)
900 (unless nnimap-dont-close
901 (imap-mailbox-close nnimap-close-asynchronous)))
902 (imap-mailbox-unselect)))
903 (t (imap-mailbox-unselect)))
904 (not imap-current-mailbox))))
906 (defun nnimap-pattern-to-list-arguments (pattern)
908 (cons (car-safe p) (or (cdr-safe p) p)))
909 (if (and (listp pattern)
910 (listp (cdr pattern)))
914 (deffoo nnimap-request-list (&optional server)
915 (when (nnimap-possibly-change-server server)
916 (with-current-buffer nntp-server-buffer
918 (gnus-message 5 "nnimap: Generating active list%s..."
919 (if (> (length server) 0) (concat " for " server) ""))
920 (nnimap-before-find-minmax-bugworkaround)
921 (with-current-buffer nnimap-server-buffer
922 (dolist (pattern (nnimap-pattern-to-list-arguments nnimap-list-pattern))
923 (dolist (mbx (funcall nnimap-request-list-method
924 (cdr pattern) (car pattern)))
925 (or (member "\\NoSelect" (imap-mailbox-get 'list-flags mbx))
926 (let ((info (nnimap-find-minmax-uid mbx 'examine)))
928 (with-current-buffer nntp-server-buffer
929 (insert (format "\"%s\" %d %d y\n"
930 mbx (or (nth 2 info) 0)
931 (max 1 (or (nth 1 info) 1)))))))))))
932 (gnus-message 5 "nnimap: Generating active list%s...done"
933 (if (> (length server) 0) (concat " for " server) ""))
936 (deffoo nnimap-request-post (&optional server)
938 (dolist (mbx (message-unquote-tokens
939 (message-tokenize-header
940 (message-fetch-field "Newsgroups") ", ")) success)
941 (let ((to-newsgroup (gnus-group-prefixed-name mbx gnus-command-method)))
942 (or (gnus-active to-newsgroup)
943 (gnus-activate-group to-newsgroup)
944 (if (gnus-y-or-n-p (format "No such group: %s. Create it? "
946 (or (and (gnus-request-create-group
947 to-newsgroup gnus-command-method)
948 (gnus-activate-group to-newsgroup nil nil
949 gnus-command-method))
950 (error "Couldn't create group %s" to-newsgroup)))
951 (error "No such group: %s" to-newsgroup))
952 (unless (nnimap-request-accept-article mbx (nth 1 gnus-command-method))
953 (setq success nil))))))
955 ;; Optional backend functions
957 (defun nnimap-string-lessp-numerical (s1 s2)
958 "Return t if first arg string is less than second in numerical order."
959 (cond ((string= s1 s2)
961 ((> (length s1) (length s2))
963 ((< (length s1) (length s2))
965 ((< (string-to-number (substring s1 0 1))
966 (string-to-number (substring s2 0 1)))
968 ((> (string-to-number (substring s1 0 1))
969 (string-to-number (substring s2 0 1)))
972 (nnimap-string-lessp-numerical (substring s1 1) (substring s2 1)))))
974 (deffoo nnimap-retrieve-groups (groups &optional server)
975 (when (nnimap-possibly-change-server server)
976 (gnus-message 5 "nnimap: Checking mailboxes...")
977 (with-current-buffer nntp-server-buffer
979 (nnimap-before-find-minmax-bugworkaround)
980 (let (asyncgroups slowgroups)
981 (if (null nnimap-retrieve-groups-asynchronous)
982 (setq slowgroups groups)
983 (dolist (group groups)
984 (gnus-message 9 "nnimap: Quickly checking mailbox %s" group)
985 (add-to-list (if (gnus-gethash-safe
986 (gnus-group-prefixed-name group server)
990 (list group (imap-mailbox-status-asynch
991 group '(uidvalidity uidnext unseen)
992 nnimap-server-buffer))))
993 (dolist (asyncgroup asyncgroups)
994 (let ((group (nth 0 asyncgroup))
995 (tag (nth 1 asyncgroup))
997 (when (imap-ok-p (imap-wait-for-tag tag nnimap-server-buffer))
998 (if (or (not (string=
999 (nth 0 (gnus-gethash (gnus-group-prefixed-name
1001 nnimap-mailbox-info))
1002 (imap-mailbox-get 'uidvalidity group
1003 nnimap-server-buffer)))
1005 (nth 1 (gnus-gethash (gnus-group-prefixed-name
1007 nnimap-mailbox-info))
1008 (imap-mailbox-get 'uidnext group
1009 nnimap-server-buffer))))
1010 (push (list group) slowgroups)
1011 (insert (nth 3 (gnus-gethash (gnus-group-prefixed-name
1013 nnimap-mailbox-info))))))))
1014 (dolist (group slowgroups)
1015 (if nnimap-retrieve-groups-asynchronous
1016 (setq group (car group)))
1017 (gnus-message 7 "nnimap: Mailbox %s modified" group)
1018 (imap-mailbox-put 'uidnext nil group nnimap-server-buffer)
1019 (or (member "\\NoSelect" (imap-mailbox-get 'list-flags group
1020 nnimap-server-buffer))
1021 (let* ((info (nnimap-find-minmax-uid group 'examine))
1022 (str (format "\"%s\" %d %d y\n" group
1024 (max 1 (or (nth 1 info) 1)))))
1025 (when (> (or (imap-mailbox-get 'recent group
1026 nnimap-server-buffer) 0)
1028 (push (list (cons group 0)) nnmail-split-history))
1030 (when nnimap-retrieve-groups-asynchronous
1032 (gnus-group-prefixed-name group server)
1033 (list (or (imap-mailbox-get
1034 'uidvalidity group nnimap-server-buffer)
1035 (imap-mailbox-status
1036 group 'uidvalidity nnimap-server-buffer))
1037 (or (imap-mailbox-get
1038 'uidnext group nnimap-server-buffer)
1039 (imap-mailbox-status
1040 group 'uidnext nnimap-server-buffer))
1041 (or (imap-mailbox-get
1042 'unseen group nnimap-server-buffer)
1043 (imap-mailbox-status
1044 group 'unseen nnimap-server-buffer))
1046 nnimap-mailbox-info)))))))
1047 (gnus-message 5 "nnimap: Checking mailboxes...done")
1050 (deffoo nnimap-request-update-info-internal (group info &optional server)
1051 (when (nnimap-possibly-change-group group server)
1052 (when info ;; xxx what does this mean? should we create a info?
1053 (with-current-buffer nnimap-server-buffer
1054 (gnus-message 5 "nnimap: Updating info for %s..."
1055 (gnus-info-group info))
1057 (when (nnimap-mark-permanent-p 'read)
1059 ;; read info could contain articles marked unread by other
1060 ;; imap clients! we correct this
1061 (setq seen (gnus-uncompress-range (gnus-info-read info))
1062 unseen (imap-search "UNSEEN UNDELETED")
1063 seen (gnus-set-difference seen unseen)
1064 ;; seen might lack articles marked as read by other
1065 ;; imap clients! we correct this
1066 seen (append seen (imap-search "SEEN"))
1069 seen (gnus-compress-sequence seen t)
1070 ;; we can't return '(1) since this isn't a "list of ranges",
1071 ;; and we can't return '((1)) since g-list-of-unread-articles
1072 ;; is buggy so we return '((1 . 1)).
1073 seen (if (and (integerp (car seen))
1075 (list (cons (car seen) (car seen)))
1077 (gnus-info-set-read info seen)))
1079 (mapcar (lambda (pred)
1080 (when (or (eq (cdr pred) 'recent)
1081 (and (nnimap-mark-permanent-p (cdr pred))
1082 (member (nnimap-mark-to-flag (cdr pred))
1083 (imap-mailbox-get 'flags))))
1084 (gnus-info-set-marks
1086 (gnus-update-alist-soft
1088 (gnus-compress-sequence
1089 (imap-search (nnimap-mark-to-predicate (cdr pred))))
1090 (gnus-info-marks info))
1092 gnus-article-mark-lists)
1094 (when nnimap-importantize-dormant
1095 ;; nnimap mark dormant article as ticked too (for other clients)
1096 ;; so we remove that mark for gnus since we support dormant
1097 (gnus-info-set-marks
1099 (gnus-update-alist-soft
1101 (gnus-remove-from-range
1102 (cdr-safe (assoc 'tick (gnus-info-marks info)))
1103 (cdr-safe (assoc 'dormant (gnus-info-marks info))))
1104 (gnus-info-marks info))
1107 (gnus-message 5 "nnimap: Updating info for %s...done"
1108 (gnus-info-group info))
1112 (deffoo nnimap-request-type (group &optional article)
1113 (if (and nnimap-news-groups (string-match nnimap-news-groups group))
1117 (deffoo nnimap-request-set-mark (group actions &optional server)
1118 (when (nnimap-possibly-change-group group server)
1119 (with-current-buffer nnimap-server-buffer
1121 (gnus-message 7 "nnimap: Setting marks in %s..." group)
1122 (while (setq action (pop actions))
1123 (let ((range (nth 0 action))
1124 (what (nth 1 action))
1125 (cmdmarks (nth 2 action))
1127 ;; bookmark can't be stored (not list/range
1128 (setq cmdmarks (delq 'bookmark cmdmarks))
1129 ;; killed can't be stored (not list/range
1130 (setq cmdmarks (delq 'killed cmdmarks))
1131 ;; unsent are for nndraft groups only
1132 (setq cmdmarks (delq 'unsent cmdmarks))
1133 ;; cache flags are pointless on the server
1134 (setq cmdmarks (delq 'cache cmdmarks))
1135 ;; seen flags are local to each gnus
1136 (setq cmdmarks (delq 'seen cmdmarks))
1137 ;; recent marks can't be set
1138 (setq cmdmarks (delq 'recent cmdmarks))
1139 (when nnimap-importantize-dormant
1140 ;; flag dormant articles as ticked
1141 (if (memq 'dormant cmdmarks)
1142 (setq cmdmarks (cons 'tick cmdmarks))))
1143 ;; remove stuff we are forbidden to store
1144 (mapcar (lambda (mark)
1145 (if (imap-message-flag-permanent-p
1146 (nnimap-mark-to-flag mark))
1147 (setq marks (cons mark marks))))
1149 (when (and range marks)
1150 (cond ((eq what 'del)
1151 (imap-message-flags-del
1152 (imap-range-to-message-set range)
1153 (nnimap-mark-to-flag marks nil t)))
1155 (imap-message-flags-add
1156 (imap-range-to-message-set range)
1157 (nnimap-mark-to-flag marks nil t)))
1159 (imap-message-flags-set
1160 (imap-range-to-message-set range)
1161 (nnimap-mark-to-flag marks nil t)))))))
1162 (gnus-message 7 "nnimap: Setting marks in %s...done" group))))
1165 (defun nnimap-split-fancy ()
1166 "Like the function `nnmail-split-fancy', but uses `nnimap-split-fancy'."
1167 (let ((nnmail-split-fancy nnimap-split-fancy))
1168 (nnmail-split-fancy)))
1170 (defun nnimap-split-to-groups (rules)
1171 ;; tries to match all rules in nnimap-split-rule against content of
1172 ;; nntp-server-buffer, returns a list of groups that matched.
1173 (with-current-buffer nntp-server-buffer
1174 ;; Fold continuation lines.
1175 (goto-char (point-min))
1176 (while (re-search-forward "\\(\r?\n[ \t]+\\)+" nil t)
1177 (replace-match " " t t))
1178 (if (functionp rules)
1180 (let (to-groups regrepp)
1182 (dolist (rule rules to-groups)
1183 (let ((group (car rule))
1184 (regexp (cadr rule)))
1185 (goto-char (point-min))
1186 (when (and (if (stringp regexp)
1188 (if (not (stringp group))
1189 (setq group (eval group))
1191 (string-match "\\\\[0-9&]" group)))
1192 (re-search-forward regexp nil t))
1193 (funcall regexp group))
1194 ;; Don't enter the article into the same group twice.
1195 (not (assoc group to-groups)))
1197 (nnmail-expand-newtext group)
1200 (or nnimap-split-crosspost
1201 (throw 'split-done to-groups))))))))))
1203 (defun nnimap-assoc-match (key alist)
1205 (while (and alist (not element))
1206 (if (string-match (car (car alist)) key)
1207 (setq element (car alist)))
1208 (setq alist (cdr alist)))
1211 (defun nnimap-split-find-rule (server inbox)
1212 (if (and (listp nnimap-split-rule) (listp (car nnimap-split-rule))
1213 (list (cdar nnimap-split-rule)) (listp (cadar nnimap-split-rule)))
1215 (cadr (nnimap-assoc-match inbox (cdr (nnimap-assoc-match
1216 server nnimap-split-rule))))
1219 (defun nnimap-split-find-inbox (server)
1220 (if (listp nnimap-split-inbox)
1222 (list nnimap-split-inbox)))
1224 (defun nnimap-split-articles (&optional group server)
1225 (when (nnimap-possibly-change-server server)
1226 (with-current-buffer nnimap-server-buffer
1227 (let (rule inbox removeorig (inboxes (nnimap-split-find-inbox server)))
1228 ;; iterate over inboxes
1229 (while (and (setq inbox (pop inboxes))
1230 (nnimap-possibly-change-group inbox)) ;; SELECT
1231 ;; find split rule for this server / inbox
1232 (when (setq rule (nnimap-split-find-rule server inbox))
1233 ;; iterate over articles
1234 (dolist (article (imap-search nnimap-split-predicate))
1235 (when (nnimap-request-head article)
1236 ;; copy article to right group(s)
1237 (setq removeorig nil)
1238 (dolist (to-group (nnimap-split-to-groups rule))
1239 (cond ((eq to-group 'junk)
1240 (message "IMAP split removed %s:%s:%d" server inbox
1242 (setq removeorig t))
1243 ((imap-message-copy (number-to-string article)
1244 to-group nil 'nocopyuid)
1245 (message "IMAP split moved %s:%s:%d to %s" server
1246 inbox article to-group)
1248 (when nnmail-cache-accepted-message-ids
1249 (with-current-buffer nntp-server-buffer
1252 (nnmail-fetch-field "message-id"))
1253 (nnmail-cache-insert msgid to-group)))))
1254 ;; Add the group-art list to the history list.
1255 (push (list (cons to-group 0)) nnmail-split-history))
1257 (message "IMAP split failed to move %s:%s:%d to %s"
1258 server inbox article to-group))))
1259 ;; remove article if it was successfully copied somewhere
1261 (imap-message-flags-add (format "%d" article)
1262 "\\Seen \\Deleted")))))
1263 (when (imap-mailbox-select inbox) ;; just in case
1264 ;; todo: UID EXPUNGE (if available) to remove splitted articles
1265 (imap-mailbox-expunge)
1266 (imap-mailbox-close)))
1267 (when nnmail-cache-accepted-message-ids
1268 (nnmail-cache-close))
1271 (deffoo nnimap-request-scan (&optional group server)
1272 (nnimap-split-articles group server))
1274 (deffoo nnimap-request-newgroups (date &optional server)
1275 (when (nnimap-possibly-change-server server)
1276 (with-current-buffer nntp-server-buffer
1277 (gnus-message 5 "nnimap: Listing subscribed mailboxes%s%s..."
1278 (if (> (length server) 0) " on " "") server)
1280 (nnimap-before-find-minmax-bugworkaround)
1281 (dolist (pattern (nnimap-pattern-to-list-arguments
1282 nnimap-list-pattern))
1283 (dolist (mbx (imap-mailbox-lsub "*" (car pattern) nil
1284 nnimap-server-buffer))
1286 (dolist (mailbox (imap-mailbox-get 'list-flags mbx
1287 nnimap-server-buffer))
1288 (if (string= (downcase mailbox) "\\noselect")
1291 (let ((info (nnimap-find-minmax-uid mbx 'examine)))
1293 (insert (format "\"%s\" %d %d y\n"
1294 mbx (or (nth 2 info) 0)
1295 (max 1 (or (nth 1 info) 1)))))))))
1296 (gnus-message 5 "nnimap: Listing subscribed mailboxes%s%s...done"
1297 (if (> (length server) 0) " on " "") server))
1300 (deffoo nnimap-request-create-group (group &optional server args)
1301 (when (nnimap-possibly-change-server server)
1302 (or (imap-mailbox-status group 'uidvalidity nnimap-server-buffer)
1303 (imap-mailbox-create group nnimap-server-buffer))))
1305 (defun nnimap-time-substract (time1 time2)
1306 "Return TIME for TIME1 - TIME2."
1307 (let* ((ms (- (car time1) (car time2)))
1308 (ls (- (nth 1 time1) (nth 1 time2))))
1310 (list (- ms 1) (+ (expt 2 16) ls))
1313 (defun nnimap-date-days-ago (daysago)
1314 "Return date, in format \"3-Aug-1998\", for DAYSAGO days ago."
1315 (let* ((time (nnimap-time-substract (current-time) (days-to-time daysago)))
1316 (date (format-time-string
1317 (format "%%d-%s-%%Y"
1318 (capitalize (car (rassoc (nth 4 (decode-time time))
1319 parse-time-months))))
1321 (if (eq ?0 (string-to-char date))
1325 (defun nnimap-request-expire-articles-progress ()
1326 (gnus-message 5 "nnimap: Marking article %d for deletion..."
1327 imap-current-message))
1329 (defun nnimap-expiry-target (arts group server)
1330 (unless (eq nnmail-expiry-target 'delete)
1333 (nnimap-request-article art group server (current-buffer))
1334 ;; hints for optimization in `nnimap-request-accept-article'
1335 (let ((nnimap-current-move-article art)
1336 (nnimap-current-move-group group)
1337 (nnimap-current-move-server server))
1338 (nnmail-expiry-target-group nnmail-expiry-target group))))
1339 ;; It is not clear if `nnmail-expiry-target' somehow cause the
1340 ;; current group to be changed or not, so we make sure here.
1341 (nnimap-possibly-change-group group server)))
1343 ;; Notice that we don't actually delete anything, we just mark them deleted.
1344 (deffoo nnimap-request-expire-articles (articles group &optional server force)
1345 (let ((artseq (gnus-compress-sequence articles)))
1346 (when (and artseq (nnimap-possibly-change-group group server))
1347 (with-current-buffer nnimap-server-buffer
1348 (let ((days (or (and nnmail-expiry-wait-function
1349 (funcall nnmail-expiry-wait-function group))
1350 nnmail-expiry-wait)))
1351 (cond ((or force (eq days 'immediate))
1352 (let ((oldarts (imap-search
1354 (imap-range-to-message-set artseq)))))
1356 (nnimap-expiry-target oldarts group server)
1357 (when (imap-message-flags-add
1358 (imap-range-to-message-set oldarts) "\\Deleted")
1359 (setq articles (gnus-set-difference
1360 articles oldarts))))))
1362 (let ((oldarts (imap-search
1363 (format nnimap-expunge-search-string
1364 (imap-range-to-message-set artseq)
1365 (nnimap-date-days-ago days))))
1366 (imap-fetch-data-hook
1367 '(nnimap-request-expire-articles-progress)))
1369 (nnimap-expiry-target oldarts group server)
1370 (when (imap-message-flags-add
1371 (imap-range-to-message-set oldarts) "\\Deleted")
1372 (setq articles (gnus-set-difference
1373 articles oldarts)))))))))))
1374 ;; return articles not deleted
1377 (deffoo nnimap-request-move-article (article group server
1378 accept-form &optional last)
1379 (when (nnimap-possibly-change-server server)
1381 (let ((buf (get-buffer-create " *nnimap move*"))
1382 (nnimap-current-move-article article)
1383 (nnimap-current-move-group group)
1384 (nnimap-current-move-server nnimap-current-server)
1386 (and (nnimap-request-article article group server)
1389 (buffer-disable-undo (current-buffer))
1390 (insert-buffer-substring nntp-server-buffer)
1391 (setq result (eval accept-form))
1394 (imap-message-flags-add
1395 (imap-range-to-message-set (list article))
1396 "\\Deleted" 'silent nnimap-server-buffer))
1399 (deffoo nnimap-request-accept-article (group &optional server last)
1400 (when (nnimap-possibly-change-server server)
1403 (if (string= nnimap-current-server nnimap-current-move-server)
1404 ;; moving article within same server, speed it up...
1405 (and (nnimap-possibly-change-group
1406 nnimap-current-move-group)
1407 (imap-message-copy (number-to-string
1408 nnimap-current-move-article)
1409 group 'dontcreate nil
1410 nnimap-server-buffer))
1411 (with-current-buffer (current-buffer)
1412 (goto-char (point-min))
1413 ;; remove any 'From blabla' lines, some IMAP servers
1414 ;; reject the entire message otherwise.
1415 (when (looking-at "^From[^:]")
1416 (kill-region (point) (progn (forward-line) (point))))
1417 ;; turn into rfc822 format (\r\n eol's)
1418 (while (search-forward "\n" nil t)
1419 (replace-match "\r\n"))
1420 (when nnmail-cache-accepted-message-ids
1421 (nnmail-cache-insert (nnmail-fetch-field "message-id")
1423 (when (and last nnmail-cache-accepted-message-ids)
1424 (nnmail-cache-close))
1425 ;; this 'or' is for Cyrus server bug
1426 (or (null (imap-current-mailbox nnimap-server-buffer))
1427 (imap-mailbox-unselect nnimap-server-buffer))
1428 (imap-message-append group (current-buffer) nil nil
1429 nnimap-server-buffer)))
1430 (cons group (nth 1 uid))
1431 (nnheader-report 'nnimap (imap-error-text nnimap-server-buffer))))))
1433 (deffoo nnimap-request-delete-group (group force &optional server)
1434 (when (nnimap-possibly-change-server server)
1435 (with-current-buffer nnimap-server-buffer
1437 (or (null (imap-mailbox-status group 'uidvalidity))
1438 (imap-mailbox-delete group))
1442 (deffoo nnimap-request-rename-group (group new-name &optional server)
1443 (when (nnimap-possibly-change-server server)
1444 (imap-mailbox-rename group new-name nnimap-server-buffer)))
1446 (defun nnimap-expunge (mailbox server)
1447 (when (nnimap-possibly-change-group mailbox server)
1448 (imap-mailbox-expunge nil nnimap-server-buffer)))
1450 (defun nnimap-acl-get (mailbox server)
1451 (when (nnimap-possibly-change-server server)
1452 (and (imap-capability 'ACL nnimap-server-buffer)
1453 (imap-mailbox-acl-get mailbox nnimap-server-buffer))))
1455 (defun nnimap-acl-edit (mailbox method old-acls new-acls)
1456 (when (nnimap-possibly-change-server (cadr method))
1457 (unless (imap-capability 'ACL nnimap-server-buffer)
1458 (error "Your server does not support ACL editing"))
1459 (with-current-buffer nnimap-server-buffer
1460 ;; delete all removed identifiers
1461 (mapcar (lambda (old-acl)
1462 (unless (assoc (car old-acl) new-acls)
1463 (or (imap-mailbox-acl-delete (car old-acl) mailbox)
1464 (error "Can't delete ACL for %s" (car old-acl)))))
1466 ;; set all changed acl's
1467 (mapcar (lambda (new-acl)
1468 (let ((new-rights (cdr new-acl))
1469 (old-rights (cdr (assoc (car new-acl) old-acls))))
1470 (unless (and old-rights new-rights
1471 (string= old-rights new-rights))
1472 (or (imap-mailbox-acl-set (car new-acl) new-rights mailbox)
1473 (error "Can't set ACL for %s to %s" (car new-acl)
1479 ;;; Internal functions
1482 ;; This is confusing.
1484 ;; mark => read, tick, draft, reply etc
1485 ;; flag => "\\Seen", "\\Flagged", "\\Draft", "gnus-expire" etc
1486 ;; predicate => "SEEN", "FLAGGED", "DRAFT", "KEYWORD gnus-expire" etc
1488 ;; Mark should not really contain 'read since it's not a "mark" in the Gnus
1489 ;; world, but we cheat. Mark == gnus-article-mark-lists + '(read . read).
1492 (defconst nnimap-mark-to-predicate-alist
1494 (lambda (pair) ; cdr is the mark
1495 (or (assoc (cdr pair)
1500 (reply . "ANSWERED")))
1502 (format "KEYWORD gnus-%s" (symbol-name (cdr pair))))))
1503 (cons '(read . read) gnus-article-mark-lists)))
1505 (defun nnimap-mark-to-predicate (pred)
1506 "Convert a Gnus mark (a symbol such as read, tick, expire) to a IMAP predicate.
1507 This is a string such as \"SEEN\", \"FLAGGED\", \"KEYWORD gnus-expire\",
1508 to be used within a IMAP SEARCH query."
1509 (cdr (assq pred nnimap-mark-to-predicate-alist)))
1511 (defconst nnimap-mark-to-flag-alist
1514 (or (assoc (cdr pair)
1516 (tick . "\\Flagged")
1518 (recent . "\\Recent")
1519 (reply . "\\Answered")))
1521 (format "gnus-%s" (symbol-name (cdr pair))))))
1522 (cons '(read . read) gnus-article-mark-lists)))
1524 (defun nnimap-mark-to-flag-1 (preds)
1525 (if (and (not (null preds)) (listp preds))
1526 (cons (nnimap-mark-to-flag (car preds))
1527 (nnimap-mark-to-flag (cdr preds)))
1528 (cdr (assoc preds nnimap-mark-to-flag-alist))))
1530 (defun nnimap-mark-to-flag (preds &optional always-list make-string)
1531 "Convert a Gnus mark (a symbol such as read, tick, expire) to a IMAP flag.
1532 This is a string such as \"\\Seen\", \"\\Flagged\", \"gnus-expire\", to
1533 be used in a STORE FLAGS command."
1534 (let ((result (nnimap-mark-to-flag-1 preds)))
1535 (setq result (if (and (or make-string always-list)
1536 (not (listp result)))
1540 (mapconcat (lambda (flag)
1542 (mapconcat 'identity flag " ")
1547 (defun nnimap-mark-permanent-p (mark &optional group)
1548 "Return t iff MARK can be permanently (between IMAP sessions) saved on articles, in GROUP."
1549 (imap-message-flag-permanent-p (nnimap-mark-to-flag mark)))
1553 (buffer-disable-undo (get-buffer-create nnimap-debug))
1554 (mapcar (lambda (f) (trace-function-background f nnimap-debug))
1556 nnimap-possibly-change-server
1557 nnimap-verify-uidvalidity
1558 nnimap-find-minmax-uid
1559 nnimap-before-find-minmax-bugworkaround
1560 nnimap-possibly-change-group
1561 ;;nnimap-replace-whitespace
1562 nnimap-retrieve-headers-progress
1563 nnimap-retrieve-which-headers
1564 nnimap-group-overview-filename
1565 nnimap-retrieve-headers-from-file
1566 nnimap-retrieve-headers-from-server
1567 nnimap-retrieve-headers
1568 nnimap-open-connection
1570 nnimap-server-opened
1572 nnimap-request-close
1573 nnimap-status-message
1575 nnimap-request-article-part
1576 nnimap-request-article
1579 nnimap-request-group
1581 nnimap-pattern-to-list-arguments
1584 nnimap-retrieve-groups
1585 nnimap-request-update-info-internal
1587 nnimap-request-set-mark
1588 nnimap-split-to-groups
1589 nnimap-split-find-rule
1590 nnimap-split-find-inbox
1591 nnimap-split-articles
1593 nnimap-request-newgroups
1594 nnimap-request-create-group
1595 nnimap-time-substract
1596 nnimap-date-days-ago
1597 nnimap-request-expire-articles-progress
1598 nnimap-request-expire-articles
1599 nnimap-request-move-article
1600 nnimap-request-accept-article
1601 nnimap-request-delete-group
1602 nnimap-request-rename-group
1603 gnus-group-nnimap-expunge
1604 gnus-group-nnimap-edit-acl
1605 gnus-group-nnimap-edit-acl-done
1606 nnimap-group-mode-hook
1607 nnimap-mark-to-predicate
1608 nnimap-mark-to-flag-1
1610 nnimap-mark-permanent-p
1615 ;;; nnimap.el ends here