* imap.el (imap-parse-resp-text-code, imap-parse-status): Treat
[gnus] / lisp / imap.el
1 ;;; imap.el --- imap library
2 ;; Copyright (C) 1998, 1999, 2000, 2001, 2002
3 ;;        Free Software Foundation, Inc.
4
5 ;; Author: Simon Josefsson <jas@pdc.kth.se>
6 ;; Keywords: mail
7
8 ;; This file is part of GNU Emacs.
9
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; any later version.
14
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 ;; GNU General Public License for more details.
19
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
24
25 ;;; Commentary:
26
27 ;; imap.el is a elisp library providing an interface for talking to
28 ;; IMAP servers.
29 ;;
30 ;; imap.el is roughly divided in two parts, one that parses IMAP
31 ;; responses from the server and storing data into buffer-local
32 ;; variables, and one for utility functions which send commands to
33 ;; server, waits for an answer, and return information.  The latter
34 ;; part is layered on top of the previous.
35 ;;
36 ;; The imap.el API consist of the following functions, other functions
37 ;; in this file should not be called directly and the result of doing
38 ;; so are at best undefined.
39 ;;
40 ;; Global commands:
41 ;;
42 ;; imap-open,       imap-opened,    imap-authenticate, imap-close,
43 ;; imap-capability, imap-namespace, imap-error-text
44 ;;
45 ;; Mailbox commands:
46 ;;
47 ;; imap-mailbox-get,       imap-mailbox-map,         imap-current-mailbox,
48 ;; imap-current-mailbox-p, imap-search,              imap-mailbox-select,
49 ;; imap-mailbox-examine,   imap-mailbox-unselect,    imap-mailbox-expunge
50 ;; imap-mailbox-close,     imap-mailbox-create,      imap-mailbox-delete
51 ;; imap-mailbox-rename,    imap-mailbox-lsub,        imap-mailbox-list
52 ;; imap-mailbox-subscribe, imap-mailbox-unsubscribe, imap-mailbox-status
53 ;; imap-mailbox-acl-get,   imap-mailbox-acl-set,     imap-mailbox-acl-delete
54 ;;
55 ;; Message commands:
56 ;;
57 ;; imap-fetch-asynch,                 imap-fetch,
58 ;; imap-current-message,              imap-list-to-message-set,
59 ;; imap-message-get,                  imap-message-map
60 ;; imap-message-envelope-date,        imap-message-envelope-subject,
61 ;; imap-message-envelope-from,        imap-message-envelope-sender,
62 ;; imap-message-envelope-reply-to,    imap-message-envelope-to,
63 ;; imap-message-envelope-cc,          imap-message-envelope-bcc
64 ;; imap-message-envelope-in-reply-to, imap-message-envelope-message-id
65 ;; imap-message-body,                 imap-message-flag-permanent-p
66 ;; imap-message-flags-set,            imap-message-flags-del
67 ;; imap-message-flags-add,            imap-message-copyuid
68 ;; imap-message-copy,                 imap-message-appenduid
69 ;; imap-message-append,               imap-envelope-from
70 ;; imap-body-lines
71 ;;
72 ;; It is my hope that theese commands should be pretty self
73 ;; explanatory for someone that know IMAP.  All functions have
74 ;; additional documentation on how to invoke them.
75 ;;
76 ;; imap.el support RFC1730/2060 (IMAP4/IMAP4rev1), implemented IMAP
77 ;; extensions are RFC2195 (CRAM-MD5), RFC2086 (ACL), RFC2342
78 ;; (NAMESPACE), RFC2359 (UIDPLUS), the IMAP-part of RFC2595 (STARTTLS,
79 ;; LOGINDISABLED) (with use of external library starttls.el and
80 ;; program starttls) and the GSSAPI / kerberos V4 sections of RFC1731
81 ;; (with use of external program `imtest').  It also take advantage
82 ;; the UNSELECT extension in Cyrus IMAPD.
83 ;;
84 ;; Without the work of John McClary Prevost and Jim Radford this library
85 ;; would not have seen the light of day.  Many thanks.
86 ;;
87 ;; This is a transcript of short interactive session for demonstration
88 ;; purposes.
89 ;;
90 ;; (imap-open "my.mail.server")
91 ;; => " *imap* my.mail.server:0"
92 ;;
93 ;; The rest are invoked with current buffer as the buffer returned by
94 ;; `imap-open'.  It is possible to do all without this, but it would
95 ;; look ugly here since `buffer' is always the last argument for all
96 ;; imap.el API functions.
97 ;;
98 ;; (imap-authenticate "myusername" "mypassword")
99 ;; => auth
100 ;;
101 ;; (imap-mailbox-lsub "*")
102 ;; => ("INBOX.sentmail" "INBOX.private" "INBOX.draft" "INBOX.spam")
103 ;;
104 ;; (imap-mailbox-list "INBOX.n%")
105 ;; => ("INBOX.namedroppers" "INBOX.nnimap" "INBOX.ntbugtraq")
106 ;;
107 ;; (imap-mailbox-select "INBOX.nnimap")
108 ;; => "INBOX.nnimap"
109 ;;
110 ;; (imap-mailbox-get 'exists)
111 ;; => 166
112 ;;
113 ;; (imap-mailbox-get 'uidvalidity)
114 ;; => "908992622"
115 ;;
116 ;; (imap-search "FLAGGED SINCE 18-DEC-98")
117 ;; => (235 236)
118 ;;
119 ;; (imap-fetch 235 "RFC822.PEEK" 'RFC822)
120 ;; => "X-Sieve: cmu-sieve 1.3^M\nX-Username: <jas@pdc.kth.se>^M\r...."
121 ;;
122 ;; Todo:
123 ;;
124 ;; o Parse UIDs as strings? We need to overcome the 28 bit limit somehow.
125 ;; o Don't use `read' at all (important places already fixed)
126 ;; o Accept list of articles instead of message set string in most
127 ;;   imap-message-* functions.
128 ;;
129 ;; Revision history:
130 ;;
131 ;;  - 19991218 added starttls/digest-md5 patch,
132 ;;             by Daiki Ueno <ueno@ueda.info.waseda.ac.jp>
133 ;;             NB! you need SLIM for starttls.el and digest-md5.el
134 ;;  - 19991023 commited to pgnus
135 ;;
136
137 ;;; Code:
138
139 (eval-when-compile (require 'cl))
140 (eval-and-compile
141   (autoload 'open-ssl-stream "ssl")
142   (autoload 'base64-decode-string "base64")
143   (autoload 'base64-encode-string "base64")
144   (autoload 'starttls-open-stream "starttls")
145   (autoload 'starttls-negotiate "starttls")
146   (autoload 'digest-md5-parse-digest-challenge "digest-md5")
147   (autoload 'digest-md5-digest-response "digest-md5")
148   (autoload 'digest-md5-digest-uri "digest-md5")
149   (autoload 'digest-md5-challenge "digest-md5")
150   (autoload 'rfc2104-hash "rfc2104")
151   (autoload 'md5 "md5")
152   (autoload 'utf7-encode "utf7")
153   (autoload 'utf7-decode "utf7")
154   (autoload 'format-spec "format-spec")
155   (autoload 'format-spec-make "format-spec")
156   ;; Avoid use gnus-point-at-eol so we're independent of Gnus.  These
157   ;; days we have point-at-eol anyhow.
158   (if (fboundp 'point-at-eol)
159       (defalias 'imap-point-at-eol 'point-at-eol)
160     (defun imap-point-at-eol ()
161       (save-excursion
162         (end-of-line)
163         (point)))))
164
165 ;; User variables.
166
167 (defgroup imap nil
168   "Low-level IMAP issues."
169   :version "21.1"
170   :group 'mail)
171
172 (defcustom imap-kerberos4-program '("imtest -m kerberos_v4 -u %l -p %p %s"
173                                     "imtest -kp %s %p")
174   "List of strings containing commands for Kerberos 4 authentication.
175 %s is replaced with server hostname, %p with port to connect to, and
176 %l with the value of `imap-default-user'.  The program should accept
177 IMAP commands on stdin and return responses to stdout.  Each entry in
178 the list is tried until a successful connection is made."
179   :group 'imap
180   :type '(repeat string))
181
182 (defcustom imap-gssapi-program '("imtest -m gssapi -u %l -p %p %s")
183   "List of strings containing commands for GSSAPI (krb5) authentication.
184 %s is replaced with server hostname, %p with port to connect to, and
185 %l with the value of `imap-default-user'.  The program should accept
186 IMAP commands on stdin and return responses to stdout.  Each entry in
187 the list is tried until a successful connection is made."
188   :group 'imap
189   :type '(repeat string))
190
191 (defcustom imap-ssl-program '("openssl s_client -quiet -ssl3 -connect %s:%p"
192                               "openssl s_client -quiet -ssl2 -connect %s:%p"
193                               "s_client -quiet -ssl3 -connect %s:%p"
194                               "s_client -quiet -ssl2 -connect %s:%p")
195   "A string, or list of strings, containing commands for SSL connections.
196 Within a string, %s is replaced with the server address and %p with
197 port number on server.  The program should accept IMAP commands on
198 stdin and return responses to stdout.  Each entry in the list is tried
199 until a successful connection is made."
200   :group 'imap
201   :type '(choice string
202                  (repeat string)))
203
204 (defcustom imap-shell-program '("ssh %s imapd"
205                                 "rsh %s imapd"
206                                 "ssh %g ssh %s imapd"
207                                 "rsh %g rsh %s imapd")
208   "A list of strings, containing commands for IMAP connection.
209 Within a string, %s is replaced with the server address, %p with port
210 number on server, %g with `imap-shell-host', and %l with
211 `imap-default-user'.  The program should read IMAP commands from stdin
212 and write IMAP response to stdout. Each entry in the list is tried
213 until a successful connection is made."
214   :group 'imap
215   :type '(repeat string))
216
217 (defcustom imap-process-connection-type nil
218   "*Value for `process-connection-type' to use for Kerberos4 and GSSAPI."
219   :group 'imap
220   :type 'boolean)
221
222 (defcustom imap-use-utf7 t
223   "If non-nil, do utf7 encoding/decoding of mailbox names.
224 Since the UTF7 decoding currently only decodes into ISO-8859-1
225 characters, you may disable this decoding if you need to access UTF7
226 encoded mailboxes which doesn't translate into ISO-8859-1."
227   :group 'imap
228   :type 'boolean)
229
230 (defcustom imap-log nil
231   "If non-nil, a imap session trace is placed in *imap-log* buffer."
232   :group 'imap
233   :type 'boolean)
234
235 (defcustom imap-debug nil
236   "If non-nil, random debug spews are placed in *imap-debug* buffer."
237   :group 'imap
238   :type 'boolean)
239
240 (defcustom imap-shell-host "gateway"
241   "Hostname of rlogin proxy."
242   :group 'imap
243   :type 'string)
244
245 (defcustom imap-default-user (user-login-name)
246   "Default username to use."
247   :group 'imap
248   :type 'string)
249
250 ;; Various variables.
251
252 (defvar imap-fetch-data-hook nil
253   "Hooks called after receiving each FETCH response.")
254
255 (defvar imap-streams '(gssapi kerberos4 starttls ssl network shell)
256   "Priority of streams to consider when opening connection to server.")
257
258 (defvar imap-stream-alist
259   '((gssapi    imap-gssapi-stream-p    imap-gssapi-open)
260     (kerberos4 imap-kerberos4-stream-p imap-kerberos4-open)
261     (ssl       imap-ssl-p              imap-ssl-open)
262     (network   imap-network-p          imap-network-open)
263     (shell     imap-shell-p            imap-shell-open)
264     (starttls  imap-starttls-p         imap-starttls-open))
265   "Definition of network streams.
266
267 \(NAME CHECK OPEN)
268
269 NAME names the stream, CHECK is a function returning non-nil if the
270 server support the stream and OPEN is a function for opening the
271 stream.")
272
273 (defvar imap-authenticators '(gssapi
274                               kerberos4
275                               digest-md5
276                               cram-md5
277                               login
278                               anonymous)
279   "Priority of authenticators to consider when authenticating to server.")
280
281 (defvar imap-authenticator-alist
282   '((gssapi     imap-gssapi-auth-p    imap-gssapi-auth)
283     (kerberos4  imap-kerberos4-auth-p imap-kerberos4-auth)
284     (cram-md5   imap-cram-md5-p       imap-cram-md5-auth)
285     (login      imap-login-p          imap-login-auth)
286     (anonymous  imap-anonymous-p      imap-anonymous-auth)
287     (digest-md5 imap-digest-md5-p     imap-digest-md5-auth))
288   "Definition of authenticators.
289
290 \(NAME CHECK AUTHENTICATE)
291
292 NAME names the authenticator.  CHECK is a function returning non-nil if
293 the server support the authenticator and AUTHENTICATE is a function
294 for doing the actual authentication.")
295
296 (defvar imap-error nil
297   "Error codes from the last command.")
298
299 ;; Internal constants.  Change theese and die.
300
301 (defconst imap-default-port 143)
302 (defconst imap-default-ssl-port 993)
303 (defconst imap-default-stream 'network)
304 (defconst imap-coding-system-for-read 'binary)
305 (defconst imap-coding-system-for-write 'binary)
306 (defconst imap-local-variables '(imap-server
307                                  imap-port
308                                  imap-client-eol
309                                  imap-server-eol
310                                  imap-auth
311                                  imap-stream
312                                  imap-username
313                                  imap-password
314                                  imap-current-mailbox
315                                  imap-current-target-mailbox
316                                  imap-message-data
317                                  imap-capability
318                                  imap-namespace
319                                  imap-state
320                                  imap-reached-tag
321                                  imap-failed-tags
322                                  imap-tag
323                                  imap-process
324                                  imap-calculate-literal-size-first
325                                  imap-mailbox-data))
326 (defconst imap-log-buffer "*imap-log*")
327 (defconst imap-debug-buffer "*imap-debug*")
328
329 ;; Internal variables.
330
331 (defvar imap-stream nil)
332 (defvar imap-auth nil)
333 (defvar imap-server nil)
334 (defvar imap-port nil)
335 (defvar imap-username nil)
336 (defvar imap-password nil)
337 (defvar imap-calculate-literal-size-first nil)
338 (defvar imap-state 'closed
339   "IMAP state.
340 Valid states are `closed', `initial', `nonauth', `auth', `selected'
341 and `examine'.")
342
343 (defvar imap-server-eol "\r\n"
344   "The EOL string sent from the server.")
345
346 (defvar imap-client-eol "\r\n"
347   "The EOL string we send to the server.")
348
349 (defvar imap-current-mailbox nil
350   "Current mailbox name.")
351
352 (defvar imap-current-target-mailbox nil
353   "Current target mailbox for COPY and APPEND commands.")
354
355 (defvar imap-mailbox-data nil
356   "Obarray with mailbox data.")
357
358 (defvar imap-mailbox-prime 997
359   "Length of imap-mailbox-data.")
360
361 (defvar imap-current-message nil
362   "Current message number.")
363
364 (defvar imap-message-data nil
365   "Obarray with message data.")
366
367 (defvar imap-message-prime 997
368   "Length of imap-message-data.")
369
370 (defvar imap-capability nil
371   "Capability for server.")
372
373 (defvar imap-namespace nil
374   "Namespace for current server.")
375
376 (defvar imap-reached-tag 0
377   "Lower limit on command tags that have been parsed.")
378
379 (defvar imap-failed-tags nil
380   "Alist of tags that failed.
381 Each element is a list with four elements; tag (a integer), response
382 state (a symbol, `OK', `NO' or `BAD'), response code (a string), and
383 human readable response text (a string).")
384
385 (defvar imap-tag 0
386   "Command tag number.")
387
388 (defvar imap-process nil
389   "Process.")
390
391 (defvar imap-continuation nil
392   "Non-nil indicates that the server emitted a continuation request.
393 The actually value is really the text on the continuation line.")
394
395 (defvar imap-callbacks nil
396   "List of response tags and callbacks, on the form `(number . function)'.
397 The function should take two arguments, the first the IMAP tag and the
398 second the status (OK, NO, BAD etc) of the command.")
399
400 \f
401 ;; Utility functions:
402
403 (defun imap-remassoc (key alist)
404   "Delete by side effect any elements of LIST whose car is `equal' to KEY.
405 The modified LIST is returned.  If the first member
406 of LIST has a car that is `equal' to KEY, there is no way to remove it
407 by side effect; therefore, write `(setq foo (remassoc key foo))' to be
408 sure of changing the value of `foo'."
409   (when alist
410     (if (equal key (caar alist))
411         (cdr alist)
412       (setcdr alist (imap-remassoc key (cdr alist)))
413       alist)))
414
415 (defsubst imap-disable-multibyte ()
416   "Enable multibyte in the current buffer."
417   (when (fboundp 'set-buffer-multibyte)
418     (set-buffer-multibyte nil)))
419
420 (defun imap-read-passwd (prompt &rest args)
421   "Read a password using PROMPT.
422 If ARGS, PROMPT is used as an argument to `format'."
423   (let ((prompt (if args
424                     (apply 'format prompt args)
425                   prompt)))
426     (funcall (if (or (fboundp 'read-passwd)
427                      (and (load "subr" t)
428                           (fboundp 'read-passwd))
429                      (and (load "passwd" t)
430                           (fboundp 'read-passwd)))
431                  'read-passwd
432                (autoload 'ange-ftp-read-passwd "ange-ftp")
433                'ange-ftp-read-passwd)
434              prompt)))
435
436 (defsubst imap-utf7-encode (string)
437   (if imap-use-utf7
438       (and string
439            (condition-case ()
440                (utf7-encode string t)
441              (error (message
442                      "imap: Could not UTF7 encode `%s', using it unencoded..."
443                      string)
444                     string)))
445     string))
446
447 (defsubst imap-utf7-decode (string)
448   (if imap-use-utf7
449       (and string
450            (condition-case ()
451                (utf7-decode string t)
452              (error (message
453                      "imap: Could not UTF7 decode `%s', using it undecoded..."
454                      string)
455                     string)))
456     string))
457
458 (defsubst imap-ok-p (status)
459   (if (eq status 'OK)
460       t
461     (setq imap-error status)
462     nil))
463
464 (defun imap-error-text (&optional buffer)
465   (with-current-buffer (or buffer (current-buffer))
466     (nth 3 (car imap-failed-tags))))
467
468 \f
469 ;; Server functions; stream stuff:
470
471 (defun imap-kerberos4-stream-p (buffer)
472   (imap-capability 'AUTH=KERBEROS_V4 buffer))
473
474 (defun imap-kerberos4-open (name buffer server port)
475   (let ((cmds imap-kerberos4-program)
476         cmd done)
477     (while (and (not done) (setq cmd (pop cmds)))
478       (message "Opening Kerberos 4 IMAP connection with `%s'..." cmd)
479       (erase-buffer)
480       (let* ((port (or port imap-default-port))
481              (coding-system-for-read imap-coding-system-for-read)
482              (coding-system-for-write imap-coding-system-for-write)
483              (process-connection-type imap-process-connection-type)
484              (process (start-process
485                        name buffer shell-file-name shell-command-switch
486                        (format-spec
487                         cmd
488                         (format-spec-make
489                          ?s server
490                          ?p (number-to-string port)
491                          ?l imap-default-user))))
492              response)
493         (when process
494           (with-current-buffer buffer
495             (setq imap-client-eol "\n"
496                   imap-calculate-literal-size-first t)
497             (while (and (memq (process-status process) '(open run))
498                         (set-buffer buffer) ;; XXX "blue moon" nntp.el bug
499                         (goto-char (point-min))
500                         ;; cyrus 1.6.x (13? < x <= 22) queries capabilities
501                         (or (while (looking-at "^C:")
502                               (forward-line))
503                             t)
504                         ;; cyrus 1.6 imtest print "S: " before server greeting
505                         (or (not (looking-at "S: "))
506                             (forward-char 3)
507                             t)
508                         (not (and (imap-parse-greeting)
509                                   ;; success in imtest < 1.6:
510                                   (or (re-search-forward
511                                        "^__\\(.*\\)__\n" nil t)
512                                       ;; success in imtest 1.6:
513                                       (re-search-forward
514                                        "^\\(Authenticat.*\\)" nil t))
515                                   (setq response (match-string 1)))))
516               (accept-process-output process 1)
517               (sit-for 1))
518             (and imap-log
519                  (with-current-buffer (get-buffer-create imap-log-buffer)
520                    (imap-disable-multibyte)
521                    (buffer-disable-undo)
522                    (goto-char (point-max))
523                    (insert-buffer-substring buffer)))
524             (erase-buffer)
525             (message "Opening Kerberos 4 IMAP connection with `%s'...%s" cmd
526                      (if response (concat "done, " response) "failed"))
527             (if (and response (let ((case-fold-search nil))
528                                 (not (string-match "failed" response))))
529                 (setq done process)
530               (if (memq (process-status process) '(open run))
531                   (imap-send-command "LOGOUT"))
532               (delete-process process)
533               nil)))))
534     done))
535
536 (defun imap-gssapi-stream-p (buffer)
537   (imap-capability 'AUTH=GSSAPI buffer))
538
539 (defun imap-gssapi-open (name buffer server port)
540   (let ((cmds imap-gssapi-program)
541         cmd done)
542     (while (and (not done) (setq cmd (pop cmds)))
543       (message "Opening GSSAPI IMAP connection with `%s'..." cmd)
544       (let* ((port (or port imap-default-port))
545              (coding-system-for-read imap-coding-system-for-read)
546              (coding-system-for-write imap-coding-system-for-write)
547              (process-connection-type imap-process-connection-type)
548              (process (start-process
549                        name buffer shell-file-name shell-command-switch
550                        (format-spec
551                         cmd
552                         (format-spec-make
553                          ?s server
554                          ?p (number-to-string port)
555                          ?l imap-default-user))))
556              response)
557         (when process
558           (with-current-buffer buffer
559             (setq imap-client-eol "\n"
560                   imap-calculate-literal-size-first t)
561             (while (and (memq (process-status process) '(open run))
562                         (set-buffer buffer) ;; XXX "blue moon" nntp.el bug
563                         (goto-char (point-min))
564                         ;; cyrus 1.6.x (13? < x <= 22) queries capabilities
565                         (or (while (looking-at "^C:")
566                               (forward-line))
567                             t)
568                         ;; cyrus 1.6 imtest print "S: " before server greeting
569                         (or (not (looking-at "S: "))
570                             (forward-char 3)
571                             t)
572                         (not (and (imap-parse-greeting)
573                                   ;; success in imtest 1.6:
574                                   (re-search-forward
575                                    "^\\(Authenticat.*\\)" nil t)
576                                   (setq response (match-string 1)))))
577               (accept-process-output process 1)
578               (sit-for 1))
579             (and imap-log
580                  (with-current-buffer (get-buffer-create imap-log-buffer)
581                    (imap-disable-multibyte)
582                    (buffer-disable-undo)
583                    (goto-char (point-max))
584                    (insert-buffer-substring buffer)))
585             (erase-buffer)
586             (message "GSSAPI IMAP connection: %s" (or response "failed"))
587             (if (and response (let ((case-fold-search nil))
588                                 (not (string-match "failed" response))))
589                 (setq done process)
590               (if (memq (process-status process) '(open run))
591                   (imap-send-command "LOGOUT"))
592               (delete-process process)
593               nil)))))
594     done))
595
596 (defun imap-ssl-p (buffer)
597   nil)
598
599 (defun imap-ssl-open (name buffer server port)
600   "Open a SSL connection to server."
601   (let ((cmds (if (listp imap-ssl-program) imap-ssl-program
602                 (list imap-ssl-program)))
603         cmd done)
604     (condition-case ()
605         (require 'ssl)
606       (error))
607     (while (and (not done) (setq cmd (pop cmds)))
608       (message "imap: Opening SSL connection with `%s'..." cmd)
609       (let* ((port (or port imap-default-ssl-port))
610              (coding-system-for-read imap-coding-system-for-read)
611              (coding-system-for-write imap-coding-system-for-write)
612              (ssl-program-name shell-file-name)
613              (ssl-program-arguments
614               (list shell-command-switch
615                     (format-spec cmd (format-spec-make
616                                       ?s server
617                                       ?p (number-to-string port)))))
618              process)
619         (when (setq process (condition-case ()
620                                 (open-ssl-stream name buffer server port)
621                               (error)))
622           (with-current-buffer buffer
623             (goto-char (point-min))
624             (while (and (memq (process-status process) '(open run))
625                         (set-buffer buffer) ;; XXX "blue moon" nntp.el bug
626                         (goto-char (point-max))
627                         (forward-line -1)
628                         (not (imap-parse-greeting)))
629               (accept-process-output process 1)
630               (sit-for 1))
631             (and imap-log
632                  (with-current-buffer (get-buffer-create imap-log-buffer)
633                    (imap-disable-multibyte)
634                    (buffer-disable-undo)
635                    (goto-char (point-max))
636                    (insert-buffer-substring buffer)))
637             (erase-buffer)
638             (when (memq (process-status process) '(open run))
639               (setq done process))))))
640     (if done
641         (progn
642           (message "imap: Opening SSL connection with `%s'...done" cmd)
643           done)
644       (message "imap: Opening SSL connection with `%s'...failed" cmd)
645       nil)))
646
647 (defun imap-network-p (buffer)
648   t)
649
650 (defun imap-network-open (name buffer server port)
651   (let* ((port (or port imap-default-port))
652          (coding-system-for-read imap-coding-system-for-read)
653          (coding-system-for-write imap-coding-system-for-write)
654          (process (open-network-stream name buffer server port)))
655     (when process
656       (while (and (memq (process-status process) '(open run))
657                   (set-buffer buffer) ;; XXX "blue moon" nntp.el bug
658                   (goto-char (point-min))
659                   (not (imap-parse-greeting)))
660         (accept-process-output process 1)
661         (sit-for 1))
662       (and imap-log
663            (with-current-buffer (get-buffer-create imap-log-buffer)
664              (imap-disable-multibyte)
665              (buffer-disable-undo)
666              (goto-char (point-max))
667              (insert-buffer-substring buffer)))
668       (when (memq (process-status process) '(open run))
669         process))))
670
671 (defun imap-shell-p (buffer)
672   nil)
673
674 (defun imap-shell-open (name buffer server port)
675   (let ((cmds imap-shell-program)
676         cmd done)
677     (while (and (not done) (setq cmd (pop cmds)))
678       (message "imap: Opening IMAP connection with `%s'..." cmd)
679       (setq imap-client-eol "\n")
680       (let* ((port (or port imap-default-port))
681              (coding-system-for-read imap-coding-system-for-read)
682              (coding-system-for-write imap-coding-system-for-write)
683              (process (start-process
684                        name buffer shell-file-name shell-command-switch
685                        (format-spec
686                         cmd
687                         (format-spec-make
688                          ?s server
689                          ?g imap-shell-host
690                          ?p (number-to-string port)
691                          ?l imap-default-user)))))
692         (when process
693           (while (and (memq (process-status process) '(open run))
694                       (set-buffer buffer) ;; XXX "blue moon" nntp.el bug
695                       (goto-char (point-min))
696                       (not (imap-parse-greeting)))
697             (accept-process-output process 1)
698             (sit-for 1))
699           (and imap-log
700                (with-current-buffer (get-buffer-create imap-log-buffer)
701                  (imap-disable-multibyte)
702                  (buffer-disable-undo)
703                  (goto-char (point-max))
704                  (insert-buffer-substring buffer)))
705           (erase-buffer)
706           (when (memq (process-status process) '(open run))
707             (setq done process)))))
708     (if done
709         (progn
710           (message "imap: Opening IMAP connection with `%s'...done" cmd)
711           done)
712       (message "imap: Opening IMAP connection with `%s'...failed" cmd)
713       nil)))
714
715 (defun imap-starttls-p (buffer)
716   (imap-capability 'STARTTLS buffer))
717
718 (defun imap-starttls-open (name buffer server port)
719   (let* ((port (or port imap-default-port))
720          (coding-system-for-read imap-coding-system-for-read)
721          (coding-system-for-write imap-coding-system-for-write)
722          (process (starttls-open-stream name buffer server port))
723          done)
724     (message "imap: Connecting with STARTTLS...")
725     (when process
726       (while (and (memq (process-status process) '(open run))
727                   (set-buffer buffer) ;; XXX "blue moon" nntp.el bug
728                   (goto-char (point-min))
729                   (not (imap-parse-greeting)))
730         (accept-process-output process 1)
731         (sit-for 1))
732       (and imap-log
733            (with-current-buffer (get-buffer-create imap-log-buffer)
734              (buffer-disable-undo)
735              (goto-char (point-max))
736              (insert-buffer-substring buffer)))
737       (let ((imap-process process))
738         (unwind-protect
739             (progn
740               (set-process-filter imap-process 'imap-arrival-filter)
741               (when (and (eq imap-stream 'starttls)
742                          (imap-ok-p (imap-send-command-wait "STARTTLS")))
743                 (starttls-negotiate imap-process)))
744           (set-process-filter imap-process nil)))
745       (when (memq (process-status process) '(open run))
746         (setq done process)))
747     (if done
748         (progn
749           (message "imap: Connecting with STARTTLS...done")
750           done)
751       (message "imap: Connecting with STARTTLS...failed")
752       nil)))
753
754 ;; Server functions; authenticator stuff:
755
756 (defun imap-interactive-login (buffer loginfunc)
757   "Login to server in BUFFER.
758 LOGINFUNC is passed a username and a password, it should return t if
759 it where sucessful authenticating itself to the server, nil otherwise.
760 Returns t if login was successful, nil otherwise."
761   (with-current-buffer buffer
762     (make-local-variable 'imap-username)
763     (make-local-variable 'imap-password)
764     (let (user passwd ret)
765       ;;      (condition-case ()
766       (while (or (not user) (not passwd))
767         (setq user (or imap-username
768                        (read-from-minibuffer
769                         (concat "IMAP username for " imap-server
770                                 " (using stream `" (symbol-name imap-stream)
771                                 "'): ")
772                         (or user imap-default-user))))
773         (setq passwd (or imap-password
774                          (imap-read-passwd
775                           (concat "IMAP password for " user "@"
776                                   imap-server " (using authenticator `"
777                                   (symbol-name imap-auth) "'): "))))
778         (when (and user passwd)
779           (if (funcall loginfunc user passwd)
780               (progn
781                 (setq ret t
782                       imap-username user)
783                 (if (and (not imap-password)
784                          (y-or-n-p "Store password for this session? "))
785                     (setq imap-password passwd)))
786             (message "Login failed...")
787             (setq passwd nil)
788             (sit-for 1))))
789       ;;        (quit (with-current-buffer buffer
790       ;;                (setq user nil
791       ;;                      passwd nil)))
792       ;;        (error (with-current-buffer buffer
793       ;;                 (setq user nil
794       ;;                       passwd nil))))
795       ret)))
796
797 (defun imap-gssapi-auth-p (buffer)
798   (and (imap-capability 'AUTH=GSSAPI buffer)
799        (eq imap-stream 'gssapi)))
800
801 (defun imap-gssapi-auth (buffer)
802   (message "imap: Authenticating using GSSAPI...%s"
803            (if (eq imap-stream 'gssapi) "done" "failed"))
804   (eq imap-stream 'gssapi))
805
806 (defun imap-kerberos4-auth-p (buffer)
807   (and (imap-capability 'AUTH=KERBEROS_V4 buffer)
808        (eq imap-stream 'kerberos4)))
809
810 (defun imap-kerberos4-auth (buffer)
811   (message "imap: Authenticating using Kerberos 4...%s"
812            (if (eq imap-stream 'kerberos4) "done" "failed"))
813   (eq imap-stream 'kerberos4))
814
815 (defun imap-cram-md5-p (buffer)
816   (imap-capability 'AUTH=CRAM-MD5 buffer))
817
818 (defun imap-cram-md5-auth (buffer)
819   "Login to server using the AUTH CRAM-MD5 method."
820   (message "imap: Authenticating using CRAM-MD5...")
821   (let ((done (imap-interactive-login
822                buffer
823                (lambda (user passwd)
824                  (imap-ok-p
825                   (imap-send-command-wait
826                    (list
827                     "AUTHENTICATE CRAM-MD5"
828                     (lambda (challenge)
829                       (let* ((decoded (base64-decode-string challenge))
830                              (hash (rfc2104-hash 'md5 64 16 passwd decoded))
831                              (response (concat user " " hash))
832                              (encoded (base64-encode-string response)))
833                         encoded)))))))))
834     (if done
835         (message "imap: Authenticating using CRAM-MD5...done")
836       (message "imap: Authenticating using CRAM-MD5...failed"))))
837
838 (defun imap-login-p (buffer)
839   (and (not (imap-capability 'LOGINDISABLED buffer))
840        (not (imap-capability 'X-LOGIN-CMD-DISABLED buffer))))
841
842 (defun imap-login-auth (buffer)
843   "Login to server using the LOGIN command."
844   (message "imap: Plaintext authentication...")
845   (imap-interactive-login buffer
846                           (lambda (user passwd)
847                             (imap-ok-p (imap-send-command-wait
848                                         (concat "LOGIN \"" user "\" \""
849                                                 passwd "\""))))))
850
851 (defun imap-anonymous-p (buffer)
852   t)
853
854 (defun imap-anonymous-auth (buffer)
855   (message "imap: Logging in anonymously...")
856   (with-current-buffer buffer
857     (imap-ok-p (imap-send-command-wait
858                 (concat "LOGIN anonymous \"" (concat (user-login-name) "@"
859                                                      (system-name)) "\"")))))
860
861 (defun imap-digest-md5-p (buffer)
862   (and (imap-capability 'AUTH=DIGEST-MD5 buffer)
863        (condition-case ()
864            (require 'digest-md5)
865          (error nil))))
866
867 (defun imap-digest-md5-auth (buffer)
868   "Login to server using the AUTH DIGEST-MD5 method."
869   (message "imap: Authenticating using DIGEST-MD5...")
870   (imap-interactive-login
871    buffer
872    (lambda (user passwd)
873      (let ((tag
874             (imap-send-command
875              (list
876               "AUTHENTICATE DIGEST-MD5"
877               (lambda (challenge)
878                 (digest-md5-parse-digest-challenge
879                  (base64-decode-string challenge))
880                 (let* ((digest-uri
881                         (digest-md5-digest-uri
882                          "imap" (digest-md5-challenge 'realm)))
883                        (response
884                         (digest-md5-digest-response
885                          user passwd digest-uri)))
886                   (base64-encode-string response 'no-line-break))))
887              )))
888        (if (not (eq (imap-wait-for-tag tag) 'INCOMPLETE))
889            nil
890          (setq imap-continuation nil)
891          (imap-send-command-1 "")
892          (imap-ok-p (imap-wait-for-tag tag)))))))
893
894 ;; Server functions:
895
896 (defun imap-open-1 (buffer)
897   (with-current-buffer buffer
898     (erase-buffer)
899     (setq imap-current-mailbox nil
900           imap-current-message nil
901           imap-state 'initial
902           imap-process (condition-case ()
903                            (funcall (nth 2 (assq imap-stream
904                                                  imap-stream-alist))
905                                     "imap" buffer imap-server imap-port)
906                          ((error quit) nil)))
907     (when imap-process
908       (set-process-filter imap-process 'imap-arrival-filter)
909       (set-process-sentinel imap-process 'imap-sentinel)
910       (while (and (eq imap-state 'initial)
911                   (memq (process-status imap-process) '(open run)))
912         (message "Waiting for response from %s..." imap-server)
913         (accept-process-output imap-process 1))
914       (message "Waiting for response from %s...done" imap-server)
915       (and (memq (process-status imap-process) '(open run))
916            imap-process))))
917
918 (defun imap-open (server &optional port stream auth buffer)
919   "Open a IMAP connection to host SERVER at PORT returning a buffer.
920 If PORT is unspecified, a default value is used (143 except
921 for SSL which use 993).
922 STREAM indicates the stream to use, see `imap-streams' for available
923 streams.  If nil, it choices the best stream the server is capable of.
924 AUTH indicates authenticator to use, see `imap-authenticators' for
925 available authenticators.  If nil, it choices the best stream the
926 server is capable of.
927 BUFFER can be a buffer or a name of a buffer, which is created if
928 necessery.  If nil, the buffer name is generated."
929   (setq buffer (or buffer (format " *imap* %s:%d" server (or port 0))))
930   (with-current-buffer (get-buffer-create buffer)
931     (if (imap-opened buffer)
932         (imap-close buffer))
933     (mapcar 'make-local-variable imap-local-variables)
934     (imap-disable-multibyte)
935     (buffer-disable-undo)
936     (setq imap-server (or server imap-server))
937     (setq imap-port (or port imap-port))
938     (setq imap-auth (or auth imap-auth))
939     (setq imap-stream (or stream imap-stream))
940     (message "imap: Connecting to %s..." imap-server)
941     (if (null (let ((imap-stream (or imap-stream imap-default-stream)))
942                 (imap-open-1 buffer)))
943         (progn
944           (message "imap: Connecting to %s...failed" imap-server)
945           nil)
946       (when (null imap-stream)
947         ;; Need to choose stream.
948         (let ((streams imap-streams))
949           (while (setq stream (pop streams))
950             ;; OK to use this stream?
951             (when (funcall (nth 1 (assq stream imap-stream-alist)) buffer)
952               ;; Stream changed?
953               (if (not (eq imap-default-stream stream))
954                   (with-current-buffer (get-buffer-create
955                                         (generate-new-buffer-name " *temp*"))
956                     (mapcar 'make-local-variable imap-local-variables)
957                     (imap-disable-multibyte)
958                     (buffer-disable-undo)
959                     (setq imap-server (or server imap-server))
960                     (setq imap-port (or port imap-port))
961                     (setq imap-auth (or auth imap-auth))
962                     (message "imap: Reconnecting with stream `%s'..." stream)
963                     (if (null (let ((imap-stream stream))
964                                 (imap-open-1 (current-buffer))))
965                         (progn
966                           (kill-buffer (current-buffer))
967                           (message
968                            "imap: Reconnecting with stream `%s'...failed"
969                            stream))
970                       ;; We're done, kill the first connection
971                       (imap-close buffer)
972                       (kill-buffer buffer)
973                       (rename-buffer buffer)
974                       (message "imap: Reconnecting with stream `%s'...done"
975                                stream)
976                       (setq imap-stream stream)
977                       (setq imap-capability nil)
978                       (setq streams nil)))
979                 ;; We're done
980                 (message "imap: Connecting to %s...done" imap-server)
981                 (setq imap-stream stream)
982                 (setq imap-capability nil)
983                 (setq streams nil))))))
984       (when (imap-opened buffer)
985         (setq imap-mailbox-data (make-vector imap-mailbox-prime 0)))
986       (when imap-stream
987         buffer))))
988
989 (defun imap-opened (&optional buffer)
990   "Return non-nil if connection to imap server in BUFFER is open.
991 If BUFFER is nil then the current buffer is used."
992   (and (setq buffer (get-buffer (or buffer (current-buffer))))
993        (buffer-live-p buffer)
994        (with-current-buffer buffer
995          (and imap-process
996               (memq (process-status imap-process) '(open run))))))
997
998 (defun imap-authenticate (&optional user passwd buffer)
999   "Authenticate to server in BUFFER, using current buffer if nil.
1000 It uses the authenticator specified when opening the server.  If the
1001 authenticator requires username/passwords, they are queried from the
1002 user and optionally stored in the buffer.  If USER and/or PASSWD is
1003 specified, the user will not be questioned and the username and/or
1004 password is remembered in the buffer."
1005   (with-current-buffer (or buffer (current-buffer))
1006     (if (not (eq imap-state 'nonauth))
1007         (or (eq imap-state 'auth)
1008             (eq imap-state 'select)
1009             (eq imap-state 'examine))
1010       (make-local-variable 'imap-username)
1011       (make-local-variable 'imap-password)
1012       (if user (setq imap-username user))
1013       (if passwd (setq imap-password passwd))
1014       (if imap-auth
1015           (and (funcall (nth 2 (assq imap-auth
1016                                      imap-authenticator-alist)) buffer)
1017                (setq imap-state 'auth))
1018         ;; Choose authenticator.
1019         (let ((auths imap-authenticators)
1020               auth)
1021           (while (setq auth (pop auths))
1022             ;; OK to use authenticator?
1023             (when (funcall (nth 1 (assq auth imap-authenticator-alist)) buffer)
1024               (message "imap: Authenticating to `%s' using `%s'..."
1025                        imap-server auth)
1026               (setq imap-auth auth)
1027               (if (funcall (nth 2 (assq auth imap-authenticator-alist)) buffer)
1028                   (progn
1029                     (message "imap: Authenticating to `%s' using `%s'...done"
1030                              imap-server auth)
1031                     (setq auths nil))
1032                 (message "imap: Authenticating to `%s' using `%s'...failed"
1033                          imap-server auth)))))
1034         imap-state))))
1035
1036 (defun imap-close (&optional buffer)
1037   "Close connection to server in BUFFER.
1038 If BUFFER is nil, the current buffer is used."
1039   (with-current-buffer (or buffer (current-buffer))
1040     (when (imap-opened)
1041       (condition-case nil
1042           (imap-send-command-wait "LOGOUT")
1043         (quit nil)))
1044     (when (and imap-process
1045                (memq (process-status imap-process) '(open run)))
1046       (delete-process imap-process))
1047     (setq imap-current-mailbox nil
1048           imap-current-message nil
1049           imap-process nil)
1050     (erase-buffer)
1051     t))
1052
1053 (defun imap-capability (&optional identifier buffer)
1054   "Return a list of identifiers which server in BUFFER support.
1055 If IDENTIFIER, return non-nil if it's among the servers capabilities.
1056 If BUFFER is nil, the current buffer is assumed."
1057   (with-current-buffer (or buffer (current-buffer))
1058     (unless imap-capability
1059       (unless (imap-ok-p (imap-send-command-wait "CAPABILITY"))
1060         (setq imap-capability '(IMAP2))))
1061     (if identifier
1062         (memq (intern (upcase (symbol-name identifier))) imap-capability)
1063       imap-capability)))
1064
1065 (defun imap-namespace (&optional buffer)
1066   "Return a namespace hierarchy at server in BUFFER.
1067 If BUFFER is nil, the current buffer is assumed."
1068   (with-current-buffer (or buffer (current-buffer))
1069     (unless imap-namespace
1070       (when (imap-capability 'NAMESPACE)
1071         (imap-send-command-wait "NAMESPACE")))
1072     imap-namespace))
1073
1074 (defun imap-send-command-wait (command &optional buffer)
1075   (imap-wait-for-tag (imap-send-command command buffer) buffer))
1076
1077 \f
1078 ;; Mailbox functions:
1079
1080 (defun imap-mailbox-put (propname value &optional mailbox buffer)
1081   (with-current-buffer (or buffer (current-buffer))
1082     (if imap-mailbox-data
1083         (put (intern (or mailbox imap-current-mailbox) imap-mailbox-data)
1084              propname value)
1085       (error "Imap-mailbox-data is nil, prop %s value %s mailbox %s buffer %s"
1086              propname value mailbox (current-buffer)))
1087     t))
1088
1089 (defsubst imap-mailbox-get-1 (propname &optional mailbox)
1090   (get (intern-soft (or mailbox imap-current-mailbox) imap-mailbox-data)
1091        propname))
1092
1093 (defun imap-mailbox-get (propname &optional mailbox buffer)
1094   (let ((mailbox (imap-utf7-encode mailbox)))
1095     (with-current-buffer (or buffer (current-buffer))
1096       (imap-mailbox-get-1 propname (or mailbox imap-current-mailbox)))))
1097
1098 (defun imap-mailbox-map-1 (func &optional mailbox-decoder buffer)
1099   (with-current-buffer (or buffer (current-buffer))
1100     (let (result)
1101       (mapatoms
1102        (lambda (s)
1103          (push (funcall func (if mailbox-decoder
1104                                  (funcall mailbox-decoder (symbol-name s))
1105                                (symbol-name s))) result))
1106        imap-mailbox-data)
1107       result)))
1108
1109 (defun imap-mailbox-map (func &optional buffer)
1110   "Map a function across each mailbox in `imap-mailbox-data', returning a list.
1111 Function should take a mailbox name (a string) as
1112 the only argument."
1113   (imap-mailbox-map-1 func 'imap-utf7-decode buffer))
1114
1115 (defun imap-current-mailbox (&optional buffer)
1116   (with-current-buffer (or buffer (current-buffer))
1117     (imap-utf7-decode imap-current-mailbox)))
1118
1119 (defun imap-current-mailbox-p-1 (mailbox &optional examine)
1120   (and (string= mailbox imap-current-mailbox)
1121        (or (and examine
1122                 (eq imap-state 'examine))
1123            (and (not examine)
1124                 (eq imap-state 'selected)))))
1125
1126 (defun imap-current-mailbox-p (mailbox &optional examine buffer)
1127   (with-current-buffer (or buffer (current-buffer))
1128     (imap-current-mailbox-p-1 (imap-utf7-encode mailbox) examine)))
1129
1130 (defun imap-mailbox-select-1 (mailbox &optional examine)
1131   "Select MAILBOX on server in BUFFER.
1132 If EXAMINE is non-nil, do a read-only select."
1133   (if (imap-current-mailbox-p-1 mailbox examine)
1134       imap-current-mailbox
1135     (setq imap-current-mailbox mailbox)
1136     (if (imap-ok-p (imap-send-command-wait
1137                     (concat (if examine "EXAMINE" "SELECT") " \""
1138                             mailbox "\"")))
1139         (progn
1140           (setq imap-message-data (make-vector imap-message-prime 0)
1141                 imap-state (if examine 'examine 'selected))
1142           imap-current-mailbox)
1143       ;; Failed SELECT/EXAMINE unselects current mailbox
1144       (setq imap-current-mailbox nil))))
1145
1146 (defun imap-mailbox-select (mailbox &optional examine buffer)
1147   (with-current-buffer (or buffer (current-buffer))
1148     (imap-utf7-decode
1149      (imap-mailbox-select-1 (imap-utf7-encode mailbox) examine))))
1150
1151 (defun imap-mailbox-examine-1 (mailbox &optional buffer)
1152   (with-current-buffer (or buffer (current-buffer))
1153     (imap-mailbox-select-1 mailbox 'examine)))
1154
1155 (defun imap-mailbox-examine (mailbox &optional buffer)
1156   "Examine MAILBOX on server in BUFFER."
1157   (imap-mailbox-select mailbox 'examine buffer))
1158
1159 (defun imap-mailbox-unselect (&optional buffer)
1160   "Close current folder in BUFFER, without expunging articles."
1161   (with-current-buffer (or buffer (current-buffer))
1162     (when (or (eq imap-state 'auth)
1163               (and (imap-capability 'UNSELECT)
1164                    (imap-ok-p (imap-send-command-wait "UNSELECT")))
1165               (and (imap-ok-p
1166                     (imap-send-command-wait (concat "EXAMINE \""
1167                                                     imap-current-mailbox
1168                                                     "\"")))
1169                    (imap-ok-p (imap-send-command-wait "CLOSE"))))
1170       (setq imap-current-mailbox nil
1171             imap-message-data nil
1172             imap-state 'auth)
1173       t)))
1174
1175 (defun imap-mailbox-expunge (&optional asynch buffer)
1176   "Expunge articles in current folder in BUFFER.
1177 If ASYNCH, do not wait for succesful completion of the command.
1178 If BUFFER is nil the current buffer is assumed."
1179   (with-current-buffer (or buffer (current-buffer))
1180     (when (and imap-current-mailbox (not (eq imap-state 'examine)))
1181       (if asynch
1182           (imap-send-command "EXPUNGE")
1183       (imap-ok-p (imap-send-command-wait "EXPUNGE"))))))
1184
1185 (defun imap-mailbox-close (&optional asynch buffer)
1186   "Expunge articles and close current folder in BUFFER.
1187 If ASYNCH, do not wait for succesful completion of the command.
1188 If BUFFER is nil the current buffer is assumed."
1189   (with-current-buffer (or buffer (current-buffer))
1190     (when imap-current-mailbox
1191       (if asynch
1192           (imap-add-callback (imap-send-command "CLOSE")
1193                              `(lambda (tag status)
1194                                 (message "IMAP mailbox `%s' closed... %s"
1195                                          imap-current-mailbox status)
1196                                 (when (eq ,imap-current-mailbox
1197                                           imap-current-mailbox)
1198                                   ;; Don't wipe out data if another mailbox
1199                                   ;; was selected...
1200                                   (setq imap-current-mailbox nil
1201                                         imap-message-data nil
1202                                         imap-state 'auth))))
1203         (when (imap-ok-p (imap-send-command-wait "CLOSE"))
1204           (setq imap-current-mailbox nil
1205                 imap-message-data nil
1206                 imap-state 'auth)))
1207       t)))
1208
1209 (defun imap-mailbox-create-1 (mailbox)
1210   (imap-ok-p (imap-send-command-wait (list "CREATE \"" mailbox "\""))))
1211
1212 (defun imap-mailbox-create (mailbox &optional buffer)
1213   "Create MAILBOX on server in BUFFER.
1214 If BUFFER is nil the current buffer is assumed."
1215   (with-current-buffer (or buffer (current-buffer))
1216     (imap-mailbox-create-1 (imap-utf7-encode mailbox))))
1217
1218 (defun imap-mailbox-delete (mailbox &optional buffer)
1219   "Delete MAILBOX on server in BUFFER.
1220 If BUFFER is nil the current buffer is assumed."
1221   (let ((mailbox (imap-utf7-encode mailbox)))
1222     (with-current-buffer (or buffer (current-buffer))
1223       (imap-ok-p
1224        (imap-send-command-wait (list "DELETE \"" mailbox "\""))))))
1225
1226 (defun imap-mailbox-rename (oldname newname &optional buffer)
1227   "Rename mailbox OLDNAME to NEWNAME on server in BUFFER.
1228 If BUFFER is nil the current buffer is assumed."
1229   (let ((oldname (imap-utf7-encode oldname))
1230         (newname (imap-utf7-encode newname)))
1231     (with-current-buffer (or buffer (current-buffer))
1232       (imap-ok-p
1233        (imap-send-command-wait (list "RENAME \"" oldname "\" "
1234                                      "\"" newname "\""))))))
1235
1236 (defun imap-mailbox-lsub (&optional root reference add-delimiter buffer)
1237   "Return a list of subscribed mailboxes on server in BUFFER.
1238 If ROOT is non-nil, only list matching mailboxes.  If ADD-DELIMITER is
1239 non-nil, a hierarchy delimiter is added to root.  REFERENCE is a
1240 implementation-specific string that has to be passed to lsub command."
1241   (with-current-buffer (or buffer (current-buffer))
1242     ;; Make sure we know the hierarchy separator for root's hierarchy
1243     (when (and add-delimiter (null (imap-mailbox-get-1 'delimiter root)))
1244       (imap-send-command-wait (concat "LIST \"" reference "\" \""
1245                                       (imap-utf7-encode root) "\"")))
1246     ;; clear list data (NB not delimiter and other stuff)
1247     (imap-mailbox-map-1 (lambda (mailbox)
1248                           (imap-mailbox-put 'lsub nil mailbox)))
1249     (when (imap-ok-p
1250            (imap-send-command-wait
1251             (concat "LSUB \"" reference "\" \"" (imap-utf7-encode root)
1252                     (and add-delimiter (imap-mailbox-get-1 'delimiter root))
1253                     "%\"")))
1254       (let (out)
1255         (imap-mailbox-map-1 (lambda (mailbox)
1256                               (when (imap-mailbox-get-1 'lsub mailbox)
1257                                 (push (imap-utf7-decode mailbox) out))))
1258         (nreverse out)))))
1259
1260 (defun imap-mailbox-list (root &optional reference add-delimiter buffer)
1261   "Return a list of mailboxes matching ROOT on server in BUFFER.
1262 If ADD-DELIMITER is non-nil, a hierarchy delimiter is added to
1263 root.  REFERENCE is a implementation-specific string that has to be
1264 passed to list command."
1265   (with-current-buffer (or buffer (current-buffer))
1266     ;; Make sure we know the hierarchy separator for root's hierarchy
1267     (when (and add-delimiter (null (imap-mailbox-get-1 'delimiter root)))
1268       (imap-send-command-wait (concat "LIST \"" reference "\" \""
1269                                       (imap-utf7-encode root) "\"")))
1270     ;; clear list data (NB not delimiter and other stuff)
1271     (imap-mailbox-map-1 (lambda (mailbox)
1272                           (imap-mailbox-put 'list nil mailbox)))
1273     (when (imap-ok-p
1274            (imap-send-command-wait
1275             (concat "LIST \"" reference "\" \"" (imap-utf7-encode root)
1276                     (and add-delimiter (imap-mailbox-get-1 'delimiter root))
1277                     "%\"")))
1278       (let (out)
1279         (imap-mailbox-map-1 (lambda (mailbox)
1280                               (when (imap-mailbox-get-1 'list mailbox)
1281                                 (push (imap-utf7-decode mailbox) out))))
1282         (nreverse out)))))
1283
1284 (defun imap-mailbox-subscribe (mailbox &optional buffer)
1285   "Send the SUBSCRIBE command on the mailbox to server in BUFFER.
1286 Returns non-nil if successful."
1287   (with-current-buffer (or buffer (current-buffer))
1288     (imap-ok-p (imap-send-command-wait (concat "SUBSCRIBE \""
1289                                                (imap-utf7-encode mailbox)
1290                                                "\"")))))
1291
1292 (defun imap-mailbox-unsubscribe (mailbox &optional buffer)
1293   "Send the SUBSCRIBE command on the mailbox to server in BUFFER.
1294 Returns non-nil if successful."
1295   (with-current-buffer (or buffer (current-buffer))
1296     (imap-ok-p (imap-send-command-wait (concat "UNSUBSCRIBE "
1297                                                (imap-utf7-encode mailbox)
1298                                                "\"")))))
1299
1300 (defun imap-mailbox-status (mailbox items &optional buffer)
1301   "Get status items ITEM in MAILBOX from server in BUFFER.
1302 ITEMS can be a symbol or a list of symbols, valid symbols are one of
1303 the STATUS data items -- ie 'messages, 'recent, 'uidnext, 'uidvalidity
1304 or 'unseen.  If ITEMS is a list of symbols, a list of values is
1305 returned, if ITEMS is a symbol only it's value is returned."
1306   (with-current-buffer (or buffer (current-buffer))
1307     (when (imap-ok-p
1308            (imap-send-command-wait (list "STATUS \""
1309                                          (imap-utf7-encode mailbox)
1310                                          "\" "
1311                                          (format "%s"
1312                                                  (if (listp items)
1313                                                      items
1314                                                    (list items))))))
1315       (if (listp items)
1316           (mapcar (lambda (item)
1317                     (imap-mailbox-get item mailbox))
1318                   items)
1319         (imap-mailbox-get items mailbox)))))
1320
1321 (defun imap-mailbox-status-asynch (mailbox items &optional buffer)
1322   "Send status item request ITEM on MAILBOX to server in BUFFER.
1323 ITEMS can be a symbol or a list of symbols, valid symbols are one of
1324 the STATUS data items -- ie 'messages, 'recent, 'uidnext, 'uidvalidity
1325 or 'unseen.  The IMAP command tag is returned."
1326   (with-current-buffer (or buffer (current-buffer))
1327     (imap-send-command (list "STATUS \""
1328                              (imap-utf7-encode mailbox)
1329                              "\" "
1330                              (format "%s"
1331                                      (if (listp items)
1332                                          items
1333                                        (list items)))))))
1334
1335 (defun imap-mailbox-acl-get (&optional mailbox buffer)
1336   "Get ACL on mailbox from server in BUFFER."
1337   (let ((mailbox (imap-utf7-encode mailbox)))
1338     (with-current-buffer (or buffer (current-buffer))
1339       (when (imap-ok-p
1340              (imap-send-command-wait (list "GETACL \""
1341                                            (or mailbox imap-current-mailbox)
1342                                            "\"")))
1343         (imap-mailbox-get-1 'acl (or mailbox imap-current-mailbox))))))
1344
1345 (defun imap-mailbox-acl-set (identifier rights &optional mailbox buffer)
1346   "Change/set ACL for IDENTIFIER to RIGHTS in MAILBOX from server in BUFFER."
1347   (let ((mailbox (imap-utf7-encode mailbox)))
1348     (with-current-buffer (or buffer (current-buffer))
1349       (imap-ok-p
1350        (imap-send-command-wait (list "SETACL \""
1351                                      (or mailbox imap-current-mailbox)
1352                                      "\" "
1353                                      identifier
1354                                      " "
1355                                      rights))))))
1356
1357 (defun imap-mailbox-acl-delete (identifier &optional mailbox buffer)
1358   "Removes any <identifier,rights> pair for IDENTIFIER in MAILBOX from server in BUFFER."
1359   (let ((mailbox (imap-utf7-encode mailbox)))
1360     (with-current-buffer (or buffer (current-buffer))
1361       (imap-ok-p
1362        (imap-send-command-wait (list "DELETEACL \""
1363                                      (or mailbox imap-current-mailbox)
1364                                      "\" "
1365                                      identifier))))))
1366
1367 \f
1368 ;; Message functions:
1369
1370 (defun imap-current-message (&optional buffer)
1371   (with-current-buffer (or buffer (current-buffer))
1372     imap-current-message))
1373
1374 (defun imap-list-to-message-set (list)
1375   (mapconcat (lambda (item)
1376                (number-to-string item))
1377              (if (listp list)
1378                  list
1379                (list list))
1380              ","))
1381
1382 (defun imap-range-to-message-set (range)
1383   (mapconcat
1384    (lambda (item)
1385      (if (consp item)
1386          (format "%d:%d"
1387                  (car item) (cdr item))
1388        (format "%d" item)))
1389    (if (and (listp range) (not (listp (cdr range))))
1390        (list range) ;; make (1 . 2) into ((1 . 2))
1391      range)
1392    ","))
1393
1394 (defun imap-fetch-asynch (uids props &optional nouidfetch buffer)
1395   (with-current-buffer (or buffer (current-buffer))
1396     (imap-send-command (format "%sFETCH %s %s" (if nouidfetch "" "UID ")
1397                                (if (listp uids)
1398                                    (imap-list-to-message-set uids)
1399                                  uids)
1400                                props))))
1401
1402 (defun imap-fetch (uids props &optional receive nouidfetch buffer)
1403   "Fetch properties PROPS from message set UIDS from server in BUFFER.
1404 UIDS can be a string, number or a list of numbers.  If RECEIVE
1405 is non-nil return theese properties."
1406   (with-current-buffer (or buffer (current-buffer))
1407     (when (imap-ok-p (imap-send-command-wait
1408                       (format "%sFETCH %s %s" (if nouidfetch "" "UID ")
1409                               (if (listp uids)
1410                                   (imap-list-to-message-set uids)
1411                                 uids)
1412                               props)))
1413       (if (or (null receive) (stringp uids))
1414           t
1415         (if (listp uids)
1416             (mapcar (lambda (uid)
1417                       (if (listp receive)
1418                           (mapcar (lambda (prop)
1419                                     (imap-message-get uid prop))
1420                                   receive)
1421                         (imap-message-get uid receive)))
1422                     uids)
1423           (imap-message-get uids receive))))))
1424
1425 (defun imap-message-put (uid propname value &optional buffer)
1426   (with-current-buffer (or buffer (current-buffer))
1427     (if imap-message-data
1428         (put (intern (number-to-string uid) imap-message-data)
1429              propname value)
1430       (error "Imap-message-data is nil, uid %s prop %s value %s buffer %s"
1431              uid propname value (current-buffer)))
1432     t))
1433
1434 (defun imap-message-get (uid propname &optional buffer)
1435   (with-current-buffer (or buffer (current-buffer))
1436     (get (intern-soft (number-to-string uid) imap-message-data)
1437          propname)))
1438
1439 (defun imap-message-map (func propname &optional buffer)
1440   "Map a function across each mailbox in `imap-message-data', returning a list."
1441   (with-current-buffer (or buffer (current-buffer))
1442     (let (result)
1443       (mapatoms
1444        (lambda (s)
1445          (push (funcall func (get s 'UID) (get s propname)) result))
1446        imap-message-data)
1447       result)))
1448
1449 (defmacro imap-message-envelope-date (uid &optional buffer)
1450   `(with-current-buffer (or ,buffer (current-buffer))
1451      (elt (imap-message-get ,uid 'ENVELOPE) 0)))
1452
1453 (defmacro imap-message-envelope-subject (uid &optional buffer)
1454   `(with-current-buffer (or ,buffer (current-buffer))
1455      (elt (imap-message-get ,uid 'ENVELOPE) 1)))
1456
1457 (defmacro imap-message-envelope-from (uid &optional buffer)
1458   `(with-current-buffer (or ,buffer (current-buffer))
1459      (elt (imap-message-get ,uid 'ENVELOPE) 2)))
1460
1461 (defmacro imap-message-envelope-sender (uid &optional buffer)
1462   `(with-current-buffer (or ,buffer (current-buffer))
1463      (elt (imap-message-get ,uid 'ENVELOPE) 3)))
1464
1465 (defmacro imap-message-envelope-reply-to (uid &optional buffer)
1466   `(with-current-buffer (or ,buffer (current-buffer))
1467      (elt (imap-message-get ,uid 'ENVELOPE) 4)))
1468
1469 (defmacro imap-message-envelope-to (uid &optional buffer)
1470   `(with-current-buffer (or ,buffer (current-buffer))
1471      (elt (imap-message-get ,uid 'ENVELOPE) 5)))
1472
1473 (defmacro imap-message-envelope-cc (uid &optional buffer)
1474   `(with-current-buffer (or ,buffer (current-buffer))
1475      (elt (imap-message-get ,uid 'ENVELOPE) 6)))
1476
1477 (defmacro imap-message-envelope-bcc (uid &optional buffer)
1478   `(with-current-buffer (or ,buffer (current-buffer))
1479      (elt (imap-message-get ,uid 'ENVELOPE) 7)))
1480
1481 (defmacro imap-message-envelope-in-reply-to (uid &optional buffer)
1482   `(with-current-buffer (or ,buffer (current-buffer))
1483      (elt (imap-message-get ,uid 'ENVELOPE) 8)))
1484
1485 (defmacro imap-message-envelope-message-id (uid &optional buffer)
1486   `(with-current-buffer (or ,buffer (current-buffer))
1487      (elt (imap-message-get ,uid 'ENVELOPE) 9)))
1488
1489 (defmacro imap-message-body (uid &optional buffer)
1490   `(with-current-buffer (or ,buffer (current-buffer))
1491      (imap-message-get ,uid 'BODY)))
1492
1493 (defun imap-search (predicate &optional buffer)
1494   (with-current-buffer (or buffer (current-buffer))
1495     (imap-mailbox-put 'search 'dummy)
1496     (when (imap-ok-p (imap-send-command-wait (concat "UID SEARCH " predicate)))
1497       (if (eq (imap-mailbox-get-1 'search imap-current-mailbox) 'dummy)
1498           (progn
1499             (message "Missing SEARCH response to a SEARCH command (server not RFC compliant)...")
1500             nil)
1501         (imap-mailbox-get-1 'search imap-current-mailbox)))))
1502
1503 (defun imap-message-flag-permanent-p (flag &optional mailbox buffer)
1504   "Return t iff FLAG can be permanently (between IMAP sessions) saved on articles, in MAILBOX on server in BUFFER."
1505   (with-current-buffer (or buffer (current-buffer))
1506     (or (member "\\*" (imap-mailbox-get 'permanentflags mailbox))
1507         (member flag (imap-mailbox-get 'permanentflags mailbox)))))
1508
1509 (defun imap-message-flags-set (articles flags &optional silent buffer)
1510   (when (and articles flags)
1511     (with-current-buffer (or buffer (current-buffer))
1512       (imap-ok-p (imap-send-command-wait
1513                   (concat "UID STORE " articles
1514                           " FLAGS" (if silent ".SILENT") " (" flags ")"))))))
1515
1516 (defun imap-message-flags-del (articles flags &optional silent buffer)
1517   (when (and articles flags)
1518     (with-current-buffer (or buffer (current-buffer))
1519       (imap-ok-p (imap-send-command-wait
1520                   (concat "UID STORE " articles
1521                           " -FLAGS" (if silent ".SILENT") " (" flags ")"))))))
1522
1523 (defun imap-message-flags-add (articles flags &optional silent buffer)
1524   (when (and articles flags)
1525     (with-current-buffer (or buffer (current-buffer))
1526       (imap-ok-p (imap-send-command-wait
1527                   (concat "UID STORE " articles
1528                           " +FLAGS" (if silent ".SILENT") " (" flags ")"))))))
1529
1530 (defun imap-message-copyuid-1 (mailbox)
1531   (if (imap-capability 'UIDPLUS)
1532       (list (nth 0 (imap-mailbox-get-1 'copyuid mailbox))
1533             (string-to-number (nth 2 (imap-mailbox-get-1 'copyuid mailbox))))
1534     (let ((old-mailbox imap-current-mailbox)
1535           (state imap-state)
1536           (imap-message-data (make-vector 2 0)))
1537       (when (imap-mailbox-examine-1 mailbox)
1538         (prog1
1539             (and (imap-fetch "*" "UID")
1540                  (list (imap-mailbox-get-1 'uidvalidity mailbox)
1541                        (apply 'max (imap-message-map
1542                                     (lambda (uid prop) uid) 'UID))))
1543           (if old-mailbox
1544               (imap-mailbox-select old-mailbox (eq state 'examine))
1545             (imap-mailbox-unselect)))))))
1546
1547 (defun imap-message-copyuid (mailbox &optional buffer)
1548   (with-current-buffer (or buffer (current-buffer))
1549     (imap-message-copyuid-1 (imap-utf7-decode mailbox))))
1550
1551 (defun imap-message-copy (articles mailbox
1552                                    &optional dont-create no-copyuid buffer)
1553   "Copy ARTICLES (a string message set) to MAILBOX on server in
1554 BUFFER, creating mailbox if it doesn't exist.  If dont-create is
1555 non-nil, it will not create a mailbox.  On success, return a list with
1556 the UIDVALIDITY of the mailbox the article(s) was copied to as the
1557 first element, rest of list contain the saved articles' UIDs."
1558   (when articles
1559     (with-current-buffer (or buffer (current-buffer))
1560       (let ((mailbox (imap-utf7-encode mailbox)))
1561         (if (let ((cmd (concat "UID COPY " articles " \"" mailbox "\""))
1562                   (imap-current-target-mailbox mailbox))
1563               (if (imap-ok-p (imap-send-command-wait cmd))
1564                   t
1565                 (when (and (not dont-create)
1566                            ;; removed because of buggy Oracle server
1567                            ;; that doesn't send TRYCREATE tags (which
1568                            ;; is a MUST according to specifications):
1569                            ;;(imap-mailbox-get-1 'trycreate mailbox)
1570                            (imap-mailbox-create-1 mailbox))
1571                   (imap-ok-p (imap-send-command-wait cmd)))))
1572             (or no-copyuid
1573                 (imap-message-copyuid-1 mailbox)))))))
1574
1575 (defun imap-message-appenduid-1 (mailbox)
1576   (if (imap-capability 'UIDPLUS)
1577       (imap-mailbox-get-1 'appenduid mailbox)
1578     (let ((old-mailbox imap-current-mailbox)
1579           (state imap-state)
1580           (imap-message-data (make-vector 2 0)))
1581       (when (imap-mailbox-examine-1 mailbox)
1582         (prog1
1583             (and (imap-fetch "*" "UID")
1584                  (list (imap-mailbox-get-1 'uidvalidity mailbox)
1585                        (apply 'max (imap-message-map
1586                                     (lambda (uid prop) uid) 'UID))))
1587           (if old-mailbox
1588               (imap-mailbox-select old-mailbox (eq state 'examine))
1589             (imap-mailbox-unselect)))))))
1590
1591 (defun imap-message-appenduid (mailbox &optional buffer)
1592   (with-current-buffer (or buffer (current-buffer))
1593     (imap-message-appenduid-1 (imap-utf7-encode mailbox))))
1594
1595 (defun imap-message-append (mailbox article &optional flags date-time buffer)
1596   "Append ARTICLE (a buffer) to MAILBOX on server in BUFFER.
1597 FLAGS and DATE-TIME is currently not used.  Return a cons holding
1598 uidvalidity of MAILBOX and UID the newly created article got, or nil
1599 on failure."
1600   (let ((mailbox (imap-utf7-encode mailbox)))
1601     (with-current-buffer (or buffer (current-buffer))
1602       (and (let ((imap-current-target-mailbox mailbox))
1603              (imap-ok-p
1604               (imap-send-command-wait
1605                (list "APPEND \"" mailbox "\" "  article))))
1606            (imap-message-appenduid-1 mailbox)))))
1607
1608 (defun imap-body-lines (body)
1609   "Return number of lines in article by looking at the mime bodystructure BODY."
1610   (if (listp body)
1611       (if (stringp (car body))
1612           (cond ((and (string= (upcase (car body)) "TEXT")
1613                       (numberp (nth 7 body)))
1614                  (nth 7 body))
1615                 ((and (string= (upcase (car body)) "MESSAGE")
1616                       (numberp (nth 9 body)))
1617                  (nth 9 body))
1618                 (t 0))
1619         (apply '+ (mapcar 'imap-body-lines body)))
1620     0))
1621
1622 (defun imap-envelope-from (from)
1623   "Return a from string line."
1624   (and from
1625        (concat (aref from 0)
1626                (if (aref from 0) " <")
1627                (aref from 2)
1628                "@"
1629                (aref from 3)
1630                (if (aref from 0) ">"))))
1631
1632 \f
1633 ;; Internal functions.
1634
1635 (defun imap-add-callback (tag func)
1636   (setq imap-callbacks (append (list (cons tag func)) imap-callbacks)))
1637
1638 (defun imap-send-command-1 (cmdstr)
1639   (setq cmdstr (concat cmdstr imap-client-eol))
1640   (and imap-log
1641        (with-current-buffer (get-buffer-create imap-log-buffer)
1642          (imap-disable-multibyte)
1643          (buffer-disable-undo)
1644          (goto-char (point-max))
1645          (insert cmdstr)))
1646   (process-send-string imap-process cmdstr))
1647
1648 (defun imap-send-command (command &optional buffer)
1649   (with-current-buffer (or buffer (current-buffer))
1650     (if (not (listp command)) (setq command (list command)))
1651     (let ((tag (setq imap-tag (1+ imap-tag)))
1652           cmd cmdstr)
1653       (setq cmdstr (concat (number-to-string imap-tag) " "))
1654       (while (setq cmd (pop command))
1655         (cond ((stringp cmd)
1656                (setq cmdstr (concat cmdstr cmd)))
1657               ((bufferp cmd)
1658                (let ((eol imap-client-eol)
1659                      (calcfirst imap-calculate-literal-size-first)
1660                      size)
1661                  (with-current-buffer cmd
1662                    (if calcfirst
1663                        (setq size (buffer-size)))
1664                    (when (not (equal eol "\r\n"))
1665                      ;; XXX modifies buffer!
1666                      (goto-char (point-min))
1667                      (while (search-forward "\r\n" nil t)
1668                        (replace-match eol)))
1669                    (if (not calcfirst)
1670                        (setq size (buffer-size))))
1671                  (setq cmdstr
1672                        (concat cmdstr (format "{%d}" size))))
1673                (unwind-protect
1674                    (progn
1675                      (imap-send-command-1 cmdstr)
1676                      (setq cmdstr nil)
1677                      (if (not (eq (imap-wait-for-tag tag) 'INCOMPLETE))
1678                          (setq command nil) ;; abort command if no cont-req
1679                        (let ((process imap-process)
1680                              (stream imap-stream)
1681                              (eol imap-client-eol))
1682                          (with-current-buffer cmd
1683                            (and imap-log
1684                                 (with-current-buffer (get-buffer-create
1685                                                       imap-log-buffer)
1686                                   (imap-disable-multibyte)
1687                                   (buffer-disable-undo)
1688                                   (goto-char (point-max))
1689                                   (insert-buffer-substring cmd)))
1690                            (process-send-region process (point-min)
1691                                                 (point-max)))
1692                          (process-send-string process imap-client-eol))))
1693                  (setq imap-continuation nil)))
1694               ((functionp cmd)
1695                (imap-send-command-1 cmdstr)
1696                (setq cmdstr nil)
1697                (unwind-protect
1698                    (if (not (eq (imap-wait-for-tag tag) 'INCOMPLETE))
1699                        (setq command nil) ;; abort command if no cont-req
1700                      (setq command (cons (funcall cmd imap-continuation)
1701                                          command)))
1702                  (setq imap-continuation nil)))
1703               (t
1704                (error "Unknown command type"))))
1705       (if cmdstr
1706           (imap-send-command-1 cmdstr))
1707       tag)))
1708
1709 (defun imap-wait-for-tag (tag &optional buffer)
1710   (with-current-buffer (or buffer (current-buffer))
1711     (let (imap-have-messaged)
1712       (while (and (null imap-continuation)
1713                   (memq (process-status imap-process) '(open run))
1714                   (< imap-reached-tag tag))
1715         (let ((len (/ (point-max) 1024))
1716               message-log-max)
1717           (unless (< len 10)
1718             (setq imap-have-messaged t)
1719             (message "imap read: %dk" len))
1720           (accept-process-output imap-process 1)))
1721       (when imap-have-messaged
1722         (message ""))
1723       (and (memq (process-status imap-process) '(open run))
1724            (or (assq tag imap-failed-tags)
1725                (if imap-continuation
1726                    'INCOMPLETE
1727                  'OK))))))
1728
1729 (defun imap-sentinel (process string)
1730   (delete-process process))
1731
1732 (defun imap-find-next-line ()
1733   "Return point at end of current line, taking into account literals.
1734 Return nil if no complete line has arrived."
1735   (when (re-search-forward (concat imap-server-eol "\\|{\\([0-9]+\\)}"
1736                                    imap-server-eol)
1737                            nil t)
1738     (if (match-string 1)
1739         (if (< (point-max) (+ (point) (string-to-number (match-string 1))))
1740             nil
1741           (goto-char (+ (point) (string-to-number (match-string 1))))
1742           (imap-find-next-line))
1743       (point))))
1744
1745 (defun imap-arrival-filter (proc string)
1746   "IMAP process filter."
1747   (with-current-buffer (process-buffer proc)
1748     (goto-char (point-max))
1749     (insert string)
1750     (and imap-log
1751          (with-current-buffer (get-buffer-create imap-log-buffer)
1752            (imap-disable-multibyte)
1753            (buffer-disable-undo)
1754            (goto-char (point-max))
1755            (insert string)))
1756     (let (end)
1757       (goto-char (point-min))
1758       (while (setq end (imap-find-next-line))
1759         (save-restriction
1760           (narrow-to-region (point-min) end)
1761           (delete-backward-char (length imap-server-eol))
1762           (goto-char (point-min))
1763           (unwind-protect
1764               (cond ((eq imap-state 'initial)
1765                      (imap-parse-greeting))
1766                     ((or (eq imap-state 'auth)
1767                          (eq imap-state 'nonauth)
1768                          (eq imap-state 'selected)
1769                          (eq imap-state 'examine))
1770                      (imap-parse-response))
1771                     (t
1772                      (message "Unknown state %s in arrival filter"
1773                               imap-state)))
1774             (delete-region (point-min) (point-max))))))))
1775
1776 \f
1777 ;; Imap parser.
1778
1779 (defsubst imap-forward ()
1780   (or (eobp) (forward-char)))
1781
1782 ;;   number          = 1*DIGIT
1783 ;;                       ; Unsigned 32-bit integer
1784 ;;                       ; (0 <= n < 4,294,967,296)
1785
1786 (defsubst imap-parse-number ()
1787   (when (looking-at "[0-9]+")
1788     (prog1
1789         (string-to-number (match-string 0))
1790       (goto-char (match-end 0)))))
1791
1792 ;;   literal         = "{" number "}" CRLF *CHAR8
1793 ;;                       ; Number represents the number of CHAR8s
1794
1795 (defsubst imap-parse-literal ()
1796   (when (looking-at "{\\([0-9]+\\)}\r\n")
1797     (let ((pos (match-end 0))
1798           (len (string-to-number (match-string 1))))
1799       (if (< (point-max) (+ pos len))
1800           nil
1801         (goto-char (+ pos len))
1802         (buffer-substring pos (+ pos len))))))
1803
1804 ;;   string          = quoted / literal
1805 ;;
1806 ;;   quoted          = DQUOTE *QUOTED-CHAR DQUOTE
1807 ;;
1808 ;;   QUOTED-CHAR     = <any TEXT-CHAR except quoted-specials> /
1809 ;;                     "\" quoted-specials
1810 ;;
1811 ;;   quoted-specials = DQUOTE / "\"
1812 ;;
1813 ;;   TEXT-CHAR       = <any CHAR except CR and LF>
1814
1815 (defsubst imap-parse-string ()
1816   (cond ((eq (char-after) ?\")
1817          (forward-char 1)
1818          (let ((p (point)) (name ""))
1819            (skip-chars-forward "^\"\\\\")
1820            (setq name (buffer-substring p (point)))
1821            (while (eq (char-after) ?\\)
1822              (setq p (1+ (point)))
1823              (forward-char 2)
1824              (skip-chars-forward "^\"\\\\")
1825              (setq name (concat name (buffer-substring p (point)))))
1826            (forward-char 1)
1827            name))
1828         ((eq (char-after) ?{)
1829          (imap-parse-literal))))
1830
1831 ;;   nil             = "NIL"
1832
1833 (defsubst imap-parse-nil ()
1834   (if (looking-at "NIL")
1835       (goto-char (match-end 0))))
1836
1837 ;;   nstring         = string / nil
1838
1839 (defsubst imap-parse-nstring ()
1840   (or (imap-parse-string)
1841       (and (imap-parse-nil)
1842            nil)))
1843
1844 ;;   astring         = atom / string
1845 ;;
1846 ;;   atom            = 1*ATOM-CHAR
1847 ;;
1848 ;;   ATOM-CHAR       = <any CHAR except atom-specials>
1849 ;;
1850 ;;   atom-specials   = "(" / ")" / "{" / SP / CTL / list-wildcards /
1851 ;;                     quoted-specials
1852 ;;
1853 ;;   list-wildcards  = "%" / "*"
1854 ;;
1855 ;;   quoted-specials = DQUOTE / "\"
1856
1857 (defsubst imap-parse-astring ()
1858   (or (imap-parse-string)
1859       (buffer-substring (point)
1860                         (if (re-search-forward "[(){ \r\n%*\"\\]" nil t)
1861                             (goto-char (1- (match-end 0)))
1862                           (end-of-line)
1863                           (point)))))
1864
1865 ;;   address         = "(" addr-name SP addr-adl SP addr-mailbox SP
1866 ;;                      addr-host ")"
1867 ;;
1868 ;;   addr-adl        = nstring
1869 ;;                       ; Holds route from [RFC-822] route-addr if
1870 ;;                       ; non-nil
1871 ;;
1872 ;;   addr-host       = nstring
1873 ;;                       ; nil indicates [RFC-822] group syntax.
1874 ;;                       ; Otherwise, holds [RFC-822] domain name
1875 ;;
1876 ;;   addr-mailbox    = nstring
1877 ;;                       ; nil indicates end of [RFC-822] group; if
1878 ;;                       ; non-nil and addr-host is nil, holds
1879 ;;                       ; [RFC-822] group name.
1880 ;;                       ; Otherwise, holds [RFC-822] local-part
1881 ;;                       ; after removing [RFC-822] quoting
1882 ;;
1883 ;;   addr-name       = nstring
1884 ;;                       ; If non-nil, holds phrase from [RFC-822]
1885 ;;                       ; mailbox after removing [RFC-822] quoting
1886 ;;
1887
1888 (defsubst imap-parse-address ()
1889   (let (address)
1890     (when (eq (char-after) ?\()
1891       (imap-forward)
1892       (setq address (vector (prog1 (imap-parse-nstring)
1893                               (imap-forward))
1894                             (prog1 (imap-parse-nstring)
1895                               (imap-forward))
1896                             (prog1 (imap-parse-nstring)
1897                               (imap-forward))
1898                             (imap-parse-nstring)))
1899       (when (eq (char-after) ?\))
1900         (imap-forward)
1901         address))))
1902
1903 ;;   address-list    = "(" 1*address ")" / nil
1904 ;;
1905 ;;   nil             = "NIL"
1906
1907 (defsubst imap-parse-address-list ()
1908   (if (eq (char-after) ?\()
1909       (let (address addresses)
1910         (imap-forward)
1911         (while (and (not (eq (char-after) ?\)))
1912                     ;; next line for MS Exchange bug
1913                     (progn (and (eq (char-after) ? ) (imap-forward)) t)
1914                     (setq address (imap-parse-address)))
1915           (setq addresses (cons address addresses)))
1916         (when (eq (char-after) ?\))
1917           (imap-forward)
1918           (nreverse addresses)))
1919     (assert (imap-parse-nil) t "In imap-parse-address-list")))
1920
1921 ;;   mailbox         = "INBOX" / astring
1922 ;;                       ; INBOX is case-insensitive.  All case variants of
1923 ;;                       ; INBOX (e.g. "iNbOx") MUST be interpreted as INBOX
1924 ;;                       ; not as an astring.  An astring which consists of
1925 ;;                       ; the case-insensitive sequence "I" "N" "B" "O" "X"
1926 ;;                       ; is considered to be INBOX and not an astring.
1927 ;;                       ;  Refer to section 5.1 for further
1928 ;;                       ; semantic details of mailbox names.
1929
1930 (defsubst imap-parse-mailbox ()
1931   (let ((mailbox (imap-parse-astring)))
1932     (if (string-equal "INBOX" (upcase mailbox))
1933         "INBOX"
1934       mailbox)))
1935
1936 ;;   greeting        = "*" SP (resp-cond-auth / resp-cond-bye) CRLF
1937 ;;
1938 ;;   resp-cond-auth  = ("OK" / "PREAUTH") SP resp-text
1939 ;;                       ; Authentication condition
1940 ;;
1941 ;;   resp-cond-bye   = "BYE" SP resp-text
1942
1943 (defun imap-parse-greeting ()
1944   "Parse a IMAP greeting."
1945   (cond ((looking-at "\\* OK ")
1946          (setq imap-state 'nonauth))
1947         ((looking-at "\\* PREAUTH ")
1948          (setq imap-state 'auth))
1949         ((looking-at "\\* BYE ")
1950          (setq imap-state 'closed))))
1951
1952 ;;   response        = *(continue-req / response-data) response-done
1953 ;;
1954 ;;   continue-req    = "+" SP (resp-text / base64) CRLF
1955 ;;
1956 ;;   response-data   = "*" SP (resp-cond-state / resp-cond-bye /
1957 ;;                     mailbox-data / message-data / capability-data) CRLF
1958 ;;
1959 ;;   response-done   = response-tagged / response-fatal
1960 ;;
1961 ;;   response-fatal  = "*" SP resp-cond-bye CRLF
1962 ;;                       ; Server closes connection immediately
1963 ;;
1964 ;;   response-tagged = tag SP resp-cond-state CRLF
1965 ;;
1966 ;;   resp-cond-state = ("OK" / "NO" / "BAD") SP resp-text
1967 ;;                       ; Status condition
1968 ;;
1969 ;;   resp-cond-bye   = "BYE" SP resp-text
1970 ;;
1971 ;;   mailbox-data    =  "FLAGS" SP flag-list /
1972 ;;                      "LIST" SP mailbox-list /
1973 ;;                      "LSUB" SP mailbox-list /
1974 ;;                      "SEARCH" *(SP nz-number) /
1975 ;;                      "STATUS" SP mailbox SP "("
1976 ;;                            [status-att SP number *(SP status-att SP number)] ")" /
1977 ;;                      number SP "EXISTS" /
1978 ;;                      number SP "RECENT"
1979 ;;
1980 ;;   message-data    = nz-number SP ("EXPUNGE" / ("FETCH" SP msg-att))
1981 ;;
1982 ;;   capability-data = "CAPABILITY" *(SP capability) SP "IMAP4rev1"
1983 ;;                     *(SP capability)
1984 ;;                       ; IMAP4rev1 servers which offer RFC 1730
1985 ;;                       ; compatibility MUST list "IMAP4" as the first
1986 ;;                       ; capability.
1987
1988 (defun imap-parse-response ()
1989   "Parse a IMAP command response."
1990   (let (token)
1991     (case (setq token (read (current-buffer)))
1992       (+ (setq imap-continuation
1993                (or (buffer-substring (min (point-max) (1+ (point)))
1994                                      (point-max))
1995                    t)))
1996       (* (case (prog1 (setq token (read (current-buffer)))
1997                  (imap-forward))
1998            (OK         (imap-parse-resp-text))
1999            (NO         (imap-parse-resp-text))
2000            (BAD        (imap-parse-resp-text))
2001            (BYE        (imap-parse-resp-text))
2002            (FLAGS      (imap-mailbox-put 'flags (imap-parse-flag-list)))
2003            (LIST       (imap-parse-data-list 'list))
2004            (LSUB       (imap-parse-data-list 'lsub))
2005            (SEARCH     (imap-mailbox-put
2006                         'search
2007                         (read (concat "(" (buffer-substring (point) (point-max)) ")"))))
2008            (STATUS     (imap-parse-status))
2009            (CAPABILITY (setq imap-capability
2010                                (read (concat "(" (upcase (buffer-substring
2011                                                           (point) (point-max)))
2012                                              ")"))))
2013            (ACL        (imap-parse-acl))
2014            (t       (case (prog1 (read (current-buffer))
2015                             (imap-forward))
2016                       (EXISTS  (imap-mailbox-put 'exists token))
2017                       (RECENT  (imap-mailbox-put 'recent token))
2018                       (EXPUNGE t)
2019                       (FETCH   (imap-parse-fetch token))
2020                       (t       (message "Garbage: %s" (buffer-string)))))))
2021       (t (let (status)
2022            (if (not (integerp token))
2023                (message "Garbage: %s" (buffer-string))
2024              (case (prog1 (setq status (read (current-buffer)))
2025                      (imap-forward))
2026                (OK  (progn
2027                       (setq imap-reached-tag (max imap-reached-tag token))
2028                       (imap-parse-resp-text)))
2029                (NO  (progn
2030                       (setq imap-reached-tag (max imap-reached-tag token))
2031                       (save-excursion
2032                         (imap-parse-resp-text))
2033                       (let (code text)
2034                         (when (eq (char-after) ?\[)
2035                           (setq code (buffer-substring (point)
2036                                                        (search-forward "]")))
2037                           (imap-forward))
2038                         (setq text (buffer-substring (point) (point-max)))
2039                         (push (list token status code text)
2040                               imap-failed-tags))))
2041                (BAD (progn
2042                       (setq imap-reached-tag (max imap-reached-tag token))
2043                       (save-excursion
2044                         (imap-parse-resp-text))
2045                       (let (code text)
2046                         (when (eq (char-after) ?\[)
2047                           (setq code (buffer-substring (point)
2048                                                        (search-forward "]")))
2049                           (imap-forward))
2050                         (setq text (buffer-substring (point) (point-max)))
2051                         (push (list token status code text) imap-failed-tags)
2052                         (error "Internal error, tag %s status %s code %s text %s"
2053                                token status code text))))
2054                (t   (message "Garbage: %s" (buffer-string))))
2055              (when (assq token imap-callbacks)
2056                (funcall (cdr (assq token imap-callbacks)) token status)
2057                (setq imap-callbacks
2058                      (imap-remassoc token imap-callbacks)))))))))
2059
2060 ;;   resp-text       = ["[" resp-text-code "]" SP] text
2061 ;;
2062 ;;   text            = 1*TEXT-CHAR
2063 ;;
2064 ;;   TEXT-CHAR       = <any CHAR except CR and LF>
2065
2066 (defun imap-parse-resp-text ()
2067   (imap-parse-resp-text-code))
2068
2069 ;;   resp-text-code  = "ALERT" /
2070 ;;                     "BADCHARSET [SP "(" astring *(SP astring) ")" ] /
2071 ;;                     "NEWNAME" SP string SP string /
2072 ;;                     "PARSE" /
2073 ;;                     "PERMANENTFLAGS" SP "("
2074 ;;                               [flag-perm *(SP flag-perm)] ")" /
2075 ;;                     "READ-ONLY" /
2076 ;;                     "READ-WRITE" /
2077 ;;                     "TRYCREATE" /
2078 ;;                     "UIDNEXT" SP nz-number /
2079 ;;                     "UIDVALIDITY" SP nz-number /
2080 ;;                     "UNSEEN" SP nz-number /
2081 ;;                     resp-text-atom [SP 1*<any TEXT-CHAR except "]">]
2082 ;;
2083 ;;   resp_code_apnd  = "APPENDUID" SPACE nz_number SPACE uniqueid
2084 ;;
2085 ;;   resp_code_copy  = "COPYUID" SPACE nz_number SPACE set SPACE set
2086 ;;
2087 ;;   set             = sequence-num / (sequence-num ":" sequence-num) /
2088 ;;                        (set "," set)
2089 ;;                          ; Identifies a set of messages.  For message
2090 ;;                          ; sequence numbers, these are consecutive
2091 ;;                          ; numbers from 1 to the number of messages in
2092 ;;                          ; the mailbox
2093 ;;                          ; Comma delimits individual numbers, colon
2094 ;;                          ; delimits between two numbers inclusive.
2095 ;;                          ; Example: 2,4:7,9,12:* is 2,4,5,6,7,9,12,13,
2096 ;;                          ; 14,15 for a mailbox with 15 messages.
2097 ;;
2098 ;;   sequence-num    = nz-number / "*"
2099 ;;                          ; * is the largest number in use.  For message
2100 ;;                          ; sequence numbers, it is the number of messages
2101 ;;                          ; in the mailbox.  For unique identifiers, it is
2102 ;;                          ; the unique identifier of the last message in
2103 ;;                          ; the mailbox.
2104 ;;
2105 ;;   flag-perm       = flag / "\*"
2106 ;;
2107 ;;   flag            = "\Answered" / "\Flagged" / "\Deleted" /
2108 ;;                     "\Seen" / "\Draft" / flag-keyword / flag-extension
2109 ;;                       ; Does not include "\Recent"
2110 ;;
2111 ;;   flag-extension  = "\" atom
2112 ;;                       ; Future expansion.  Client implementations
2113 ;;                       ; MUST accept flag-extension flags.  Server
2114 ;;                       ; implementations MUST NOT generate
2115 ;;                       ; flag-extension flags except as defined by
2116 ;;                       ; future standard or standards-track
2117 ;;                       ; revisions of this specification.
2118 ;;
2119 ;;   flag-keyword    = atom
2120 ;;
2121 ;;   resp-text-atom  = 1*<any ATOM-CHAR except "]">
2122
2123 (defun imap-parse-resp-text-code ()
2124   ;; xxx next line for stalker communigate pro 3.3.1 bug
2125   (when (looking-at " \\[")
2126     (imap-forward))
2127   (when (eq (char-after) ?\[)
2128     (imap-forward)
2129     (cond ((search-forward "PERMANENTFLAGS " nil t)
2130            (imap-mailbox-put 'permanentflags (imap-parse-flag-list)))
2131           ((search-forward "UIDNEXT \\([0-9]+\\)" nil t)
2132            (imap-mailbox-put 'uidnext (match-string 1)))
2133           ((search-forward "UNSEEN " nil t)
2134            (imap-mailbox-put 'unseen (read (current-buffer))))
2135           ((looking-at "UIDVALIDITY \\([0-9]+\\)")
2136            (imap-mailbox-put 'uidvalidity (match-string 1)))
2137           ((search-forward "READ-ONLY" nil t)
2138            (imap-mailbox-put 'read-only t))
2139           ((search-forward "NEWNAME " nil t)
2140            (let (oldname newname)
2141              (setq oldname (imap-parse-string))
2142              (imap-forward)
2143              (setq newname (imap-parse-string))
2144              (imap-mailbox-put 'newname newname oldname)))
2145           ((search-forward "TRYCREATE" nil t)
2146            (imap-mailbox-put 'trycreate t imap-current-target-mailbox))
2147           ((looking-at "APPENDUID \\([0-9]+\\) \\([0-9]+\\)")
2148            (imap-mailbox-put 'appenduid
2149                              (list (match-string 1)
2150                                    (string-to-number (match-string 2)))
2151                              imap-current-target-mailbox))
2152           ((looking-at "COPYUID \\([0-9]+\\) \\([0-9,:]+\\) \\([0-9,:]+\\)")
2153            (imap-mailbox-put 'copyuid (list (match-string 1)
2154                                             (match-string 2)
2155                                             (match-string 3))
2156                              imap-current-target-mailbox))
2157           ((search-forward "ALERT] " nil t)
2158            (message "Imap server %s information: %s" imap-server
2159                     (buffer-substring (point) (point-max)))))))
2160
2161 ;;   mailbox-list    = "(" [mbx-list-flags] ")" SP
2162 ;;                      (DQUOTE QUOTED-CHAR DQUOTE / nil) SP mailbox
2163 ;;
2164 ;;   mbx-list-flags  = *(mbx-list-oflag SP) mbx-list-sflag
2165 ;;                     *(SP mbx-list-oflag) /
2166 ;;                     mbx-list-oflag *(SP mbx-list-oflag)
2167 ;;
2168 ;;   mbx-list-oflag  = "\Noinferiors" / flag-extension
2169 ;;                       ; Other flags; multiple possible per LIST response
2170 ;;
2171 ;;   mbx-list-sflag  = "\Noselect" / "\Marked" / "\Unmarked"
2172 ;;                       ; Selectability flags; only one per LIST response
2173 ;;
2174 ;;   QUOTED-CHAR     = <any TEXT-CHAR except quoted-specials> /
2175 ;;                     "\" quoted-specials
2176 ;;
2177 ;;   quoted-specials = DQUOTE / "\"
2178
2179 (defun imap-parse-data-list (type)
2180   (let (flags delimiter mailbox)
2181     (setq flags (imap-parse-flag-list))
2182     (when (looking-at " NIL\\| \"\\\\?\\(.\\)\"")
2183       (setq delimiter (match-string 1))
2184       (goto-char (1+ (match-end 0)))
2185       (when (setq mailbox (imap-parse-mailbox))
2186         (imap-mailbox-put type t mailbox)
2187         (imap-mailbox-put 'list-flags flags mailbox)
2188         (imap-mailbox-put 'delimiter delimiter mailbox)))))
2189
2190 ;;  msg_att         ::= "(" 1#("ENVELOPE" SPACE envelope /
2191 ;;                      "FLAGS" SPACE "(" #(flag / "\Recent") ")" /
2192 ;;                      "INTERNALDATE" SPACE date_time /
2193 ;;                      "RFC822" [".HEADER" / ".TEXT"] SPACE nstring /
2194 ;;                      "RFC822.SIZE" SPACE number /
2195 ;;                      "BODY" ["STRUCTURE"] SPACE body /
2196 ;;                      "BODY" section ["<" number ">"] SPACE nstring /
2197 ;;                      "UID" SPACE uniqueid) ")"
2198 ;;
2199 ;;  date_time       ::= <"> date_day_fixed "-" date_month "-" date_year
2200 ;;                      SPACE time SPACE zone <">
2201 ;;
2202 ;;  section         ::= "[" [section_text / (nz_number *["." nz_number]
2203 ;;                      ["." (section_text / "MIME")])] "]"
2204 ;;
2205 ;;  section_text    ::= "HEADER" / "HEADER.FIELDS" [".NOT"]
2206 ;;                      SPACE header_list / "TEXT"
2207 ;;
2208 ;;  header_fld_name ::= astring
2209 ;;
2210 ;;  header_list     ::= "(" 1#header_fld_name ")"
2211
2212 (defsubst imap-parse-header-list ()
2213   (when (eq (char-after) ?\()
2214     (let (strlist)
2215       (while (not (eq (char-after) ?\)))
2216         (imap-forward)
2217         (push (imap-parse-astring) strlist))
2218       (imap-forward)
2219       (nreverse strlist))))
2220
2221 (defsubst imap-parse-fetch-body-section ()
2222   (let ((section
2223          (buffer-substring (point) (1- (re-search-forward "[] ]" nil t)))))
2224     (if (eq (char-before) ? )
2225         (prog1
2226             (mapconcat 'identity (cons section (imap-parse-header-list)) " ")
2227           (search-forward "]" nil t))
2228       section)))
2229
2230 (defun imap-parse-fetch (response)
2231   (when (eq (char-after) ?\()
2232     (let (uid flags envelope internaldate rfc822 rfc822header rfc822text
2233               rfc822size body bodydetail bodystructure flags-empty)
2234       (while (not (eq (char-after) ?\)))
2235         (imap-forward)
2236         (let ((token (read (current-buffer))))
2237           (imap-forward)
2238           (cond ((eq token 'UID)
2239                  (setq uid (condition-case ()
2240                                (read (current-buffer))
2241                              (error))))
2242                 ((eq token 'FLAGS)
2243                  (setq flags (imap-parse-flag-list))
2244                  (if (not flags)
2245                      (setq flags-empty 't)))
2246                 ((eq token 'ENVELOPE)
2247                  (setq envelope (imap-parse-envelope)))
2248                 ((eq token 'INTERNALDATE)
2249                  (setq internaldate (imap-parse-string)))
2250                 ((eq token 'RFC822)
2251                  (setq rfc822 (imap-parse-nstring)))
2252                 ((eq token 'RFC822.HEADER)
2253                  (setq rfc822header (imap-parse-nstring)))
2254                 ((eq token 'RFC822.TEXT)
2255                  (setq rfc822text (imap-parse-nstring)))
2256                 ((eq token 'RFC822.SIZE)
2257                  (setq rfc822size (read (current-buffer))))
2258                 ((eq token 'BODY)
2259                  (if (eq (char-before) ?\[)
2260                      (push (list
2261                             (upcase (imap-parse-fetch-body-section))
2262                             (and (eq (char-after) ?<)
2263                                  (buffer-substring (1+ (point))
2264                                                    (search-forward ">" nil t)))
2265                             (progn (imap-forward)
2266                                    (imap-parse-nstring)))
2267                            bodydetail)
2268                    (setq body (imap-parse-body))))
2269                 ((eq token 'BODYSTRUCTURE)
2270                  (setq bodystructure (imap-parse-body))))))
2271       (when uid
2272         (setq imap-current-message uid)
2273         (imap-message-put uid 'UID uid)
2274         (and (or flags flags-empty) (imap-message-put uid 'FLAGS flags))
2275         (and envelope (imap-message-put uid 'ENVELOPE envelope))
2276         (and internaldate (imap-message-put uid 'INTERNALDATE internaldate))
2277         (and rfc822 (imap-message-put uid 'RFC822 rfc822))
2278         (and rfc822header (imap-message-put uid 'RFC822.HEADER rfc822header))
2279         (and rfc822text (imap-message-put uid 'RFC822.TEXT rfc822text))
2280         (and rfc822size (imap-message-put uid 'RFC822.SIZE rfc822size))
2281         (and body (imap-message-put uid 'BODY body))
2282         (and bodydetail (imap-message-put uid 'BODYDETAIL bodydetail))
2283         (and bodystructure (imap-message-put uid 'BODYSTRUCTURE bodystructure))
2284         (run-hooks 'imap-fetch-data-hook)))))
2285
2286 ;;   mailbox-data    =  ...
2287 ;;                      "STATUS" SP mailbox SP "("
2288 ;;                            [status-att SP number
2289 ;;                            *(SP status-att SP number)] ")"
2290 ;;                      ...
2291 ;;
2292 ;;   status-att      = "MESSAGES" / "RECENT" / "UIDNEXT" / "UIDVALIDITY" /
2293 ;;                     "UNSEEN"
2294
2295 (defun imap-parse-status ()
2296   (let ((mailbox (imap-parse-mailbox)))
2297     (when (and mailbox (search-forward "(" nil t))
2298       (while (not (eq (char-after) ?\)))
2299         (let ((token (read (current-buffer))))
2300           (cond ((eq token 'MESSAGES)
2301                  (imap-mailbox-put 'messages (read (current-buffer)) mailbox))
2302                 ((eq token 'RECENT)
2303                  (imap-mailbox-put 'recent (read (current-buffer)) mailbox))
2304                 ((eq token 'UIDNEXT)
2305                  (and (looking-at " \\([0-9]+\\)")
2306                       (imap-mailbox-put 'uidnext (match-string 1) mailbox)
2307                       (goto-char (match-end 1))))
2308                 ((eq token 'UIDVALIDITY)
2309                  (and (looking-at " \\([0-9]+\\)")
2310                       (imap-mailbox-put 'uidvalidity (match-string 1) mailbox)
2311                       (goto-char (match-end 1))))
2312                 ((eq token 'UNSEEN)
2313                  (imap-mailbox-put 'unseen (read (current-buffer)) mailbox))
2314                 (t
2315                  (message "Unknown status data %s in mailbox %s ignored"
2316                           token mailbox))))))))
2317
2318 ;;   acl_data        ::= "ACL" SPACE mailbox *(SPACE identifier SPACE
2319 ;;                        rights)
2320 ;;
2321 ;;   identifier      ::= astring
2322 ;;
2323 ;;   rights          ::= astring
2324
2325 (defun imap-parse-acl ()
2326   (let ((mailbox (imap-parse-mailbox))
2327         identifier rights acl)
2328     (while (eq (char-after) ?\ )
2329       (imap-forward)
2330       (setq identifier (imap-parse-astring))
2331       (imap-forward)
2332       (setq rights (imap-parse-astring))
2333       (setq acl (append acl (list (cons identifier rights)))))
2334     (imap-mailbox-put 'acl acl mailbox)))
2335
2336 ;;   flag-list       = "(" [flag *(SP flag)] ")"
2337 ;;
2338 ;;   flag            = "\Answered" / "\Flagged" / "\Deleted" /
2339 ;;                     "\Seen" / "\Draft" / flag-keyword / flag-extension
2340 ;;                       ; Does not include "\Recent"
2341 ;;
2342 ;;   flag-keyword    = atom
2343 ;;
2344 ;;   flag-extension  = "\" atom
2345 ;;                       ; Future expansion.  Client implementations
2346 ;;                       ; MUST accept flag-extension flags.  Server
2347 ;;                       ; implementations MUST NOT generate
2348 ;;                       ; flag-extension flags except as defined by
2349 ;;                       ; future standard or standards-track
2350 ;;                       ; revisions of this specification.
2351
2352 (defun imap-parse-flag-list ()
2353   (let (flag-list start)
2354     (assert (eq (char-after) ?\() t "In imap-parse-flag-list")
2355     (while (and (not (eq (char-after) ?\)))
2356                 (setq start (progn
2357                               (imap-forward)
2358                               ;; next line for Courier IMAP bug.
2359                               (skip-chars-forward " ")
2360                               (point)))
2361                 (> (skip-chars-forward "^ )" (imap-point-at-eol)) 0))
2362       (push (buffer-substring start (point)) flag-list))
2363     (assert (eq (char-after) ?\)) t "In imap-parse-flag-list")
2364     (imap-forward)
2365     (nreverse flag-list)))
2366
2367 ;;   envelope        = "(" env-date SP env-subject SP env-from SP env-sender SP
2368 ;;                     env-reply-to SP env-to SP env-cc SP env-bcc SP
2369 ;;                     env-in-reply-to SP env-message-id ")"
2370 ;;
2371 ;;   env-bcc         = "(" 1*address ")" / nil
2372 ;;
2373 ;;   env-cc          = "(" 1*address ")" / nil
2374 ;;
2375 ;;   env-date        = nstring
2376 ;;
2377 ;;   env-from        = "(" 1*address ")" / nil
2378 ;;
2379 ;;   env-in-reply-to = nstring
2380 ;;
2381 ;;   env-message-id  = nstring
2382 ;;
2383 ;;   env-reply-to    = "(" 1*address ")" / nil
2384 ;;
2385 ;;   env-sender      = "(" 1*address ")" / nil
2386 ;;
2387 ;;   env-subject     = nstring
2388 ;;
2389 ;;   env-to          = "(" 1*address ")" / nil
2390
2391 (defun imap-parse-envelope ()
2392   (when (eq (char-after) ?\()
2393     (imap-forward)
2394     (vector (prog1 (imap-parse-nstring) ;; date
2395               (imap-forward))
2396             (prog1 (imap-parse-nstring) ;; subject
2397               (imap-forward))
2398             (prog1 (imap-parse-address-list) ;; from
2399               (imap-forward))
2400             (prog1 (imap-parse-address-list) ;; sender
2401               (imap-forward))
2402             (prog1 (imap-parse-address-list) ;; reply-to
2403               (imap-forward))
2404             (prog1 (imap-parse-address-list) ;; to
2405               (imap-forward))
2406             (prog1 (imap-parse-address-list) ;; cc
2407               (imap-forward))
2408             (prog1 (imap-parse-address-list) ;; bcc
2409               (imap-forward))
2410             (prog1 (imap-parse-nstring) ;; in-reply-to
2411               (imap-forward))
2412             (prog1 (imap-parse-nstring) ;; message-id
2413               (imap-forward)))))
2414
2415 ;;   body-fld-param  = "(" string SP string *(SP string SP string) ")" / nil
2416
2417 (defsubst imap-parse-string-list ()
2418   (cond ((eq (char-after) ?\() ;; body-fld-param
2419          (let (strlist str)
2420            (imap-forward)
2421            (while (setq str (imap-parse-string))
2422              (push str strlist)
2423              ;; buggy stalker communigate pro 3.0 doesn't print SPC
2424              ;; between body-fld-param's sometimes
2425              (or (eq (char-after) ?\")
2426                  (imap-forward)))
2427            (nreverse strlist)))
2428         ((imap-parse-nil)
2429          nil)))
2430
2431 ;;   body-extension  = nstring / number /
2432 ;;                      "(" body-extension *(SP body-extension) ")"
2433 ;;                       ; Future expansion.  Client implementations
2434 ;;                       ; MUST accept body-extension fields.  Server
2435 ;;                       ; implementations MUST NOT generate
2436 ;;                       ; body-extension fields except as defined by
2437 ;;                       ; future standard or standards-track
2438 ;;                       ; revisions of this specification.
2439
2440 (defun imap-parse-body-extension ()
2441   (if (eq (char-after) ?\()
2442       (let (b-e)
2443         (imap-forward)
2444         (push (imap-parse-body-extension) b-e)
2445         (while (eq (char-after) ?\ )
2446           (imap-forward)
2447           (push (imap-parse-body-extension) b-e))
2448         (assert (eq (char-after) ?\)) t "In imap-parse-body-extension")
2449         (imap-forward)
2450         (nreverse b-e))
2451     (or (imap-parse-number)
2452         (imap-parse-nstring))))
2453
2454 ;;   body-ext-1part  = body-fld-md5 [SP body-fld-dsp [SP body-fld-lang
2455 ;;                     *(SP body-extension)]]
2456 ;;                       ; MUST NOT be returned on non-extensible
2457 ;;                       ; "BODY" fetch
2458 ;;
2459 ;;   body-ext-mpart  = body-fld-param [SP body-fld-dsp [SP body-fld-lang
2460 ;;                     *(SP body-extension)]]
2461 ;;                       ; MUST NOT be returned on non-extensible
2462 ;;                       ; "BODY" fetch
2463
2464 (defsubst imap-parse-body-ext ()
2465   (let (ext)
2466     (when (eq (char-after) ?\ ) ;; body-fld-dsp
2467       (imap-forward)
2468       (let (dsp)
2469         (if (eq (char-after) ?\()
2470             (progn
2471               (imap-forward)
2472               (push (imap-parse-string) dsp)
2473               (imap-forward)
2474               (push (imap-parse-string-list) dsp)
2475               (imap-forward))
2476           (assert (imap-parse-nil) t "In imap-parse-body-ext"))
2477         (push (nreverse dsp) ext))
2478       (when (eq (char-after) ?\ ) ;; body-fld-lang
2479         (imap-forward)
2480         (if (eq (char-after) ?\()
2481             (push (imap-parse-string-list) ext)
2482           (push (imap-parse-nstring) ext))
2483         (while (eq (char-after) ?\ ) ;; body-extension
2484           (imap-forward)
2485           (setq ext (append (imap-parse-body-extension) ext)))))
2486     ext))
2487
2488 ;;   body            = "(" body-type-1part / body-type-mpart ")"
2489 ;;
2490 ;;   body-ext-1part  = body-fld-md5 [SP body-fld-dsp [SP body-fld-lang
2491 ;;                     *(SP body-extension)]]
2492 ;;                       ; MUST NOT be returned on non-extensible
2493 ;;                       ; "BODY" fetch
2494 ;;
2495 ;;   body-ext-mpart  = body-fld-param [SP body-fld-dsp [SP body-fld-lang
2496 ;;                     *(SP body-extension)]]
2497 ;;                       ; MUST NOT be returned on non-extensible
2498 ;;                       ; "BODY" fetch
2499 ;;
2500 ;;   body-fields     = body-fld-param SP body-fld-id SP body-fld-desc SP
2501 ;;                     body-fld-enc SP body-fld-octets
2502 ;;
2503 ;;   body-fld-desc   = nstring
2504 ;;
2505 ;;   body-fld-dsp    = "(" string SP body-fld-param ")" / nil
2506 ;;
2507 ;;   body-fld-enc    = (DQUOTE ("7BIT" / "8BIT" / "BINARY" / "BASE64"/
2508 ;;                     "QUOTED-PRINTABLE") DQUOTE) / string
2509 ;;
2510 ;;   body-fld-id     = nstring
2511 ;;
2512 ;;   body-fld-lang   = nstring / "(" string *(SP string) ")"
2513 ;;
2514 ;;   body-fld-lines  = number
2515 ;;
2516 ;;   body-fld-md5    = nstring
2517 ;;
2518 ;;   body-fld-octets = number
2519 ;;
2520 ;;   body-fld-param  = "(" string SP string *(SP string SP string) ")" / nil
2521 ;;
2522 ;;   body-type-1part = (body-type-basic / body-type-msg / body-type-text)
2523 ;;                     [SP body-ext-1part]
2524 ;;
2525 ;;   body-type-basic = media-basic SP body-fields
2526 ;;                       ; MESSAGE subtype MUST NOT be "RFC822"
2527 ;;
2528 ;;   body-type-msg   = media-message SP body-fields SP envelope
2529 ;;                     SP body SP body-fld-lines
2530 ;;
2531 ;;   body-type-text  = media-text SP body-fields SP body-fld-lines
2532 ;;
2533 ;;   body-type-mpart = 1*body SP media-subtype
2534 ;;                     [SP body-ext-mpart]
2535 ;;
2536 ;;   media-basic     = ((DQUOTE ("APPLICATION" / "AUDIO" / "IMAGE" /
2537 ;;                     "MESSAGE" / "VIDEO") DQUOTE) / string) SP media-subtype
2538 ;;                       ; Defined in [MIME-IMT]
2539 ;;
2540 ;;   media-message   = DQUOTE "MESSAGE" DQUOTE SP DQUOTE "RFC822" DQUOTE
2541 ;;                      ; Defined in [MIME-IMT]
2542 ;;
2543 ;;   media-subtype   = string
2544 ;;                       ; Defined in [MIME-IMT]
2545 ;;
2546 ;;   media-text      = DQUOTE "TEXT" DQUOTE SP media-subtype
2547 ;;                       ; Defined in [MIME-IMT]
2548
2549 (defun imap-parse-body ()
2550   (let (body)
2551     (when (eq (char-after) ?\()
2552       (imap-forward)
2553       (if (eq (char-after) ?\()
2554           (let (subbody)
2555             (while (and (eq (char-after) ?\()
2556                         (setq subbody (imap-parse-body)))
2557              ;; buggy stalker communigate pro 3.0 insert a SPC between
2558               ;; parts in multiparts
2559               (when (and (eq (char-after) ?\ )
2560                          (eq (char-after (1+ (point))) ?\())
2561                 (imap-forward))
2562               (push subbody body))
2563             (imap-forward)
2564             (push (imap-parse-string) body) ;; media-subtype
2565             (when (eq (char-after) ?\ ) ;; body-ext-mpart:
2566               (imap-forward)
2567               (if (eq (char-after) ?\() ;; body-fld-param
2568                   (push (imap-parse-string-list) body)
2569                 (push (and (imap-parse-nil) nil) body))
2570               (setq body
2571                     (append (imap-parse-body-ext) body))) ;; body-ext-...
2572             (assert (eq (char-after) ?\)) t "In imap-parse-body")
2573             (imap-forward)
2574             (nreverse body))
2575
2576         (push (imap-parse-string) body) ;; media-type
2577         (imap-forward)
2578         (push (imap-parse-string) body) ;; media-subtype
2579         (imap-forward)
2580         ;; next line for Sun SIMS bug
2581         (and (eq (char-after) ? ) (imap-forward))
2582         (if (eq (char-after) ?\() ;; body-fld-param
2583             (push (imap-parse-string-list) body)
2584           (push (and (imap-parse-nil) nil) body))
2585         (imap-forward)
2586         (push (imap-parse-nstring) body) ;; body-fld-id
2587         (imap-forward)
2588         (push (imap-parse-nstring) body) ;; body-fld-desc
2589         (imap-forward)
2590         ;; next `or' for Sun SIMS bug, it regard body-fld-enc as a
2591         ;; nstring and return nil instead of defaulting back to 7BIT
2592         ;; as the standard says.
2593         (push (or (imap-parse-nstring) "7BIT") body) ;; body-fld-enc
2594         (imap-forward)
2595         (push (imap-parse-number) body) ;; body-fld-octets
2596
2597    ;; ok, we're done parsing the required parts, what comes now is one
2598         ;; of three things:
2599         ;;
2600         ;; envelope       (then we're parsing body-type-msg)
2601         ;; body-fld-lines (then we're parsing body-type-text)
2602         ;; body-ext-1part (then we're parsing body-type-basic)
2603         ;;
2604   ;; the problem is that the two first are in turn optionally followed
2605 ;; by the third.  So we parse the first two here (if there are any)...
2606
2607         (when (eq (char-after) ?\ )
2608           (imap-forward)
2609           (let (lines)
2610             (cond ((eq (char-after) ?\() ;; body-type-msg:
2611                    (push (imap-parse-envelope) body) ;; envelope
2612                    (imap-forward)
2613                    (push (imap-parse-body) body) ;; body
2614                    ;; buggy stalker communigate pro 3.0 doesn't print
2615                    ;; number of lines in message/rfc822 attachment
2616                    (if (eq (char-after) ?\))
2617                        (push 0 body)
2618                      (imap-forward)
2619                      (push (imap-parse-number) body))) ;; body-fld-lines
2620                   ((setq lines (imap-parse-number)) ;; body-type-text:
2621                    (push lines body)) ;; body-fld-lines
2622                   (t
2623                    (backward-char))))) ;; no match...
2624
2625         ;; ...and then parse the third one here...
2626
2627         (when (eq (char-after) ?\ ) ;; body-ext-1part:
2628           (imap-forward)
2629           (push (imap-parse-nstring) body) ;; body-fld-md5
2630           (setq body (append (imap-parse-body-ext) body))) ;; body-ext-1part..
2631
2632         (assert (eq (char-after) ?\)) t "In imap-parse-body 2")
2633         (imap-forward)
2634         (nreverse body)))))
2635
2636 (when imap-debug                        ; (untrace-all)
2637   (require 'trace)
2638   (buffer-disable-undo (get-buffer-create imap-debug-buffer))
2639   (mapcar (lambda (f) (trace-function-background f imap-debug-buffer))
2640           '(
2641             imap-read-passwd
2642             imap-utf7-encode
2643             imap-utf7-decode
2644             imap-error-text
2645             imap-kerberos4s-p
2646             imap-kerberos4-open
2647             imap-ssl-p
2648             imap-ssl-open
2649             imap-network-p
2650             imap-network-open
2651             imap-interactive-login
2652             imap-kerberos4a-p
2653             imap-kerberos4-auth
2654             imap-cram-md5-p
2655             imap-cram-md5-auth
2656             imap-login-p
2657             imap-login-auth
2658             imap-anonymous-p
2659             imap-anonymous-auth
2660             imap-open-1
2661             imap-open
2662             imap-opened
2663             imap-authenticate
2664             imap-close
2665             imap-capability
2666             imap-namespace
2667             imap-send-command-wait
2668             imap-mailbox-put
2669             imap-mailbox-get
2670             imap-mailbox-map-1
2671             imap-mailbox-map
2672             imap-current-mailbox
2673             imap-current-mailbox-p-1
2674             imap-current-mailbox-p
2675             imap-mailbox-select-1
2676             imap-mailbox-select
2677             imap-mailbox-examine-1
2678             imap-mailbox-examine
2679             imap-mailbox-unselect
2680             imap-mailbox-expunge
2681             imap-mailbox-close
2682             imap-mailbox-create-1
2683             imap-mailbox-create
2684             imap-mailbox-delete
2685             imap-mailbox-rename
2686             imap-mailbox-lsub
2687             imap-mailbox-list
2688             imap-mailbox-subscribe
2689             imap-mailbox-unsubscribe
2690             imap-mailbox-status
2691             imap-mailbox-acl-get
2692             imap-mailbox-acl-set
2693             imap-mailbox-acl-delete
2694             imap-current-message
2695             imap-list-to-message-set
2696             imap-fetch-asynch
2697             imap-fetch
2698             imap-message-put
2699             imap-message-get
2700             imap-message-map
2701             imap-search
2702             imap-message-flag-permanent-p
2703             imap-message-flags-set
2704             imap-message-flags-del
2705             imap-message-flags-add
2706             imap-message-copyuid-1
2707             imap-message-copyuid
2708             imap-message-copy
2709             imap-message-appenduid-1
2710             imap-message-appenduid
2711             imap-message-append
2712             imap-body-lines
2713             imap-envelope-from
2714             imap-send-command-1
2715             imap-send-command
2716             imap-wait-for-tag
2717             imap-sentinel
2718             imap-find-next-line
2719             imap-arrival-filter
2720             imap-parse-greeting
2721             imap-parse-response
2722             imap-parse-resp-text
2723             imap-parse-resp-text-code
2724             imap-parse-data-list
2725             imap-parse-fetch
2726             imap-parse-status
2727             imap-parse-acl
2728             imap-parse-flag-list
2729             imap-parse-envelope
2730             imap-parse-body-extension
2731             imap-parse-body
2732             )))
2733
2734 (provide 'imap)
2735
2736 ;;; imap.el ends here