1 ;;; nnimap.el --- imap backend for Gnus
3 ;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
4 ;; 2007, 2008 Free Software Foundation, Inc.
6 ;; Author: Simon Josefsson <jas@pdc.kth.se>
7 ;; Jim Radford <radford@robby.caltech.edu>
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
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?) (unnecessary?)
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
72 (eval-when-compile (require 'cl
))
74 (autoload 'auth-source-user-or-password
"auth-source")
78 (defconst nnimap-version
"nnimap 1.0")
81 "Reading IMAP mail with Gnus."
84 (defvoo nnimap-address nil
85 "Address of physical IMAP server. If nil, use the virtual server's name.")
87 (defvoo nnimap-server-port nil
88 "Port number on physical IMAP server.
89 If nil, defaults to 993 for TLS/SSL connections and 143 otherwise.")
91 ;; Splitting variables
93 (defcustom nnimap-split-crosspost t
94 "If non-nil, do crossposting if several split methods match the mail.
95 If nil, the first match found will be used."
99 (defcustom nnimap-split-inbox nil
100 "Name of mailbox to split mail from.
102 Mail is read from this mailbox and split according to rules in
105 This can be a string or a list of strings."
107 :type
'(choice (string)
110 (define-widget 'nnimap-strict-function
'function
111 "This widget only matches values that are functionp.
113 Warning: This means that a value that is the symbol of a not yet
114 loaded function will not match. Use with care."
115 :match
'nnimap-strict-function-match
)
117 (defun nnimap-strict-function-match (widget value
)
118 "Ignoring WIDGET, match if VALUE is a function."
121 (defcustom nnimap-split-rule nil
122 "Mail will be split according to these rules.
124 Mail is read from mailbox(es) specified in `nnimap-split-inbox'.
126 If you'd like, for instance, one mail group for mail from the
127 \"gnus-imap\" mailing list, one group for junk mail and leave
128 everything else in the incoming mailbox, you could do something like
131 \(setq nnimap-split-rule '((\"INBOX.gnus-imap\" \"From:.*gnus-imap\")
132 (\"INBOX.junk\" \"Subject:.*buy\")))
134 As you can see, `nnimap-split-rule' is a list of lists, where the
135 first element in each \"rule\" is the name of the IMAP mailbox (or the
136 symbol `junk' if you want to remove the mail), and the second is a
137 regexp that nnimap will try to match on the header to find a fit.
139 The second element can also be a function. In that case, it will be
140 called narrowed to the headers with the first element of the rule as
141 the argument. It should return a non-nil value if it thinks that the
142 mail belongs in that group.
144 This variable can also have a function as its value, the function will
145 be called with the headers narrowed and should return a group where it
146 thinks the article should be splitted to. See `nnimap-split-fancy'.
148 To allow for different split rules on different virtual servers, and
149 even different split rules in different inboxes on the same server,
150 the syntax of this variable have been extended along the lines of:
152 \(setq nnimap-split-rule
153 '((\"my1server\" (\".*\" ((\"ding\" \"ding@gnus.org\")
154 (\"junk\" \"From:.*Simon\")))
155 (\"my2server\" (\"INBOX\" nnimap-split-fancy))
156 (\"my[34]server\" (\".*\" ((\"private\" \"To:.*Simon\")
157 (\"junk\" my-junk-func)))))
159 The virtual server name is in fact a regexp, so that the same rules
160 may apply to several servers. In the example, the servers
161 \"my3server\" and \"my4server\" both use the same rules. Similarly,
162 the inbox string is also a regexp. The actual splitting rules are as
163 before, either a function, or a list with group/regexp or
164 group/function elements."
166 :type
'(choice :tag
"Rule type"
167 (repeat :menu-tag
"Single-server"
168 :tag
"Single-server list"
169 (list (string :tag
"Mailbox")
170 (choice :tag
"Predicate"
171 (regexp :tag
"A regexp")
172 (nnimap-strict-function :tag
"A function"))))
173 (choice :menu-tag
"A function"
175 (function-item nnimap-split-fancy
)
176 (function-item nnmail-split-fancy
)
177 (nnimap-strict-function :tag
"User-defined function"))
178 (repeat :menu-tag
"Multi-server (extended)"
179 :tag
"Multi-server list"
180 (list (regexp :tag
"Server regexp")
181 (list (regexp :tag
"Incoming Mailbox regexp")
182 (repeat :tag
"Rules for matching server(s) and mailbox(es)"
183 (list (string :tag
"Destination mailbox")
184 (choice :tag
"Predicate"
185 (regexp :tag
"A Regexp")
186 (nnimap-strict-function :tag
"A Function")))))))))
188 (defcustom nnimap-split-predicate
"UNSEEN UNDELETED"
189 "The predicate used to find articles to split.
190 If you use another IMAP client to peek on articles but always would
191 like nnimap to split them once it's started, you could change this to
192 \"UNDELETED\". Other available predicates are available in
193 RFC2060 section 6.4.4."
197 (defcustom nnimap-split-fancy nil
198 "Like the variable `nnmail-split-fancy'."
202 (defvar nnimap-split-download-body-default nil
203 "Internal variable with default value for `nnimap-split-download-body'.")
205 (defcustom nnimap-split-download-body
'default
206 "Whether to download entire articles during splitting.
207 This is generally not required, and will slow things down considerably.
208 You may need it if you want to use an advanced splitting function that
209 analyzes the body before splitting the article.
210 If this variable is nil, bodies will not be downloaded; if this
211 variable is the symbol `default' the default behavior is
212 used (which currently is nil, unless you use a statistical
213 spam.el test); if this variable is another non-nil value bodies
217 :type
'(choice (const :tag
"Let system decide" deault
)
220 ;; Performance / bug workaround variables
222 (defcustom nnimap-close-asynchronous t
223 "Close mailboxes asynchronously in `nnimap-close-group'.
224 This means that errors caught by nnimap when closing the mailbox will
225 not prevent Gnus from updating the group status, which may be harmful.
226 However, it increases speed."
231 (defcustom nnimap-dont-close t
232 "Never close mailboxes.
233 This increases the speed of closing mailboxes (quiting group) but may
234 decrease the speed of selecting another mailbox later. Re-selecting
235 the same mailbox will be faster though."
240 (defcustom nnimap-retrieve-groups-asynchronous t
241 "Send asynchronous STATUS commands for each mailbox before checking mail.
242 If you have mailboxes that rarely receives mail, this speeds up new
243 mail checking. It works by first sending STATUS commands for each
244 mailbox, and then only checking groups which has a modified UIDNEXT
245 more carefully for new mail.
247 In summary, the default is O((1-p)*k+p*n) and changing it to nil makes
248 it O(n). If p is small, then the default is probably faster."
253 (defvoo nnimap-need-unselect-to-notice-new-mail t
254 "Unselect mailboxes before looking for new mail in them.
255 Some servers seem to need this under some circumstances.")
257 (defvoo nnimap-logout-timeout nil
258 "Close server immediately if it can't logout in this number of seconds.
259 If it is nil, never close server until logout completes. This variable
260 overrides `imap-logout-timeout' on a per-server basis.")
262 ;; Authorization / Privacy variables
264 (defvoo nnimap-auth-method nil
267 (defvoo nnimap-stream nil
268 "How nnimap will connect to the server.
270 The default, nil, will try to use the \"best\" method the server can
275 1) you want to connect with TLS/SSL. The TLS/SSL integration
276 with IMAP is suboptimal so you'll have to tell it
279 2) your server is more capable than your environment -- i.e. your
280 server accept Kerberos login's but you haven't installed the
281 `imtest' program or your machine isn't configured for Kerberos.
283 Possible choices: gssapi, kerberos4, starttls, tls, ssl, network, shell.
284 See also `imap-streams' and `imap-stream-alist'.")
286 (defvoo nnimap-authenticator nil
287 "How nnimap authenticate itself to the server.
289 The default, nil, will try to use the \"best\" method the server can
292 There is only one reason for fiddling with this variable, and that is
293 if your server is more capable than your environment -- i.e. you
294 connect to a server that accept Kerberos login's but you haven't
295 installed the `imtest' program or your machine isn't configured for
298 Possible choices: gssapi, kerberos4, digest-md5, cram-md5, login, anonymous.
299 See also `imap-authenticators' and `imap-authenticator-alist'")
301 (defvoo nnimap-directory
(nnheader-concat gnus-directory
"overview/")
302 "Directory to keep NOV cache files for nnimap groups.
303 See also `nnimap-nov-file-name'.")
305 (defvoo nnimap-nov-file-name
"nnimap."
306 "NOV cache base filename.
307 The group name and `nnimap-nov-file-name-suffix' will be appended. A
308 typical complete file name would be
309 ~/News/overview/nnimap.pdc.INBOX.ding.nov, or
310 ~/News/overview/nnimap/pdc/INBOX/ding/nov if
311 `nnmail-use-long-file-names' is nil")
313 (defvoo nnimap-nov-file-name-suffix
".novcache"
314 "Suffix for NOV cache base filename.")
316 (defvoo nnimap-nov-is-evil gnus-agent
317 "If non-nil, never generate or use a local nov database for this backend.
318 Using nov databases should speed up header fetching considerably.
319 However, it will invoke a UID SEARCH UID command on the server, and
320 some servers implement this command inefficiently by opening each and
321 every message in the group, thus making it quite slow.
322 Unlike other backends, you do not need to take special care if you
323 flip this variable.")
325 (defvoo nnimap-search-uids-not-since-is-evil nil
326 "If non-nil, avoid \"UID SEARCH UID ... NOT SINCE\" queries when expiring.
327 Instead, use \"UID SEARCH SINCE\" to prune the list of expirable
328 articles within Gnus. This seems to be faster on Courier in some cases.")
330 (defvoo nnimap-expunge-on-close
'always
; 'ask, 'never
331 "Whether to expunge a group when it is closed.
332 When a IMAP group with articles marked for deletion is closed, this
333 variable determine if nnimap should actually remove the articles or
336 If always, nnimap always perform a expunge when closing the group.
337 If never, nnimap never expunges articles marked for deletion.
338 If ask, nnimap will ask you if you wish to expunge marked articles.
340 When setting this variable to `never', you can only expunge articles
341 by using `G x' (gnus-group-nnimap-expunge) from the Group buffer.")
343 (defvoo nnimap-list-pattern
"*"
344 "A string LIMIT or list of strings with mailbox wildcards used to limit available groups.
345 See below for available wildcards.
347 The LIMIT string can be a cons cell (REFERENCE . LIMIT), where
348 REFERENCE will be passed as the first parameter to LIST/LSUB. The
349 semantics of this are server specific, on the University of Washington
350 server you can specify a directory.
353 '(\"INBOX\" \"mail/*\" (\"~friend/mail/\" . \"list/*\"))
355 There are two wildcards * and %. * matches everything, % matches
356 everything in the current hierarchy.")
358 (defvoo nnimap-news-groups nil
359 "IMAP support a news-like mode, also known as bulletin board mode,
360 where replies is sent via IMAP instead of SMTP.
362 This variable should contain a regexp matching groups where you wish
363 replies to be stored to the mailbox directly.
366 '(\"^[^I][^N][^B][^O][^X].*$\")
368 This will match all groups not beginning with \"INBOX\".
370 Note that there is nothing technically different between mail-like and
371 news-like mailboxes. If you wish to have a group with todo items or
372 similar which you wouldn't want to set up a mailing list for, you can
373 use this to make replies go directly to the group.")
375 (defvoo nnimap-expunge-search-string
"UID %s NOT SINCE %s"
376 "IMAP search command to use for articles that are to be expired.
377 The first %s is replaced by a UID set of articles to search on,
378 and the second %s is replaced by a date criterium.
380 One useful (and perhaps the only useful) value to change this to would
381 be `UID %s NOT SENTSINCE %s' to make nnimap use the Date: header
382 instead of the internal date of messages. See section 6.4.4 of RFC
383 2060 for more information on valid strings.
385 However, if `nnimap-search-uids-not-since-is-evil' is true, this
386 variable has no effect since the search logic is reversed.")
388 (defvoo nnimap-importantize-dormant t
389 "If non-nil, mark \"dormant\" articles as \"ticked\" for other IMAP clients.
390 Note that within Gnus, dormant articles will still (only) be
391 marked as ticked. This is to make \"dormant\" articles stand out,
392 just like \"ticked\" articles, in other IMAP clients.")
394 (defvoo nnimap-server-address nil
395 "Obsolete. Use `nnimap-address'.")
397 (defcustom nnimap-authinfo-file
"~/.authinfo"
398 "Authorization information for IMAP servers. In .netrc format."
401 (repeat :tag
"Entries"
404 :value
("" ("login" .
"") ("password" .
""))
408 (const :format
"" "login")
409 (string :format
"Login: %v"))
411 (const :format
"" "password")
412 (string :format
"Password: %v"))))))
415 (defcustom nnimap-prune-cache t
416 "If non-nil, nnimap check whether articles still exist on server before using data stored in NOV cache."
420 (defvar nnimap-request-list-method
'imap-mailbox-list
421 "Method to use to request a list of all folders from the server.
422 If this is 'imap-mailbox-lsub, then use a server-side subscription list to
423 restrict visible folders.")
425 (defcustom nnimap-id nil
426 "Plist with client identity to send to server upon login.
427 A nil value means no information is sent, symbol `no' to disable ID query
428 altogether, or plist with identifier-value pairs to send to
429 server. RFC 2971 describes the list as follows:
431 Any string may be sent as a field, but the following are defined to
432 describe certain values that might be sent. Implementations are free
433 to send none, any, or all of these. Strings are not case-sensitive.
434 Field strings MUST NOT be longer than 30 octets. Value strings MUST
435 NOT be longer than 1024 octets. Implementations MUST NOT send more
436 than 30 field-value pairs.
438 name Name of the program
439 version Version number of the program
440 os Name of the operating system
441 os-version Version of the operating system
442 vendor Vendor of the client/server
443 support-url URL to contact for support
444 address Postal address of contact/vendor
445 date Date program was released, specified as a date-time
447 command Command used to start the program
448 arguments Arguments supplied on the command line, if any
450 environment Description of environment, i.e., UNIX environment
451 variables or Windows registry settings
453 Implementations MUST NOT send the same field name more than once.
455 An example plist would be '(\"name\" \"Gnus\" \"version\" gnus-version-number
456 \"os\" system-configuration \"vendor\" \"GNU\")."
458 :type
'(choice (const :tag
"No information" nil
)
459 (const :tag
"Disable ID query" no
)
460 (plist :key-type string
:value-type string
)))
462 (defcustom nnimap-debug nil
463 "If non-nil, random debug spews are placed in *nnimap-debug* buffer.
464 Note that username, passwords and other privacy sensitive
465 information (such as e-mail) may be stored in the *nnimap-debug*
466 buffer. It is not written to disk, however. Do not enable this
467 variable unless you are comfortable with that."
471 ;; Internal variables:
473 (defvar nnimap-debug-buffer
"*nnimap-debug*")
474 (defvar nnimap-mailbox-info
(gnus-make-hashtable 997))
475 (defvar nnimap-current-move-server nil
)
476 (defvar nnimap-current-move-group nil
)
477 (defvar nnimap-current-move-article nil
)
478 (defvar nnimap-length
)
479 (defvar nnimap-progress-chars
'(?| ?
/ ?- ?
\\))
480 (defvar nnimap-progress-how-often
20)
481 (defvar nnimap-counter
)
482 (defvar nnimap-server-buffer-alist nil
) ;; Map server name to buffers.
483 (defvar nnimap-current-server nil
) ;; Current server
484 (defvar nnimap-server-buffer nil
) ;; Current servers' buffer
488 (nnoo-define-basics nnimap
)
490 ;; Utility functions:
492 (defsubst nnimap-get-server-buffer
(server)
493 "Return buffer for SERVER, if nil use current server."
494 (cadr (assoc (or server nnimap-current-server
) nnimap-server-buffer-alist
)))
496 (defun nnimap-remove-server-from-buffer-alist (server list
)
497 "Remove SERVER from LIST."
500 (unless (equal server
(car-safe e
))
504 (defun nnimap-possibly-change-server (server)
505 "Return buffer for SERVER, changing the current server as a side-effect.
506 If SERVER is nil, uses the current server."
507 (setq nnimap-current-server
(or server nnimap-current-server
)
508 nnimap-server-buffer
(nnimap-get-server-buffer nnimap-current-server
)))
510 (defun nnimap-verify-uidvalidity (group server
)
511 "Verify stored uidvalidity match current one in GROUP on SERVER."
512 (let* ((gnusgroup (gnus-group-prefixed-name
513 group
(gnus-server-to-method
514 (format "nnimap:%s" server
))))
515 (new-uidvalidity (imap-mailbox-get 'uidvalidity
))
516 (old-uidvalidity (gnus-group-get-parameter gnusgroup
'uidvalidity
))
517 (dir (file-name-as-directory (expand-file-name nnimap-directory
)))
518 (nameuid (nnheader-translate-file-chars
519 (concat nnimap-nov-file-name
520 (if (equal server
"")
522 server
) "." group
"." old-uidvalidity
523 nnimap-nov-file-name-suffix
) t
))
524 (file (if (or nnmail-use-long-file-names
525 (file-exists-p (expand-file-name nameuid dir
)))
526 (expand-file-name nameuid dir
)
528 (mm-encode-coding-string
529 (nnheader-replace-chars-in-string nameuid ?. ?
/)
530 nnmail-pathname-coding-system
)
533 (if (not (equal old-uidvalidity new-uidvalidity
))
535 (gnus-delete-file file
)
536 (gnus-group-set-parameter gnusgroup
'uidvalidity new-uidvalidity
)
538 (gnus-group-add-parameter gnusgroup
(cons 'uidvalidity new-uidvalidity
))
541 (defun nnimap-before-find-minmax-bugworkaround ()
542 "Function called before iterating through mailboxes with
543 `nnimap-find-minmax-uid'."
544 (when nnimap-need-unselect-to-notice-new-mail
545 ;; XXX this is for UoW imapd problem, it doesn't notice new mail in
546 ;; currently selected mailbox without a re-select/examine.
547 (or (null (imap-current-mailbox nnimap-server-buffer
))
548 (imap-mailbox-unselect nnimap-server-buffer
))))
550 (defun nnimap-find-minmax-uid (group &optional examine
)
551 "Find lowest and highest active article number in GROUP.
552 If EXAMINE is non-nil the group is selected read-only."
553 (with-current-buffer nnimap-server-buffer
554 (when (or (string= group
(imap-current-mailbox))
555 (imap-mailbox-select group examine
))
557 (when (> (imap-mailbox-get 'exists
) 0)
558 (imap-fetch (if imap-enable-exchange-bug-workaround
"1,*:*" "1,*")
559 "UID" nil
'nouidfetch
)
560 (imap-message-map (lambda (uid Uid
)
561 (setq minuid
(if minuid
(min minuid uid
) uid
)
562 maxuid
(if maxuid
(max maxuid uid
) uid
)))
564 (list (imap-mailbox-get 'exists
) minuid maxuid
)))))
566 (defun nnimap-possibly-change-group (group &optional server
)
567 "Make GROUP the current group, and SERVER the current server."
568 (when (nnimap-possibly-change-server server
)
569 (with-current-buffer nnimap-server-buffer
570 (if (or (null group
) (imap-current-mailbox-p group
))
572 (if (imap-mailbox-select group
)
573 (if (or (nnimap-verify-uidvalidity
574 group
(or server nnimap-current-server
))
575 (zerop (imap-mailbox-get 'exists group
))
576 t
;; for OGnus to see if ignoring uidvalidity
577 ;; changes has any bad effects.
580 "nnimap: Group %s is not uidvalid. Continue? " group
)))
582 (imap-mailbox-unselect)
583 (error "nnimap: Group %s is not uid-valid" group
))
584 (nnheader-report 'nnimap
(imap-error-text)))))))
586 (defun nnimap-replace-whitespace (string)
587 "Return STRING with all whitespace replaced with space."
589 (while (string-match "[\r\n\t]+" string
)
590 (setq string
(replace-match " " t t string
)))
593 ;; Required backend functions
595 (defun nnimap-retrieve-headers-progress ()
596 "Hook to insert NOV line for current article into `nntp-server-buffer'."
597 (and (numberp nnmail-large-newsgroup
)
598 (zerop (%
(incf nnimap-counter
) nnimap-progress-how-often
))
599 (> nnimap-length nnmail-large-newsgroup
)
600 (nnheader-message 6 "nnimap: Retrieving headers... %c"
601 (nth (/ (% nnimap-counter
602 (* (length nnimap-progress-chars
)
603 nnimap-progress-how-often
))
604 nnimap-progress-how-often
)
605 nnimap-progress-chars
)))
606 (with-current-buffer nntp-server-buffer
607 (let (headers lines chars uid mbx
)
608 (with-current-buffer nnimap-server-buffer
609 (setq uid imap-current-message
610 mbx imap-current-mailbox
611 headers
(nnimap-demule
612 (if (imap-capability 'IMAP4rev1
)
613 ;; xxx don't just use car? alist doesn't contain
614 ;; anything else now, but it might...
615 (nth 2 (car (imap-message-get uid
'BODYDETAIL
)))
616 (imap-message-get uid
'RFC822.HEADER
)))
617 lines
(imap-body-lines (imap-message-body imap-current-message
))
618 chars
(imap-message-get imap-current-message
'RFC822.SIZE
)))
620 ;; At this stage, we only have bytes, so let's use unibyte buffers
621 ;; to make it more clear.
622 (mm-with-unibyte-buffer
623 (buffer-disable-undo)
625 (let ((head (nnheader-parse-naked-head uid
)))
626 (mail-header-set-number head uid
)
627 (mail-header-set-chars head chars
)
628 (mail-header-set-lines head lines
)
629 (mail-header-set-xref
630 head
(format "%s %s:%d" (system-name) mbx uid
))
633 (defun nnimap-retrieve-which-headers (articles fetch-old
)
634 "Get a range of articles to fetch based on ARTICLES and FETCH-OLD."
635 (with-current-buffer nnimap-server-buffer
636 (if (numberp (car-safe articles
))
639 (imap-range-to-message-set
640 (gnus-compress-sequence
641 (append (gnus-uncompress-sequence
643 (cons (if (numberp fetch-old
)
644 (max 1 (- (car articles
) fetch-old
))
646 (1- (car articles
)))))
648 (mapcar (lambda (msgid)
650 (format "HEADER Message-Id \"%s\"" msgid
)))
653 (defun nnimap-group-overview-filename (group server
)
654 "Make file name for GROUP on SERVER."
655 (let* ((dir (file-name-as-directory (expand-file-name nnimap-directory
)))
656 (uidvalidity (gnus-group-get-parameter
657 (gnus-group-prefixed-name
658 group
(gnus-server-to-method
659 (format "nnimap:%s" server
)))
661 (name (nnheader-translate-file-chars
662 (concat nnimap-nov-file-name
663 (if (equal server
"")
665 server
) "." group nnimap-nov-file-name-suffix
) t
))
666 (nameuid (nnheader-translate-file-chars
667 (concat nnimap-nov-file-name
668 (if (equal server
"")
670 server
) "." group
"." uidvalidity
671 nnimap-nov-file-name-suffix
) t
))
672 (oldfile (if (or nnmail-use-long-file-names
673 (file-exists-p (expand-file-name name dir
)))
674 (expand-file-name name dir
)
676 (mm-encode-coding-string
677 (nnheader-replace-chars-in-string name ?. ?
/)
678 nnmail-pathname-coding-system
)
680 (newfile (if (or nnmail-use-long-file-names
681 (file-exists-p (expand-file-name nameuid dir
)))
682 (expand-file-name nameuid dir
)
684 (mm-encode-coding-string
685 (nnheader-replace-chars-in-string nameuid ?. ?
/)
686 nnmail-pathname-coding-system
)
688 (when (and (file-exists-p oldfile
) (not (file-exists-p newfile
)))
689 (message "nnimap: Upgrading novcache filename...")
691 (gnus-make-directory (file-name-directory newfile
))
692 (unless (ignore-errors (rename-file oldfile newfile
) t
)
693 (if (ignore-errors (copy-file oldfile newfile
) t
)
694 (delete-file oldfile
)
695 (error "Can't rename `%s' to `%s'" oldfile newfile
))))
698 (defun nnimap-retrieve-headers-from-file (group server
)
699 (with-current-buffer nntp-server-buffer
700 (let ((nov (nnimap-group-overview-filename group server
)))
701 (when (file-exists-p nov
)
702 (mm-insert-file-contents nov
)
703 (set-buffer-modified-p nil
)
704 (let ((min (ignore-errors (goto-char (point-min))
705 (read (current-buffer))))
706 (max (ignore-errors (goto-char (point-max))
708 (read (current-buffer)))))
709 (if (and (numberp min
) (numberp max
))
711 ;; junk, remove it, it's saved later
715 (defun nnimap-retrieve-headers-from-server (articles group server
)
716 (with-current-buffer nnimap-server-buffer
717 (let ((imap-fetch-data-hook '(nnimap-retrieve-headers-progress))
718 (nnimap-length (gnus-range-length articles
))
720 (imap-fetch (imap-range-to-message-set articles
)
721 (concat "(UID RFC822.SIZE BODY "
723 (append '(Subject From Date Message-Id
724 References In-Reply-To Xref
)
726 nnmail-extra-headers
))))
727 (if (imap-capability 'IMAP4rev1
)
728 (format "BODY.PEEK[HEADER.FIELDS %s])" headers
)
729 (format "RFC822.HEADER.LINES %s)" headers
)))))
730 (with-current-buffer nntp-server-buffer
731 (sort-numeric-fields 1 (point-min) (point-max)))
732 (and (numberp nnmail-large-newsgroup
)
733 (> nnimap-length nnmail-large-newsgroup
)
734 (nnheader-message 6 "nnimap: Retrieving headers...done")))))
736 (defun nnimap-dont-use-nov-p (group server
)
737 (or gnus-nov-is-evil nnimap-nov-is-evil
738 (unless (and (gnus-make-directory
740 (nnimap-group-overview-filename group server
)))
742 (nnimap-group-overview-filename group server
)))
743 (message "nnimap: Nov cache not writable, %s"
744 (nnimap-group-overview-filename group server
)))))
746 (deffoo nnimap-retrieve-headers
(articles &optional group server fetch-old
)
747 (when (nnimap-possibly-change-group group server
)
748 (with-current-buffer nntp-server-buffer
750 (if (nnimap-dont-use-nov-p group server
)
751 (nnimap-retrieve-headers-from-server
752 (gnus-compress-sequence articles
) group server
)
753 (let (uids cached low high
)
754 (when (setq uids
(nnimap-retrieve-which-headers articles fetch-old
)
756 high
(car (last uids
)))
757 (if (setq cached
(nnimap-retrieve-headers-from-file group server
))
759 ;; fetch articles with uids before cache block
760 (when (< low
(car cached
))
761 (goto-char (point-min))
762 (nnimap-retrieve-headers-from-server
763 (cons low
(1- (car cached
))) group server
))
764 ;; fetch articles with uids after cache block
765 (when (> high
(cdr cached
))
766 (goto-char (point-max))
767 (nnimap-retrieve-headers-from-server
768 (cons (1+ (cdr cached
)) high
) group server
))
769 (when nnimap-prune-cache
770 ;; remove nov's for articles which has expired on server
771 (goto-char (point-min))
772 (dolist (uid (gnus-set-difference articles uids
))
773 (when (re-search-forward (format "^%d\t" uid
) nil t
)
774 (gnus-delete-line)))))
775 ;; nothing cached, fetch whole range from server
776 (nnimap-retrieve-headers-from-server
777 (cons low high
) group server
))
778 (when (buffer-modified-p)
780 (point-min) (point-max)
781 (nnimap-group-overview-filename group server
) nil
'nomesg
))
782 (nnheader-nov-delete-outside-range low high
))))
785 (defun nnimap-open-connection (server)
786 ;; Note: `nnimap-open-server' that calls this function binds
787 ;; `imap-logout-timeout' to `nnimap-logout-timeout'.
788 (if (not (imap-open nnimap-address nnimap-server-port nnimap-stream
789 nnimap-authenticator nnimap-server-buffer
))
790 (nnheader-report 'nnimap
"Can't open connection to server %s" server
)
791 (unless (or (imap-capability 'IMAP4 nnimap-server-buffer
)
792 (imap-capability 'IMAP4rev1 nnimap-server-buffer
))
793 (imap-close nnimap-server-buffer
)
794 (nnheader-report 'nnimap
"Server %s is not IMAP4 compliant" server
))
795 (let* ((list (progn (gnus-message 7 "Parsing authinfo file `%s'."
796 nnimap-authinfo-file
)
797 (netrc-parse nnimap-authinfo-file
)))
798 (port (if nnimap-server-port
799 (int-to-string nnimap-server-port
)
802 (auth-source-user-or-password "login" server port
) ; this is preferred to netrc-*
803 (netrc-machine-user-or-password
807 (or nnimap-server-address
810 (list "imap" "imaps" "143" "993"))))
812 (auth-source-user-or-password "password" server port
) ; this is preferred to netrc-*
813 (netrc-machine-user-or-password
817 (or nnimap-server-address
820 (list "imap" "imaps" "143" "993")))))
821 (if (imap-authenticate user passwd nnimap-server-buffer
)
823 (setq nnimap-server-buffer-alist
824 (nnimap-remove-server-from-buffer-alist
826 nnimap-server-buffer-alist
))
827 (push (list server nnimap-server-buffer
)
828 nnimap-server-buffer-alist
)
829 (imap-id nnimap-id nnimap-server-buffer
)
830 (nnimap-possibly-change-server server
))
831 (imap-close nnimap-server-buffer
)
832 (kill-buffer nnimap-server-buffer
)
833 (nnheader-report 'nnimap
"Could not authenticate to %s" server
)))))
835 (deffoo nnimap-open-server
(server &optional defs
)
836 (nnheader-init-server-buffer)
837 (if (nnimap-server-opened server
)
839 (unless (assq 'nnimap-server-buffer defs
)
840 (push (list 'nnimap-server-buffer
(concat " *nnimap* " server
)) defs
))
841 ;; translate `nnimap-server-address' to `nnimap-address' in defs
842 ;; for people that configured nnimap with a very old version
843 (unless (assq 'nnimap-address defs
)
844 (if (assq 'nnimap-server-address defs
)
845 (push (list 'nnimap-address
846 (cadr (assq 'nnimap-server-address defs
))) defs
)
847 (push (list 'nnimap-address server
) defs
)))
848 (nnoo-change-server 'nnimap server defs
)
849 (or nnimap-server-buffer
850 (setq nnimap-server-buffer
(cadr (assq 'nnimap-server-buffer defs
))))
851 (with-current-buffer (get-buffer-create nnimap-server-buffer
)
852 (nnoo-change-server 'nnimap server defs
))
853 (let ((imap-logout-timeout nnimap-logout-timeout
))
854 (or (and nnimap-server-buffer
855 (imap-opened nnimap-server-buffer
)
856 (if (with-current-buffer nnimap-server-buffer
857 (memq imap-state
'(auth selected examine
)))
859 (imap-close nnimap-server-buffer
)
860 (nnimap-open-connection server
)))
861 (nnimap-open-connection server
)))))
863 (deffoo nnimap-server-opened
(&optional server
)
864 "Whether SERVER is opened.
865 If SERVER is the current virtual server, and the connection to the
866 physical server is alive, this function return a non-nil value. If
867 SERVER is nil, it is treated as the current server."
868 ;; clean up autologouts??
869 (and (or server nnimap-current-server
)
870 (nnoo-server-opened 'nnimap
(or server nnimap-current-server
))
871 (imap-opened (nnimap-get-server-buffer server
))))
873 (deffoo nnimap-close-server
(&optional server
)
874 "Close connection to server and free all resources connected to it.
875 Return nil if the server couldn't be closed for some reason."
876 (let ((server (or server nnimap-current-server
))
877 (imap-logout-timeout nnimap-logout-timeout
))
878 (when (or (nnimap-server-opened server
)
879 (imap-opened (nnimap-get-server-buffer server
)))
880 (imap-close (nnimap-get-server-buffer server
))
881 (kill-buffer (nnimap-get-server-buffer server
))
882 (setq nnimap-server-buffer nil
883 nnimap-current-server nil
884 nnimap-server-buffer-alist
885 (nnimap-remove-server-from-buffer-alist
887 nnimap-server-buffer-alist
)))
888 (nnoo-close-server 'nnimap server
)))
890 (deffoo nnimap-request-close
()
891 "Close connection to all servers and free all resources that the backend have reserved.
892 All buffers that have been created by that
893 backend should be killed. (Not the nntp-server-buffer, though.) This
894 function is generally only called when Gnus is shutting down."
895 (mapc (lambda (server) (nnimap-close-server (car server
)))
896 nnimap-server-buffer-alist
)
897 (setq nnimap-server-buffer-alist nil
))
899 (deffoo nnimap-status-message
(&optional server
)
900 "This function returns the last error message from server."
901 (when (nnimap-possibly-change-server server
)
902 (nnoo-status-message 'nnimap server
)))
904 (defun nnimap-demule (string)
905 ;; BEWARE: we used to use string-as-multibyte here which is braindead
906 ;; because it will turn accidental emacs-mule-valid byte sequences
907 ;; into multibyte chars. --Stef
908 ;; Reverted, braindead got 7.5 out of 10 on imdb, so it can't be
910 (funcall (if (and (fboundp 'string-as-multibyte
)
911 (subrp (symbol-function 'string-as-multibyte
)))
916 (defun nnimap-make-callback (article gnus-callback buffer
)
917 "Return a callback function."
919 (nnimap-callback ,article
,gnus-callback
,buffer
)))
921 (defun nnimap-callback (article gnus-callback buffer
)
922 (when (eq article
(imap-current-message))
923 (remove-hook 'imap-fetch-data-hook
924 (nnimap-make-callback article gnus-callback buffer
))
925 (with-current-buffer buffer
927 (with-current-buffer nnimap-server-buffer
929 (if (imap-capability 'IMAP4rev1
)
930 ;; xxx don't just use car? alist doesn't contain
931 ;; anything else now, but it might...
932 (nth 2 (car (imap-message-get article
'BODYDETAIL
)))
933 (imap-message-get article
'RFC822
)))))
934 (nnheader-ms-strip-cr)
935 (funcall gnus-callback t
))))
937 (defun nnimap-request-article-part (article part prop
&optional
938 group server to-buffer detail
)
939 (when (nnimap-possibly-change-group group server
)
940 (let ((article (if (stringp article
)
941 (car-safe (imap-search
942 (format "HEADER Message-Id \"%s\"" article
)
943 nnimap-server-buffer
))
946 (gnus-message 10 "nnimap: Fetching (part of) article %d from %s..."
947 article
(or group imap-current-mailbox
948 gnus-newsgroup-name
))
949 (if (not nnheader-callback-function
)
950 (with-current-buffer (or to-buffer nntp-server-buffer
)
952 (let ((data (imap-fetch article part prop nil
953 nnimap-server-buffer
)))
954 (insert (nnimap-demule (if detail
957 (nnheader-ms-strip-cr)
959 10 "nnimap: Fetching (part of) article %d from %s...done"
960 article
(or group imap-current-mailbox gnus-newsgroup-name
))
962 (nnheader-report 'nnimap
"No such article %d in %s: %s"
963 article
(or group imap-current-mailbox
965 (imap-error-text nnimap-server-buffer
))
966 (cons group article
)))
967 (add-hook 'imap-fetch-data-hook
968 (nnimap-make-callback article
969 nnheader-callback-function
971 (imap-fetch-asynch article part nil nnimap-server-buffer
)
972 (cons group article
))))))
974 (deffoo nnimap-asynchronous-p
()
977 (deffoo nnimap-request-article
(article &optional group server to-buffer
)
978 (if (imap-capability 'IMAP4rev1 nnimap-server-buffer
)
979 (nnimap-request-article-part
980 article
"BODY.PEEK[]" 'BODYDETAIL group server to-buffer
'detail
)
981 (nnimap-request-article-part
982 article
"RFC822.PEEK" 'RFC822 group server to-buffer
)))
984 (deffoo nnimap-request-head
(article &optional group server to-buffer
)
985 (if (imap-capability 'IMAP4rev1 nnimap-server-buffer
)
986 (nnimap-request-article-part
987 article
"BODY.PEEK[HEADER]" 'BODYDETAIL group server to-buffer
'detail
)
988 (nnimap-request-article-part
989 article
"RFC822.HEADER" 'RFC822.HEADER group server to-buffer
)))
991 (deffoo nnimap-request-body
(article &optional group server to-buffer
)
992 (if (imap-capability 'IMAP4rev1 nnimap-server-buffer
)
993 (nnimap-request-article-part
994 article
"BODY.PEEK[TEXT]" 'BODYDETAIL group server to-buffer
'detail
)
995 (nnimap-request-article-part
996 article
"RFC822.TEXT.PEEK" 'RFC822.TEXT group server to-buffer
)))
998 (deffoo nnimap-request-group
(group &optional server fast
)
999 (nnimap-request-update-info-internal
1001 (gnus-get-info (gnus-group-prefixed-name
1002 group
(gnus-server-to-method (format "nnimap:%s" server
))))
1004 (when (nnimap-possibly-change-group group server
)
1005 (nnimap-before-find-minmax-bugworkaround)
1008 ((null (setq info
(nnimap-find-minmax-uid group t
)))
1009 (nnheader-report 'nnimap
"Could not get active info for %s"
1012 (nnheader-insert "211 %d %d %d %s\n" (or (nth 0 info
) 0)
1013 (max 1 (or (nth 1 info
) 1))
1014 (or (nth 2 info
) 0) group
)
1015 (nnheader-report 'nnimap
"Group %s selected" group
)
1018 (defun nnimap-update-unseen (group &optional server
)
1019 "Update the unseen count in `nnimap-mailbox-info'."
1021 (gnus-group-prefixed-name group server
)
1022 (let ((old (gnus-gethash-safe (gnus-group-prefixed-name group server
)
1023 nnimap-mailbox-info
)))
1024 (list (nth 0 old
) (nth 1 old
)
1025 (imap-mailbox-status group
'unseen nnimap-server-buffer
)
1027 nnimap-mailbox-info
))
1029 (defun nnimap-close-group (group &optional server
)
1030 (with-current-buffer nnimap-server-buffer
1031 (when (and (imap-opened)
1032 (nnimap-possibly-change-group group server
))
1033 (nnimap-update-unseen group server
)
1034 (case nnimap-expunge-on-close
1036 (imap-mailbox-expunge nnimap-close-asynchronous
)
1037 (unless nnimap-dont-close
1038 (imap-mailbox-close nnimap-close-asynchronous
))))
1039 (ask (if (and (imap-search "DELETED")
1040 (gnus-y-or-n-p (format "Expunge articles in group `%s'? "
1041 imap-current-mailbox
)))
1043 (imap-mailbox-expunge nnimap-close-asynchronous
)
1044 (unless nnimap-dont-close
1045 (imap-mailbox-close nnimap-close-asynchronous
)))
1046 (imap-mailbox-unselect)))
1047 (t (imap-mailbox-unselect)))
1048 (not imap-current-mailbox
))))
1050 (defun nnimap-pattern-to-list-arguments (pattern)
1052 (cons (car-safe p
) (or (cdr-safe p
) p
)))
1053 (if (and (listp pattern
)
1054 (listp (cdr pattern
)))
1058 (deffoo nnimap-request-list
(&optional server
)
1059 (when (nnimap-possibly-change-server server
)
1060 (with-current-buffer nntp-server-buffer
1062 (gnus-message 5 "nnimap: Generating active list%s..."
1063 (if (> (length server
) 0) (concat " for " server
) ""))
1064 (nnimap-before-find-minmax-bugworkaround)
1065 (with-current-buffer nnimap-server-buffer
1066 (dolist (pattern (nnimap-pattern-to-list-arguments nnimap-list-pattern
))
1067 (dolist (mbx (funcall nnimap-request-list-method
1068 (cdr pattern
) (car pattern
)))
1069 (or (member "\\NoSelect" (imap-mailbox-get 'list-flags mbx
))
1070 (let ((info (nnimap-find-minmax-uid mbx
'examine
)))
1072 (with-current-buffer nntp-server-buffer
1073 (insert (format "\"%s\" %d %d y\n"
1074 mbx
(or (nth 2 info
) 0)
1075 (max 1 (or (nth 1 info
) 1)))))))))))
1076 (gnus-message 5 "nnimap: Generating active list%s...done"
1077 (if (> (length server
) 0) (concat " for " server
) ""))
1080 (deffoo nnimap-request-post
(&optional server
)
1082 (dolist (mbx (message-unquote-tokens
1083 (message-tokenize-header
1084 (message-fetch-field "Newsgroups") ", ")) success
)
1085 (let ((to-newsgroup (gnus-group-prefixed-name mbx gnus-command-method
)))
1086 (or (gnus-active to-newsgroup
)
1087 (gnus-activate-group to-newsgroup
)
1088 (if (gnus-y-or-n-p (format "No such group: %s. Create it? "
1090 (or (and (gnus-request-create-group
1091 to-newsgroup gnus-command-method
)
1092 (gnus-activate-group to-newsgroup nil nil
1093 gnus-command-method
))
1094 (error "Couldn't create group %s" to-newsgroup
)))
1095 (error "No such group: %s" to-newsgroup
))
1096 (unless (nnimap-request-accept-article mbx
(nth 1 gnus-command-method
))
1097 (setq success nil
))))))
1099 ;; Optional backend functions
1101 (defun nnimap-string-lessp-numerical (s1 s2
)
1102 "Return t if first arg string is less than second in numerical order."
1103 (cond ((string= s1 s2
)
1105 ((> (length s1
) (length s2
))
1107 ((< (length s1
) (length s2
))
1109 ((< (string-to-number (substring s1
0 1))
1110 (string-to-number (substring s2
0 1)))
1112 ((> (string-to-number (substring s1
0 1))
1113 (string-to-number (substring s2
0 1)))
1116 (nnimap-string-lessp-numerical (substring s1
1) (substring s2
1)))))
1118 (deffoo nnimap-retrieve-groups
(groups &optional server
)
1119 (when (nnimap-possibly-change-server server
)
1120 (gnus-message 5 "nnimap: Checking mailboxes...")
1121 (with-current-buffer nntp-server-buffer
1123 (nnimap-before-find-minmax-bugworkaround)
1124 (let (asyncgroups slowgroups
)
1125 (if (null nnimap-retrieve-groups-asynchronous
)
1126 (setq slowgroups groups
)
1127 (dolist (group groups
)
1128 (gnus-message 9 "nnimap: Quickly checking mailbox %s" group
)
1129 (add-to-list (if (gnus-gethash-safe
1130 (gnus-group-prefixed-name group server
)
1131 nnimap-mailbox-info
)
1134 (list group
(imap-mailbox-status-asynch
1135 group
'(uidvalidity uidnext unseen
)
1136 nnimap-server-buffer
))))
1137 (dolist (asyncgroup asyncgroups
)
1138 (let ((group (nth 0 asyncgroup
))
1139 (tag (nth 1 asyncgroup
))
1141 (when (imap-ok-p (imap-wait-for-tag tag nnimap-server-buffer
))
1142 (if (or (not (string=
1143 (nth 0 (gnus-gethash (gnus-group-prefixed-name
1145 nnimap-mailbox-info
))
1146 (imap-mailbox-get 'uidvalidity group
1147 nnimap-server-buffer
)))
1149 (nth 1 (gnus-gethash (gnus-group-prefixed-name
1151 nnimap-mailbox-info
))
1152 (imap-mailbox-get 'uidnext group
1153 nnimap-server-buffer
))))
1154 (push (list group
) slowgroups
)
1155 (insert (nth 3 (gnus-gethash (gnus-group-prefixed-name
1157 nnimap-mailbox-info
))))))))
1158 (dolist (group slowgroups
)
1159 (if nnimap-retrieve-groups-asynchronous
1160 (setq group
(car group
)))
1161 (gnus-message 7 "nnimap: Mailbox %s modified" group
)
1162 (imap-mailbox-put 'uidnext nil group nnimap-server-buffer
)
1163 (or (member "\\NoSelect" (imap-mailbox-get 'list-flags group
1164 nnimap-server-buffer
))
1165 (let* ((info (nnimap-find-minmax-uid group
'examine
))
1166 (str (format "\"%s\" %d %d y\n" group
1168 (max 1 (or (nth 1 info
) 1)))))
1169 (when (> (or (imap-mailbox-get 'recent group
1170 nnimap-server-buffer
) 0)
1172 (push (list (cons group
0)) nnmail-split-history
))
1174 (when nnimap-retrieve-groups-asynchronous
1176 (gnus-group-prefixed-name group server
)
1177 (list (or (imap-mailbox-get
1178 'uidvalidity group nnimap-server-buffer
)
1179 (imap-mailbox-status
1180 group
'uidvalidity nnimap-server-buffer
))
1181 (or (imap-mailbox-get
1182 'uidnext group nnimap-server-buffer
)
1183 (imap-mailbox-status
1184 group
'uidnext nnimap-server-buffer
))
1185 (or (imap-mailbox-get
1186 'unseen group nnimap-server-buffer
)
1187 (imap-mailbox-status
1188 group
'unseen nnimap-server-buffer
))
1190 nnimap-mailbox-info
)))))))
1191 (gnus-message 5 "nnimap: Checking mailboxes...done")
1194 (deffoo nnimap-request-update-info-internal
(group info
&optional server
)
1195 (when (nnimap-possibly-change-group group server
)
1196 (when info
;; xxx what does this mean? should we create a info?
1197 (with-current-buffer nnimap-server-buffer
1198 (gnus-message 5 "nnimap: Updating info for %s..."
1199 (gnus-info-group info
))
1201 (when (nnimap-mark-permanent-p 'read
)
1203 ;; read info could contain articles marked unread by other
1204 ;; imap clients! we correct this
1205 (setq unseen
(gnus-compress-sequence
1206 (imap-search "UNSEEN UNDELETED"))
1207 seen
(gnus-range-difference (gnus-info-read info
) unseen
)
1208 seen
(gnus-range-add seen
1209 (gnus-compress-sequence
1210 (imap-search "SEEN")))
1211 seen
(if (and (integerp (car seen
))
1213 (list (cons (car seen
) (car seen
)))
1215 (gnus-info-set-read info seen
)))
1217 (dolist (pred gnus-article-mark-lists
)
1218 (when (or (eq (cdr pred
) 'recent
)
1219 (and (nnimap-mark-permanent-p (cdr pred
))
1220 (member (nnimap-mark-to-flag (cdr pred
))
1221 (imap-mailbox-get 'flags
))))
1222 (gnus-info-set-marks
1224 (gnus-update-alist-soft
1226 (gnus-compress-sequence
1227 (imap-search (nnimap-mark-to-predicate (cdr pred
))))
1228 (gnus-info-marks info
))
1231 (when nnimap-importantize-dormant
1232 ;; nnimap mark dormant article as ticked too (for other clients)
1233 ;; so we remove that mark for gnus since we support dormant
1234 (gnus-info-set-marks
1236 (gnus-update-alist-soft
1238 (gnus-remove-from-range
1239 (cdr-safe (assoc 'tick
(gnus-info-marks info
)))
1240 (cdr-safe (assoc 'dormant
(gnus-info-marks info
))))
1241 (gnus-info-marks info
))
1244 (gnus-message 5 "nnimap: Updating info for %s...done"
1245 (gnus-info-group info
))
1249 (deffoo nnimap-request-type
(group &optional article
)
1250 (if (and nnimap-news-groups
(string-match nnimap-news-groups group
))
1254 (deffoo nnimap-request-set-mark
(group actions
&optional server
)
1255 (when (nnimap-possibly-change-group group server
)
1256 (with-current-buffer nnimap-server-buffer
1258 (gnus-message 7 "nnimap: Setting marks in %s..." group
)
1259 (while (setq action
(pop actions
))
1260 (let ((range (nth 0 action
))
1261 (what (nth 1 action
))
1262 (cmdmarks (nth 2 action
))
1264 ;; bookmark can't be stored (not list/range
1265 (setq cmdmarks
(delq 'bookmark cmdmarks
))
1266 ;; killed can't be stored (not list/range
1267 (setq cmdmarks
(delq 'killed cmdmarks
))
1268 ;; unsent are for nndraft groups only
1269 (setq cmdmarks
(delq 'unsent cmdmarks
))
1270 ;; cache flags are pointless on the server
1271 (setq cmdmarks
(delq 'cache cmdmarks
))
1272 ;; seen flags are local to each gnus
1273 (setq cmdmarks
(delq 'seen cmdmarks
))
1274 ;; recent marks can't be set
1275 (setq cmdmarks
(delq 'recent cmdmarks
))
1276 (when nnimap-importantize-dormant
1277 ;; flag dormant articles as ticked
1278 (if (memq 'dormant cmdmarks
)
1279 (setq cmdmarks
(cons 'tick cmdmarks
))))
1280 ;; remove stuff we are forbidden to store
1281 (mapc (lambda (mark)
1282 (if (imap-message-flag-permanent-p
1283 (nnimap-mark-to-flag mark
))
1284 (setq marks
(cons mark marks
))))
1286 (when (and range marks
)
1287 (cond ((eq what
'del
)
1288 (imap-message-flags-del
1289 (imap-range-to-message-set range
)
1290 (nnimap-mark-to-flag marks nil t
)))
1292 (imap-message-flags-add
1293 (imap-range-to-message-set range
)
1294 (nnimap-mark-to-flag marks nil t
)))
1296 (imap-message-flags-set
1297 (imap-range-to-message-set range
)
1298 (nnimap-mark-to-flag marks nil t
)))))))
1299 (gnus-message 7 "nnimap: Setting marks in %s...done" group
))))
1302 (defun nnimap-split-fancy ()
1303 "Like the function `nnmail-split-fancy', but uses `nnimap-split-fancy'."
1304 (let ((nnmail-split-fancy nnimap-split-fancy
))
1305 (nnmail-split-fancy)))
1307 (defun nnimap-split-to-groups (rules)
1308 ;; tries to match all rules in nnimap-split-rule against content of
1309 ;; nntp-server-buffer, returns a list of groups that matched.
1310 (with-current-buffer nntp-server-buffer
1311 ;; Fold continuation lines.
1312 (goto-char (point-min))
1313 (while (re-search-forward "\\(\r?\n[ \t]+\\)+" nil t
)
1314 (replace-match " " t t
))
1315 (if (functionp rules
)
1317 (let (to-groups regrepp
)
1319 (dolist (rule rules to-groups
)
1320 (let ((group (car rule
))
1321 (regexp (cadr rule
)))
1322 (goto-char (point-min))
1323 (when (and (if (stringp regexp
)
1325 (if (not (stringp group
))
1326 (setq group
(eval group
))
1328 (string-match "\\\\[0-9&]" group
)))
1329 (re-search-forward regexp nil t
))
1330 (funcall regexp group
))
1331 ;; Don't enter the article into the same group twice.
1332 (not (assoc group to-groups
)))
1334 (nnmail-expand-newtext group
)
1337 (or nnimap-split-crosspost
1338 (throw 'split-done to-groups
))))))))))
1340 (defun nnimap-assoc-match (key alist
)
1342 (while (and alist
(not element
))
1343 (if (string-match (car (car alist
)) key
)
1344 (setq element
(car alist
)))
1345 (setq alist
(cdr alist
)))
1348 (defun nnimap-split-find-rule (server inbox
)
1349 (if (and (listp nnimap-split-rule
) (listp (car nnimap-split-rule
))
1350 (list (cdar nnimap-split-rule
)) (listp (cadar nnimap-split-rule
)))
1352 (cadr (nnimap-assoc-match inbox
(cdr (nnimap-assoc-match
1353 server nnimap-split-rule
))))
1356 (defun nnimap-split-find-inbox (server)
1357 (if (listp nnimap-split-inbox
)
1359 (list nnimap-split-inbox
)))
1361 (defun nnimap-split-articles (&optional group server
)
1362 (when (nnimap-possibly-change-server server
)
1363 (with-current-buffer nnimap-server-buffer
1364 (let (rule inbox removeorig
(inboxes (nnimap-split-find-inbox server
)))
1365 ;; iterate over inboxes
1366 (while (and (setq inbox
(pop inboxes
))
1367 (nnimap-possibly-change-group inbox
)) ;; SELECT
1368 ;; find split rule for this server / inbox
1369 (when (setq rule
(nnimap-split-find-rule server inbox
))
1370 ;; iterate over articles
1371 (dolist (article (imap-search nnimap-split-predicate
))
1372 (when (if (if (eq nnimap-split-download-body
'default
)
1373 nnimap-split-download-body-default
1374 nnimap-split-download-body
)
1375 (and (nnimap-request-article article
)
1376 (with-current-buffer nntp-server-buffer
(mail-narrow-to-head)))
1377 (nnimap-request-head article
))
1378 ;; copy article to right group(s)
1379 (setq removeorig nil
)
1380 (dolist (to-group (nnimap-split-to-groups rule
))
1381 (cond ((eq to-group
'junk
)
1382 (message "IMAP split removed %s:%s:%d" server inbox
1384 (setq removeorig t
))
1385 ((imap-message-copy (number-to-string article
)
1386 to-group nil
'nocopyuid
)
1387 (message "IMAP split moved %s:%s:%d to %s" server
1388 inbox article to-group
)
1390 (when nnmail-cache-accepted-message-ids
1391 (with-current-buffer nntp-server-buffer
1394 (nnmail-fetch-field "message-id"))
1395 (nnmail-cache-insert msgid
1397 (nnmail-fetch-field "subject"))))))
1398 ;; Add the group-art list to the history list.
1399 (push (list (cons to-group
0)) nnmail-split-history
))
1401 (message "IMAP split failed to move %s:%s:%d to %s"
1402 server inbox article to-group
))))
1403 (if (if (eq nnimap-split-download-body
'default
)
1404 nnimap-split-download-body-default
1405 nnimap-split-download-body
)
1407 ;; remove article if it was successfully copied somewhere
1409 (imap-message-flags-add (format "%d" article
)
1410 "\\Seen \\Deleted")))))
1411 (when (imap-mailbox-select inbox
) ;; just in case
1412 ;; todo: UID EXPUNGE (if available) to remove splitted articles
1413 (imap-mailbox-expunge)
1414 (imap-mailbox-close)))
1415 (when nnmail-cache-accepted-message-ids
1416 (nnmail-cache-close))
1419 (deffoo nnimap-request-scan
(&optional group server
)
1420 (nnimap-split-articles group server
))
1422 (deffoo nnimap-request-newgroups
(date &optional server
)
1423 (when (nnimap-possibly-change-server server
)
1424 (with-current-buffer nntp-server-buffer
1425 (gnus-message 5 "nnimap: Listing subscribed mailboxes%s%s..."
1426 (if (> (length server
) 0) " on " "") server
)
1428 (nnimap-before-find-minmax-bugworkaround)
1429 (dolist (pattern (nnimap-pattern-to-list-arguments
1430 nnimap-list-pattern
))
1431 (dolist (mbx (imap-mailbox-lsub (cdr pattern
) (car pattern
) nil
1432 nnimap-server-buffer
))
1434 (dolist (mailbox (imap-mailbox-get 'list-flags mbx
1435 nnimap-server-buffer
))
1436 (if (string= (downcase mailbox
) "\\noselect")
1439 (let ((info (nnimap-find-minmax-uid mbx
'examine
)))
1441 (insert (format "\"%s\" %d %d y\n"
1442 mbx
(or (nth 2 info
) 0)
1443 (max 1 (or (nth 1 info
) 1)))))))))
1444 (gnus-message 5 "nnimap: Listing subscribed mailboxes%s%s...done"
1445 (if (> (length server
) 0) " on " "") server
))
1448 (deffoo nnimap-request-create-group
(group &optional server args
)
1449 (when (nnimap-possibly-change-server server
)
1450 (or (imap-mailbox-status group
'uidvalidity nnimap-server-buffer
)
1451 (imap-mailbox-create group nnimap-server-buffer
)
1452 (nnheader-report 'nnimap
"%S"
1453 (imap-error-text nnimap-server-buffer
)))))
1455 (defun nnimap-time-substract (time1 time2
)
1456 "Return TIME for TIME1 - TIME2."
1457 (let* ((ms (- (car time1
) (car time2
)))
1458 (ls (- (nth 1 time1
) (nth 1 time2
))))
1460 (list (- ms
1) (+ (expt 2 16) ls
))
1463 (eval-when-compile (require 'parse-time
))
1464 (defun nnimap-date-days-ago (daysago)
1465 "Return date, in format \"3-Aug-1998\", for DAYSAGO days ago."
1466 (require 'parse-time
)
1467 (let* ((time (nnimap-time-substract (current-time) (days-to-time daysago
)))
1468 (date (format-time-string
1469 (format "%%d-%s-%%Y"
1470 (capitalize (car (rassoc (nth 4 (decode-time time
))
1471 parse-time-months
))))
1473 (if (eq ?
0 (string-to-char date
))
1477 (defun nnimap-request-expire-articles-progress ()
1478 (gnus-message 5 "nnimap: Marking article %d for deletion..."
1479 imap-current-message
))
1481 (defun nnimap-expiry-target (arts group server
)
1482 (unless (eq nnmail-expiry-target
'delete
)
1485 (nnimap-request-article art group server
(current-buffer))
1486 ;; hints for optimization in `nnimap-request-accept-article'
1487 (let ((nnimap-current-move-article art
)
1488 (nnimap-current-move-group group
)
1489 (nnimap-current-move-server server
))
1490 (nnmail-expiry-target-group nnmail-expiry-target group
))))
1491 ;; It is not clear if `nnmail-expiry-target' somehow cause the
1492 ;; current group to be changed or not, so we make sure here.
1493 (nnimap-possibly-change-group group server
)))
1495 ;; Notice that we don't actually delete anything, we just mark them deleted.
1496 (deffoo nnimap-request-expire-articles
(articles group
&optional server force
)
1497 (let ((artseq (gnus-compress-sequence articles
)))
1498 (when (and artseq
(nnimap-possibly-change-group group server
))
1499 (with-current-buffer nnimap-server-buffer
1500 (let ((days (or (and nnmail-expiry-wait-function
1501 (funcall nnmail-expiry-wait-function group
))
1502 nnmail-expiry-wait
)))
1503 (cond ((or force
(eq days
'immediate
))
1504 (let ((oldarts (imap-search
1506 (imap-range-to-message-set artseq
)))))
1508 (nnimap-expiry-target oldarts group server
)
1509 (when (imap-message-flags-add
1510 (imap-range-to-message-set
1511 (gnus-compress-sequence oldarts
)) "\\Deleted")
1512 (setq articles
(gnus-set-difference
1513 articles oldarts
))))))
1514 ((and nnimap-search-uids-not-since-is-evil
(numberp days
))
1515 (let* ((all-new-articles
1516 (gnus-compress-sequence
1517 (imap-search (format "SINCE %s"
1518 (nnimap-date-days-ago days
)))))
1520 (gnus-range-difference artseq all-new-articles
))
1521 (oldarts (gnus-uncompress-range oldartseq
)))
1523 (nnimap-expiry-target oldarts group server
)
1524 (when (imap-message-flags-add
1525 (imap-range-to-message-set oldartseq
)
1527 (setq articles
(gnus-set-difference
1528 articles oldarts
))))))
1530 (let ((oldarts (imap-search
1531 (format nnimap-expunge-search-string
1532 (imap-range-to-message-set artseq
)
1533 (nnimap-date-days-ago days
))))
1534 (imap-fetch-data-hook
1535 '(nnimap-request-expire-articles-progress)))
1537 (nnimap-expiry-target oldarts group server
)
1538 (when (imap-message-flags-add
1539 (imap-range-to-message-set
1540 (gnus-compress-sequence oldarts
)) "\\Deleted")
1541 (setq articles
(gnus-set-difference
1542 articles oldarts
)))))))))))
1543 ;; return articles not deleted
1546 (deffoo nnimap-request-move-article
(article group server accept-form
1547 &optional last move-is-internal
)
1548 (when (nnimap-possibly-change-server server
)
1550 (let ((buf (get-buffer-create " *nnimap move*"))
1551 (nnimap-current-move-article article
)
1552 (nnimap-current-move-group group
)
1553 (nnimap-current-move-server nnimap-current-server
)
1555 (gnus-message 10 "nnimap-request-move-article: this is an %s move"
1556 (if move-is-internal
1559 ;; request the article only when the move is NOT internal
1560 (and (or move-is-internal
1561 (nnimap-request-article article group server
))
1562 (with-current-buffer buf
1563 (buffer-disable-undo (current-buffer))
1564 (insert-buffer-substring nntp-server-buffer
)
1565 (setq result
(eval accept-form
))
1568 (nnimap-possibly-change-group group server
)
1569 (imap-message-flags-add
1570 (imap-range-to-message-set (list article
))
1571 "\\Deleted" 'silent nnimap-server-buffer
))
1574 (deffoo nnimap-request-accept-article
(group &optional server last
)
1575 (when (nnimap-possibly-change-server server
)
1578 (if (string= nnimap-current-server nnimap-current-move-server
)
1579 ;; moving article within same server, speed it up...
1580 (and (nnimap-possibly-change-group
1581 nnimap-current-move-group
)
1582 (imap-message-copy (number-to-string
1583 nnimap-current-move-article
)
1584 group
'dontcreate nil
1585 nnimap-server-buffer
))
1586 (with-current-buffer (current-buffer)
1587 (goto-char (point-min))
1588 ;; remove any 'From blabla' lines, some IMAP servers
1589 ;; reject the entire message otherwise.
1590 (when (looking-at "^From[^:]")
1591 (delete-region (point) (progn (forward-line) (point))))
1592 ;; turn into rfc822 format (\r\n eol's)
1593 (while (search-forward "\n" nil t
)
1594 (replace-match "\r\n"))
1595 (when nnmail-cache-accepted-message-ids
1596 (nnmail-cache-insert (nnmail-fetch-field "message-id")
1598 (nnmail-fetch-field "subject"))))
1599 (when (and last nnmail-cache-accepted-message-ids
)
1600 (nnmail-cache-close))
1601 ;; this 'or' is for Cyrus server bug
1602 (or (null (imap-current-mailbox nnimap-server-buffer
))
1603 (imap-mailbox-unselect nnimap-server-buffer
))
1604 (imap-message-append group
(current-buffer) nil nil
1605 nnimap-server-buffer
)))
1606 (cons group
(nth 1 uid
))
1607 (nnheader-report 'nnimap
(imap-error-text nnimap-server-buffer
))))))
1609 (deffoo nnimap-request-delete-group
(group force
&optional server
)
1610 (when (nnimap-possibly-change-server server
)
1611 (when (string= group
(imap-current-mailbox nnimap-server-buffer
))
1612 (imap-mailbox-unselect nnimap-server-buffer
))
1613 (with-current-buffer nnimap-server-buffer
1615 (or (null (imap-mailbox-status group
'uidvalidity
))
1616 (imap-mailbox-delete group
))
1620 (deffoo nnimap-request-rename-group
(group new-name
&optional server
)
1621 (when (nnimap-possibly-change-server server
)
1622 (imap-mailbox-rename group new-name nnimap-server-buffer
)))
1624 (defun nnimap-expunge (mailbox server
)
1625 (when (nnimap-possibly-change-group mailbox server
)
1626 (imap-mailbox-expunge nil nnimap-server-buffer
)))
1628 (defun nnimap-acl-get (mailbox server
)
1629 (when (nnimap-possibly-change-server server
)
1630 (and (imap-capability 'ACL nnimap-server-buffer
)
1631 (imap-mailbox-acl-get mailbox nnimap-server-buffer
))))
1633 (defun nnimap-acl-edit (mailbox method old-acls new-acls
)
1634 (when (nnimap-possibly-change-server (cadr method
))
1635 (unless (imap-capability 'ACL nnimap-server-buffer
)
1636 (error "Your server does not support ACL editing"))
1637 (with-current-buffer nnimap-server-buffer
1638 ;; delete all removed identifiers
1639 (mapc (lambda (old-acl)
1640 (unless (assoc (car old-acl
) new-acls
)
1641 (or (imap-mailbox-acl-delete (car old-acl
) mailbox
)
1642 (error "Can't delete ACL for %s" (car old-acl
)))))
1644 ;; set all changed acl's
1645 (mapc (lambda (new-acl)
1646 (let ((new-rights (cdr new-acl
))
1647 (old-rights (cdr (assoc (car new-acl
) old-acls
))))
1648 (unless (and old-rights new-rights
1649 (string= old-rights new-rights
))
1650 (or (imap-mailbox-acl-set (car new-acl
) new-rights mailbox
)
1651 (error "Can't set ACL for %s to %s" (car new-acl
)
1657 ;;; Internal functions
1660 ;; This is confusing.
1662 ;; mark => read, tick, draft, reply etc
1663 ;; flag => "\\Seen", "\\Flagged", "\\Draft", "gnus-expire" etc
1664 ;; predicate => "SEEN", "FLAGGED", "DRAFT", "KEYWORD gnus-expire" etc
1666 ;; Mark should not really contain 'read since it's not a "mark" in the Gnus
1667 ;; world, but we cheat. Mark == gnus-article-mark-lists + '(read . read).
1670 (defconst nnimap-mark-to-predicate-alist
1672 (lambda (pair) ; cdr is the mark
1673 (or (assoc (cdr pair
)
1678 (reply .
"ANSWERED")))
1680 (format "KEYWORD gnus-%s" (symbol-name (cdr pair
))))))
1681 (cons '(read . read
) gnus-article-mark-lists
)))
1683 (defun nnimap-mark-to-predicate (pred)
1684 "Convert a Gnus mark (a symbol such as read, tick, expire) to a IMAP predicate.
1685 This is a string such as \"SEEN\", \"FLAGGED\", \"KEYWORD gnus-expire\",
1686 to be used within a IMAP SEARCH query."
1687 (cdr (assq pred nnimap-mark-to-predicate-alist
)))
1689 (defconst nnimap-mark-to-flag-alist
1692 (or (assoc (cdr pair
)
1694 (tick .
"\\Flagged")
1696 (recent .
"\\Recent")
1697 (reply .
"\\Answered")))
1699 (format "gnus-%s" (symbol-name (cdr pair
))))))
1700 (cons '(read . read
) gnus-article-mark-lists
)))
1702 (defun nnimap-mark-to-flag-1 (preds)
1703 (if (and (not (null preds
)) (listp preds
))
1704 (cons (nnimap-mark-to-flag (car preds
))
1705 (nnimap-mark-to-flag (cdr preds
)))
1706 (cdr (assoc preds nnimap-mark-to-flag-alist
))))
1708 (defun nnimap-mark-to-flag (preds &optional always-list make-string
)
1709 "Convert a Gnus mark (a symbol such as read, tick, expire) to a IMAP flag.
1710 This is a string such as \"\\Seen\", \"\\Flagged\", \"gnus-expire\", to
1711 be used in a STORE FLAGS command."
1712 (let ((result (nnimap-mark-to-flag-1 preds
)))
1713 (setq result
(if (and (or make-string always-list
)
1714 (not (listp result
)))
1718 (mapconcat (lambda (flag)
1720 (mapconcat 'identity flag
" ")
1725 (defun nnimap-mark-permanent-p (mark &optional group
)
1726 "Return t if MARK can be permanently (between IMAP sessions) saved on articles, in GROUP."
1727 (imap-message-flag-permanent-p (nnimap-mark-to-flag mark
)))
1731 (buffer-disable-undo (get-buffer-create nnimap-debug-buffer
))
1732 (mapc (lambda (f) (trace-function-background f nnimap-debug-buffer
))
1734 nnimap-possibly-change-server
1735 nnimap-verify-uidvalidity
1736 nnimap-find-minmax-uid
1737 nnimap-before-find-minmax-bugworkaround
1738 nnimap-possibly-change-group
1739 ;;nnimap-replace-whitespace
1740 nnimap-retrieve-headers-progress
1741 nnimap-retrieve-which-headers
1742 nnimap-group-overview-filename
1743 nnimap-retrieve-headers-from-file
1744 nnimap-retrieve-headers-from-server
1745 nnimap-retrieve-headers
1746 nnimap-open-connection
1748 nnimap-server-opened
1750 nnimap-request-close
1751 nnimap-status-message
1753 nnimap-request-article-part
1754 nnimap-request-article
1757 nnimap-request-group
1759 nnimap-pattern-to-list-arguments
1762 nnimap-retrieve-groups
1763 nnimap-request-update-info-internal
1765 nnimap-request-set-mark
1766 nnimap-split-to-groups
1767 nnimap-split-find-rule
1768 nnimap-split-find-inbox
1769 nnimap-split-articles
1771 nnimap-request-newgroups
1772 nnimap-request-create-group
1773 nnimap-time-substract
1774 nnimap-date-days-ago
1775 nnimap-request-expire-articles-progress
1776 nnimap-request-expire-articles
1777 nnimap-request-move-article
1778 nnimap-request-accept-article
1779 nnimap-request-delete-group
1780 nnimap-request-rename-group
1781 gnus-group-nnimap-expunge
1782 gnus-group-nnimap-edit-acl
1783 gnus-group-nnimap-edit-acl-done
1784 nnimap-group-mode-hook
1785 nnimap-mark-to-predicate
1786 nnimap-mark-to-flag-1
1788 nnimap-mark-permanent-p
1793 ;; arch-tag: 2b001f20-3ff9-4094-a0ad-46807c1ba70b
1794 ;;; nnimap.el ends here
