1 ;;; imap.el --- imap library
3 ;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007 Free Software Foundation, Inc.
6 ;; Author: Simon Josefsson <jas@pdc.kth.se>
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 3, or (at your option)
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, USA.
28 ;; imap.el is a elisp library providing an interface for talking to
31 ;; imap.el is roughly divided in two parts, one that parses IMAP
32 ;; responses from the server and storing data into buffer-local
33 ;; variables, and one for utility functions which send commands to
34 ;; server, waits for an answer, and return information. The latter
35 ;; part is layered on top of the previous.
37 ;; The imap.el API consist of the following functions, other functions
38 ;; in this file should not be called directly and the result of doing
39 ;; so are at best undefined.
43 ;; imap-open, imap-opened, imap-authenticate, imap-close,
44 ;; imap-capability, imap-namespace, imap-error-text
48 ;; imap-mailbox-get, imap-mailbox-map, imap-current-mailbox,
49 ;; imap-current-mailbox-p, imap-search, imap-mailbox-select,
50 ;; imap-mailbox-examine, imap-mailbox-unselect, imap-mailbox-expunge
51 ;; imap-mailbox-close, imap-mailbox-create, imap-mailbox-delete
52 ;; imap-mailbox-rename, imap-mailbox-lsub, imap-mailbox-list
53 ;; imap-mailbox-subscribe, imap-mailbox-unsubscribe, imap-mailbox-status
54 ;; imap-mailbox-acl-get, imap-mailbox-acl-set, imap-mailbox-acl-delete
58 ;; imap-fetch-asynch, imap-fetch,
59 ;; imap-current-message, imap-list-to-message-set,
60 ;; imap-message-get, imap-message-map
61 ;; imap-message-envelope-date, imap-message-envelope-subject,
62 ;; imap-message-envelope-from, imap-message-envelope-sender,
63 ;; imap-message-envelope-reply-to, imap-message-envelope-to,
64 ;; imap-message-envelope-cc, imap-message-envelope-bcc
65 ;; imap-message-envelope-in-reply-to, imap-message-envelope-message-id
66 ;; imap-message-body, imap-message-flag-permanent-p
67 ;; imap-message-flags-set, imap-message-flags-del
68 ;; imap-message-flags-add, imap-message-copyuid
69 ;; imap-message-copy, imap-message-appenduid
70 ;; imap-message-append, imap-envelope-from
73 ;; It is my hope that these commands should be pretty self
74 ;; explanatory for someone that know IMAP. All functions have
75 ;; additional documentation on how to invoke them.
77 ;; imap.el support RFC1730/2060/RFC3501 (IMAP4/IMAP4rev1), implemented
78 ;; IMAP extensions are RFC2195 (CRAM-MD5), RFC2086 (ACL), RFC2342
79 ;; (NAMESPACE), RFC2359 (UIDPLUS), the IMAP-part of RFC2595 (STARTTLS,
80 ;; LOGINDISABLED) (with use of external library starttls.el and
81 ;; program starttls), and the GSSAPI / kerberos V4 sections of RFC1731
82 ;; (with use of external program `imtest'), RFC2971 (ID). It also
83 ;; takes advantage of the UNSELECT extension in Cyrus IMAPD.
85 ;; Without the work of John McClary Prevost and Jim Radford this library
86 ;; would not have seen the light of day. Many thanks.
88 ;; This is a transcript of short interactive session for demonstration
91 ;; (imap-open "my.mail.server")
92 ;; => " *imap* my.mail.server:0"
94 ;; The rest are invoked with current buffer as the buffer returned by
95 ;; `imap-open'. It is possible to do all without this, but it would
96 ;; look ugly here since `buffer' is always the last argument for all
97 ;; imap.el API functions.
99 ;; (imap-authenticate "myusername" "mypassword")
102 ;; (imap-mailbox-lsub "*")
103 ;; => ("INBOX.sentmail" "INBOX.private" "INBOX.draft" "INBOX.spam")
105 ;; (imap-mailbox-list "INBOX.n%")
106 ;; => ("INBOX.namedroppers" "INBOX.nnimap" "INBOX.ntbugtraq")
108 ;; (imap-mailbox-select "INBOX.nnimap")
111 ;; (imap-mailbox-get 'exists)
114 ;; (imap-mailbox-get 'uidvalidity)
117 ;; (imap-search "FLAGGED SINCE 18-DEC-98")
120 ;; (imap-fetch 235 "RFC822.PEEK" 'RFC822)
121 ;; => "X-Sieve: cmu-sieve 1.3^M\nX-Username: <jas@pdc.kth.se>^M\r...."
125 ;; o Parse UIDs as strings? We need to overcome the 28 bit limit somehow.
126 ;; o Don't use `read' at all (important places already fixed)
127 ;; o Accept list of articles instead of message set string in most
128 ;; imap-message-* functions.
129 ;; o Send strings as literal if they contain, e.g., ".
133 ;; - 19991218 added starttls/digest-md5 patch,
134 ;; by Daiki Ueno <ueno@ueda.info.waseda.ac.jp>
135 ;; NB! you need SLIM for starttls.el and digest-md5.el
136 ;; - 19991023 commited to pgnus
141 (eval-when-compile (require 'cl))
143 (unless (fboundp 'declare-function) (defmacro declare-function (&rest r)))
144 (autoload 'starttls-open-stream "starttls")
145 (autoload 'starttls-negotiate "starttls")
146 (autoload 'sasl-find-mechanism "sasl")
147 (autoload 'digest-md5-parse-digest-challenge "digest-md5")
148 (autoload 'digest-md5-digest-response "digest-md5")
149 (autoload 'digest-md5-digest-uri "digest-md5")
150 (autoload 'digest-md5-challenge "digest-md5")
151 (autoload 'rfc2104-hash "rfc2104")
152 (autoload 'utf7-encode "utf7")
153 (autoload 'utf7-decode "utf7")
154 (autoload 'format-spec "format-spec")
155 (autoload 'format-spec-make "format-spec")
156 (autoload 'open-tls-stream "tls"))
161 "Low-level IMAP issues."
165 (defcustom imap-kerberos4-program '("imtest -m kerberos_v4 -u %l -p %p %s"
167 "List of strings containing commands for Kerberos 4 authentication.
168 %s is replaced with server hostname, %p with port to connect to, and
169 %l with the value of `imap-default-user'. The program should accept
170 IMAP commands on stdin and return responses to stdout. Each entry in
171 the list is tried until a successful connection is made."
173 :type '(repeat string))
175 (defcustom imap-gssapi-program (list
176 (concat "gsasl %s %p "
177 "--mechanism GSSAPI "
178 "--authentication-id %l")
179 "imtest -m gssapi -u %l -p %p %s")
180 "List of strings containing commands for GSSAPI (krb5) authentication.
181 %s is replaced with server hostname, %p with port to connect to, and
182 %l with the value of `imap-default-user'. The program should accept
183 IMAP commands on stdin and return responses to stdout. Each entry in
184 the list is tried until a successful connection is made."
186 :type '(repeat string))
188 (defcustom imap-ssl-program '("openssl s_client -quiet -ssl3 -connect %s:%p"
189 "openssl s_client -quiet -ssl2 -connect %s:%p"
190 "s_client -quiet -ssl3 -connect %s:%p"
191 "s_client -quiet -ssl2 -connect %s:%p")
192 "A string, or list of strings, containing commands for SSL connections.
193 Within a string, %s is replaced with the server address and %p with
194 port number on server. The program should accept IMAP commands on
195 stdin and return responses to stdout. Each entry in the list is tried
196 until a successful connection is made."
198 :type '(choice string
201 (defcustom imap-shell-program '("ssh %s imapd"
203 "ssh %g ssh %s imapd"
204 "rsh %g rsh %s imapd")
205 "A list of strings, containing commands for IMAP connection.
206 Within a string, %s is replaced with the server address, %p with port
207 number on server, %g with `imap-shell-host', and %l with
208 `imap-default-user'. The program should read IMAP commands from stdin
209 and write IMAP response to stdout. Each entry in the list is tried
210 until a successful connection is made."
212 :type '(repeat string))
214 (defcustom imap-process-connection-type nil
215 "*Value for `process-connection-type' to use for Kerberos4, GSSAPI and SSL.
216 The `process-connection-type' variable control type of device
217 used to communicate with subprocesses. Values are nil to use a
218 pipe, or t or `pty' to use a pty. The value has no effect if the
219 system has no ptys or if all ptys are busy: then a pipe is used
220 in any case. The value takes effect when a IMAP server is
221 opened, changing it after that has no effect."
226 (defcustom imap-use-utf7 t
227 "If non-nil, do utf7 encoding/decoding of mailbox names.
228 Since the UTF7 decoding currently only decodes into ISO-8859-1
229 characters, you may disable this decoding if you need to access UTF7
230 encoded mailboxes which doesn't translate into ISO-8859-1."
234 (defcustom imap-log nil
235 "If non-nil, a imap session trace is placed in *imap-log* buffer.
236 Note that username, passwords and other privacy sensitive
237 information (such as e-mail) may be stored in the *imap-log*
238 buffer. It is not written to disk, however. Do not enable this
239 variable unless you are comfortable with that."
243 (defcustom imap-debug nil
244 "If non-nil, random debug spews are placed in *imap-debug* buffer.
245 Note that username, passwords and other privacy sensitive
246 information (such as e-mail) may be stored in the *imap-debug*
247 buffer. It is not written to disk, however. Do not enable this
248 variable unless you are comfortable with that."
252 (defcustom imap-shell-host "gateway"
253 "Hostname of rlogin proxy."
257 (defcustom imap-default-user (user-login-name)
258 "Default username to use."
262 (defcustom imap-read-timeout (if (string-match
263 "windows-nt\\|os/2\\|emx\\|cygwin"
264 (symbol-name system-type))
267 "*How long to wait between checking for the end of output.
268 Shorter values mean quicker response, but is more CPU intensive."
272 (defcustom imap-store-password nil
273 "If non-nil, store session password without promting."
277 ;; Various variables.
279 (defvar imap-fetch-data-hook nil
280 "Hooks called after receiving each FETCH response.")
282 (defvar imap-streams '(gssapi kerberos4 starttls tls ssl network shell)
283 "Priority of streams to consider when opening connection to server.")
285 (defvar imap-stream-alist
286 '((gssapi imap-gssapi-stream-p imap-gssapi-open)
287 (kerberos4 imap-kerberos4-stream-p imap-kerberos4-open)
288 (tls imap-tls-p imap-tls-open)
289 (ssl imap-ssl-p imap-ssl-open)
290 (network imap-network-p imap-network-open)
291 (shell imap-shell-p imap-shell-open)
292 (starttls imap-starttls-p imap-starttls-open))
293 "Definition of network streams.
297 NAME names the stream, CHECK is a function returning non-nil if the
298 server support the stream and OPEN is a function for opening the
301 (defvar imap-authenticators '(gssapi
308 "Priority of authenticators to consider when authenticating to server.")
310 (defvar imap-authenticator-alist
311 '((gssapi imap-gssapi-auth-p imap-gssapi-auth)
312 (kerberos4 imap-kerberos4-auth-p imap-kerberos4-auth)
313 (sasl imap-sasl-auth-p imap-sasl-auth)
314 (cram-md5 imap-cram-md5-p imap-cram-md5-auth)
315 (login imap-login-p imap-login-auth)
316 (anonymous imap-anonymous-p imap-anonymous-auth)
317 (digest-md5 imap-digest-md5-p imap-digest-md5-auth))
318 "Definition of authenticators.
320 \(NAME CHECK AUTHENTICATE)
322 NAME names the authenticator. CHECK is a function returning non-nil if
323 the server support the authenticator and AUTHENTICATE is a function
324 for doing the actual authentication.")
326 (defvar imap-error nil
327 "Error codes from the last command.")
329 (defvar imap-logout-timeout nil
330 "Close server immediately if it can't logout in this number of seconds.
331 If it is nil, never close server until logout completes. Normally,
332 the value of this variable will be bound to a certain value to which
333 an application program that uses this module specifies on a per-server
336 ;; Internal constants. Change these and die.
338 (defconst imap-default-port 143)
339 (defconst imap-default-ssl-port 993)
340 (defconst imap-default-tls-port 993)
341 (defconst imap-default-stream 'network)
342 (defconst imap-coding-system-for-read 'binary)
343 (defconst imap-coding-system-for-write 'binary)
344 (defconst imap-local-variables '(imap-server
353 imap-current-target-mailbox
363 imap-calculate-literal-size-first
365 (defconst imap-log-buffer "*imap-log*")
366 (defconst imap-debug-buffer "*imap-debug*")
368 ;; Internal variables.
370 (defvar imap-stream nil)
371 (defvar imap-auth nil)
372 (defvar imap-server nil)
373 (defvar imap-port nil)
374 (defvar imap-username nil)
375 (defvar imap-password nil)
376 (defvar imap-calculate-literal-size-first nil)
377 (defvar imap-state 'closed
379 Valid states are `closed', `initial', `nonauth', `auth', `selected'
382 (defvar imap-server-eol "\r\n"
383 "The EOL string sent from the server.")
385 (defvar imap-client-eol "\r\n"
386 "The EOL string we send to the server.")
388 (defvar imap-current-mailbox nil
389 "Current mailbox name.")
391 (defvar imap-current-target-mailbox nil
392 "Current target mailbox for COPY and APPEND commands.")
394 (defvar imap-mailbox-data nil
395 "Obarray with mailbox data.")
397 (defvar imap-mailbox-prime 997
398 "Length of imap-mailbox-data.")
400 (defvar imap-current-message nil
401 "Current message number.")
403 (defvar imap-message-data nil
404 "Obarray with message data.")
406 (defvar imap-message-prime 997
407 "Length of imap-message-data.")
409 (defvar imap-capability nil
410 "Capability for server.")
416 (defvar imap-namespace nil
417 "Namespace for current server.")
419 (defvar imap-reached-tag 0
420 "Lower limit on command tags that have been parsed.")
422 (defvar imap-failed-tags nil
423 "Alist of tags that failed.
424 Each element is a list with four elements; tag (a integer), response
425 state (a symbol, `OK', `NO' or `BAD'), response code (a string), and
426 human readable response text (a string).")
429 "Command tag number.")
431 (defvar imap-process nil
434 (defvar imap-continuation nil
435 "Non-nil indicates that the server emitted a continuation request.
436 The actual value is really the text on the continuation line.")
438 (defvar imap-callbacks nil
439 "List of response tags and callbacks, on the form `(number . function)'.
440 The function should take two arguments, the first the IMAP tag and the
441 second the status (OK, NO, BAD etc) of the command.")
444 ;; Utility functions:
446 (defun imap-remassoc (key alist)
447 "Delete by side effect any elements of LIST whose car is `equal' to KEY.
448 The modified LIST is returned. If the first member
449 of LIST has a car that is `equal' to KEY, there is no way to remove it
450 by side effect; therefore, write `(setq foo (remassoc key foo))' to be
451 sure of changing the value of `foo'."
453 (if (equal key (caar alist))
455 (setcdr alist (imap-remassoc key (cdr alist)))
458 (defsubst imap-disable-multibyte ()
459 "Enable multibyte in the current buffer."
460 (when (fboundp 'set-buffer-multibyte)
461 (set-buffer-multibyte nil)))
463 (defsubst imap-utf7-encode (string)
467 (utf7-encode string t)
469 "imap: Could not UTF7 encode `%s', using it unencoded..."
474 (defsubst imap-utf7-decode (string)
478 (utf7-decode string t)
480 "imap: Could not UTF7 decode `%s', using it undecoded..."
485 (defsubst imap-ok-p (status)
488 (setq imap-error status)
491 (defun imap-error-text (&optional buffer)
492 (with-current-buffer (or buffer (current-buffer))
493 (nth 3 (car imap-failed-tags))))
496 ;; Server functions; stream stuff:
498 (defun imap-kerberos4-stream-p (buffer)
499 (imap-capability 'AUTH=KERBEROS_V4 buffer))
501 (defun imap-kerberos4-open (name buffer server port)
502 (let ((cmds imap-kerberos4-program)
504 (while (and (not done) (setq cmd (pop cmds)))
505 (message "Opening Kerberos 4 IMAP connection with `%s'..." cmd)
507 (let* ((port (or port imap-default-port))
508 (coding-system-for-read imap-coding-system-for-read)
509 (coding-system-for-write imap-coding-system-for-write)
510 (process-connection-type imap-process-connection-type)
511 (process (start-process
512 name buffer shell-file-name shell-command-switch
517 ?p (number-to-string port)
518 ?l imap-default-user))))
521 (with-current-buffer buffer
522 (setq imap-client-eol "\n"
523 imap-calculate-literal-size-first t)
524 (while (and (memq (process-status process) '(open run))
525 (set-buffer buffer) ;; XXX "blue moon" nntp.el bug
526 (goto-char (point-min))
527 ;; Athena IMTEST can output SSL verify errors
528 (or (while (looking-at "^verify error:num=")
531 (or (while (looking-at "^TLS connection established")
534 ;; cyrus 1.6.x (13? < x <= 22) queries capabilities
535 (or (while (looking-at "^C:")
538 ;; cyrus 1.6 imtest print "S: " before server greeting
539 (or (not (looking-at "S: "))
542 (not (and (imap-parse-greeting)
543 ;; success in imtest < 1.6:
544 (or (re-search-forward
545 "^__\\(.*\\)__\n" nil t)
546 ;; success in imtest 1.6:
548 "^\\(Authenticat.*\\)" nil t))
549 (setq response (match-string 1)))))
550 (accept-process-output process 1)
553 (with-current-buffer (get-buffer-create imap-log-buffer)
554 (imap-disable-multibyte)
555 (buffer-disable-undo)
556 (goto-char (point-max))
557 (insert-buffer-substring buffer)))
559 (message "Opening Kerberos 4 IMAP connection with `%s'...%s" cmd
560 (if response (concat "done, " response) "failed"))
561 (if (and response (let ((case-fold-search nil))
562 (not (string-match "failed" response))))
564 (if (memq (process-status process) '(open run))
566 (delete-process process)
570 (defun imap-gssapi-stream-p (buffer)
571 (imap-capability 'AUTH=GSSAPI buffer))
573 (defun imap-gssapi-open (name buffer server port)
574 (let ((cmds imap-gssapi-program)
576 (while (and (not done) (setq cmd (pop cmds)))
577 (message "Opening GSSAPI IMAP connection with `%s'..." cmd)
579 (let* ((port (or port imap-default-port))
580 (coding-system-for-read imap-coding-system-for-read)
581 (coding-system-for-write imap-coding-system-for-write)
582 (process-connection-type imap-process-connection-type)
583 (process (start-process
584 name buffer shell-file-name shell-command-switch
589 ?p (number-to-string port)
590 ?l imap-default-user))))
593 (with-current-buffer buffer
594 (setq imap-client-eol "\n"
595 imap-calculate-literal-size-first t)
596 (while (and (memq (process-status process) '(open run))
597 (set-buffer buffer) ;; XXX "blue moon" nntp.el bug
598 (goto-char (point-min))
599 ;; Athena IMTEST can output SSL verify errors
600 (or (while (looking-at "^verify error:num=")
603 (or (while (looking-at "^TLS connection established")
606 ;; cyrus 1.6.x (13? < x <= 22) queries capabilities
607 (or (while (looking-at "^C:")
610 ;; cyrus 1.6 imtest print "S: " before server greeting
611 (or (not (looking-at "S: "))
614 ;; GNU SASL may print 'Trying ...' first.
615 (or (not (looking-at "Trying "))
618 (not (and (imap-parse-greeting)
619 ;; success in imtest 1.6:
621 (concat "^\\(\\(Authenticat.*\\)\\|\\("
622 "Client authentication "
625 (setq response (match-string 1)))))
626 (accept-process-output process 1)
629 (with-current-buffer (get-buffer-create imap-log-buffer)
630 (imap-disable-multibyte)
631 (buffer-disable-undo)
632 (goto-char (point-max))
633 (insert-buffer-substring buffer)))
635 (message "GSSAPI IMAP connection: %s" (or response "failed"))
636 (if (and response (let ((case-fold-search nil))
637 (not (string-match "failed" response))))
639 (if (memq (process-status process) '(open run))
641 (delete-process process)
645 (defun imap-ssl-p (buffer)
648 (defun imap-ssl-open (name buffer server port)
649 "Open a SSL connection to server."
650 (let ((cmds (if (listp imap-ssl-program) imap-ssl-program
651 (list imap-ssl-program)))
653 (while (and (not done) (setq cmd (pop cmds)))
654 (message "imap: Opening SSL connection with `%s'..." cmd)
656 (let* ((port (or port imap-default-ssl-port))
657 (coding-system-for-read imap-coding-system-for-read)
658 (coding-system-for-write imap-coding-system-for-write)
659 (process-connection-type imap-process-connection-type)
660 (set-process-query-on-exit-flag
661 (if (fboundp 'set-process-query-on-exit-flag)
662 'set-process-query-on-exit-flag
663 'process-kill-without-query))
666 (setq process (start-process
667 name buffer shell-file-name
672 ?p (number-to-string port)))))
673 (funcall set-process-query-on-exit-flag process nil)
675 (with-current-buffer buffer
676 (goto-char (point-min))
677 (while (and (memq (process-status process) '(open run))
678 (set-buffer buffer) ;; XXX "blue moon" nntp.el bug
679 (goto-char (point-max))
681 (not (imap-parse-greeting)))
682 (accept-process-output process 1)
685 (with-current-buffer (get-buffer-create imap-log-buffer)
686 (imap-disable-multibyte)
687 (buffer-disable-undo)
688 (goto-char (point-max))
689 (insert-buffer-substring buffer)))
691 (when (memq (process-status process) '(open run))
692 (setq done process))))))
695 (message "imap: Opening SSL connection with `%s'...done" cmd)
697 (message "imap: Opening SSL connection with `%s'...failed" cmd)
700 (defun imap-tls-p (buffer)
703 (defun imap-tls-open (name buffer server port)
704 (let* ((port (or port imap-default-tls-port))
705 (coding-system-for-read imap-coding-system-for-read)
706 (coding-system-for-write imap-coding-system-for-write)
707 (process (open-tls-stream name buffer server port)))
709 (while (and (memq (process-status process) '(open run))
710 (set-buffer buffer) ;; XXX "blue moon" nntp.el bug
711 (goto-char (point-max))
713 (not (imap-parse-greeting)))
714 (accept-process-output process 1)
717 (with-current-buffer (get-buffer-create imap-log-buffer)
718 (imap-disable-multibyte)
719 (buffer-disable-undo)
720 (goto-char (point-max))
721 (insert-buffer-substring buffer)))
722 (when (memq (process-status process) '(open run))
725 (defun imap-network-p (buffer)
728 (defun imap-network-open (name buffer server port)
729 (let* ((port (or port imap-default-port))
730 (coding-system-for-read imap-coding-system-for-read)
731 (coding-system-for-write imap-coding-system-for-write)
732 (process (open-network-stream name buffer server port)))
734 (while (and (memq (process-status process) '(open run))
735 (set-buffer buffer) ;; XXX "blue moon" nntp.el bug
736 (goto-char (point-min))
737 (not (imap-parse-greeting)))
738 (accept-process-output process 1)
741 (with-current-buffer (get-buffer-create imap-log-buffer)
742 (imap-disable-multibyte)
743 (buffer-disable-undo)
744 (goto-char (point-max))
745 (insert-buffer-substring buffer)))
746 (when (memq (process-status process) '(open run))
749 (defun imap-shell-p (buffer)
752 (defun imap-shell-open (name buffer server port)
753 (let ((cmds (if (listp imap-shell-program) imap-shell-program
754 (list imap-shell-program)))
756 (while (and (not done) (setq cmd (pop cmds)))
757 (message "imap: Opening IMAP connection with `%s'..." cmd)
758 (setq imap-client-eol "\n")
759 (let* ((port (or port imap-default-port))
760 (coding-system-for-read imap-coding-system-for-read)
761 (coding-system-for-write imap-coding-system-for-write)
762 (process (start-process
763 name buffer shell-file-name shell-command-switch
769 ?p (number-to-string port)
770 ?l imap-default-user)))))
772 (while (and (memq (process-status process) '(open run))
773 (set-buffer buffer) ;; XXX "blue moon" nntp.el bug
774 (goto-char (point-max))
776 (not (imap-parse-greeting)))
777 (accept-process-output process 1)
780 (with-current-buffer (get-buffer-create imap-log-buffer)
781 (imap-disable-multibyte)
782 (buffer-disable-undo)
783 (goto-char (point-max))
784 (insert-buffer-substring buffer)))
786 (when (memq (process-status process) '(open run))
787 (setq done process)))))
790 (message "imap: Opening IMAP connection with `%s'...done" cmd)
792 (message "imap: Opening IMAP connection with `%s'...failed" cmd)
795 (defun imap-starttls-p (buffer)
796 (imap-capability 'STARTTLS buffer))
798 (defun imap-starttls-open (name buffer server port)
799 (let* ((port (or port imap-default-port))
800 (coding-system-for-read imap-coding-system-for-read)
801 (coding-system-for-write imap-coding-system-for-write)
802 (process (starttls-open-stream name buffer server port))
804 (message "imap: Connecting with STARTTLS...")
806 (while (and (memq (process-status process) '(open run))
807 (set-buffer buffer) ;; XXX "blue moon" nntp.el bug
808 (goto-char (point-max))
810 (not (imap-parse-greeting)))
811 (accept-process-output process 1)
813 (imap-send-command "STARTTLS")
814 (while (and (memq (process-status process) '(open run))
815 (set-buffer buffer) ;; XXX "blue moon" nntp.el bug
816 (goto-char (point-max))
818 (not (re-search-forward "[0-9]+ OK.*\r?\n" nil t)))
819 (accept-process-output process 1)
822 (with-current-buffer (get-buffer-create imap-log-buffer)
823 (buffer-disable-undo)
824 (goto-char (point-max))
825 (insert-buffer-substring buffer)))
826 (when (and (setq tls-info (starttls-negotiate process))
827 (memq (process-status process) '(open run)))
828 (setq done process)))
829 (if (stringp tls-info)
830 (message "imap: STARTTLS info: %s" tls-info))
831 (message "imap: Connecting with STARTTLS...%s" (if done "done" "failed"))
834 ;; Server functions; authenticator stuff:
836 (defun imap-interactive-login (buffer loginfunc)
837 "Login to server in BUFFER.
838 LOGINFUNC is passed a username and a password, it should return t if
839 it where successful authenticating itself to the server, nil otherwise.
840 Returns t if login was successful, nil otherwise."
841 (with-current-buffer buffer
842 (make-local-variable 'imap-username)
843 (make-local-variable 'imap-password)
844 (let (user passwd ret)
845 ;; (condition-case ()
846 (while (or (not user) (not passwd))
847 (setq user (or imap-username
848 (read-from-minibuffer
849 (concat "IMAP username for " imap-server
850 " (using stream `" (symbol-name imap-stream)
852 (or user imap-default-user))))
853 (setq passwd (or imap-password
855 (concat "IMAP password for " user "@"
856 imap-server " (using authenticator `"
857 (symbol-name imap-auth) "'): "))))
858 (when (and user passwd)
859 (if (funcall loginfunc user passwd)
863 (when (and (not imap-password)
864 (or imap-store-password
865 (y-or-n-p "Store password for this session? ")))
866 (setq imap-password passwd)))
867 (message "Login failed...")
869 (setq imap-password nil)
871 ;; (quit (with-current-buffer buffer
874 ;; (error (with-current-buffer buffer
879 (defun imap-gssapi-auth-p (buffer)
880 (eq imap-stream 'gssapi))
882 (defun imap-gssapi-auth (buffer)
883 (message "imap: Authenticating using GSSAPI...%s"
884 (if (eq imap-stream 'gssapi) "done" "failed"))
885 (eq imap-stream 'gssapi))
887 (defun imap-kerberos4-auth-p (buffer)
888 (and (imap-capability 'AUTH=KERBEROS_V4 buffer)
889 (eq imap-stream 'kerberos4)))
891 (defun imap-kerberos4-auth (buffer)
892 (message "imap: Authenticating using Kerberos 4...%s"
893 (if (eq imap-stream 'kerberos4) "done" "failed"))
894 (eq imap-stream 'kerberos4))
896 (defun imap-cram-md5-p (buffer)
897 (imap-capability 'AUTH=CRAM-MD5 buffer))
899 (defun imap-cram-md5-auth (buffer)
900 "Login to server using the AUTH CRAM-MD5 method."
901 (message "imap: Authenticating using CRAM-MD5...")
902 (let ((done (imap-interactive-login
904 (lambda (user passwd)
906 (imap-send-command-wait
908 "AUTHENTICATE CRAM-MD5"
910 (let* ((decoded (base64-decode-string challenge))
911 (hash (rfc2104-hash 'md5 64 16 passwd decoded))
912 (response (concat user " " hash))
913 (encoded (base64-encode-string response)))
916 (message "imap: Authenticating using CRAM-MD5...done")
917 (message "imap: Authenticating using CRAM-MD5...failed"))))
919 (defun imap-login-p (buffer)
920 (and (not (imap-capability 'LOGINDISABLED buffer))
921 (not (imap-capability 'X-LOGIN-CMD-DISABLED buffer))))
923 (defun imap-quote-specials (string)
926 (goto-char (point-min))
927 (while (re-search-forward "[\\\"]" nil t)
933 (defun imap-login-auth (buffer)
934 "Login to server using the LOGIN command."
935 (message "imap: Plaintext authentication...")
936 (imap-interactive-login buffer
937 (lambda (user passwd)
938 (imap-ok-p (imap-send-command-wait
940 (imap-quote-specials user)
942 (imap-quote-specials passwd)
945 (defun imap-anonymous-p (buffer)
948 (defun imap-anonymous-auth (buffer)
949 (message "imap: Logging in anonymously...")
950 (with-current-buffer buffer
951 (imap-ok-p (imap-send-command-wait
952 (concat "LOGIN anonymous \"" (concat (user-login-name) "@"
953 (system-name)) "\"")))))
955 ;;; Compiler directives.
957 (defvar imap-sasl-client)
958 (defvar imap-sasl-step)
960 (defun imap-sasl-make-mechanisms (buffer)
963 (let ((name (symbol-name sym)))
964 (if (and (> (length name) 5)
965 (string-equal "AUTH=" (substring name 0 5 )))
966 (setq mecs (cons (substring name 5) mecs)))))
967 (imap-capability nil buffer))
970 (declare-function sasl-find-mechanism "sasl" (mechanism))
971 (declare-function sasl-mechanism-name "sasl" (mechanism))
972 (declare-function sasl-make-client "sasl" (mechanism name service server))
973 (declare-function sasl-next-step "sasl" (client step))
974 (declare-function sasl-step-data "sasl" (step))
975 (declare-function sasl-step-set-data "sasl" (step data))
977 (defun imap-sasl-auth-p (buffer)
978 (and (condition-case ()
981 (sasl-find-mechanism (imap-sasl-make-mechanisms buffer))))
983 (defun imap-sasl-auth (buffer)
984 "Login to server using the SASL method."
985 (message "imap: Authenticating using SASL...")
986 (with-current-buffer buffer
987 (make-local-variable 'imap-username)
988 (make-local-variable 'imap-sasl-client)
989 (make-local-variable 'imap-sasl-step)
990 (let ((mechanism (sasl-find-mechanism (imap-sasl-make-mechanisms buffer)))
993 (setq user (or imap-username
994 (read-from-minibuffer
995 (concat "IMAP username for " imap-server " using SASL "
996 (sasl-mechanism-name mechanism) ": ")
997 (or user imap-default-user))))
999 (setq imap-sasl-client (sasl-make-client mechanism user "imap2" imap-server)
1000 imap-sasl-step (sasl-next-step imap-sasl-client nil))
1001 (let ((tag (imap-send-command
1002 (if (sasl-step-data imap-sasl-step)
1003 (format "AUTHENTICATE %s %s"
1004 (sasl-mechanism-name mechanism)
1005 (sasl-step-data imap-sasl-step))
1006 (format "AUTHENTICATE %s" (sasl-mechanism-name mechanism)))
1008 (while (eq (imap-wait-for-tag tag) 'INCOMPLETE)
1009 (sasl-step-set-data imap-sasl-step (base64-decode-string imap-continuation))
1010 (setq imap-continuation nil
1011 imap-sasl-step (sasl-next-step imap-sasl-client imap-sasl-step))
1012 (imap-send-command-1 (if (sasl-step-data imap-sasl-step)
1013 (base64-encode-string (sasl-step-data imap-sasl-step) t)
1015 (if (imap-ok-p (imap-wait-for-tag tag))
1016 (setq imap-username user
1018 (message "Login failed...")
1022 (defun imap-digest-md5-p (buffer)
1023 (and (imap-capability 'AUTH=DIGEST-MD5 buffer)
1025 (require 'digest-md5)
1028 (defun imap-digest-md5-auth (buffer)
1029 "Login to server using the AUTH DIGEST-MD5 method."
1030 (message "imap: Authenticating using DIGEST-MD5...")
1031 (imap-interactive-login
1033 (lambda (user passwd)
1037 "AUTHENTICATE DIGEST-MD5"
1039 (digest-md5-parse-digest-challenge
1040 (base64-decode-string challenge))
1042 (digest-md5-digest-uri
1043 "imap" (digest-md5-challenge 'realm)))
1045 (digest-md5-digest-response
1046 user passwd digest-uri)))
1047 (base64-encode-string response 'no-line-break))))
1049 (if (not (eq (imap-wait-for-tag tag) 'INCOMPLETE))
1051 (setq imap-continuation nil)
1052 (imap-send-command-1 "")
1053 (imap-ok-p (imap-wait-for-tag tag)))))))
1055 ;; Server functions:
1057 (defun imap-open-1 (buffer)
1058 (with-current-buffer buffer
1060 (setq imap-current-mailbox nil
1061 imap-current-message nil
1063 imap-process (condition-case ()
1064 (funcall (nth 2 (assq imap-stream
1066 "imap" buffer imap-server imap-port)
1067 ((error quit) nil)))
1069 (set-process-filter imap-process 'imap-arrival-filter)
1070 (set-process-sentinel imap-process 'imap-sentinel)
1071 (while (and (eq imap-state 'initial)
1072 (memq (process-status imap-process) '(open run)))
1073 (message "Waiting for response from %s..." imap-server)
1074 (accept-process-output imap-process 1))
1075 (message "Waiting for response from %s...done" imap-server)
1076 (and (memq (process-status imap-process) '(open run))
1079 (defun imap-open (server &optional port stream auth buffer)
1080 "Open a IMAP connection to host SERVER at PORT returning a buffer.
1081 If PORT is unspecified, a default value is used (143 except
1082 for SSL which use 993).
1083 STREAM indicates the stream to use, see `imap-streams' for available
1084 streams. If nil, it choices the best stream the server is capable of.
1085 AUTH indicates authenticator to use, see `imap-authenticators' for
1086 available authenticators. If nil, it choices the best stream the
1087 server is capable of.
1088 BUFFER can be a buffer or a name of a buffer, which is created if
1089 necessary. If nil, the buffer name is generated."
1090 (setq buffer (or buffer (format " *imap* %s:%d" server (or port 0))))
1091 (with-current-buffer (get-buffer-create buffer)
1092 (if (imap-opened buffer)
1093 (imap-close buffer))
1094 (mapc 'make-local-variable imap-local-variables)
1095 (imap-disable-multibyte)
1096 (buffer-disable-undo)
1097 (setq imap-server (or server imap-server))
1098 (setq imap-port (or port imap-port))
1099 (setq imap-auth (or auth imap-auth))
1100 (setq imap-stream (or stream imap-stream))
1101 (message "imap: Connecting to %s..." imap-server)
1102 (if (null (let ((imap-stream (or imap-stream imap-default-stream)))
1103 (imap-open-1 buffer)))
1105 (message "imap: Connecting to %s...failed" imap-server)
1107 (when (null imap-stream)
1108 ;; Need to choose stream.
1109 (let ((streams imap-streams))
1110 (while (setq stream (pop streams))
1111 ;; OK to use this stream?
1112 (when (funcall (nth 1 (assq stream imap-stream-alist)) buffer)
1114 (if (not (eq imap-default-stream stream))
1115 (with-current-buffer (get-buffer-create
1116 (generate-new-buffer-name " *temp*"))
1117 (mapc 'make-local-variable imap-local-variables)
1118 (imap-disable-multibyte)
1119 (buffer-disable-undo)
1120 (setq imap-server (or server imap-server))
1121 (setq imap-port (or port imap-port))
1122 (setq imap-auth (or auth imap-auth))
1123 (message "imap: Reconnecting with stream `%s'..." stream)
1124 (if (null (let ((imap-stream stream))
1125 (imap-open-1 (current-buffer))))
1127 (kill-buffer (current-buffer))
1129 "imap: Reconnecting with stream `%s'...failed"
1131 ;; We're done, kill the first connection
1133 (let ((name (if (stringp buffer)
1135 (buffer-name buffer))))
1136 (kill-buffer buffer)
1137 (rename-buffer name))
1138 (message "imap: Reconnecting with stream `%s'...done"
1140 (setq imap-stream stream)
1141 (setq imap-capability nil)
1142 (setq streams nil)))
1144 (message "imap: Connecting to %s...done" imap-server)
1145 (setq imap-stream stream)
1146 (setq imap-capability nil)
1147 (setq streams nil))))))
1148 (when (imap-opened buffer)
1149 (setq imap-mailbox-data (make-vector imap-mailbox-prime 0)))
1153 (defcustom imap-ping-server t
1154 "If non-nil, check if IMAP is open.
1155 See the function `imap-ping-server'."
1156 :version "23.0" ;; No Gnus
1160 (defun imap-opened (&optional buffer)
1161 "Return non-nil if connection to imap server in BUFFER is open.
1162 If BUFFER is nil then the current buffer is used."
1163 (and (setq buffer (get-buffer (or buffer (current-buffer))))
1164 (buffer-live-p buffer)
1165 (with-current-buffer buffer
1167 (memq (process-status imap-process) '(open run))
1168 (if imap-ping-server
1172 (defun imap-ping-server (&optional buffer)
1173 "Ping the IMAP server in BUFFER with a \"NOOP\" command.
1174 Return non-nil if the server responds, and nil if it does not
1175 respond. If BUFFER is nil, the current buffer is used."
1177 (imap-ok-p (imap-send-command-wait "NOOP" buffer))
1180 (defun imap-authenticate (&optional user passwd buffer)
1181 "Authenticate to server in BUFFER, using current buffer if nil.
1182 It uses the authenticator specified when opening the server. If the
1183 authenticator requires username/passwords, they are queried from the
1184 user and optionally stored in the buffer. If USER and/or PASSWD is
1185 specified, the user will not be questioned and the username and/or
1186 password is remembered in the buffer."
1187 (with-current-buffer (or buffer (current-buffer))
1188 (if (not (eq imap-state 'nonauth))
1189 (or (eq imap-state 'auth)
1190 (eq imap-state 'selected)
1191 (eq imap-state 'examine))
1192 (make-local-variable 'imap-username)
1193 (make-local-variable 'imap-password)
1194 (if user (setq imap-username user))
1195 (if passwd (setq imap-password passwd))
1197 (and (funcall (nth 2 (assq imap-auth
1198 imap-authenticator-alist)) (current-buffer))
1199 (setq imap-state 'auth))
1200 ;; Choose authenticator.
1201 (let ((auths imap-authenticators)
1203 (while (setq auth (pop auths))
1204 ;; OK to use authenticator?
1205 (when (funcall (nth 1 (assq auth imap-authenticator-alist)) (current-buffer))
1206 (message "imap: Authenticating to `%s' using `%s'..."
1208 (setq imap-auth auth)
1209 (if (funcall (nth 2 (assq auth imap-authenticator-alist)) (current-buffer))
1211 (message "imap: Authenticating to `%s' using `%s'...done"
1214 (message "imap: Authenticating to `%s' using `%s'...failed"
1215 imap-server auth)))))
1218 (defun imap-close (&optional buffer)
1219 "Close connection to server in BUFFER.
1220 If BUFFER is nil, the current buffer is used."
1221 (with-current-buffer (or buffer (current-buffer))
1226 (when (and imap-process
1227 (memq (process-status imap-process) '(open run)))
1228 (delete-process imap-process))
1229 (setq imap-current-mailbox nil
1230 imap-current-message nil
1235 (defun imap-capability (&optional identifier buffer)
1236 "Return a list of identifiers which server in BUFFER support.
1237 If IDENTIFIER, return non-nil if it's among the servers capabilities.
1238 If BUFFER is nil, the current buffer is assumed."
1239 (with-current-buffer (or buffer (current-buffer))
1240 (unless imap-capability
1241 (unless (imap-ok-p (imap-send-command-wait "CAPABILITY"))
1242 (setq imap-capability '(IMAP2))))
1244 (memq (intern (upcase (symbol-name identifier))) imap-capability)
1247 (defun imap-id (&optional list-of-values buffer)
1248 "Identify client to server in BUFFER, and return server identity.
1249 LIST-OF-VALUES is nil, or a plist with identifier and value
1250 strings to send to the server to identify the client.
1252 Return a list of identifiers which server in BUFFER support, or
1253 nil if it doesn't support ID or returns no information.
1255 If BUFFER is nil, the current buffer is assumed."
1256 (with-current-buffer (or buffer (current-buffer))
1257 (when (and (imap-capability 'ID)
1258 (imap-ok-p (imap-send-command-wait
1259 (if (null list-of-values)
1261 (concat "ID (" (mapconcat (lambda (el)
1262 (concat "\"" el "\""))
1267 (defun imap-namespace (&optional buffer)
1268 "Return a namespace hierarchy at server in BUFFER.
1269 If BUFFER is nil, the current buffer is assumed."
1270 (with-current-buffer (or buffer (current-buffer))
1271 (unless imap-namespace
1272 (when (imap-capability 'NAMESPACE)
1273 (imap-send-command-wait "NAMESPACE")))
1276 (defun imap-send-command-wait (command &optional buffer)
1277 (imap-wait-for-tag (imap-send-command command buffer) buffer))
1279 (defun imap-logout (&optional buffer)
1280 (or buffer (setq buffer (current-buffer)))
1281 (if imap-logout-timeout
1282 (with-timeout (imap-logout-timeout
1284 (with-current-buffer buffer
1285 (delete-process imap-process))
1287 (imap-send-command "LOGOUT" buffer))
1288 (imap-send-command "LOGOUT" buffer)))
1290 (defun imap-logout-wait (&optional buffer)
1291 (or buffer (setq buffer (current-buffer)))
1292 (if imap-logout-timeout
1293 (with-timeout (imap-logout-timeout
1295 (with-current-buffer buffer
1296 (delete-process imap-process))
1298 (imap-send-command-wait "LOGOUT" buffer))
1299 (imap-send-command-wait "LOGOUT" buffer)))
1302 ;; Mailbox functions:
1304 (defun imap-mailbox-put (propname value &optional mailbox buffer)
1305 (with-current-buffer (or buffer (current-buffer))
1306 (if imap-mailbox-data
1307 (put (intern (or mailbox imap-current-mailbox) imap-mailbox-data)
1309 (error "Imap-mailbox-data is nil, prop %s value %s mailbox %s buffer %s"
1310 propname value mailbox (current-buffer)))
1313 (defsubst imap-mailbox-get-1 (propname &optional mailbox)
1314 (get (intern-soft (or mailbox imap-current-mailbox) imap-mailbox-data)
1317 (defun imap-mailbox-get (propname &optional mailbox buffer)
1318 (let ((mailbox (imap-utf7-encode mailbox)))
1319 (with-current-buffer (or buffer (current-buffer))
1320 (imap-mailbox-get-1 propname (or mailbox imap-current-mailbox)))))
1322 (defun imap-mailbox-map-1 (func &optional mailbox-decoder buffer)
1323 (with-current-buffer (or buffer (current-buffer))
1327 (push (funcall func (if mailbox-decoder
1328 (funcall mailbox-decoder (symbol-name s))
1329 (symbol-name s))) result))
1333 (defun imap-mailbox-map (func &optional buffer)
1334 "Map a function across each mailbox in `imap-mailbox-data', returning a list.
1335 Function should take a mailbox name (a string) as
1337 (imap-mailbox-map-1 func 'imap-utf7-decode buffer))
1339 (defun imap-current-mailbox (&optional buffer)
1340 (with-current-buffer (or buffer (current-buffer))
1341 (imap-utf7-decode imap-current-mailbox)))
1343 (defun imap-current-mailbox-p-1 (mailbox &optional examine)
1344 (and (string= mailbox imap-current-mailbox)
1346 (eq imap-state 'examine))
1348 (eq imap-state 'selected)))))
1350 (defun imap-current-mailbox-p (mailbox &optional examine buffer)
1351 (with-current-buffer (or buffer (current-buffer))
1352 (imap-current-mailbox-p-1 (imap-utf7-encode mailbox) examine)))
1354 (defun imap-mailbox-select-1 (mailbox &optional examine)
1355 "Select MAILBOX on server in BUFFER.
1356 If EXAMINE is non-nil, do a read-only select."
1357 (if (imap-current-mailbox-p-1 mailbox examine)
1358 imap-current-mailbox
1359 (setq imap-current-mailbox mailbox)
1360 (if (imap-ok-p (imap-send-command-wait
1361 (concat (if examine "EXAMINE" "SELECT") " \""
1364 (setq imap-message-data (make-vector imap-message-prime 0)
1365 imap-state (if examine 'examine 'selected))
1366 imap-current-mailbox)
1367 ;; Failed SELECT/EXAMINE unselects current mailbox
1368 (setq imap-current-mailbox nil))))
1370 (defun imap-mailbox-select (mailbox &optional examine buffer)
1371 (with-current-buffer (or buffer (current-buffer))
1373 (imap-mailbox-select-1 (imap-utf7-encode mailbox) examine))))
1375 (defun imap-mailbox-examine-1 (mailbox &optional buffer)
1376 (with-current-buffer (or buffer (current-buffer))
1377 (imap-mailbox-select-1 mailbox 'examine)))
1379 (defun imap-mailbox-examine (mailbox &optional buffer)
1380 "Examine MAILBOX on server in BUFFER."
1381 (imap-mailbox-select mailbox 'examine buffer))
1383 (defun imap-mailbox-unselect (&optional buffer)
1384 "Close current folder in BUFFER, without expunging articles."
1385 (with-current-buffer (or buffer (current-buffer))
1386 (when (or (eq imap-state 'auth)
1387 (and (imap-capability 'UNSELECT)
1388 (imap-ok-p (imap-send-command-wait "UNSELECT")))
1390 (imap-send-command-wait (concat "EXAMINE \""
1391 imap-current-mailbox
1393 (imap-ok-p (imap-send-command-wait "CLOSE"))))
1394 (setq imap-current-mailbox nil
1395 imap-message-data nil
1399 (defun imap-mailbox-expunge (&optional asynch buffer)
1400 "Expunge articles in current folder in BUFFER.
1401 If ASYNCH, do not wait for succesful completion of the command.
1402 If BUFFER is nil the current buffer is assumed."
1403 (with-current-buffer (or buffer (current-buffer))
1404 (when (and imap-current-mailbox (not (eq imap-state 'examine)))
1406 (imap-send-command "EXPUNGE")
1407 (imap-ok-p (imap-send-command-wait "EXPUNGE"))))))
1409 (defun imap-mailbox-close (&optional asynch buffer)
1410 "Expunge articles and close current folder in BUFFER.
1411 If ASYNCH, do not wait for succesful completion of the command.
1412 If BUFFER is nil the current buffer is assumed."
1413 (with-current-buffer (or buffer (current-buffer))
1414 (when imap-current-mailbox
1416 (imap-add-callback (imap-send-command "CLOSE")
1417 `(lambda (tag status)
1418 (message "IMAP mailbox `%s' closed... %s"
1419 imap-current-mailbox status)
1420 (when (eq ,imap-current-mailbox
1421 imap-current-mailbox)
1422 ;; Don't wipe out data if another mailbox
1424 (setq imap-current-mailbox nil
1425 imap-message-data nil
1426 imap-state 'auth))))
1427 (when (imap-ok-p (imap-send-command-wait "CLOSE"))
1428 (setq imap-current-mailbox nil
1429 imap-message-data nil
1433 (defun imap-mailbox-create-1 (mailbox)
1434 (imap-ok-p (imap-send-command-wait (list "CREATE \"" mailbox "\""))))
1436 (defun imap-mailbox-create (mailbox &optional buffer)
1437 "Create MAILBOX on server in BUFFER.
1438 If BUFFER is nil the current buffer is assumed."
1439 (with-current-buffer (or buffer (current-buffer))
1440 (imap-mailbox-create-1 (imap-utf7-encode mailbox))))
1442 (defun imap-mailbox-delete (mailbox &optional buffer)
1443 "Delete MAILBOX on server in BUFFER.
1444 If BUFFER is nil the current buffer is assumed."
1445 (let ((mailbox (imap-utf7-encode mailbox)))
1446 (with-current-buffer (or buffer (current-buffer))
1448 (imap-send-command-wait (list "DELETE \"" mailbox "\""))))))
1450 (defun imap-mailbox-rename (oldname newname &optional buffer)
1451 "Rename mailbox OLDNAME to NEWNAME on server in BUFFER.
1452 If BUFFER is nil the current buffer is assumed."
1453 (let ((oldname (imap-utf7-encode oldname))
1454 (newname (imap-utf7-encode newname)))
1455 (with-current-buffer (or buffer (current-buffer))
1457 (imap-send-command-wait (list "RENAME \"" oldname "\" "
1458 "\"" newname "\""))))))
1460 (defun imap-mailbox-lsub (&optional root reference add-delimiter buffer)
1461 "Return a list of subscribed mailboxes on server in BUFFER.
1462 If ROOT is non-nil, only list matching mailboxes. If ADD-DELIMITER is
1463 non-nil, a hierarchy delimiter is added to root. REFERENCE is a
1464 implementation-specific string that has to be passed to lsub command."
1465 (with-current-buffer (or buffer (current-buffer))
1466 ;; Make sure we know the hierarchy separator for root's hierarchy
1467 (when (and add-delimiter (null (imap-mailbox-get-1 'delimiter root)))
1468 (imap-send-command-wait (concat "LIST \"" reference "\" \""
1469 (imap-utf7-encode root) "\"")))
1470 ;; clear list data (NB not delimiter and other stuff)
1471 (imap-mailbox-map-1 (lambda (mailbox)
1472 (imap-mailbox-put 'lsub nil mailbox)))
1474 (imap-send-command-wait
1475 (concat "LSUB \"" reference "\" \"" (imap-utf7-encode root)
1476 (and add-delimiter (imap-mailbox-get-1 'delimiter root))
1479 (imap-mailbox-map-1 (lambda (mailbox)
1480 (when (imap-mailbox-get-1 'lsub mailbox)
1481 (push (imap-utf7-decode mailbox) out))))
1484 (defun imap-mailbox-list (root &optional reference add-delimiter buffer)
1485 "Return a list of mailboxes matching ROOT on server in BUFFER.
1486 If ADD-DELIMITER is non-nil, a hierarchy delimiter is added to
1487 root. REFERENCE is a implementation-specific string that has to be
1488 passed to list command."
1489 (with-current-buffer (or buffer (current-buffer))
1490 ;; Make sure we know the hierarchy separator for root's hierarchy
1491 (when (and add-delimiter (null (imap-mailbox-get-1 'delimiter root)))
1492 (imap-send-command-wait (concat "LIST \"" reference "\" \""
1493 (imap-utf7-encode root) "\"")))
1494 ;; clear list data (NB not delimiter and other stuff)
1495 (imap-mailbox-map-1 (lambda (mailbox)
1496 (imap-mailbox-put 'list nil mailbox)))
1498 (imap-send-command-wait
1499 (concat "LIST \"" reference "\" \"" (imap-utf7-encode root)
1500 (and add-delimiter (imap-mailbox-get-1 'delimiter root))
1503 (imap-mailbox-map-1 (lambda (mailbox)
1504 (when (imap-mailbox-get-1 'list mailbox)
1505 (push (imap-utf7-decode mailbox) out))))
1508 (defun imap-mailbox-subscribe (mailbox &optional buffer)
1509 "Send the SUBSCRIBE command on the mailbox to server in BUFFER.
1510 Returns non-nil if successful."
1511 (with-current-buffer (or buffer (current-buffer))
1512 (imap-ok-p (imap-send-command-wait (concat "SUBSCRIBE \""
1513 (imap-utf7-encode mailbox)
1516 (defun imap-mailbox-unsubscribe (mailbox &optional buffer)
1517 "Send the SUBSCRIBE command on the mailbox to server in BUFFER.
1518 Returns non-nil if successful."
1519 (with-current-buffer (or buffer (current-buffer))
1520 (imap-ok-p (imap-send-command-wait (concat "UNSUBSCRIBE "
1521 (imap-utf7-encode mailbox)
1524 (defun imap-mailbox-status (mailbox items &optional buffer)
1525 "Get status items ITEM in MAILBOX from server in BUFFER.
1526 ITEMS can be a symbol or a list of symbols, valid symbols are one of
1527 the STATUS data items -- ie 'messages, 'recent, 'uidnext, 'uidvalidity
1528 or 'unseen. If ITEMS is a list of symbols, a list of values is
1529 returned, if ITEMS is a symbol only its value is returned."
1530 (with-current-buffer (or buffer (current-buffer))
1532 (imap-send-command-wait (list "STATUS \""
1533 (imap-utf7-encode mailbox)
1541 (mapcar (lambda (item)
1542 (imap-mailbox-get item mailbox))
1544 (imap-mailbox-get items mailbox)))))
1546 (defun imap-mailbox-status-asynch (mailbox items &optional buffer)
1547 "Send status item request ITEM on MAILBOX to server in BUFFER.
1548 ITEMS can be a symbol or a list of symbols, valid symbols are one of
1549 the STATUS data items -- ie 'messages, 'recent, 'uidnext, 'uidvalidity
1550 or 'unseen. The IMAP command tag is returned."
1551 (with-current-buffer (or buffer (current-buffer))
1552 (imap-send-command (list "STATUS \""
1553 (imap-utf7-encode mailbox)
1561 (defun imap-mailbox-acl-get (&optional mailbox buffer)
1562 "Get ACL on mailbox from server in BUFFER."
1563 (let ((mailbox (imap-utf7-encode mailbox)))
1564 (with-current-buffer (or buffer (current-buffer))
1566 (imap-send-command-wait (list "GETACL \""
1567 (or mailbox imap-current-mailbox)
1569 (imap-mailbox-get-1 'acl (or mailbox imap-current-mailbox))))))
1571 (defun imap-mailbox-acl-set (identifier rights &optional mailbox buffer)
1572 "Change/set ACL for IDENTIFIER to RIGHTS in MAILBOX from server in BUFFER."
1573 (let ((mailbox (imap-utf7-encode mailbox)))
1574 (with-current-buffer (or buffer (current-buffer))
1576 (imap-send-command-wait (list "SETACL \""
1577 (or mailbox imap-current-mailbox)
1583 (defun imap-mailbox-acl-delete (identifier &optional mailbox buffer)
1584 "Removes any <identifier,rights> pair for IDENTIFIER in MAILBOX from server in BUFFER."
1585 (let ((mailbox (imap-utf7-encode mailbox)))
1586 (with-current-buffer (or buffer (current-buffer))
1588 (imap-send-command-wait (list "DELETEACL \""
1589 (or mailbox imap-current-mailbox)
1594 ;; Message functions:
1596 (defun imap-current-message (&optional buffer)
1597 (with-current-buffer (or buffer (current-buffer))
1598 imap-current-message))
1600 (defun imap-list-to-message-set (list)
1601 (mapconcat (lambda (item)
1602 (number-to-string item))
1608 (defun imap-range-to-message-set (range)
1613 (car item) (cdr item))
1614 (format "%d" item)))
1615 (if (and (listp range) (not (listp (cdr range))))
1616 (list range) ;; make (1 . 2) into ((1 . 2))
1620 (defun imap-fetch-asynch (uids props &optional nouidfetch buffer)
1621 (with-current-buffer (or buffer (current-buffer))
1622 (imap-send-command (format "%sFETCH %s %s" (if nouidfetch "" "UID ")
1624 (imap-list-to-message-set uids)
1628 (defun imap-fetch (uids props &optional receive nouidfetch buffer)
1629 "Fetch properties PROPS from message set UIDS from server in BUFFER.
1630 UIDS can be a string, number or a list of numbers. If RECEIVE
1631 is non-nil return these properties."
1632 (with-current-buffer (or buffer (current-buffer))
1633 (when (imap-ok-p (imap-send-command-wait
1634 (format "%sFETCH %s %s" (if nouidfetch "" "UID ")
1636 (imap-list-to-message-set uids)
1639 (if (or (null receive) (stringp uids))
1642 (mapcar (lambda (uid)
1644 (mapcar (lambda (prop)
1645 (imap-message-get uid prop))
1647 (imap-message-get uid receive)))
1649 (imap-message-get uids receive))))))
1651 (defun imap-message-put (uid propname value &optional buffer)
1652 (with-current-buffer (or buffer (current-buffer))
1653 (if imap-message-data
1654 (put (intern (number-to-string uid) imap-message-data)
1656 (error "Imap-message-data is nil, uid %s prop %s value %s buffer %s"
1657 uid propname value (current-buffer)))
1660 (defun imap-message-get (uid propname &optional buffer)
1661 (with-current-buffer (or buffer (current-buffer))
1662 (get (intern-soft (number-to-string uid) imap-message-data)
1665 (defun imap-message-map (func propname &optional buffer)
1666 "Map a function across each mailbox in `imap-message-data', returning a list."
1667 (with-current-buffer (or buffer (current-buffer))
1671 (push (funcall func (get s 'UID) (get s propname)) result))
1675 (defmacro imap-message-envelope-date (uid &optional buffer)
1676 `(with-current-buffer (or ,buffer (current-buffer))
1677 (elt (imap-message-get ,uid 'ENVELOPE) 0)))
1679 (defmacro imap-message-envelope-subject (uid &optional buffer)
1680 `(with-current-buffer (or ,buffer (current-buffer))
1681 (elt (imap-message-get ,uid 'ENVELOPE) 1)))
1683 (defmacro imap-message-envelope-from (uid &optional buffer)
1684 `(with-current-buffer (or ,buffer (current-buffer))
1685 (elt (imap-message-get ,uid 'ENVELOPE) 2)))
1687 (defmacro imap-message-envelope-sender (uid &optional buffer)
1688 `(with-current-buffer (or ,buffer (current-buffer))
1689 (elt (imap-message-get ,uid 'ENVELOPE) 3)))
1691 (defmacro imap-message-envelope-reply-to (uid &optional buffer)
1692 `(with-current-buffer (or ,buffer (current-buffer))
1693 (elt (imap-message-get ,uid 'ENVELOPE) 4)))
1695 (defmacro imap-message-envelope-to (uid &optional buffer)
1696 `(with-current-buffer (or ,buffer (current-buffer))
1697 (elt (imap-message-get ,uid 'ENVELOPE) 5)))
1699 (defmacro imap-message-envelope-cc (uid &optional buffer)
1700 `(with-current-buffer (or ,buffer (current-buffer))
1701 (elt (imap-message-get ,uid 'ENVELOPE) 6)))
1703 (defmacro imap-message-envelope-bcc (uid &optional buffer)
1704 `(with-current-buffer (or ,buffer (current-buffer))
1705 (elt (imap-message-get ,uid 'ENVELOPE) 7)))
1707 (defmacro imap-message-envelope-in-reply-to (uid &optional buffer)
1708 `(with-current-buffer (or ,buffer (current-buffer))
1709 (elt (imap-message-get ,uid 'ENVELOPE) 8)))
1711 (defmacro imap-message-envelope-message-id (uid &optional buffer)
1712 `(with-current-buffer (or ,buffer (current-buffer))
1713 (elt (imap-message-get ,uid 'ENVELOPE) 9)))
1715 (defmacro imap-message-body (uid &optional buffer)
1716 `(with-current-buffer (or ,buffer (current-buffer))
1717 (imap-message-get ,uid 'BODY)))
1719 (defun imap-search (predicate &optional buffer)
1720 (with-current-buffer (or buffer (current-buffer))
1721 (imap-mailbox-put 'search 'dummy)
1722 (when (imap-ok-p (imap-send-command-wait (concat "UID SEARCH " predicate)))
1723 (if (eq (imap-mailbox-get-1 'search imap-current-mailbox) 'dummy)
1725 (message "Missing SEARCH response to a SEARCH command (server not RFC compliant)...")
1727 (imap-mailbox-get-1 'search imap-current-mailbox)))))
1729 (defun imap-message-flag-permanent-p (flag &optional mailbox buffer)
1730 "Return t if FLAG can be permanently (between IMAP sessions) saved on articles, in MAILBOX on server in BUFFER."
1731 (with-current-buffer (or buffer (current-buffer))
1732 (or (member "\\*" (imap-mailbox-get 'permanentflags mailbox))
1733 (member flag (imap-mailbox-get 'permanentflags mailbox)))))
1735 (defun imap-message-flags-set (articles flags &optional silent buffer)
1736 (when (and articles flags)
1737 (with-current-buffer (or buffer (current-buffer))
1738 (imap-ok-p (imap-send-command-wait
1739 (concat "UID STORE " articles
1740 " FLAGS" (if silent ".SILENT") " (" flags ")"))))))
1742 (defun imap-message-flags-del (articles flags &optional silent buffer)
1743 (when (and articles flags)
1744 (with-current-buffer (or buffer (current-buffer))
1745 (imap-ok-p (imap-send-command-wait
1746 (concat "UID STORE " articles
1747 " -FLAGS" (if silent ".SILENT") " (" flags ")"))))))
1749 (defun imap-message-flags-add (articles flags &optional silent buffer)
1750 (when (and articles flags)
1751 (with-current-buffer (or buffer (current-buffer))
1752 (imap-ok-p (imap-send-command-wait
1753 (concat "UID STORE " articles
1754 " +FLAGS" (if silent ".SILENT") " (" flags ")"))))))
1756 ;; Cf. http://thread.gmane.org/gmane.emacs.gnus.general/65317/focus=65343
1757 ;; Signal an error if we'd get an integer overflow.
1759 ;; FIXME: Identify relevant calls to `string-to-number' and replace them with
1760 ;; `imap-string-to-integer'.
1761 (defun imap-string-to-integer (string &optional base)
1762 (let ((number (string-to-number string base)))
1763 (if (> number most-positive-fixnum)
1765 (format "String %s cannot be converted to a lisp integer" number))
1768 (defun imap-message-copyuid-1 (mailbox)
1769 (if (imap-capability 'UIDPLUS)
1770 (list (nth 0 (imap-mailbox-get-1 'copyuid mailbox))
1771 (string-to-number (nth 2 (imap-mailbox-get-1 'copyuid mailbox))))
1772 (let ((old-mailbox imap-current-mailbox)
1774 (imap-message-data (make-vector 2 0)))
1775 (when (imap-mailbox-examine-1 mailbox)
1777 (and (imap-fetch "*" "UID")
1778 (list (imap-mailbox-get-1 'uidvalidity mailbox)
1779 (apply 'max (imap-message-map
1780 (lambda (uid prop) uid) 'UID))))
1782 (imap-mailbox-select old-mailbox (eq state 'examine))
1783 (imap-mailbox-unselect)))))))
1785 (defun imap-message-copyuid (mailbox &optional buffer)
1786 (with-current-buffer (or buffer (current-buffer))
1787 (imap-message-copyuid-1 (imap-utf7-decode mailbox))))
1789 (defun imap-message-copy (articles mailbox
1790 &optional dont-create no-copyuid buffer)
1791 "Copy ARTICLES (a string message set) to MAILBOX on server in
1792 BUFFER, creating mailbox if it doesn't exist. If dont-create is
1793 non-nil, it will not create a mailbox. On success, return a list with
1794 the UIDVALIDITY of the mailbox the article(s) was copied to as the
1795 first element, rest of list contain the saved articles' UIDs."
1797 (with-current-buffer (or buffer (current-buffer))
1798 (let ((mailbox (imap-utf7-encode mailbox)))
1799 (if (let ((cmd (concat "UID COPY " articles " \"" mailbox "\""))
1800 (imap-current-target-mailbox mailbox))
1801 (if (imap-ok-p (imap-send-command-wait cmd))
1803 (when (and (not dont-create)
1804 ;; removed because of buggy Oracle server
1805 ;; that doesn't send TRYCREATE tags (which
1806 ;; is a MUST according to specifications):
1807 ;;(imap-mailbox-get-1 'trycreate mailbox)
1808 (imap-mailbox-create-1 mailbox))
1809 (imap-ok-p (imap-send-command-wait cmd)))))
1811 (imap-message-copyuid-1 mailbox)))))))
1813 (defun imap-message-appenduid-1 (mailbox)
1814 (if (imap-capability 'UIDPLUS)
1815 (imap-mailbox-get-1 'appenduid mailbox)
1816 (let ((old-mailbox imap-current-mailbox)
1818 (imap-message-data (make-vector 2 0)))
1819 (when (imap-mailbox-examine-1 mailbox)
1821 (and (imap-fetch "*" "UID")
1822 (list (imap-mailbox-get-1 'uidvalidity mailbox)
1823 (apply 'max (imap-message-map
1824 (lambda (uid prop) uid) 'UID))))
1826 (imap-mailbox-select old-mailbox (eq state 'examine))
1827 (imap-mailbox-unselect)))))))
1829 (defun imap-message-appenduid (mailbox &optional buffer)
1830 (with-current-buffer (or buffer (current-buffer))
1831 (imap-message-appenduid-1 (imap-utf7-encode mailbox))))
1833 (defun imap-message-append (mailbox article &optional flags date-time buffer)
1834 "Append ARTICLE (a buffer) to MAILBOX on server in BUFFER.
1835 FLAGS and DATE-TIME is currently not used. Return a cons holding
1836 uidvalidity of MAILBOX and UID the newly created article got, or nil
1838 (let ((mailbox (imap-utf7-encode mailbox)))
1839 (with-current-buffer (or buffer (current-buffer))
1840 (and (let ((imap-current-target-mailbox mailbox))
1842 (imap-send-command-wait
1843 (list "APPEND \"" mailbox "\" " article))))
1844 (imap-message-appenduid-1 mailbox)))))
1846 (defun imap-body-lines (body)
1847 "Return number of lines in article by looking at the mime bodystructure BODY."
1849 (if (stringp (car body))
1850 (cond ((and (string= (upcase (car body)) "TEXT")
1851 (numberp (nth 7 body)))
1853 ((and (string= (upcase (car body)) "MESSAGE")
1854 (numberp (nth 9 body)))
1857 (apply '+ (mapcar 'imap-body-lines body)))
1860 (defun imap-envelope-from (from)
1861 "Return a from string line."
1863 (concat (aref from 0)
1864 (if (aref from 0) " <")
1868 (if (aref from 0) ">"))))
1871 ;; Internal functions.
1873 (defun imap-add-callback (tag func)
1874 (setq imap-callbacks (append (list (cons tag func)) imap-callbacks)))
1876 (defun imap-send-command-1 (cmdstr)
1877 (setq cmdstr (concat cmdstr imap-client-eol))
1879 (with-current-buffer (get-buffer-create imap-log-buffer)
1880 (imap-disable-multibyte)
1881 (buffer-disable-undo)
1882 (goto-char (point-max))
1884 (process-send-string imap-process cmdstr))
1886 (defun imap-send-command (command &optional buffer)
1887 (with-current-buffer (or buffer (current-buffer))
1888 (if (not (listp command)) (setq command (list command)))
1889 (let ((tag (setq imap-tag (1+ imap-tag)))
1891 (setq cmdstr (concat (number-to-string imap-tag) " "))
1892 (while (setq cmd (pop command))
1893 (cond ((stringp cmd)
1894 (setq cmdstr (concat cmdstr cmd)))
1896 (let ((eol imap-client-eol)
1897 (calcfirst imap-calculate-literal-size-first)
1899 (with-current-buffer cmd
1901 (setq size (buffer-size)))
1902 (when (not (equal eol "\r\n"))
1903 ;; XXX modifies buffer!
1904 (goto-char (point-min))
1905 (while (search-forward "\r\n" nil t)
1906 (replace-match eol)))
1908 (setq size (buffer-size))))
1910 (concat cmdstr (format "{%d}" size))))
1913 (imap-send-command-1 cmdstr)
1915 (if (not (eq (imap-wait-for-tag tag) 'INCOMPLETE))
1916 (setq command nil) ;; abort command if no cont-req
1917 (let ((process imap-process)
1918 (stream imap-stream)
1919 (eol imap-client-eol))
1920 (with-current-buffer cmd
1922 (with-current-buffer (get-buffer-create
1924 (imap-disable-multibyte)
1925 (buffer-disable-undo)
1926 (goto-char (point-max))
1927 (insert-buffer-substring cmd)))
1928 (process-send-region process (point-min)
1930 (process-send-string process imap-client-eol))))
1931 (setq imap-continuation nil)))
1933 (imap-send-command-1 cmdstr)
1936 (if (not (eq (imap-wait-for-tag tag) 'INCOMPLETE))
1937 (setq command nil) ;; abort command if no cont-req
1938 (setq command (cons (funcall cmd imap-continuation)
1940 (setq imap-continuation nil)))
1942 (error "Unknown command type"))))
1944 (imap-send-command-1 cmdstr))
1947 (defun imap-wait-for-tag (tag &optional buffer)
1948 (with-current-buffer (or buffer (current-buffer))
1949 (let (imap-have-messaged)
1950 (while (and (null imap-continuation)
1951 (memq (process-status imap-process) '(open run))
1952 (< imap-reached-tag tag))
1953 (let ((len (/ (point-max) 1024))
1956 (setq imap-have-messaged t)
1957 (message "imap read: %dk" len))
1958 (accept-process-output imap-process
1959 (truncate imap-read-timeout)
1960 (truncate (* (- imap-read-timeout
1961 (truncate imap-read-timeout))
1963 ;; A process can die _before_ we have processed everything it
1964 ;; has to say. Moreover, this can happen in between the call to
1965 ;; accept-process-output and the call to process-status in an
1966 ;; iteration of the loop above.
1967 (when (and (null imap-continuation)
1968 (< imap-reached-tag tag))
1969 (accept-process-output imap-process 0 0))
1970 (when imap-have-messaged
1972 (and (memq (process-status imap-process) '(open run))
1973 (or (assq tag imap-failed-tags)
1974 (if imap-continuation
1978 (defun imap-sentinel (process string)
1979 (delete-process process))
1981 (defun imap-find-next-line ()
1982 "Return point at end of current line, taking into account literals.
1983 Return nil if no complete line has arrived."
1984 (when (re-search-forward (concat imap-server-eol "\\|{\\([0-9]+\\)}"
1987 (if (match-string 1)
1988 (if (< (point-max) (+ (point) (string-to-number (match-string 1))))
1990 (goto-char (+ (point) (string-to-number (match-string 1))))
1991 (imap-find-next-line))
1994 (defun imap-arrival-filter (proc string)
1995 "IMAP process filter."
1996 ;; Sometimes, we are called even though the process has died.
1997 ;; Better abstain from doing stuff in that case.
1998 (when (buffer-name (process-buffer proc))
1999 (with-current-buffer (process-buffer proc)
2000 (goto-char (point-max))
2003 (with-current-buffer (get-buffer-create imap-log-buffer)
2004 (imap-disable-multibyte)
2005 (buffer-disable-undo)
2006 (goto-char (point-max))
2009 (goto-char (point-min))
2010 (while (setq end (imap-find-next-line))
2012 (narrow-to-region (point-min) end)
2013 (delete-backward-char (length imap-server-eol))
2014 (goto-char (point-min))
2016 (cond ((eq imap-state 'initial)
2017 (imap-parse-greeting))
2018 ((or (eq imap-state 'auth)
2019 (eq imap-state 'nonauth)
2020 (eq imap-state 'selected)
2021 (eq imap-state 'examine))
2022 (imap-parse-response))
2024 (message "Unknown state %s in arrival filter"
2026 (delete-region (point-min) (point-max)))))))))
2031 (defsubst imap-forward ()
2032 (or (eobp) (forward-char)))
2035 ;; ; Unsigned 32-bit integer
2036 ;; ; (0 <= n < 4,294,967,296)
2038 (defsubst imap-parse-number ()
2039 (when (looking-at "[0-9]+")
2041 (string-to-number (match-string 0))
2042 (goto-char (match-end 0)))))
2044 ;; literal = "{" number "}" CRLF *CHAR8
2045 ;; ; Number represents the number of CHAR8s
2047 (defsubst imap-parse-literal ()
2048 (when (looking-at "{\\([0-9]+\\)}\r\n")
2049 (let ((pos (match-end 0))
2050 (len (string-to-number (match-string 1))))
2051 (if (< (point-max) (+ pos len))
2053 (goto-char (+ pos len))
2054 (buffer-substring pos (+ pos len))))))
2056 ;; string = quoted / literal
2058 ;; quoted = DQUOTE *QUOTED-CHAR DQUOTE
2060 ;; QUOTED-CHAR = <any TEXT-CHAR except quoted-specials> /
2061 ;; "\" quoted-specials
2063 ;; quoted-specials = DQUOTE / "\"
2065 ;; TEXT-CHAR = <any CHAR except CR and LF>
2067 (defsubst imap-parse-string ()
2068 (cond ((eq (char-after) ?\")
2070 (let ((p (point)) (name ""))
2071 (skip-chars-forward "^\"\\\\")
2072 (setq name (buffer-substring p (point)))
2073 (while (eq (char-after) ?\\)
2074 (setq p (1+ (point)))
2076 (skip-chars-forward "^\"\\\\")
2077 (setq name (concat name (buffer-substring p (point)))))
2080 ((eq (char-after) ?{)
2081 (imap-parse-literal))))
2085 (defsubst imap-parse-nil ()
2086 (if (looking-at "NIL")
2087 (goto-char (match-end 0))))
2089 ;; nstring = string / nil
2091 (defsubst imap-parse-nstring ()
2092 (or (imap-parse-string)
2093 (and (imap-parse-nil)
2096 ;; astring = atom / string
2098 ;; atom = 1*ATOM-CHAR
2100 ;; ATOM-CHAR = <any CHAR except atom-specials>
2102 ;; atom-specials = "(" / ")" / "{" / SP / CTL / list-wildcards /
2105 ;; list-wildcards = "%" / "*"
2107 ;; quoted-specials = DQUOTE / "\"
2109 (defsubst imap-parse-astring ()
2110 (or (imap-parse-string)
2111 (buffer-substring (point)
2112 (if (re-search-forward "[(){ \r\n%*\"\\]" nil t)
2113 (goto-char (1- (match-end 0)))
2117 ;; address = "(" addr-name SP addr-adl SP addr-mailbox SP
2120 ;; addr-adl = nstring
2121 ;; ; Holds route from [RFC-822] route-addr if
2124 ;; addr-host = nstring
2125 ;; ; nil indicates [RFC-822] group syntax.
2126 ;; ; Otherwise, holds [RFC-822] domain name
2128 ;; addr-mailbox = nstring
2129 ;; ; nil indicates end of [RFC-822] group; if
2130 ;; ; non-nil and addr-host is nil, holds
2131 ;; ; [RFC-822] group name.
2132 ;; ; Otherwise, holds [RFC-822] local-part
2133 ;; ; after removing [RFC-822] quoting
2135 ;; addr-name = nstring
2136 ;; ; If non-nil, holds phrase from [RFC-822]
2137 ;; ; mailbox after removing [RFC-822] quoting
2140 (defsubst imap-parse-address ()
2142 (when (eq (char-after) ?\()
2144 (setq address (vector (prog1 (imap-parse-nstring)
2146 (prog1 (imap-parse-nstring)
2148 (prog1 (imap-parse-nstring)
2150 (imap-parse-nstring)))
2151 (when (eq (char-after) ?\))
2155 ;; address-list = "(" 1*address ")" / nil
2159 (defsubst imap-parse-address-list ()
2160 (if (eq (char-after) ?\()
2161 (let (address addresses)
2163 (while (and (not (eq (char-after) ?\)))
2164 ;; next line for MS Exchange bug
2165 (progn (and (eq (char-after) ? ) (imap-forward)) t)
2166 (setq address (imap-parse-address)))
2167 (setq addresses (cons address addresses)))
2168 (when (eq (char-after) ?\))
2170 (nreverse addresses)))
2171 ;; With assert, the code might not be eval'd.
2172 ;; (assert (imap-parse-nil) t "In imap-parse-address-list")
2175 ;; mailbox = "INBOX" / astring
2176 ;; ; INBOX is case-insensitive. All case variants of
2177 ;; ; INBOX (e.g. "iNbOx") MUST be interpreted as INBOX
2178 ;; ; not as an astring. An astring which consists of
2179 ;; ; the case-insensitive sequence "I" "N" "B" "O" "X"
2180 ;; ; is considered to be INBOX and not an astring.
2181 ;; ; Refer to section 5.1 for further
2182 ;; ; semantic details of mailbox names.
2184 (defsubst imap-parse-mailbox ()
2185 (let ((mailbox (imap-parse-astring)))
2186 (if (string-equal "INBOX" (upcase mailbox))
2190 ;; greeting = "*" SP (resp-cond-auth / resp-cond-bye) CRLF
2192 ;; resp-cond-auth = ("OK" / "PREAUTH") SP resp-text
2193 ;; ; Authentication condition
2195 ;; resp-cond-bye = "BYE" SP resp-text
2197 (defun imap-parse-greeting ()
2198 "Parse a IMAP greeting."
2199 (cond ((looking-at "\\* OK ")
2200 (setq imap-state 'nonauth))
2201 ((looking-at "\\* PREAUTH ")
2202 (setq imap-state 'auth))
2203 ((looking-at "\\* BYE ")
2204 (setq imap-state 'closed))))
2206 ;; response = *(continue-req / response-data) response-done
2208 ;; continue-req = "+" SP (resp-text / base64) CRLF
2210 ;; response-data = "*" SP (resp-cond-state / resp-cond-bye /
2211 ;; mailbox-data / message-data / capability-data) CRLF
2213 ;; response-done = response-tagged / response-fatal
2215 ;; response-fatal = "*" SP resp-cond-bye CRLF
2216 ;; ; Server closes connection immediately
2218 ;; response-tagged = tag SP resp-cond-state CRLF
2220 ;; resp-cond-state = ("OK" / "NO" / "BAD") SP resp-text
2221 ;; ; Status condition
2223 ;; resp-cond-bye = "BYE" SP resp-text
2225 ;; mailbox-data = "FLAGS" SP flag-list /
2226 ;; "LIST" SP mailbox-list /
2227 ;; "LSUB" SP mailbox-list /
2228 ;; "SEARCH" *(SP nz-number) /
2229 ;; "STATUS" SP mailbox SP "("
2230 ;; [status-att SP number *(SP status-att SP number)] ")" /
2231 ;; number SP "EXISTS" /
2232 ;; number SP "RECENT"
2234 ;; message-data = nz-number SP ("EXPUNGE" / ("FETCH" SP msg-att))
2236 ;; capability-data = "CAPABILITY" *(SP capability) SP "IMAP4rev1"
2238 ;; ; IMAP4rev1 servers which offer RFC 1730
2239 ;; ; compatibility MUST list "IMAP4" as the first
2242 (defun imap-parse-response ()
2243 "Parse a IMAP command response."
2245 (case (setq token (read (current-buffer)))
2246 (+ (setq imap-continuation
2247 (or (buffer-substring (min (point-max) (1+ (point)))
2250 (* (case (prog1 (setq token (read (current-buffer)))
2252 (OK (imap-parse-resp-text))
2253 (NO (imap-parse-resp-text))
2254 (BAD (imap-parse-resp-text))
2255 (BYE (imap-parse-resp-text))
2256 (FLAGS (imap-mailbox-put 'flags (imap-parse-flag-list)))
2257 (LIST (imap-parse-data-list 'list))
2258 (LSUB (imap-parse-data-list 'lsub))
2259 (SEARCH (imap-mailbox-put
2261 (read (concat "(" (buffer-substring (point) (point-max)) ")"))))
2262 (STATUS (imap-parse-status))
2263 (CAPABILITY (setq imap-capability
2264 (read (concat "(" (upcase (buffer-substring
2265 (point) (point-max)))
2267 (ID (setq imap-id (read (buffer-substring (point)
2269 (ACL (imap-parse-acl))
2270 (t (case (prog1 (read (current-buffer))
2272 (EXISTS (imap-mailbox-put 'exists token))
2273 (RECENT (imap-mailbox-put 'recent token))
2275 (FETCH (imap-parse-fetch token))
2276 (t (message "Garbage: %s" (buffer-string)))))))
2278 (if (not (integerp token))
2279 (message "Garbage: %s" (buffer-string))
2280 (case (prog1 (setq status (read (current-buffer)))
2283 (setq imap-reached-tag (max imap-reached-tag token))
2284 (imap-parse-resp-text)))
2286 (setq imap-reached-tag (max imap-reached-tag token))
2288 (imap-parse-resp-text))
2290 (when (eq (char-after) ?\[)
2291 (setq code (buffer-substring (point)
2292 (search-forward "]")))
2294 (setq text (buffer-substring (point) (point-max)))
2295 (push (list token status code text)
2296 imap-failed-tags))))
2298 (setq imap-reached-tag (max imap-reached-tag token))
2300 (imap-parse-resp-text))
2302 (when (eq (char-after) ?\[)
2303 (setq code (buffer-substring (point)
2304 (search-forward "]")))
2306 (setq text (buffer-substring (point) (point-max)))
2307 (push (list token status code text) imap-failed-tags)
2308 (error "Internal error, tag %s status %s code %s text %s"
2309 token status code text))))
2310 (t (message "Garbage: %s" (buffer-string))))
2311 (when (assq token imap-callbacks)
2312 (funcall (cdr (assq token imap-callbacks)) token status)
2313 (setq imap-callbacks
2314 (imap-remassoc token imap-callbacks)))))))))
2316 ;; resp-text = ["[" resp-text-code "]" SP] text
2318 ;; text = 1*TEXT-CHAR
2320 ;; TEXT-CHAR = <any CHAR except CR and LF>
2322 (defun imap-parse-resp-text ()
2323 (imap-parse-resp-text-code))
2325 ;; resp-text-code = "ALERT" /
2326 ;; "BADCHARSET [SP "(" astring *(SP astring) ")" ] /
2327 ;; "NEWNAME" SP string SP string /
2329 ;; "PERMANENTFLAGS" SP "("
2330 ;; [flag-perm *(SP flag-perm)] ")" /
2334 ;; "UIDNEXT" SP nz-number /
2335 ;; "UIDVALIDITY" SP nz-number /
2336 ;; "UNSEEN" SP nz-number /
2337 ;; resp-text-atom [SP 1*<any TEXT-CHAR except "]">]
2339 ;; resp_code_apnd = "APPENDUID" SPACE nz_number SPACE uniqueid
2341 ;; resp_code_copy = "COPYUID" SPACE nz_number SPACE set SPACE set
2343 ;; set = sequence-num / (sequence-num ":" sequence-num) /
2345 ;; ; Identifies a set of messages. For message
2346 ;; ; sequence numbers, these are consecutive
2347 ;; ; numbers from 1 to the number of messages in
2349 ;; ; Comma delimits individual numbers, colon
2350 ;; ; delimits between two numbers inclusive.
2351 ;; ; Example: 2,4:7,9,12:* is 2,4,5,6,7,9,12,13,
2352 ;; ; 14,15 for a mailbox with 15 messages.
2354 ;; sequence-num = nz-number / "*"
2355 ;; ; * is the largest number in use. For message
2356 ;; ; sequence numbers, it is the number of messages
2357 ;; ; in the mailbox. For unique identifiers, it is
2358 ;; ; the unique identifier of the last message in
2361 ;; flag-perm = flag / "\*"
2363 ;; flag = "\Answered" / "\Flagged" / "\Deleted" /
2364 ;; "\Seen" / "\Draft" / flag-keyword / flag-extension
2365 ;; ; Does not include "\Recent"
2367 ;; flag-extension = "\" atom
2368 ;; ; Future expansion. Client implementations
2369 ;; ; MUST accept flag-extension flags. Server
2370 ;; ; implementations MUST NOT generate
2371 ;; ; flag-extension flags except as defined by
2372 ;; ; future standard or standards-track
2373 ;; ; revisions of this specification.
2375 ;; flag-keyword = atom
2377 ;; resp-text-atom = 1*<any ATOM-CHAR except "]">
2379 (defun imap-parse-resp-text-code ()
2380 ;; xxx next line for stalker communigate pro 3.3.1 bug
2381 (when (looking-at " \\[")
2383 (when (eq (char-after) ?\[)
2385 (cond ((search-forward "PERMANENTFLAGS " nil t)
2386 (imap-mailbox-put 'permanentflags (imap-parse-flag-list)))
2387 ((search-forward "UIDNEXT \\([0-9]+\\)" nil t)
2388 (imap-mailbox-put 'uidnext (match-string 1)))
2389 ((search-forward "UNSEEN " nil t)
2390 (imap-mailbox-put 'first-unseen (read (current-buffer))))
2391 ((looking-at "UIDVALIDITY \\([0-9]+\\)")
2392 (imap-mailbox-put 'uidvalidity (match-string 1)))
2393 ((search-forward "READ-ONLY" nil t)
2394 (imap-mailbox-put 'read-only t))
2395 ((search-forward "NEWNAME " nil t)
2396 (let (oldname newname)
2397 (setq oldname (imap-parse-string))
2399 (setq newname (imap-parse-string))
2400 (imap-mailbox-put 'newname newname oldname)))
2401 ((search-forward "TRYCREATE" nil t)
2402 (imap-mailbox-put 'trycreate t imap-current-target-mailbox))
2403 ((looking-at "APPENDUID \\([0-9]+\\) \\([0-9]+\\)")
2404 (imap-mailbox-put 'appenduid
2405 (list (match-string 1)
2406 (string-to-number (match-string 2)))
2407 imap-current-target-mailbox))
2408 ((looking-at "COPYUID \\([0-9]+\\) \\([0-9,:]+\\) \\([0-9,:]+\\)")
2409 (imap-mailbox-put 'copyuid (list (match-string 1)
2412 imap-current-target-mailbox))
2413 ((search-forward "ALERT] " nil t)
2414 (message "Imap server %s information: %s" imap-server
2415 (buffer-substring (point) (point-max)))))))
2417 ;; mailbox-list = "(" [mbx-list-flags] ")" SP
2418 ;; (DQUOTE QUOTED-CHAR DQUOTE / nil) SP mailbox
2420 ;; mbx-list-flags = *(mbx-list-oflag SP) mbx-list-sflag
2421 ;; *(SP mbx-list-oflag) /
2422 ;; mbx-list-oflag *(SP mbx-list-oflag)
2424 ;; mbx-list-oflag = "\Noinferiors" / flag-extension
2425 ;; ; Other flags; multiple possible per LIST response
2427 ;; mbx-list-sflag = "\Noselect" / "\Marked" / "\Unmarked"
2428 ;; ; Selectability flags; only one per LIST response
2430 ;; QUOTED-CHAR = <any TEXT-CHAR except quoted-specials> /
2431 ;; "\" quoted-specials
2433 ;; quoted-specials = DQUOTE / "\"
2435 (defun imap-parse-data-list (type)
2436 (let (flags delimiter mailbox)
2437 (setq flags (imap-parse-flag-list))
2438 (when (looking-at " NIL\\| \"\\\\?\\(.\\)\"")
2439 (setq delimiter (match-string 1))
2440 (goto-char (1+ (match-end 0)))
2441 (when (setq mailbox (imap-parse-mailbox))
2442 (imap-mailbox-put type t mailbox)
2443 (imap-mailbox-put 'list-flags flags mailbox)
2444 (imap-mailbox-put 'delimiter delimiter mailbox)))))
2446 ;; msg_att ::= "(" 1#("ENVELOPE" SPACE envelope /
2447 ;; "FLAGS" SPACE "(" #(flag / "\Recent") ")" /
2448 ;; "INTERNALDATE" SPACE date_time /
2449 ;; "RFC822" [".HEADER" / ".TEXT"] SPACE nstring /
2450 ;; "RFC822.SIZE" SPACE number /
2451 ;; "BODY" ["STRUCTURE"] SPACE body /
2452 ;; "BODY" section ["<" number ">"] SPACE nstring /
2453 ;; "UID" SPACE uniqueid) ")"
2455 ;; date_time ::= <"> date_day_fixed "-" date_month "-" date_year
2456 ;; SPACE time SPACE zone <">
2458 ;; section ::= "[" [section_text / (nz_number *["." nz_number]
2459 ;; ["." (section_text / "MIME")])] "]"
2461 ;; section_text ::= "HEADER" / "HEADER.FIELDS" [".NOT"]
2462 ;; SPACE header_list / "TEXT"
2464 ;; header_fld_name ::= astring
2466 ;; header_list ::= "(" 1#header_fld_name ")"
2468 (defsubst imap-parse-header-list ()
2469 (when (eq (char-after) ?\()
2471 (while (not (eq (char-after) ?\)))
2473 (push (imap-parse-astring) strlist))
2475 (nreverse strlist))))
2477 (defsubst imap-parse-fetch-body-section ()
2479 (buffer-substring (point) (1- (re-search-forward "[] ]" nil t)))))
2480 (if (eq (char-before) ? )
2482 (mapconcat 'identity (cons section (imap-parse-header-list)) " ")
2483 (search-forward "]" nil t))
2486 (defun imap-parse-fetch (response)
2487 (when (eq (char-after) ?\()
2488 (let (uid flags envelope internaldate rfc822 rfc822header rfc822text
2489 rfc822size body bodydetail bodystructure flags-empty)
2490 (while (not (eq (char-after) ?\)))
2492 (let ((token (read (current-buffer))))
2494 (cond ((eq token 'UID)
2495 (setq uid (condition-case ()
2496 (read (current-buffer))
2499 (setq flags (imap-parse-flag-list))
2501 (setq flags-empty 't)))
2502 ((eq token 'ENVELOPE)
2503 (setq envelope (imap-parse-envelope)))
2504 ((eq token 'INTERNALDATE)
2505 (setq internaldate (imap-parse-string)))
2507 (setq rfc822 (imap-parse-nstring)))
2508 ((eq token 'RFC822.HEADER)
2509 (setq rfc822header (imap-parse-nstring)))
2510 ((eq token 'RFC822.TEXT)
2511 (setq rfc822text (imap-parse-nstring)))
2512 ((eq token 'RFC822.SIZE)
2513 (setq rfc822size (read (current-buffer))))
2515 (if (eq (char-before) ?\[)
2517 (upcase (imap-parse-fetch-body-section))
2518 (and (eq (char-after) ?<)
2519 (buffer-substring (1+ (point))
2520 (search-forward ">" nil t)))
2521 (progn (imap-forward)
2522 (imap-parse-nstring)))
2524 (setq body (imap-parse-body))))
2525 ((eq token 'BODYSTRUCTURE)
2526 (setq bodystructure (imap-parse-body))))))
2528 (setq imap-current-message uid)
2529 (imap-message-put uid 'UID uid)
2530 (and (or flags flags-empty) (imap-message-put uid 'FLAGS flags))
2531 (and envelope (imap-message-put uid 'ENVELOPE envelope))
2532 (and internaldate (imap-message-put uid 'INTERNALDATE internaldate))
2533 (and rfc822 (imap-message-put uid 'RFC822 rfc822))
2534 (and rfc822header (imap-message-put uid 'RFC822.HEADER rfc822header))
2535 (and rfc822text (imap-message-put uid 'RFC822.TEXT rfc822text))
2536 (and rfc822size (imap-message-put uid 'RFC822.SIZE rfc822size))
2537 (and body (imap-message-put uid 'BODY body))
2538 (and bodydetail (imap-message-put uid 'BODYDETAIL bodydetail))
2539 (and bodystructure (imap-message-put uid 'BODYSTRUCTURE bodystructure))
2540 (run-hooks 'imap-fetch-data-hook)))))
2542 ;; mailbox-data = ...
2543 ;; "STATUS" SP mailbox SP "("
2544 ;; [status-att SP number
2545 ;; *(SP status-att SP number)] ")"
2548 ;; status-att = "MESSAGES" / "RECENT" / "UIDNEXT" / "UIDVALIDITY" /
2551 (defun imap-parse-status ()
2552 (let ((mailbox (imap-parse-mailbox)))
2553 (if (eq (char-after) ? )
2555 (when (and mailbox (eq (char-after) ?\())
2556 (while (and (not (eq (char-after) ?\)))
2557 (or (forward-char) t)
2558 (looking-at "\\([A-Za-z]+\\) "))
2559 (let ((token (upcase (match-string 1))))
2560 (goto-char (match-end 0))
2561 (cond ((string= token "MESSAGES")
2562 (imap-mailbox-put 'messages (read (current-buffer)) mailbox))
2563 ((string= token "RECENT")
2564 (imap-mailbox-put 'recent (read (current-buffer)) mailbox))
2565 ((string= token "UIDNEXT")
2566 (and (looking-at "[0-9]+")
2567 (imap-mailbox-put 'uidnext (match-string 0) mailbox)
2568 (goto-char (match-end 0))))
2569 ((string= token "UIDVALIDITY")
2570 (and (looking-at "[0-9]+")
2571 (imap-mailbox-put 'uidvalidity (match-string 0) mailbox)
2572 (goto-char (match-end 0))))
2573 ((string= token "UNSEEN")
2574 (imap-mailbox-put 'unseen (read (current-buffer)) mailbox))
2576 (message "Unknown status data %s in mailbox %s ignored"
2578 (read (current-buffer)))))))))
2580 ;; acl_data ::= "ACL" SPACE mailbox *(SPACE identifier SPACE
2583 ;; identifier ::= astring
2585 ;; rights ::= astring
2587 (defun imap-parse-acl ()
2588 (let ((mailbox (imap-parse-mailbox))
2589 identifier rights acl)
2590 (while (eq (char-after) ?\ )
2592 (setq identifier (imap-parse-astring))
2594 (setq rights (imap-parse-astring))
2595 (setq acl (append acl (list (cons identifier rights)))))
2596 (imap-mailbox-put 'acl acl mailbox)))
2598 ;; flag-list = "(" [flag *(SP flag)] ")"
2600 ;; flag = "\Answered" / "\Flagged" / "\Deleted" /
2601 ;; "\Seen" / "\Draft" / flag-keyword / flag-extension
2602 ;; ; Does not include "\Recent"
2604 ;; flag-keyword = atom
2606 ;; flag-extension = "\" atom
2607 ;; ; Future expansion. Client implementations
2608 ;; ; MUST accept flag-extension flags. Server
2609 ;; ; implementations MUST NOT generate
2610 ;; ; flag-extension flags except as defined by
2611 ;; ; future standard or standards-track
2612 ;; ; revisions of this specification.
2614 (defun imap-parse-flag-list ()
2615 (let (flag-list start)
2616 (assert (eq (char-after) ?\() nil "In imap-parse-flag-list")
2617 (while (and (not (eq (char-after) ?\)))
2620 ;; next line for Courier IMAP bug.
2621 (skip-chars-forward " ")
2623 (> (skip-chars-forward "^ )" (point-at-eol)) 0))
2624 (push (buffer-substring start (point)) flag-list))
2625 (assert (eq (char-after) ?\)) nil "In imap-parse-flag-list")
2627 (nreverse flag-list)))
2629 ;; envelope = "(" env-date SP env-subject SP env-from SP env-sender SP
2630 ;; env-reply-to SP env-to SP env-cc SP env-bcc SP
2631 ;; env-in-reply-to SP env-message-id ")"
2633 ;; env-bcc = "(" 1*address ")" / nil
2635 ;; env-cc = "(" 1*address ")" / nil
2637 ;; env-date = nstring
2639 ;; env-from = "(" 1*address ")" / nil
2641 ;; env-in-reply-to = nstring
2643 ;; env-message-id = nstring
2645 ;; env-reply-to = "(" 1*address ")" / nil
2647 ;; env-sender = "(" 1*address ")" / nil
2649 ;; env-subject = nstring
2651 ;; env-to = "(" 1*address ")" / nil
2653 (defun imap-parse-envelope ()
2654 (when (eq (char-after) ?\()
2656 (vector (prog1 (imap-parse-nstring) ;; date
2658 (prog1 (imap-parse-nstring) ;; subject
2660 (prog1 (imap-parse-address-list) ;; from
2662 (prog1 (imap-parse-address-list) ;; sender
2664 (prog1 (imap-parse-address-list) ;; reply-to
2666 (prog1 (imap-parse-address-list) ;; to
2668 (prog1 (imap-parse-address-list) ;; cc
2670 (prog1 (imap-parse-address-list) ;; bcc
2672 (prog1 (imap-parse-nstring) ;; in-reply-to
2674 (prog1 (imap-parse-nstring) ;; message-id
2677 ;; body-fld-param = "(" string SP string *(SP string SP string) ")" / nil
2679 (defsubst imap-parse-string-list ()
2680 (cond ((eq (char-after) ?\() ;; body-fld-param
2683 (while (setq str (imap-parse-string))
2685 ;; buggy stalker communigate pro 3.0 doesn't print SPC
2686 ;; between body-fld-param's sometimes
2687 (or (eq (char-after) ?\")
2689 (nreverse strlist)))
2693 ;; body-extension = nstring / number /
2694 ;; "(" body-extension *(SP body-extension) ")"
2695 ;; ; Future expansion. Client implementations
2696 ;; ; MUST accept body-extension fields. Server
2697 ;; ; implementations MUST NOT generate
2698 ;; ; body-extension fields except as defined by
2699 ;; ; future standard or standards-track
2700 ;; ; revisions of this specification.
2702 (defun imap-parse-body-extension ()
2703 (if (eq (char-after) ?\()
2706 (push (imap-parse-body-extension) b-e)
2707 (while (eq (char-after) ?\ )
2709 (push (imap-parse-body-extension) b-e))
2710 (assert (eq (char-after) ?\)) nil "In imap-parse-body-extension")
2713 (or (imap-parse-number)
2714 (imap-parse-nstring))))
2716 ;; body-ext-1part = body-fld-md5 [SP body-fld-dsp [SP body-fld-lang
2717 ;; *(SP body-extension)]]
2718 ;; ; MUST NOT be returned on non-extensible
2721 ;; body-ext-mpart = body-fld-param [SP body-fld-dsp [SP body-fld-lang
2722 ;; *(SP body-extension)]]
2723 ;; ; MUST NOT be returned on non-extensible
2726 (defsubst imap-parse-body-ext ()
2728 (when (eq (char-after) ?\ ) ;; body-fld-dsp
2731 (if (eq (char-after) ?\()
2734 (push (imap-parse-string) dsp)
2736 (push (imap-parse-string-list) dsp)
2738 ;; With assert, the code might not be eval'd.
2739 ;; (assert (imap-parse-nil) t "In imap-parse-body-ext")
2741 (push (nreverse dsp) ext))
2742 (when (eq (char-after) ?\ ) ;; body-fld-lang
2744 (if (eq (char-after) ?\()
2745 (push (imap-parse-string-list) ext)
2746 (push (imap-parse-nstring) ext))
2747 (while (eq (char-after) ?\ ) ;; body-extension
2749 (setq ext (append (imap-parse-body-extension) ext)))))
2752 ;; body = "(" body-type-1part / body-type-mpart ")"
2754 ;; body-ext-1part = body-fld-md5 [SP body-fld-dsp [SP body-fld-lang
2755 ;; *(SP body-extension)]]
2756 ;; ; MUST NOT be returned on non-extensible
2759 ;; body-ext-mpart = body-fld-param [SP body-fld-dsp [SP body-fld-lang
2760 ;; *(SP body-extension)]]
2761 ;; ; MUST NOT be returned on non-extensible
2764 ;; body-fields = body-fld-param SP body-fld-id SP body-fld-desc SP
2765 ;; body-fld-enc SP body-fld-octets
2767 ;; body-fld-desc = nstring
2769 ;; body-fld-dsp = "(" string SP body-fld-param ")" / nil
2771 ;; body-fld-enc = (DQUOTE ("7BIT" / "8BIT" / "BINARY" / "BASE64"/
2772 ;; "QUOTED-PRINTABLE") DQUOTE) / string
2774 ;; body-fld-id = nstring
2776 ;; body-fld-lang = nstring / "(" string *(SP string) ")"
2778 ;; body-fld-lines = number
2780 ;; body-fld-md5 = nstring
2782 ;; body-fld-octets = number
2784 ;; body-fld-param = "(" string SP string *(SP string SP string) ")" / nil
2786 ;; body-type-1part = (body-type-basic / body-type-msg / body-type-text)
2787 ;; [SP body-ext-1part]
2789 ;; body-type-basic = media-basic SP body-fields
2790 ;; ; MESSAGE subtype MUST NOT be "RFC822"
2792 ;; body-type-msg = media-message SP body-fields SP envelope
2793 ;; SP body SP body-fld-lines
2795 ;; body-type-text = media-text SP body-fields SP body-fld-lines
2797 ;; body-type-mpart = 1*body SP media-subtype
2798 ;; [SP body-ext-mpart]
2800 ;; media-basic = ((DQUOTE ("APPLICATION" / "AUDIO" / "IMAGE" /
2801 ;; "MESSAGE" / "VIDEO") DQUOTE) / string) SP media-subtype
2802 ;; ; Defined in [MIME-IMT]
2804 ;; media-message = DQUOTE "MESSAGE" DQUOTE SP DQUOTE "RFC822" DQUOTE
2805 ;; ; Defined in [MIME-IMT]
2807 ;; media-subtype = string
2808 ;; ; Defined in [MIME-IMT]
2810 ;; media-text = DQUOTE "TEXT" DQUOTE SP media-subtype
2811 ;; ; Defined in [MIME-IMT]
2813 (defun imap-parse-body ()
2815 (when (eq (char-after) ?\()
2817 (if (eq (char-after) ?\()
2819 (while (and (eq (char-after) ?\()
2820 (setq subbody (imap-parse-body)))
2821 ;; buggy stalker communigate pro 3.0 insert a SPC between
2822 ;; parts in multiparts
2823 (when (and (eq (char-after) ?\ )
2824 (eq (char-after (1+ (point))) ?\())
2826 (push subbody body))
2828 (push (imap-parse-string) body) ;; media-subtype
2829 (when (eq (char-after) ?\ ) ;; body-ext-mpart:
2831 (if (eq (char-after) ?\() ;; body-fld-param
2832 (push (imap-parse-string-list) body)
2833 (push (and (imap-parse-nil) nil) body))
2835 (append (imap-parse-body-ext) body))) ;; body-ext-...
2836 (assert (eq (char-after) ?\)) nil "In imap-parse-body")
2840 (push (imap-parse-string) body) ;; media-type
2842 (push (imap-parse-string) body) ;; media-subtype
2844 ;; next line for Sun SIMS bug
2845 (and (eq (char-after) ? ) (imap-forward))
2846 (if (eq (char-after) ?\() ;; body-fld-param
2847 (push (imap-parse-string-list) body)
2848 (push (and (imap-parse-nil) nil) body))
2850 (push (imap-parse-nstring) body) ;; body-fld-id
2852 (push (imap-parse-nstring) body) ;; body-fld-desc
2854 ;; next `or' for Sun SIMS bug, it regard body-fld-enc as a
2855 ;; nstring and return nil instead of defaulting back to 7BIT
2856 ;; as the standard says.
2857 (push (or (imap-parse-nstring) "7BIT") body) ;; body-fld-enc
2859 (push (imap-parse-number) body) ;; body-fld-octets
2861 ;; ok, we're done parsing the required parts, what comes now is one
2864 ;; envelope (then we're parsing body-type-msg)
2865 ;; body-fld-lines (then we're parsing body-type-text)
2866 ;; body-ext-1part (then we're parsing body-type-basic)
2868 ;; the problem is that the two first are in turn optionally followed
2869 ;; by the third. So we parse the first two here (if there are any)...
2871 (when (eq (char-after) ?\ )
2874 (cond ((eq (char-after) ?\() ;; body-type-msg:
2875 (push (imap-parse-envelope) body) ;; envelope
2877 (push (imap-parse-body) body) ;; body
2878 ;; buggy stalker communigate pro 3.0 doesn't print
2879 ;; number of lines in message/rfc822 attachment
2880 (if (eq (char-after) ?\))
2883 (push (imap-parse-number) body))) ;; body-fld-lines
2884 ((setq lines (imap-parse-number)) ;; body-type-text:
2885 (push lines body)) ;; body-fld-lines
2887 (backward-char))))) ;; no match...
2889 ;; ...and then parse the third one here...
2891 (when (eq (char-after) ?\ ) ;; body-ext-1part:
2893 (push (imap-parse-nstring) body) ;; body-fld-md5
2894 (setq body (append (imap-parse-body-ext) body))) ;; body-ext-1part..
2896 (assert (eq (char-after) ?\)) nil "In imap-parse-body 2")
2900 (when imap-debug ; (untrace-all)
2902 (buffer-disable-undo (get-buffer-create imap-debug-buffer))
2903 (mapc (lambda (f) (trace-function-background f imap-debug-buffer))
2914 imap-interactive-login
2930 imap-send-command-wait
2935 imap-current-mailbox
2936 imap-current-mailbox-p-1
2937 imap-current-mailbox-p
2938 imap-mailbox-select-1
2940 imap-mailbox-examine-1
2941 imap-mailbox-examine
2942 imap-mailbox-unselect
2943 imap-mailbox-expunge
2945 imap-mailbox-create-1
2951 imap-mailbox-subscribe
2952 imap-mailbox-unsubscribe
2954 imap-mailbox-acl-get
2955 imap-mailbox-acl-set
2956 imap-mailbox-acl-delete
2957 imap-current-message
2958 imap-list-to-message-set
2965 imap-message-flag-permanent-p
2966 imap-message-flags-set
2967 imap-message-flags-del
2968 imap-message-flags-add
2969 imap-message-copyuid-1
2970 imap-message-copyuid
2972 imap-message-appenduid-1
2973 imap-message-appenduid
2985 imap-parse-resp-text
2986 imap-parse-resp-text-code
2987 imap-parse-data-list
2991 imap-parse-flag-list
2993 imap-parse-body-extension
2999 ;;; arch-tag: 27369ed6-33e4-482f-96f1-8bb906ba70f7
3000 ;;; imap.el ends here