1 ;;; nnimap.el --- imap backend for Gnus
3 ;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 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, or (at your option)
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; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, USA.
29 ;; Todo, major things:
31 ;; o Fix Gnus to view correct number of unread/total articles in group buffer
32 ;; o Fix Gnus to handle leading '.' in group names (fixed?)
33 ;; o Finish disconnected mode (moving articles between mailboxes unplugged)
35 ;; o MIME (partial article fetches)
36 ;; o Split to other backends, different split rules for different
39 ;; Todo, minor things:
41 ;; o Don't require half of Gnus -- backends should be standalone
42 ;; o Verify that we don't use IMAP4rev1 specific things (RFC2060 App B)
43 ;; o Dont uid fetch 1,* in nnimap-retrive-groups (slow)
44 ;; o Split up big fetches (1,* header especially) in smaller chunks
45 ;; o What do I do with gnus-newsgroup-*?
46 ;; o Tell Gnus about new groups (how can we tell?)
47 ;; o Respooling (fix Gnus?) (unnecessary?)
48 ;; o Add support for the following: (if applicable)
49 ;; request-list-newsgroups, request-regenerate
51 ;; request-associate-buffer, request-restore-buffer,
52 ;; o Do The Right Thing when UIDVALIDITY changes (what's the right thing?)
53 ;; o Support RFC2221 (Login referrals)
54 ;; o IMAP2BIS compatibility? (RFC2061)
55 ;; o ACAP stuff (perhaps a different project, would be nice to ACAPify
57 ;; o What about Gnus's article editing, can we support it? NO!
58 ;; o Use \Draft to support the draft group??
59 ;; o Duplicate suppression
60 ;; o Rewrite UID SEARCH UID X as UID FETCH X (UID) for those with slow servers
74 (eval-when-compile (require 'cl
))
78 (defconst nnimap-version
"nnimap 1.0")
81 "Reading IMAP mail with Gnus."
84 (defvoo nnimap-address nil
85 "Address of physical IMAP server. If nil, use the virtual server's name.")
87 (defvoo nnimap-server-port nil
88 "Port number on physical IMAP server.
89 If nil, defaults to 993 for TLS/SSL connections and 143 otherwise.")
91 ;; Splitting variables
93 (defcustom nnimap-split-crosspost t
94 "If non-nil, do crossposting if several split methods match the mail.
95 If nil, the first match found will be used."
99 (defcustom nnimap-split-inbox nil
100 "Name of mailbox to split mail from.
102 Mail is read from this mailbox and split according to rules in
105 This can be a string or a list of strings."
107 :type
'(choice (string)
110 (define-widget 'nnimap-strict-function
'function
111 "This widget only matches values that are functionp.
113 Warning: This means that a value that is the symbol of a not yet
114 loaded function will not match. Use with care."
115 :match
'nnimap-strict-function-match
)
117 (defun nnimap-strict-function-match (widget value
)
118 "Ignoring WIDGET, match if VALUE is a function."
121 (defcustom nnimap-split-rule nil
122 "Mail will be split according to these rules.
124 Mail is read from mailbox(es) specified in `nnimap-split-inbox'.
126 If you'd like, for instance, one mail group for mail from the
127 \"gnus-imap\" mailing list, one group for junk mail and leave
128 everything else in the incoming mailbox, you could do something like
131 \(setq nnimap-split-rule '((\"INBOX.gnus-imap\" \"From:.*gnus-imap\")
132 (\"INBOX.junk\" \"Subject:.*buy\")))
134 As you can see, `nnimap-split-rule' is a list of lists, where the
135 first element in each \"rule\" is the name of the IMAP mailbox (or the
136 symbol `junk' if you want to remove the mail), and the second is a
137 regexp that nnimap will try to match on the header to find a fit.
139 The second element can also be a function. In that case, it will be
140 called narrowed to the headers with the first element of the rule as
141 the argument. It should return a non-nil value if it thinks that the
142 mail belongs in that group.
144 This variable can also have a function as its value, the function will
145 be called with the headers narrowed and should return a group where it
146 thinks the article should be splitted to. See `nnimap-split-fancy'.
148 To allow for different split rules on different virtual servers, and
149 even different split rules in different inboxes on the same server,
150 the syntax of this variable have been extended along the lines of:
152 \(setq nnimap-split-rule
153 '((\"my1server\" (\".*\" ((\"ding\" \"ding@gnus.org\")
154 (\"junk\" \"From:.*Simon\")))
155 (\"my2server\" (\"INBOX\" nnimap-split-fancy))
156 (\"my[34]server\" (\".*\" ((\"private\" \"To:.*Simon\")
157 (\"junk\" my-junk-func)))))
159 The virtual server name is in fact a regexp, so that the same rules
160 may apply to several servers. In the example, the servers
161 \"my3server\" and \"my4server\" both use the same rules. Similarly,
162 the inbox string is also a regexp. The actual splitting rules are as
163 before, either a function, or a list with group/regexp or
164 group/function elements."
166 :type
'(choice :tag
"Rule type"
167 (repeat :menu-tag
"Single-server"
168 :tag
"Single-server list"
169 (list (string :tag
"Mailbox")
170 (choice :tag
"Predicate"
171 (regexp :tag
"A regexp")
172 (nnimap-strict-function :tag
"A function"))))
173 (choice :menu-tag
"A function"
175 (function-item nnimap-split-fancy
)
176 (function-item nnmail-split-fancy
)
177 (nnimap-strict-function :tag
"User-defined function"))
178 (repeat :menu-tag
"Multi-server (extended)"
179 :tag
"Multi-server list"
180 (list (regexp :tag
"Server regexp")
181 (list (regexp :tag
"Incoming Mailbox regexp")
182 (repeat :tag
"Rules for matching server(s) and mailbox(es)"
183 (list (string :tag
"Destination mailbox")
184 (choice :tag
"Predicate"
185 (regexp :tag
"A Regexp")
186 (nnimap-strict-function :tag
"A Function")))))))))
188 (defcustom nnimap-split-predicate
"UNSEEN UNDELETED"
189 "The predicate used to find articles to split.
190 If you use another IMAP client to peek on articles but always would
191 like nnimap to split them once it's started, you could change this to
192 \"UNDELETED\". Other available predicates are available in
193 RFC2060 section 6.4.4."
197 (defcustom nnimap-split-fancy nil
198 "Like the variable `nnmail-split-fancy'."
202 (defvar nnimap-split-download-body-default nil
203 "Internal variable with default value for `nnimap-split-download-body'.")
205 (defcustom nnimap-split-download-body
'default
206 "Whether to download entire articles during splitting.
207 This is generally not required, and will slow things down considerably.
208 You may need it if you want to use an advanced splitting function that
209 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 Nil means no information is sent, symbol `no' to disable ID query
428 alltogheter, 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 "1,*" "UID" nil
'nouidfetch
)
559 (imap-message-map (lambda (uid Uid
)
560 (setq minuid
(if minuid
(min minuid uid
) uid
)
561 maxuid
(if maxuid
(max maxuid uid
) uid
)))
563 (list (imap-mailbox-get 'exists
) minuid maxuid
)))))
565 (defun nnimap-possibly-change-group (group &optional server
)
566 "Make GROUP the current group, and SERVER the current server."
567 (when (nnimap-possibly-change-server server
)
568 (with-current-buffer nnimap-server-buffer
569 (if (or (null group
) (imap-current-mailbox-p group
))
571 (if (imap-mailbox-select group
)
572 (if (or (nnimap-verify-uidvalidity
573 group
(or server nnimap-current-server
))
574 (zerop (imap-mailbox-get 'exists group
))
575 t
;; for OGnus to see if ignoring uidvalidity
576 ;; changes has any bad effects.
579 "nnimap: Group %s is not uidvalid. Continue? " group
)))
581 (imap-mailbox-unselect)
582 (error "nnimap: Group %s is not uid-valid" group
))
583 (nnheader-report 'nnimap
(imap-error-text)))))))
585 (defun nnimap-replace-whitespace (string)
586 "Return STRING with all whitespace replaced with space."
588 (while (string-match "[\r\n\t]+" string
)
589 (setq string
(replace-match " " t t string
)))
592 ;; Required backend functions
594 (defun nnimap-retrieve-headers-progress ()
595 "Hook to insert NOV line for current article into `nntp-server-buffer'."
596 (and (numberp nnmail-large-newsgroup
)
597 (zerop (%
(incf nnimap-counter
) nnimap-progress-how-often
))
598 (> nnimap-length nnmail-large-newsgroup
)
599 (nnheader-message 6 "nnimap: Retrieving headers... %c"
600 (nth (/ (% nnimap-counter
601 (* (length nnimap-progress-chars
)
602 nnimap-progress-how-often
))
603 nnimap-progress-how-often
)
604 nnimap-progress-chars
)))
605 (with-current-buffer nntp-server-buffer
606 (let (headers lines chars uid mbx
)
607 (with-current-buffer nnimap-server-buffer
608 (setq uid imap-current-message
609 mbx imap-current-mailbox
610 headers
(nnimap-demule
611 (if (imap-capability 'IMAP4rev1
)
612 ;; xxx don't just use car? alist doesn't contain
613 ;; anything else now, but it might...
614 (nth 2 (car (imap-message-get uid
'BODYDETAIL
)))
615 (imap-message-get uid
'RFC822.HEADER
)))
616 lines
(imap-body-lines (imap-message-body imap-current-message
))
617 chars
(imap-message-get imap-current-message
'RFC822.SIZE
)))
619 ;; At this stage, we only have bytes, so let's use unibyte buffers
620 ;; to make it more clear.
621 (mm-with-unibyte-buffer
622 (buffer-disable-undo)
624 (let ((head (nnheader-parse-naked-head uid
)))
625 (mail-header-set-number head uid
)
626 (mail-header-set-chars head chars
)
627 (mail-header-set-lines head lines
)
628 (mail-header-set-xref
629 head
(format "%s %s:%d" (system-name) mbx uid
))
632 (defun nnimap-retrieve-which-headers (articles fetch-old
)
633 "Get a range of articles to fetch based on ARTICLES and FETCH-OLD."
634 (with-current-buffer nnimap-server-buffer
635 (if (numberp (car-safe articles
))
638 (imap-range-to-message-set
639 (gnus-compress-sequence
640 (append (gnus-uncompress-sequence
642 (cons (if (numberp fetch-old
)
643 (max 1 (- (car articles
) fetch-old
))
645 (1- (car articles
)))))
647 (mapcar (lambda (msgid)
649 (format "HEADER Message-Id \"%s\"" msgid
)))
652 (defun nnimap-group-overview-filename (group server
)
653 "Make file name for GROUP on SERVER."
654 (let* ((dir (file-name-as-directory (expand-file-name nnimap-directory
)))
655 (uidvalidity (gnus-group-get-parameter
656 (gnus-group-prefixed-name
657 group
(gnus-server-to-method
658 (format "nnimap:%s" server
)))
660 (name (nnheader-translate-file-chars
661 (concat nnimap-nov-file-name
662 (if (equal server
"")
664 server
) "." group nnimap-nov-file-name-suffix
) t
))
665 (nameuid (nnheader-translate-file-chars
666 (concat nnimap-nov-file-name
667 (if (equal server
"")
669 server
) "." group
"." uidvalidity
670 nnimap-nov-file-name-suffix
) t
))
671 (oldfile (if (or nnmail-use-long-file-names
672 (file-exists-p (expand-file-name name dir
)))
673 (expand-file-name name dir
)
675 (mm-encode-coding-string
676 (nnheader-replace-chars-in-string name ?. ?
/)
677 nnmail-pathname-coding-system
)
679 (newfile (if (or nnmail-use-long-file-names
680 (file-exists-p (expand-file-name nameuid dir
)))
681 (expand-file-name nameuid dir
)
683 (mm-encode-coding-string
684 (nnheader-replace-chars-in-string nameuid ?. ?
/)
685 nnmail-pathname-coding-system
)
687 (when (and (file-exists-p oldfile
) (not (file-exists-p newfile
)))
688 (message "nnimap: Upgrading novcache filename...")
690 (gnus-make-directory (file-name-directory newfile
))
691 (unless (ignore-errors (rename-file oldfile newfile
) t
)
692 (if (ignore-errors (copy-file oldfile newfile
) t
)
693 (delete-file oldfile
)
694 (error "Can't rename `%s' to `%s'" oldfile newfile
))))
697 (defun nnimap-retrieve-headers-from-file (group server
)
698 (with-current-buffer nntp-server-buffer
699 (let ((nov (nnimap-group-overview-filename group server
)))
700 (when (file-exists-p nov
)
701 (mm-insert-file-contents nov
)
702 (set-buffer-modified-p nil
)
703 (let ((min (ignore-errors (goto-char (point-min))
704 (read (current-buffer))))
705 (max (ignore-errors (goto-char (point-max))
707 (read (current-buffer)))))
708 (if (and (numberp min
) (numberp max
))
710 ;; junk, remove it, it's saved later
714 (defun nnimap-retrieve-headers-from-server (articles group server
)
715 (with-current-buffer nnimap-server-buffer
716 (let ((imap-fetch-data-hook '(nnimap-retrieve-headers-progress))
717 (nnimap-length (gnus-range-length articles
))
719 (imap-fetch (imap-range-to-message-set articles
)
720 (concat "(UID RFC822.SIZE BODY "
722 (append '(Subject From Date Message-Id
723 References In-Reply-To Xref
)
725 nnmail-extra-headers
))))
726 (if (imap-capability 'IMAP4rev1
)
727 (format "BODY.PEEK[HEADER.FIELDS %s])" headers
)
728 (format "RFC822.HEADER.LINES %s)" headers
)))))
729 (with-current-buffer nntp-server-buffer
730 (sort-numeric-fields 1 (point-min) (point-max)))
731 (and (numberp nnmail-large-newsgroup
)
732 (> nnimap-length nnmail-large-newsgroup
)
733 (nnheader-message 6 "nnimap: Retrieving headers...done")))))
735 (defun nnimap-dont-use-nov-p (group server
)
736 (or gnus-nov-is-evil nnimap-nov-is-evil
737 (unless (and (gnus-make-directory
739 (nnimap-group-overview-filename group server
)))
741 (nnimap-group-overview-filename group server
)))
742 (message "nnimap: Nov cache not writable, %s"
743 (nnimap-group-overview-filename group server
)))))
745 (deffoo nnimap-retrieve-headers
(articles &optional group server fetch-old
)
746 (when (nnimap-possibly-change-group group server
)
747 (with-current-buffer nntp-server-buffer
749 (if (nnimap-dont-use-nov-p group server
)
750 (nnimap-retrieve-headers-from-server
751 (gnus-compress-sequence articles
) group server
)
752 (let (uids cached low high
)
753 (when (setq uids
(nnimap-retrieve-which-headers articles fetch-old
)
755 high
(car (last uids
)))
756 (if (setq cached
(nnimap-retrieve-headers-from-file group server
))
758 ;; fetch articles with uids before cache block
759 (when (< low
(car cached
))
760 (goto-char (point-min))
761 (nnimap-retrieve-headers-from-server
762 (cons low
(1- (car cached
))) group server
))
763 ;; fetch articles with uids after cache block
764 (when (> high
(cdr cached
))
765 (goto-char (point-max))
766 (nnimap-retrieve-headers-from-server
767 (cons (1+ (cdr cached
)) high
) group server
))
768 (when nnimap-prune-cache
769 ;; remove nov's for articles which has expired on server
770 (goto-char (point-min))
771 (dolist (uid (gnus-set-difference articles uids
))
772 (when (re-search-forward (format "^%d\t" uid
) nil t
)
773 (gnus-delete-line)))))
774 ;; nothing cached, fetch whole range from server
775 (nnimap-retrieve-headers-from-server
776 (cons low high
) group server
))
777 (when (buffer-modified-p)
779 (point-min) (point-max)
780 (nnimap-group-overview-filename group server
) nil
'nomesg
))
781 (nnheader-nov-delete-outside-range low high
))))
784 (defun nnimap-open-connection (server)
785 ;; Note: `nnimap-open-server' that calls this function binds
786 ;; `imap-logout-timeout' to `nnimap-logout-timeout'.
787 (if (not (imap-open nnimap-address nnimap-server-port nnimap-stream
788 nnimap-authenticator nnimap-server-buffer
))
789 (nnheader-report 'nnimap
"Can't open connection to server %s" server
)
790 (unless (or (imap-capability 'IMAP4 nnimap-server-buffer
)
791 (imap-capability 'IMAP4rev1 nnimap-server-buffer
))
792 (imap-close nnimap-server-buffer
)
793 (nnheader-report 'nnimap
"Server %s is not IMAP4 compliant" server
))
794 (let* ((list (progn (gnus-message 7 "Parsing authinfo file `%s'."
795 nnimap-authinfo-file
)
796 (netrc-parse nnimap-authinfo-file
)))
797 (port (if nnimap-server-port
798 (int-to-string nnimap-server-port
)
800 (user (netrc-machine-user-or-password
804 (or nnimap-server-address
807 (list "imap" "imaps" "143" "993")))
808 (passwd (netrc-machine-user-or-password
812 (or nnimap-server-address
815 (list "imap" "imaps" "143" "993"))))
816 (if (imap-authenticate user passwd nnimap-server-buffer
)
818 (setq nnimap-server-buffer-alist
819 (nnimap-remove-server-from-buffer-alist
821 nnimap-server-buffer-alist
))
822 (push (list server nnimap-server-buffer
)
823 nnimap-server-buffer-alist
)
824 (imap-id nnimap-id nnimap-server-buffer
)
825 (nnimap-possibly-change-server server
))
826 (imap-close nnimap-server-buffer
)
827 (kill-buffer nnimap-server-buffer
)
828 (nnheader-report 'nnimap
"Could not authenticate to %s" server
)))))
830 (deffoo nnimap-open-server
(server &optional defs
)
831 (nnheader-init-server-buffer)
832 (if (nnimap-server-opened server
)
834 (unless (assq 'nnimap-server-buffer defs
)
835 (push (list 'nnimap-server-buffer
(concat " *nnimap* " server
)) defs
))
836 ;; translate `nnimap-server-address' to `nnimap-address' in defs
837 ;; for people that configured nnimap with a very old version
838 (unless (assq 'nnimap-address defs
)
839 (if (assq 'nnimap-server-address defs
)
840 (push (list 'nnimap-address
841 (cadr (assq 'nnimap-server-address defs
))) defs
)
842 (push (list 'nnimap-address server
) defs
)))
843 (nnoo-change-server 'nnimap server defs
)
844 (or nnimap-server-buffer
845 (setq nnimap-server-buffer
(cadr (assq 'nnimap-server-buffer defs
))))
846 (with-current-buffer (get-buffer-create nnimap-server-buffer
)
847 (nnoo-change-server 'nnimap server defs
))
848 (let ((imap-logout-timeout nnimap-logout-timeout
))
849 (or (and nnimap-server-buffer
850 (imap-opened nnimap-server-buffer
)
851 (if (with-current-buffer nnimap-server-buffer
852 (memq imap-state
'(auth selected examine
)))
854 (imap-close nnimap-server-buffer
)
855 (nnimap-open-connection server
)))
856 (nnimap-open-connection server
)))))
858 (deffoo nnimap-server-opened
(&optional server
)
859 "Whether SERVER is opened.
860 If SERVER is the current virtual server, and the connection to the
861 physical server is alive, this function return a non-nil value. If
862 SERVER is nil, it is treated as the current server."
863 ;; clean up autologouts??
864 (and (or server nnimap-current-server
)
865 (nnoo-server-opened 'nnimap
(or server nnimap-current-server
))
866 (imap-opened (nnimap-get-server-buffer server
))))
868 (deffoo nnimap-close-server
(&optional server
)
869 "Close connection to server and free all resources connected to it.
870 Return nil if the server couldn't be closed for some reason."
871 (let ((server (or server nnimap-current-server
))
872 (imap-logout-timeout nnimap-logout-timeout
))
873 (when (or (nnimap-server-opened server
)
874 (imap-opened (nnimap-get-server-buffer server
)))
875 (imap-close (nnimap-get-server-buffer server
))
876 (kill-buffer (nnimap-get-server-buffer server
))
877 (setq nnimap-server-buffer nil
878 nnimap-current-server nil
879 nnimap-server-buffer-alist
880 (nnimap-remove-server-from-buffer-alist
882 nnimap-server-buffer-alist
)))
883 (nnoo-close-server 'nnimap server
)))
885 (deffoo nnimap-request-close
()
886 "Close connection to all servers and free all resources that the backend have reserved.
887 All buffers that have been created by that
888 backend should be killed. (Not the nntp-server-buffer, though.) This
889 function is generally only called when Gnus is shutting down."
890 (mapc (lambda (server) (nnimap-close-server (car server
)))
891 nnimap-server-buffer-alist
)
892 (setq nnimap-server-buffer-alist nil
))
894 (deffoo nnimap-status-message
(&optional server
)
895 "This function returns the last error message from server."
896 (when (nnimap-possibly-change-server server
)
897 (nnoo-status-message 'nnimap server
)))
899 (defun nnimap-demule (string)
900 ;; BEWARE: we used to use string-as-multibyte here which is braindead
901 ;; because it will turn accidental emacs-mule-valid byte sequences
902 ;; into multibyte chars. --Stef
903 ;; Reverted, braindead got 7.5 out of 10 on imdb, so it can't be
905 (funcall (if (and (fboundp 'string-as-multibyte
)
906 (subrp (symbol-function 'string-as-multibyte
)))
911 (defun nnimap-make-callback (article gnus-callback buffer
)
912 "Return a callback function."
914 (nnimap-callback ,article
,gnus-callback
,buffer
)))
916 (defun nnimap-callback (article gnus-callback buffer
)
917 (when (eq article
(imap-current-message))
918 (remove-hook 'imap-fetch-data-hook
919 (nnimap-make-callback article gnus-callback buffer
))
920 (with-current-buffer buffer
922 (with-current-buffer nnimap-server-buffer
924 (if (imap-capability 'IMAP4rev1
)
925 ;; xxx don't just use car? alist doesn't contain
926 ;; anything else now, but it might...
927 (nth 2 (car (imap-message-get article
'BODYDETAIL
)))
928 (imap-message-get article
'RFC822
)))))
929 (nnheader-ms-strip-cr)
930 (funcall gnus-callback t
))))
932 (defun nnimap-request-article-part (article part prop
&optional
933 group server to-buffer detail
)
934 (when (nnimap-possibly-change-group group server
)
935 (let ((article (if (stringp article
)
936 (car-safe (imap-search
937 (format "HEADER Message-Id \"%s\"" article
)
938 nnimap-server-buffer
))
941 (gnus-message 10 "nnimap: Fetching (part of) article %d from %s..."
942 article
(or group imap-current-mailbox
943 gnus-newsgroup-name
))
944 (if (not nnheader-callback-function
)
945 (with-current-buffer (or to-buffer nntp-server-buffer
)
947 (let ((data (imap-fetch article part prop nil
948 nnimap-server-buffer
)))
949 (insert (nnimap-demule (if detail
952 (nnheader-ms-strip-cr)
954 10 "nnimap: Fetching (part of) article %d from %s...done"
955 article
(or group imap-current-mailbox gnus-newsgroup-name
))
957 (nnheader-report 'nnimap
"No such article %d in %s: %s"
958 article
(or group imap-current-mailbox
960 (imap-error-text nnimap-server-buffer
))
961 (cons group article
)))
962 (add-hook 'imap-fetch-data-hook
963 (nnimap-make-callback article
964 nnheader-callback-function
966 (imap-fetch-asynch article part nil nnimap-server-buffer
)
967 (cons group article
))))))
969 (deffoo nnimap-asynchronous-p
()
972 (deffoo nnimap-request-article
(article &optional group server to-buffer
)
973 (if (imap-capability 'IMAP4rev1 nnimap-server-buffer
)
974 (nnimap-request-article-part
975 article
"BODY.PEEK[]" 'BODYDETAIL group server to-buffer
'detail
)
976 (nnimap-request-article-part
977 article
"RFC822.PEEK" 'RFC822 group server to-buffer
)))
979 (deffoo nnimap-request-head
(article &optional group server to-buffer
)
980 (if (imap-capability 'IMAP4rev1 nnimap-server-buffer
)
981 (nnimap-request-article-part
982 article
"BODY.PEEK[HEADER]" 'BODYDETAIL group server to-buffer
'detail
)
983 (nnimap-request-article-part
984 article
"RFC822.HEADER" 'RFC822.HEADER group server to-buffer
)))
986 (deffoo nnimap-request-body
(article &optional group server to-buffer
)
987 (if (imap-capability 'IMAP4rev1 nnimap-server-buffer
)
988 (nnimap-request-article-part
989 article
"BODY.PEEK[TEXT]" 'BODYDETAIL group server to-buffer
'detail
)
990 (nnimap-request-article-part
991 article
"RFC822.TEXT.PEEK" 'RFC822.TEXT group server to-buffer
)))
993 (deffoo nnimap-request-group
(group &optional server fast
)
994 (nnimap-request-update-info-internal
996 (gnus-get-info (gnus-group-prefixed-name
997 group
(gnus-server-to-method (format "nnimap:%s" server
))))
999 (when (nnimap-possibly-change-group group server
)
1000 (nnimap-before-find-minmax-bugworkaround)
1003 ((null (setq info
(nnimap-find-minmax-uid group t
)))
1004 (nnheader-report 'nnimap
"Could not get active info for %s"
1007 (nnheader-insert "211 %d %d %d %s\n" (or (nth 0 info
) 0)
1008 (max 1 (or (nth 1 info
) 1))
1009 (or (nth 2 info
) 0) group
)
1010 (nnheader-report 'nnimap
"Group %s selected" group
)
1013 (defun nnimap-update-unseen (group &optional server
)
1014 "Update the unseen count in `nnimap-mailbox-info'."
1016 (gnus-group-prefixed-name group server
)
1017 (let ((old (gnus-gethash-safe (gnus-group-prefixed-name group server
)
1018 nnimap-mailbox-info
)))
1019 (list (nth 0 old
) (nth 1 old
)
1020 (imap-mailbox-status group
'unseen nnimap-server-buffer
)
1022 nnimap-mailbox-info
))
1024 (defun nnimap-close-group (group &optional server
)
1025 (with-current-buffer nnimap-server-buffer
1026 (when (and (imap-opened)
1027 (nnimap-possibly-change-group group server
))
1028 (nnimap-update-unseen group server
)
1029 (case nnimap-expunge-on-close
1031 (imap-mailbox-expunge nnimap-close-asynchronous
)
1032 (unless nnimap-dont-close
1033 (imap-mailbox-close nnimap-close-asynchronous
))))
1034 (ask (if (and (imap-search "DELETED")
1035 (gnus-y-or-n-p (format "Expunge articles in group `%s'? "
1036 imap-current-mailbox
)))
1038 (imap-mailbox-expunge nnimap-close-asynchronous
)
1039 (unless nnimap-dont-close
1040 (imap-mailbox-close nnimap-close-asynchronous
)))
1041 (imap-mailbox-unselect)))
1042 (t (imap-mailbox-unselect)))
1043 (not imap-current-mailbox
))))
1045 (defun nnimap-pattern-to-list-arguments (pattern)
1047 (cons (car-safe p
) (or (cdr-safe p
) p
)))
1048 (if (and (listp pattern
)
1049 (listp (cdr pattern
)))
1053 (deffoo nnimap-request-list
(&optional server
)
1054 (when (nnimap-possibly-change-server server
)
1055 (with-current-buffer nntp-server-buffer
1057 (gnus-message 5 "nnimap: Generating active list%s..."
1058 (if (> (length server
) 0) (concat " for " server
) ""))
1059 (nnimap-before-find-minmax-bugworkaround)
1060 (with-current-buffer nnimap-server-buffer
1061 (dolist (pattern (nnimap-pattern-to-list-arguments nnimap-list-pattern
))
1062 (dolist (mbx (funcall nnimap-request-list-method
1063 (cdr pattern
) (car pattern
)))
1064 (or (member "\\NoSelect" (imap-mailbox-get 'list-flags mbx
))
1065 (let ((info (nnimap-find-minmax-uid mbx
'examine
)))
1067 (with-current-buffer nntp-server-buffer
1068 (insert (format "\"%s\" %d %d y\n"
1069 mbx
(or (nth 2 info
) 0)
1070 (max 1 (or (nth 1 info
) 1)))))))))))
1071 (gnus-message 5 "nnimap: Generating active list%s...done"
1072 (if (> (length server
) 0) (concat " for " server
) ""))
1075 (deffoo nnimap-request-post
(&optional server
)
1077 (dolist (mbx (message-unquote-tokens
1078 (message-tokenize-header
1079 (message-fetch-field "Newsgroups") ", ")) success
)
1080 (let ((to-newsgroup (gnus-group-prefixed-name mbx gnus-command-method
)))
1081 (or (gnus-active to-newsgroup
)
1082 (gnus-activate-group to-newsgroup
)
1083 (if (gnus-y-or-n-p (format "No such group: %s. Create it? "
1085 (or (and (gnus-request-create-group
1086 to-newsgroup gnus-command-method
)
1087 (gnus-activate-group to-newsgroup nil nil
1088 gnus-command-method
))
1089 (error "Couldn't create group %s" to-newsgroup
)))
1090 (error "No such group: %s" to-newsgroup
))
1091 (unless (nnimap-request-accept-article mbx
(nth 1 gnus-command-method
))
1092 (setq success nil
))))))
1094 ;; Optional backend functions
1096 (defun nnimap-string-lessp-numerical (s1 s2
)
1097 "Return t if first arg string is less than second in numerical order."
1098 (cond ((string= s1 s2
)
1100 ((> (length s1
) (length s2
))
1102 ((< (length s1
) (length s2
))
1104 ((< (string-to-number (substring s1
0 1))
1105 (string-to-number (substring s2
0 1)))
1107 ((> (string-to-number (substring s1
0 1))
1108 (string-to-number (substring s2
0 1)))
1111 (nnimap-string-lessp-numerical (substring s1
1) (substring s2
1)))))
1113 (deffoo nnimap-retrieve-groups
(groups &optional server
)
1114 (when (nnimap-possibly-change-server server
)
1115 (gnus-message 5 "nnimap: Checking mailboxes...")
1116 (with-current-buffer nntp-server-buffer
1118 (nnimap-before-find-minmax-bugworkaround)
1119 (let (asyncgroups slowgroups
)
1120 (if (null nnimap-retrieve-groups-asynchronous
)
1121 (setq slowgroups groups
)
1122 (dolist (group groups
)
1123 (gnus-message 9 "nnimap: Quickly checking mailbox %s" group
)
1124 (add-to-list (if (gnus-gethash-safe
1125 (gnus-group-prefixed-name group server
)
1126 nnimap-mailbox-info
)
1129 (list group
(imap-mailbox-status-asynch
1130 group
'(uidvalidity uidnext unseen
)
1131 nnimap-server-buffer
))))
1132 (dolist (asyncgroup asyncgroups
)
1133 (let ((group (nth 0 asyncgroup
))
1134 (tag (nth 1 asyncgroup
))
1136 (when (imap-ok-p (imap-wait-for-tag tag nnimap-server-buffer
))
1137 (if (or (not (string=
1138 (nth 0 (gnus-gethash (gnus-group-prefixed-name
1140 nnimap-mailbox-info
))
1141 (imap-mailbox-get 'uidvalidity group
1142 nnimap-server-buffer
)))
1144 (nth 1 (gnus-gethash (gnus-group-prefixed-name
1146 nnimap-mailbox-info
))
1147 (imap-mailbox-get 'uidnext group
1148 nnimap-server-buffer
))))
1149 (push (list group
) slowgroups
)
1150 (insert (nth 3 (gnus-gethash (gnus-group-prefixed-name
1152 nnimap-mailbox-info
))))))))
1153 (dolist (group slowgroups
)
1154 (if nnimap-retrieve-groups-asynchronous
1155 (setq group
(car group
)))
1156 (gnus-message 7 "nnimap: Mailbox %s modified" group
)
1157 (imap-mailbox-put 'uidnext nil group nnimap-server-buffer
)
1158 (or (member "\\NoSelect" (imap-mailbox-get 'list-flags group
1159 nnimap-server-buffer
))
1160 (let* ((info (nnimap-find-minmax-uid group
'examine
))
1161 (str (format "\"%s\" %d %d y\n" group
1163 (max 1 (or (nth 1 info
) 1)))))
1164 (when (> (or (imap-mailbox-get 'recent group
1165 nnimap-server-buffer
) 0)
1167 (push (list (cons group
0)) nnmail-split-history
))
1169 (when nnimap-retrieve-groups-asynchronous
1171 (gnus-group-prefixed-name group server
)
1172 (list (or (imap-mailbox-get
1173 'uidvalidity group nnimap-server-buffer
)
1174 (imap-mailbox-status
1175 group
'uidvalidity nnimap-server-buffer
))
1176 (or (imap-mailbox-get
1177 'uidnext group nnimap-server-buffer
)
1178 (imap-mailbox-status
1179 group
'uidnext nnimap-server-buffer
))
1180 (or (imap-mailbox-get
1181 'unseen group nnimap-server-buffer
)
1182 (imap-mailbox-status
1183 group
'unseen nnimap-server-buffer
))
1185 nnimap-mailbox-info
)))))))
1186 (gnus-message 5 "nnimap: Checking mailboxes...done")
1189 (deffoo nnimap-request-update-info-internal
(group info
&optional server
)
1190 (when (nnimap-possibly-change-group group server
)
1191 (when info
;; xxx what does this mean? should we create a info?
1192 (with-current-buffer nnimap-server-buffer
1193 (gnus-message 5 "nnimap: Updating info for %s..."
1194 (gnus-info-group info
))
1196 (when (nnimap-mark-permanent-p 'read
)
1198 ;; read info could contain articles marked unread by other
1199 ;; imap clients! we correct this
1200 (setq unseen
(gnus-compress-sequence
1201 (imap-search "UNSEEN UNDELETED"))
1202 seen
(gnus-range-difference (gnus-info-read info
) unseen
)
1203 seen
(gnus-range-add seen
1204 (gnus-compress-sequence
1205 (imap-search "SEEN")))
1206 seen
(if (and (integerp (car seen
))
1208 (list (cons (car seen
) (car seen
)))
1210 (gnus-info-set-read info seen
)))
1212 (dolist (pred gnus-article-mark-lists
)
1213 (when (or (eq (cdr pred
) 'recent
)
1214 (and (nnimap-mark-permanent-p (cdr pred
))
1215 (member (nnimap-mark-to-flag (cdr pred
))
1216 (imap-mailbox-get 'flags
))))
1217 (gnus-info-set-marks
1219 (gnus-update-alist-soft
1221 (gnus-compress-sequence
1222 (imap-search (nnimap-mark-to-predicate (cdr pred
))))
1223 (gnus-info-marks info
))
1226 (when nnimap-importantize-dormant
1227 ;; nnimap mark dormant article as ticked too (for other clients)
1228 ;; so we remove that mark for gnus since we support dormant
1229 (gnus-info-set-marks
1231 (gnus-update-alist-soft
1233 (gnus-remove-from-range
1234 (cdr-safe (assoc 'tick
(gnus-info-marks info
)))
1235 (cdr-safe (assoc 'dormant
(gnus-info-marks info
))))
1236 (gnus-info-marks info
))
1239 (gnus-message 5 "nnimap: Updating info for %s...done"
1240 (gnus-info-group info
))
1244 (deffoo nnimap-request-type
(group &optional article
)
1245 (if (and nnimap-news-groups
(string-match nnimap-news-groups group
))
1249 (deffoo nnimap-request-set-mark
(group actions
&optional server
)
1250 (when (nnimap-possibly-change-group group server
)
1251 (with-current-buffer nnimap-server-buffer
1253 (gnus-message 7 "nnimap: Setting marks in %s..." group
)
1254 (while (setq action
(pop actions
))
1255 (let ((range (nth 0 action
))
1256 (what (nth 1 action
))
1257 (cmdmarks (nth 2 action
))
1259 ;; bookmark can't be stored (not list/range
1260 (setq cmdmarks
(delq 'bookmark cmdmarks
))
1261 ;; killed can't be stored (not list/range
1262 (setq cmdmarks
(delq 'killed cmdmarks
))
1263 ;; unsent are for nndraft groups only
1264 (setq cmdmarks
(delq 'unsent cmdmarks
))
1265 ;; cache flags are pointless on the server
1266 (setq cmdmarks
(delq 'cache cmdmarks
))
1267 ;; seen flags are local to each gnus
1268 (setq cmdmarks
(delq 'seen cmdmarks
))
1269 ;; recent marks can't be set
1270 (setq cmdmarks
(delq 'recent cmdmarks
))
1271 (when nnimap-importantize-dormant
1272 ;; flag dormant articles as ticked
1273 (if (memq 'dormant cmdmarks
)
1274 (setq cmdmarks
(cons 'tick cmdmarks
))))
1275 ;; remove stuff we are forbidden to store
1276 (mapc (lambda (mark)
1277 (if (imap-message-flag-permanent-p
1278 (nnimap-mark-to-flag mark
))
1279 (setq marks
(cons mark marks
))))
1281 (when (and range marks
)
1282 (cond ((eq what
'del
)
1283 (imap-message-flags-del
1284 (imap-range-to-message-set range
)
1285 (nnimap-mark-to-flag marks nil t
)))
1287 (imap-message-flags-add
1288 (imap-range-to-message-set range
)
1289 (nnimap-mark-to-flag marks nil t
)))
1291 (imap-message-flags-set
1292 (imap-range-to-message-set range
)
1293 (nnimap-mark-to-flag marks nil t
)))))))
1294 (gnus-message 7 "nnimap: Setting marks in %s...done" group
))))
1297 (defun nnimap-split-fancy ()
1298 "Like the function `nnmail-split-fancy', but uses `nnimap-split-fancy'."
1299 (let ((nnmail-split-fancy nnimap-split-fancy
))
1300 (nnmail-split-fancy)))
1302 (defun nnimap-split-to-groups (rules)
1303 ;; tries to match all rules in nnimap-split-rule against content of
1304 ;; nntp-server-buffer, returns a list of groups that matched.
1305 (with-current-buffer nntp-server-buffer
1306 ;; Fold continuation lines.
1307 (goto-char (point-min))
1308 (while (re-search-forward "\\(\r?\n[ \t]+\\)+" nil t
)
1309 (replace-match " " t t
))
1310 (if (functionp rules
)
1312 (let (to-groups regrepp
)
1314 (dolist (rule rules to-groups
)
1315 (let ((group (car rule
))
1316 (regexp (cadr rule
)))
1317 (goto-char (point-min))
1318 (when (and (if (stringp regexp
)
1320 (if (not (stringp group
))
1321 (setq group
(eval group
))
1323 (string-match "\\\\[0-9&]" group
)))
1324 (re-search-forward regexp nil t
))
1325 (funcall regexp group
))
1326 ;; Don't enter the article into the same group twice.
1327 (not (assoc group to-groups
)))
1329 (nnmail-expand-newtext group
)
1332 (or nnimap-split-crosspost
1333 (throw 'split-done to-groups
))))))))))
1335 (defun nnimap-assoc-match (key alist
)
1337 (while (and alist
(not element
))
1338 (if (string-match (car (car alist
)) key
)
1339 (setq element
(car alist
)))
1340 (setq alist
(cdr alist
)))
1343 (defun nnimap-split-find-rule (server inbox
)
1344 (if (and (listp nnimap-split-rule
) (listp (car nnimap-split-rule
))
1345 (list (cdar nnimap-split-rule
)) (listp (cadar nnimap-split-rule
)))
1347 (cadr (nnimap-assoc-match inbox
(cdr (nnimap-assoc-match
1348 server nnimap-split-rule
))))
1351 (defun nnimap-split-find-inbox (server)
1352 (if (listp nnimap-split-inbox
)
1354 (list nnimap-split-inbox
)))
1356 (defun nnimap-split-articles (&optional group server
)
1357 (when (nnimap-possibly-change-server server
)
1358 (with-current-buffer nnimap-server-buffer
1359 (let (rule inbox removeorig
(inboxes (nnimap-split-find-inbox server
)))
1360 ;; iterate over inboxes
1361 (while (and (setq inbox
(pop inboxes
))
1362 (nnimap-possibly-change-group inbox
)) ;; SELECT
1363 ;; find split rule for this server / inbox
1364 (when (setq rule
(nnimap-split-find-rule server inbox
))
1365 ;; iterate over articles
1366 (dolist (article (imap-search nnimap-split-predicate
))
1367 (when (if (if (eq nnimap-split-download-body
'default
)
1368 nnimap-split-download-body-default
1369 nnimap-split-download-body
)
1370 (and (nnimap-request-article article
)
1371 (with-current-buffer nntp-server-buffer
(mail-narrow-to-head)))
1372 (nnimap-request-head article
))
1373 ;; copy article to right group(s)
1374 (setq removeorig nil
)
1375 (dolist (to-group (nnimap-split-to-groups rule
))
1376 (cond ((eq to-group
'junk
)
1377 (message "IMAP split removed %s:%s:%d" server inbox
1379 (setq removeorig t
))
1380 ((imap-message-copy (number-to-string article
)
1381 to-group nil
'nocopyuid
)
1382 (message "IMAP split moved %s:%s:%d to %s" server
1383 inbox article to-group
)
1385 (when nnmail-cache-accepted-message-ids
1386 (with-current-buffer nntp-server-buffer
1389 (nnmail-fetch-field "message-id"))
1390 (nnmail-cache-insert msgid
1392 (nnmail-fetch-field "subject"))))))
1393 ;; Add the group-art list to the history list.
1394 (push (list (cons to-group
0)) nnmail-split-history
))
1396 (message "IMAP split failed to move %s:%s:%d to %s"
1397 server inbox article to-group
))))
1398 (if (if (eq nnimap-split-download-body
'default
)
1399 nnimap-split-download-body-default
1400 nnimap-split-download-body
)
1402 ;; remove article if it was successfully copied somewhere
1404 (imap-message-flags-add (format "%d" article
)
1405 "\\Seen \\Deleted")))))
1406 (when (imap-mailbox-select inbox
) ;; just in case
1407 ;; todo: UID EXPUNGE (if available) to remove splitted articles
1408 (imap-mailbox-expunge)
1409 (imap-mailbox-close)))
1410 (when nnmail-cache-accepted-message-ids
1411 (nnmail-cache-close))
1414 (deffoo nnimap-request-scan
(&optional group server
)
1415 (nnimap-split-articles group server
))
1417 (deffoo nnimap-request-newgroups
(date &optional server
)
1418 (when (nnimap-possibly-change-server server
)
1419 (with-current-buffer nntp-server-buffer
1420 (gnus-message 5 "nnimap: Listing subscribed mailboxes%s%s..."
1421 (if (> (length server
) 0) " on " "") server
)
1423 (nnimap-before-find-minmax-bugworkaround)
1424 (dolist (pattern (nnimap-pattern-to-list-arguments
1425 nnimap-list-pattern
))
1426 (dolist (mbx (imap-mailbox-lsub (cdr pattern
) (car pattern
) nil
1427 nnimap-server-buffer
))
1429 (dolist (mailbox (imap-mailbox-get 'list-flags mbx
1430 nnimap-server-buffer
))
1431 (if (string= (downcase mailbox
) "\\noselect")
1434 (let ((info (nnimap-find-minmax-uid mbx
'examine
)))
1436 (insert (format "\"%s\" %d %d y\n"
1437 mbx
(or (nth 2 info
) 0)
1438 (max 1 (or (nth 1 info
) 1)))))))))
1439 (gnus-message 5 "nnimap: Listing subscribed mailboxes%s%s...done"
1440 (if (> (length server
) 0) " on " "") server
))
1443 (deffoo nnimap-request-create-group
(group &optional server args
)
1444 (when (nnimap-possibly-change-server server
)
1445 (or (imap-mailbox-status group
'uidvalidity nnimap-server-buffer
)
1446 (imap-mailbox-create group nnimap-server-buffer
)
1447 (nnheader-report 'nnimap
"%S"
1448 (imap-error-text nnimap-server-buffer
)))))
1450 (defun nnimap-time-substract (time1 time2
)
1451 "Return TIME for TIME1 - TIME2."
1452 (let* ((ms (- (car time1
) (car time2
)))
1453 (ls (- (nth 1 time1
) (nth 1 time2
))))
1455 (list (- ms
1) (+ (expt 2 16) ls
))
1458 (eval-when-compile (require 'parse-time
))
1459 (defun nnimap-date-days-ago (daysago)
1460 "Return date, in format \"3-Aug-1998\", for DAYSAGO days ago."
1461 (require 'parse-time
)
1462 (let* ((time (nnimap-time-substract (current-time) (days-to-time daysago
)))
1463 (date (format-time-string
1464 (format "%%d-%s-%%Y"
1465 (capitalize (car (rassoc (nth 4 (decode-time time
))
1466 parse-time-months
))))
1468 (if (eq ?
0 (string-to-char date
))
1472 (defun nnimap-request-expire-articles-progress ()
1473 (gnus-message 5 "nnimap: Marking article %d for deletion..."
1474 imap-current-message
))
1476 (defun nnimap-expiry-target (arts group server
)
1477 (unless (eq nnmail-expiry-target
'delete
)
1480 (nnimap-request-article art group server
(current-buffer))
1481 ;; hints for optimization in `nnimap-request-accept-article'
1482 (let ((nnimap-current-move-article art
)
1483 (nnimap-current-move-group group
)
1484 (nnimap-current-move-server server
))
1485 (nnmail-expiry-target-group nnmail-expiry-target group
))))
1486 ;; It is not clear if `nnmail-expiry-target' somehow cause the
1487 ;; current group to be changed or not, so we make sure here.
1488 (nnimap-possibly-change-group group server
)))
1490 ;; Notice that we don't actually delete anything, we just mark them deleted.
1491 (deffoo nnimap-request-expire-articles
(articles group
&optional server force
)
1492 (let ((artseq (gnus-compress-sequence articles
)))
1493 (when (and artseq
(nnimap-possibly-change-group group server
))
1494 (with-current-buffer nnimap-server-buffer
1495 (let ((days (or (and nnmail-expiry-wait-function
1496 (funcall nnmail-expiry-wait-function group
))
1497 nnmail-expiry-wait
)))
1498 (cond ((or force
(eq days
'immediate
))
1499 (let ((oldarts (imap-search
1501 (imap-range-to-message-set artseq
)))))
1503 (nnimap-expiry-target oldarts group server
)
1504 (when (imap-message-flags-add
1505 (imap-range-to-message-set
1506 (gnus-compress-sequence oldarts
)) "\\Deleted")
1507 (setq articles
(gnus-set-difference
1508 articles oldarts
))))))
1509 ((and nnimap-search-uids-not-since-is-evil
(numberp days
))
1510 (let* ((all-new-articles
1511 (gnus-compress-sequence
1512 (imap-search (format "SINCE %s"
1513 (nnimap-date-days-ago days
)))))
1515 (gnus-range-difference artseq all-new-articles
))
1516 (oldarts (gnus-uncompress-range oldartseq
)))
1518 (nnimap-expiry-target oldarts group server
)
1519 (when (imap-message-flags-add
1520 (imap-range-to-message-set oldartseq
)
1522 (setq articles
(gnus-set-difference
1523 articles oldarts
))))))
1525 (let ((oldarts (imap-search
1526 (format nnimap-expunge-search-string
1527 (imap-range-to-message-set artseq
)
1528 (nnimap-date-days-ago days
))))
1529 (imap-fetch-data-hook
1530 '(nnimap-request-expire-articles-progress)))
1532 (nnimap-expiry-target oldarts group server
)
1533 (when (imap-message-flags-add
1534 (imap-range-to-message-set
1535 (gnus-compress-sequence oldarts
)) "\\Deleted")
1536 (setq articles
(gnus-set-difference
1537 articles oldarts
)))))))))))
1538 ;; return articles not deleted
1541 (deffoo nnimap-request-move-article
(article group server accept-form
1542 &optional last move-is-internal
)
1543 (when (nnimap-possibly-change-server server
)
1545 (let ((buf (get-buffer-create " *nnimap move*"))
1546 (nnimap-current-move-article article
)
1547 (nnimap-current-move-group group
)
1548 (nnimap-current-move-server nnimap-current-server
)
1550 (gnus-message 10 "nnimap-request-move-article: this is an %s move"
1551 (if move-is-internal
1554 ;; request the article only when the move is NOT internal
1555 (and (or move-is-internal
1556 (nnimap-request-article article group server
))
1557 (with-current-buffer buf
1558 (buffer-disable-undo (current-buffer))
1559 (insert-buffer-substring nntp-server-buffer
)
1560 (setq result
(eval accept-form
))
1563 (nnimap-possibly-change-group group server
)
1564 (imap-message-flags-add
1565 (imap-range-to-message-set (list article
))
1566 "\\Deleted" 'silent nnimap-server-buffer
))
1569 (deffoo nnimap-request-accept-article
(group &optional server last
)
1570 (when (nnimap-possibly-change-server server
)
1573 (if (string= nnimap-current-server nnimap-current-move-server
)
1574 ;; moving article within same server, speed it up...
1575 (and (nnimap-possibly-change-group
1576 nnimap-current-move-group
)
1577 (imap-message-copy (number-to-string
1578 nnimap-current-move-article
)
1579 group
'dontcreate nil
1580 nnimap-server-buffer
))
1581 (with-current-buffer (current-buffer)
1582 (goto-char (point-min))
1583 ;; remove any 'From blabla' lines, some IMAP servers
1584 ;; reject the entire message otherwise.
1585 (when (looking-at "^From[^:]")
1586 (delete-region (point) (progn (forward-line) (point))))
1587 ;; turn into rfc822 format (\r\n eol's)
1588 (while (search-forward "\n" nil t
)
1589 (replace-match "\r\n"))
1590 (when nnmail-cache-accepted-message-ids
1591 (nnmail-cache-insert (nnmail-fetch-field "message-id")
1593 (nnmail-fetch-field "subject"))))
1594 (when (and last nnmail-cache-accepted-message-ids
)
1595 (nnmail-cache-close))
1596 ;; this 'or' is for Cyrus server bug
1597 (or (null (imap-current-mailbox nnimap-server-buffer
))
1598 (imap-mailbox-unselect nnimap-server-buffer
))
1599 (imap-message-append group
(current-buffer) nil nil
1600 nnimap-server-buffer
)))
1601 (cons group
(nth 1 uid
))
1602 (nnheader-report 'nnimap
(imap-error-text nnimap-server-buffer
))))))
1604 (deffoo nnimap-request-delete-group
(group force
&optional server
)
1605 (when (nnimap-possibly-change-server server
)
1606 (with-current-buffer nnimap-server-buffer
1608 (or (null (imap-mailbox-status group
'uidvalidity
))
1609 (imap-mailbox-delete group
))
1613 (deffoo nnimap-request-rename-group
(group new-name
&optional server
)
1614 (when (nnimap-possibly-change-server server
)
1615 (imap-mailbox-rename group new-name nnimap-server-buffer
)))
1617 (defun nnimap-expunge (mailbox server
)
1618 (when (nnimap-possibly-change-group mailbox server
)
1619 (imap-mailbox-expunge nil nnimap-server-buffer
)))
1621 (defun nnimap-acl-get (mailbox server
)
1622 (when (nnimap-possibly-change-server server
)
1623 (and (imap-capability 'ACL nnimap-server-buffer
)
1624 (imap-mailbox-acl-get mailbox nnimap-server-buffer
))))
1626 (defun nnimap-acl-edit (mailbox method old-acls new-acls
)
1627 (when (nnimap-possibly-change-server (cadr method
))
1628 (unless (imap-capability 'ACL nnimap-server-buffer
)
1629 (error "Your server does not support ACL editing"))
1630 (with-current-buffer nnimap-server-buffer
1631 ;; delete all removed identifiers
1632 (mapc (lambda (old-acl)
1633 (unless (assoc (car old-acl
) new-acls
)
1634 (or (imap-mailbox-acl-delete (car old-acl
) mailbox
)
1635 (error "Can't delete ACL for %s" (car old-acl
)))))
1637 ;; set all changed acl's
1638 (mapc (lambda (new-acl)
1639 (let ((new-rights (cdr new-acl
))
1640 (old-rights (cdr (assoc (car new-acl
) old-acls
))))
1641 (unless (and old-rights new-rights
1642 (string= old-rights new-rights
))
1643 (or (imap-mailbox-acl-set (car new-acl
) new-rights mailbox
)
1644 (error "Can't set ACL for %s to %s" (car new-acl
)
1650 ;;; Internal functions
1653 ;; This is confusing.
1655 ;; mark => read, tick, draft, reply etc
1656 ;; flag => "\\Seen", "\\Flagged", "\\Draft", "gnus-expire" etc
1657 ;; predicate => "SEEN", "FLAGGED", "DRAFT", "KEYWORD gnus-expire" etc
1659 ;; Mark should not really contain 'read since it's not a "mark" in the Gnus
1660 ;; world, but we cheat. Mark == gnus-article-mark-lists + '(read . read).
1663 (defconst nnimap-mark-to-predicate-alist
1665 (lambda (pair) ; cdr is the mark
1666 (or (assoc (cdr pair
)
1671 (reply .
"ANSWERED")))
1673 (format "KEYWORD gnus-%s" (symbol-name (cdr pair
))))))
1674 (cons '(read . read
) gnus-article-mark-lists
)))
1676 (defun nnimap-mark-to-predicate (pred)
1677 "Convert a Gnus mark (a symbol such as read, tick, expire) to a IMAP predicate.
1678 This is a string such as \"SEEN\", \"FLAGGED\", \"KEYWORD gnus-expire\",
1679 to be used within a IMAP SEARCH query."
1680 (cdr (assq pred nnimap-mark-to-predicate-alist
)))
1682 (defconst nnimap-mark-to-flag-alist
1685 (or (assoc (cdr pair
)
1687 (tick .
"\\Flagged")
1689 (recent .
"\\Recent")
1690 (reply .
"\\Answered")))
1692 (format "gnus-%s" (symbol-name (cdr pair
))))))
1693 (cons '(read . read
) gnus-article-mark-lists
)))
1695 (defun nnimap-mark-to-flag-1 (preds)
1696 (if (and (not (null preds
)) (listp preds
))
1697 (cons (nnimap-mark-to-flag (car preds
))
1698 (nnimap-mark-to-flag (cdr preds
)))
1699 (cdr (assoc preds nnimap-mark-to-flag-alist
))))
1701 (defun nnimap-mark-to-flag (preds &optional always-list make-string
)
1702 "Convert a Gnus mark (a symbol such as read, tick, expire) to a IMAP flag.
1703 This is a string such as \"\\Seen\", \"\\Flagged\", \"gnus-expire\", to
1704 be used in a STORE FLAGS command."
1705 (let ((result (nnimap-mark-to-flag-1 preds
)))
1706 (setq result
(if (and (or make-string always-list
)
1707 (not (listp result
)))
1711 (mapconcat (lambda (flag)
1713 (mapconcat 'identity flag
" ")
1718 (defun nnimap-mark-permanent-p (mark &optional group
)
1719 "Return t if MARK can be permanently (between IMAP sessions) saved on articles, in GROUP."
1720 (imap-message-flag-permanent-p (nnimap-mark-to-flag mark
)))
1724 (buffer-disable-undo (get-buffer-create nnimap-debug-buffer
))
1725 (mapc (lambda (f) (trace-function-background f nnimap-debug-buffer
))
1727 nnimap-possibly-change-server
1728 nnimap-verify-uidvalidity
1729 nnimap-find-minmax-uid
1730 nnimap-before-find-minmax-bugworkaround
1731 nnimap-possibly-change-group
1732 ;;nnimap-replace-whitespace
1733 nnimap-retrieve-headers-progress
1734 nnimap-retrieve-which-headers
1735 nnimap-group-overview-filename
1736 nnimap-retrieve-headers-from-file
1737 nnimap-retrieve-headers-from-server
1738 nnimap-retrieve-headers
1739 nnimap-open-connection
1741 nnimap-server-opened
1743 nnimap-request-close
1744 nnimap-status-message
1746 nnimap-request-article-part
1747 nnimap-request-article
1750 nnimap-request-group
1752 nnimap-pattern-to-list-arguments
1755 nnimap-retrieve-groups
1756 nnimap-request-update-info-internal
1758 nnimap-request-set-mark
1759 nnimap-split-to-groups
1760 nnimap-split-find-rule
1761 nnimap-split-find-inbox
1762 nnimap-split-articles
1764 nnimap-request-newgroups
1765 nnimap-request-create-group
1766 nnimap-time-substract
1767 nnimap-date-days-ago
1768 nnimap-request-expire-articles-progress
1769 nnimap-request-expire-articles
1770 nnimap-request-move-article
1771 nnimap-request-accept-article
1772 nnimap-request-delete-group
1773 nnimap-request-rename-group
1774 gnus-group-nnimap-expunge
1775 gnus-group-nnimap-edit-acl
1776 gnus-group-nnimap-edit-acl-done
1777 nnimap-group-mode-hook
1778 nnimap-mark-to-predicate
1779 nnimap-mark-to-flag-1
1781 nnimap-mark-permanent-p
1786 ;; arch-tag: 2b001f20-3ff9-4094-a0ad-46807c1ba70b
1787 ;;; nnimap.el ends here
