1 ;;; imap.el --- imap library
3 ;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
6 ;; Author: Simon Josefsson <simon@josefsson.org>
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 of the License, or
14 ;; (at your option) any later version.
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. If not, see <http://www.gnu.org/licenses/>.
26 ;; imap.el is an elisp library providing an interface for talking to
29 ;; imap.el is roughly divided in two parts, one that parses IMAP
30 ;; responses from the server and storing data into buffer-local
31 ;; variables, and one for utility functions which send commands to
32 ;; server, waits for an answer, and return information. The latter
33 ;; part is layered on top of the previous.
35 ;; The imap.el API consist of the following functions, other functions
36 ;; in this file should not be called directly and the result of doing
37 ;; so are at best undefined.
41 ;; imap-open, imap-opened, imap-authenticate, imap-close,
42 ;; imap-capability, imap-namespace, imap-error-text
46 ;; imap-mailbox-get, imap-mailbox-map, imap-current-mailbox,
47 ;; imap-current-mailbox-p, imap-search, imap-mailbox-select,
48 ;; imap-mailbox-examine, imap-mailbox-unselect, imap-mailbox-expunge
49 ;; imap-mailbox-close, imap-mailbox-create, imap-mailbox-delete
50 ;; imap-mailbox-rename, imap-mailbox-lsub, imap-mailbox-list
51 ;; imap-mailbox-subscribe, imap-mailbox-unsubscribe, imap-mailbox-status
52 ;; imap-mailbox-acl-get, imap-mailbox-acl-set, imap-mailbox-acl-delete
56 ;; imap-fetch-asynch, imap-fetch,
57 ;; imap-current-message, imap-list-to-message-set,
58 ;; imap-message-get, imap-message-map
59 ;; imap-message-envelope-date, imap-message-envelope-subject,
60 ;; imap-message-envelope-from, imap-message-envelope-sender,
61 ;; imap-message-envelope-reply-to, imap-message-envelope-to,
62 ;; imap-message-envelope-cc, imap-message-envelope-bcc
63 ;; imap-message-envelope-in-reply-to, imap-message-envelope-message-id
64 ;; imap-message-body, imap-message-flag-permanent-p
65 ;; imap-message-flags-set, imap-message-flags-del
66 ;; imap-message-flags-add, imap-message-copyuid
67 ;; imap-message-copy, imap-message-appenduid
68 ;; imap-message-append, imap-envelope-from
71 ;; It is my hope that these commands should be pretty self
72 ;; explanatory for someone that know IMAP. All functions have
73 ;; additional documentation on how to invoke them.
75 ;; imap.el supports RFC1730/2060/RFC3501 (IMAP4/IMAP4rev1). The implemented
76 ;; IMAP extensions are RFC2195 (CRAM-MD5), RFC2086 (ACL), RFC2342
77 ;; (NAMESPACE), RFC2359 (UIDPLUS), the IMAP-part of RFC2595 (STARTTLS,
78 ;; LOGINDISABLED) (with use of external library starttls.el and
79 ;; program starttls), and the GSSAPI / Kerberos V4 sections of RFC1731
80 ;; (with use of external program `imtest'), and RFC2971 (ID). It also
81 ;; takes advantage of the UNSELECT extension in Cyrus IMAPD.
83 ;; Without the work of John McClary Prevost and Jim Radford this library
84 ;; would not have seen the light of day. Many thanks.
86 ;; This is a transcript of a short interactive session for demonstration
89 ;; (imap-open "my.mail.server")
90 ;; => " *imap* my.mail.server:0"
92 ;; The rest are invoked with current buffer as the buffer returned by
93 ;; `imap-open'. It is possible to do it all without this, but it would
94 ;; look ugly here since `buffer' is always the last argument for all
95 ;; imap.el API functions.
97 ;; (imap-authenticate "myusername" "mypassword")
100 ;; (imap-mailbox-lsub "*")
101 ;; => ("INBOX.sentmail" "INBOX.private" "INBOX.draft" "INBOX.spam")
103 ;; (imap-mailbox-list "INBOX.n%")
104 ;; => ("INBOX.namedroppers" "INBOX.nnimap" "INBOX.ntbugtraq")
106 ;; (imap-mailbox-select "INBOX.nnimap")
109 ;; (imap-mailbox-get 'exists)
112 ;; (imap-mailbox-get 'uidvalidity)
115 ;; (imap-search "FLAGGED SINCE 18-DEC-98")
118 ;; (imap-fetch 235 "RFC822.PEEK" 'RFC822)
119 ;; => "X-Sieve: cmu-sieve 1.3^M\nX-Username: <jas@pdc.kth.se>^M\r...."
123 ;; o Parse UIDs as strings? We need to overcome the 28 bit limit somehow.
124 ;; Use IEEE floats (which are effectively exact)? -- fx
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 ;; o Send strings as literal if they contain, e.g., ".
132 ;; - 19991218 added starttls/digest-md5 patch,
133 ;; by Daiki Ueno <ueno@ueda.info.waseda.ac.jp>
134 ;; NB! you need SLIM for starttls.el and digest-md5.el
135 ;; - 19991023 committed to pgnus
140 (eval-when-compile (require 'cl))
142 (unless (fboundp 'declare-function) (defmacro declare-function (&rest r)))
143 (autoload 'starttls-open-stream "starttls")
144 (autoload 'starttls-negotiate "starttls")
145 (autoload 'sasl-find-mechanism "sasl")
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 'utf7-encode "utf7")
152 (autoload 'utf7-decode "utf7")
153 (autoload 'format-spec "format-spec")
154 (autoload 'format-spec-make "format-spec")
155 (autoload 'open-tls-stream "tls"))
160 "Low-level IMAP issues."
164 (defcustom imap-kerberos4-program '("imtest -m kerberos_v4 -u %l -p %p %s"
166 "List of strings containing commands for Kerberos 4 authentication.
167 %s is replaced with server hostname, %p with port to connect to, and
168 %l with the value of `imap-default-user'. The program should accept
169 IMAP commands on stdin and return responses to stdout. Each entry in
170 the list is tried until a successful connection is made."
172 :type '(repeat string))
174 (defcustom imap-gssapi-program (list
175 (concat "gsasl %s %p "
176 "--mechanism GSSAPI "
177 "--authentication-id %l")
178 "imtest -m gssapi -u %l -p %p %s")
179 "List of strings containing commands for GSSAPI (krb5) authentication.
180 %s is replaced with server hostname, %p with port to connect to, and
181 %l with the value of `imap-default-user'. The program should accept
182 IMAP commands on stdin and return responses to stdout. Each entry in
183 the list is tried until a successful connection is made."
185 :type '(repeat string))
187 (defcustom imap-ssl-program '("openssl s_client -quiet -ssl3 -connect %s:%p"
188 "openssl s_client -quiet -ssl2 -connect %s:%p"
189 "s_client -quiet -ssl3 -connect %s:%p"
190 "s_client -quiet -ssl2 -connect %s:%p")
191 "A string, or list of strings, containing commands for SSL connections.
192 Within a string, %s is replaced with the server address and %p with
193 port number on server. The program should accept IMAP commands on
194 stdin and return responses to stdout. Each entry in the list is tried
195 until a successful connection is made."
197 :type '(choice string
200 (defcustom imap-shell-program '("ssh %s imapd"
202 "ssh %g ssh %s imapd"
203 "rsh %g rsh %s imapd")
204 "A list of strings, containing commands for IMAP connection.
205 Within a string, %s is replaced with the server address, %p with port
206 number on server, %g with `imap-shell-host', and %l with
207 `imap-default-user'. The program should read IMAP commands from stdin
208 and write IMAP response to stdout. Each entry in the list is tried
209 until a successful connection is made."
211 :type '(repeat string))
213 (defcustom imap-process-connection-type nil
214 "*Value for `process-connection-type' to use for Kerberos4, GSSAPI and SSL.
215 The `process-connection-type' variable controls the type of device
216 used to communicate with subprocesses. Values are nil to use a
217 pipe, or t or `pty' to use a pty. The value has no effect if the
218 system has no ptys or if all ptys are busy: then a pipe is used
219 in any case. The value takes effect when an IMAP server is
220 opened; changing it after that has no effect."
225 (defcustom imap-use-utf7 t
226 "If non-nil, do utf7 encoding/decoding of mailbox names.
227 Since the UTF7 decoding currently only decodes into ISO-8859-1
228 characters, you may disable this decoding if you need to access UTF7
229 encoded mailboxes which doesn't translate into ISO-8859-1."
233 (defcustom imap-log nil
234 "If non-nil, an imap session trace is placed in `imap-log-buffer'.
235 Note that username, passwords and other privacy sensitive
236 information (such as e-mail) may be stored in the buffer.
237 It is not written to disk, however. Do not enable this
238 variable unless you are comfortable with that.
240 See also `imap-debug'."
244 (defcustom imap-debug nil
245 "If non-nil, trace imap- functions into `imap-debug-buffer'.
246 Uses `trace-function-background', so you can turn it off with,
249 Note that username, passwords and other privacy sensitive
250 information (such as e-mail) may be stored in the buffer.
251 It is not written to disk, however. Do not enable this
252 variable unless you are comfortable with that.
254 This variable only takes effect when loading the `imap' library.
255 See also `imap-log'."
259 (defcustom imap-shell-host "gateway"
260 "Hostname of rlogin proxy."
264 (defcustom imap-default-user (user-login-name)
265 "Default username to use."
269 (defcustom imap-read-timeout (if (string-match
270 "windows-nt\\|os/2\\|cygwin"
271 (symbol-name system-type))
274 "*How long to wait between checking for the end of output.
275 Shorter values mean quicker response, but is more CPU intensive."
279 (defcustom imap-store-password nil
280 "If non-nil, store session password without prompting."
284 ;; Various variables.
286 (defvar imap-fetch-data-hook nil
287 "Hooks called after receiving each FETCH response.")
289 (defvar imap-streams '(gssapi kerberos4 starttls tls ssl network shell)
290 "Priority of streams to consider when opening connection to server.")
292 (defvar imap-stream-alist
293 '((gssapi imap-gssapi-stream-p imap-gssapi-open)
294 (kerberos4 imap-kerberos4-stream-p imap-kerberos4-open)
295 (tls imap-tls-p imap-tls-open)
296 (ssl imap-ssl-p imap-ssl-open)
297 (network imap-network-p imap-network-open)
298 (shell imap-shell-p imap-shell-open)
299 (starttls imap-starttls-p imap-starttls-open))
300 "Definition of network streams.
304 NAME names the stream, CHECK is a function returning non-nil if the
305 server support the stream and OPEN is a function for opening the
308 (defvar imap-authenticators '(gssapi
315 "Priority of authenticators to consider when authenticating to server.")
317 (defvar imap-authenticator-alist
318 '((gssapi imap-gssapi-auth-p imap-gssapi-auth)
319 (kerberos4 imap-kerberos4-auth-p imap-kerberos4-auth)
320 (sasl imap-sasl-auth-p imap-sasl-auth)
321 (cram-md5 imap-cram-md5-p imap-cram-md5-auth)
322 (login imap-login-p imap-login-auth)
323 (anonymous imap-anonymous-p imap-anonymous-auth)
324 (digest-md5 imap-digest-md5-p imap-digest-md5-auth))
325 "Definition of authenticators.
327 \(NAME CHECK AUTHENTICATE)
329 NAME names the authenticator. CHECK is a function returning non-nil if
330 the server support the authenticator and AUTHENTICATE is a function
331 for doing the actual authentication.")
333 (defvar imap-error nil
334 "Error codes from the last command.")
336 (defvar imap-logout-timeout nil
337 "Close server immediately if it can't logout in this number of seconds.
338 If it is nil, never close server until logout completes. Normally,
339 the value of this variable will be bound to a certain value to which
340 an application program that uses this module specifies on a per-server
343 ;; Internal constants. Change these and die.
345 (defconst imap-default-port 143)
346 (defconst imap-default-ssl-port 993)
347 (defconst imap-default-tls-port 993)
348 (defconst imap-default-stream 'network)
349 (defconst imap-coding-system-for-read 'binary)
350 (defconst imap-coding-system-for-write 'binary)
351 (defconst imap-local-variables '(imap-server
360 imap-current-target-mailbox
370 imap-calculate-literal-size-first
372 (defconst imap-log-buffer "*imap-log*")
373 (defconst imap-debug-buffer "*imap-debug*")
375 ;; Internal variables.
377 (defvar imap-stream nil)
378 (defvar imap-auth nil)
379 (defvar imap-server nil)
380 (defvar imap-port nil)
381 (defvar imap-username nil)
382 (defvar imap-password nil)
383 (defvar imap-last-authenticator nil)
384 (defvar imap-calculate-literal-size-first nil)
385 (defvar imap-state 'closed
387 Valid states are `closed', `initial', `nonauth', `auth', `selected'
390 (defvar imap-server-eol "\r\n"
391 "The EOL string sent from the server.")
393 (defvar imap-client-eol "\r\n"
394 "The EOL string we send to the server.")
396 (defvar imap-current-mailbox nil
397 "Current mailbox name.")
399 (defvar imap-current-target-mailbox nil
400 "Current target mailbox for COPY and APPEND commands.")
402 (defvar imap-mailbox-data nil
403 "Obarray with mailbox data.")
405 (defvar imap-mailbox-prime 997
406 "Length of `imap-mailbox-data'.")
408 (defvar imap-current-message nil
409 "Current message number.")
411 (defvar imap-message-data nil
412 "Obarray with message data.")
414 (defvar imap-message-prime 997
415 "Length of `imap-message-data'.")
417 (defvar imap-capability nil
418 "Capability for server.")
424 (defvar imap-namespace nil
425 "Namespace for current server.")
427 (defvar imap-reached-tag 0
428 "Lower limit on command tags that have been parsed.")
430 (defvar imap-failed-tags nil
431 "Alist of tags that failed.
432 Each element is a list with four elements; tag (a integer), response
433 state (a symbol, `OK', `NO' or `BAD'), response code (a string), and
434 human readable response text (a string).")
437 "Command tag number.")
439 (defvar imap-process nil
442 (defvar imap-continuation nil
443 "Non-nil indicates that the server emitted a continuation request.
444 The actual value is really the text on the continuation line.")
446 (defvar imap-callbacks nil
447 "List of response tags and callbacks, on the form `(number . function)'.
448 The function should take two arguments, the first the IMAP tag and the
449 second the status (OK, NO, BAD etc) of the command.")
451 (defvar imap-enable-exchange-bug-workaround nil
452 "Send FETCH UID commands as *:* instead of *.
454 When non-nil, use an alternative UIDS form. Enabling appears to
455 be required for some servers (e.g., Microsoft Exchange 2007)
456 which otherwise would trigger a response 'BAD The specified
457 message set is invalid.'. We don't unconditionally use this
458 form, since this is said to be significantly inefficient.
460 This variable is set to t automatically per server if the
461 canonical form fails.")
464 ;; Utility functions:
466 (defun imap-remassoc (key alist)
467 "Delete by side effect any elements of ALIST whose car is `equal' to KEY.
468 The modified ALIST is returned. If the first member
469 of ALIST has a car that is `equal' to KEY, there is no way to remove it
470 by side effect; therefore, write `(setq foo (remassoc key foo))' to be
471 sure of changing the value of `foo'."
473 (if (equal key (caar alist))
475 (setcdr alist (imap-remassoc key (cdr alist)))
478 (defmacro imap-disable-multibyte ()
479 "Enable multibyte in the current buffer."
480 (unless (featurep 'xemacs)
481 '(set-buffer-multibyte nil)))
483 (defsubst imap-utf7-encode (string)
487 (utf7-encode string t)
489 "imap: Could not UTF7 encode `%s', using it unencoded..."
494 (defsubst imap-utf7-decode (string)
498 (utf7-decode string t)
500 "imap: Could not UTF7 decode `%s', using it undecoded..."
505 (defsubst imap-ok-p (status)
508 (setq imap-error status)
511 (defun imap-error-text (&optional buffer)
512 (with-current-buffer (or buffer (current-buffer))
513 (nth 3 (car imap-failed-tags))))
516 ;; Server functions; stream stuff:
518 (defun imap-log (string-or-buffer)
520 (with-current-buffer (get-buffer-create imap-log-buffer)
521 (imap-disable-multibyte)
522 (buffer-disable-undo)
523 (goto-char (point-max))
524 (if (bufferp string-or-buffer)
525 (insert-buffer-substring string-or-buffer)
526 (insert string-or-buffer)))))
528 (defun imap-kerberos4-stream-p (buffer)
529 (imap-capability 'AUTH=KERBEROS_V4 buffer))
531 (defun imap-kerberos4-open (name buffer server port)
532 (let ((cmds imap-kerberos4-program)
534 (while (and (not done) (setq cmd (pop cmds)))
535 (message "Opening Kerberos 4 IMAP connection with `%s'..." cmd)
537 (let* ((port (or port imap-default-port))
538 (coding-system-for-read imap-coding-system-for-read)
539 (coding-system-for-write imap-coding-system-for-write)
540 (process-connection-type imap-process-connection-type)
541 (process (start-process
542 name buffer shell-file-name shell-command-switch
547 ?p (number-to-string port)
548 ?l imap-default-user))))
551 (with-current-buffer buffer
552 (setq imap-client-eol "\n"
553 imap-calculate-literal-size-first t)
554 (while (and (memq (process-status process) '(open run))
555 (set-buffer buffer) ;; XXX "blue moon" nntp.el bug
556 (goto-char (point-min))
557 ;; Athena IMTEST can output SSL verify errors
558 (or (while (looking-at "^verify error:num=")
561 (or (while (looking-at "^TLS connection established")
564 ;; cyrus 1.6.x (13? < x <= 22) queries capabilities
565 (or (while (looking-at "^C:")
568 ;; cyrus 1.6 imtest print "S: " before server greeting
569 (or (not (looking-at "S: "))
572 (not (and (imap-parse-greeting)
573 ;; success in imtest < 1.6:
574 (or (re-search-forward
575 "^__\\(.*\\)__\n" nil t)
576 ;; success in imtest 1.6:
578 "^\\(Authenticat.*\\)" nil t))
579 (setq response (match-string 1)))))
580 (accept-process-output process 1)
583 (message "Opening Kerberos 4 IMAP connection with `%s'...%s" cmd
584 (if response (concat "done, " response) "failed"))
585 (if (and response (let ((case-fold-search nil))
586 (not (string-match "failed" response))))
588 (if (memq (process-status process) '(open run))
590 (delete-process process)
594 (defun imap-gssapi-stream-p (buffer)
595 (imap-capability 'AUTH=GSSAPI buffer))
597 (defun imap-gssapi-open (name buffer server port)
598 (let ((cmds imap-gssapi-program)
600 (while (and (not done) (setq cmd (pop cmds)))
601 (message "Opening GSSAPI IMAP connection with `%s'..." cmd)
603 (let* ((port (or port imap-default-port))
604 (coding-system-for-read imap-coding-system-for-read)
605 (coding-system-for-write imap-coding-system-for-write)
606 (process-connection-type imap-process-connection-type)
607 (process (start-process
608 name buffer shell-file-name shell-command-switch
613 ?p (number-to-string port)
614 ?l imap-default-user))))
617 (with-current-buffer buffer
618 (setq imap-client-eol "\n"
619 imap-calculate-literal-size-first t)
620 (while (and (memq (process-status process) '(open run))
621 (set-buffer buffer) ;; XXX "blue moon" nntp.el bug
622 (goto-char (point-min))
623 ;; Athena IMTEST can output SSL verify errors
624 (or (while (looking-at "^verify error:num=")
627 (or (while (looking-at "^TLS connection established")
630 ;; cyrus 1.6.x (13? < x <= 22) queries capabilities
631 (or (while (looking-at "^C:")
634 ;; cyrus 1.6 imtest print "S: " before server greeting
635 (or (not (looking-at "S: "))
638 ;; GNU SASL may print 'Trying ...' first.
639 (or (not (looking-at "Trying "))
642 (not (and (imap-parse-greeting)
643 ;; success in imtest 1.6:
645 (concat "^\\(\\(Authenticat.*\\)\\|\\("
646 "Client authentication "
649 (setq response (match-string 1)))))
650 (accept-process-output process 1)
654 (message "GSSAPI IMAP connection: %s" (or response "failed"))
655 (if (and response (let ((case-fold-search nil))
656 (not (string-match "failed" response))))
658 (if (memq (process-status process) '(open run))
660 (delete-process process)
664 (defun imap-ssl-p (buffer)
667 (defun imap-ssl-open (name buffer server port)
668 "Open an SSL connection to SERVER."
669 (let ((cmds (if (listp imap-ssl-program) imap-ssl-program
670 (list imap-ssl-program)))
672 (while (and (not done) (setq cmd (pop cmds)))
673 (message "imap: Opening SSL connection with `%s'..." cmd)
675 (let* ((port (or port imap-default-ssl-port))
676 (coding-system-for-read imap-coding-system-for-read)
677 (coding-system-for-write imap-coding-system-for-write)
678 (process-connection-type imap-process-connection-type)
679 (set-process-query-on-exit-flag
680 (if (fboundp 'set-process-query-on-exit-flag)
681 'set-process-query-on-exit-flag
682 'process-kill-without-query))
685 (setq process (start-process
686 name buffer shell-file-name
691 ?p (number-to-string port)))))
692 (funcall set-process-query-on-exit-flag process nil)
694 (with-current-buffer buffer
695 (goto-char (point-min))
696 (while (and (memq (process-status process) '(open run))
697 (set-buffer buffer) ;; XXX "blue moon" nntp.el bug
698 (goto-char (point-max))
700 (not (imap-parse-greeting)))
701 (accept-process-output process 1)
705 (when (memq (process-status process) '(open run))
706 (setq done process))))))
709 (message "imap: Opening SSL connection with `%s'...done" cmd)
711 (message "imap: Opening SSL connection with `%s'...failed" cmd)
714 (defun imap-tls-p (buffer)
717 (defun imap-tls-open (name buffer server port)
718 (let* ((port (or port imap-default-tls-port))
719 (coding-system-for-read imap-coding-system-for-read)
720 (coding-system-for-write imap-coding-system-for-write)
721 (process (open-tls-stream name buffer server port)))
723 (while (and (memq (process-status process) '(open run))
724 ;; FIXME: Per the "blue moon" comment, the process/buffer
725 ;; handling here, and elsewhere in functions which open
726 ;; streams, looks confused. Obviously we can change buffers
727 ;; if a different process handler kicks in from
728 ;; `accept-process-output' or `sit-for' below, and TRT seems
729 ;; to be to `save-buffer' around those calls. (I wonder why
730 ;; `sit-for' is used with a non-zero wait.) -- fx
731 (set-buffer buffer) ;; XXX "blue moon" nntp.el bug
732 (goto-char (point-max))
734 (not (imap-parse-greeting)))
735 (accept-process-output process 1)
738 (when (memq (process-status process) '(open run))
741 (defun imap-network-p (buffer)
744 (defun imap-network-open (name buffer server port)
745 (let* ((port (or port imap-default-port))
746 (coding-system-for-read imap-coding-system-for-read)
747 (coding-system-for-write imap-coding-system-for-write)
748 (process (open-network-stream name buffer server port)))
750 (while (and (memq (process-status process) '(open run))
751 (set-buffer buffer) ;; XXX "blue moon" nntp.el bug
752 (goto-char (point-min))
753 (not (imap-parse-greeting)))
754 (accept-process-output process 1)
757 (when (memq (process-status process) '(open run))
760 (defun imap-shell-p (buffer)
763 (defun imap-shell-open (name buffer server port)
764 (let ((cmds (if (listp imap-shell-program) imap-shell-program
765 (list imap-shell-program)))
767 (while (and (not done) (setq cmd (pop cmds)))
768 (message "imap: Opening IMAP connection with `%s'..." cmd)
769 (setq imap-client-eol "\n")
770 (let* ((port (or port imap-default-port))
771 (coding-system-for-read imap-coding-system-for-read)
772 (coding-system-for-write imap-coding-system-for-write)
773 (process (start-process
774 name buffer shell-file-name shell-command-switch
780 ?p (number-to-string port)
781 ?l imap-default-user)))))
783 (while (and (memq (process-status process) '(open run))
784 (set-buffer buffer) ;; XXX "blue moon" nntp.el bug
785 (goto-char (point-max))
787 (not (imap-parse-greeting)))
788 (accept-process-output process 1)
792 (when (memq (process-status process) '(open run))
793 (setq done process)))))
796 (message "imap: Opening IMAP connection with `%s'...done" cmd)
798 (message "imap: Opening IMAP connection with `%s'...failed" cmd)
801 (defun imap-starttls-p (buffer)
802 (imap-capability 'STARTTLS buffer))
804 (defun imap-starttls-open (name buffer server port)
805 (let* ((port (or port imap-default-port))
806 (coding-system-for-read imap-coding-system-for-read)
807 (coding-system-for-write imap-coding-system-for-write)
808 (process (starttls-open-stream name buffer server port))
810 (message "imap: Connecting with STARTTLS...")
812 (while (and (memq (process-status process) '(open run))
813 (set-buffer buffer) ;; XXX "blue moon" nntp.el bug
814 (goto-char (point-max))
816 (not (imap-parse-greeting)))
817 (accept-process-output process 1)
819 (imap-send-command "STARTTLS")
820 (while (and (memq (process-status process) '(open run))
821 (set-buffer buffer) ;; XXX "blue moon" nntp.el bug
822 (goto-char (point-max))
824 (not (re-search-forward "[0-9]+ OK.*\r?\n" nil t)))
825 (accept-process-output process 1)
828 (when (and (setq tls-info (starttls-negotiate process))
829 (memq (process-status process) '(open run)))
830 (setq done process)))
831 (if (stringp tls-info)
832 (message "imap: STARTTLS info: %s" tls-info))
833 (message "imap: Connecting with STARTTLS...%s" (if done "done" "failed"))
836 ;; Server functions; authenticator stuff:
838 (defun imap-interactive-login (buffer loginfunc)
839 "Login to server in BUFFER.
840 LOGINFUNC is passed a username and a password, it should return t if
841 it where successful authenticating itself to the server, nil otherwise.
842 Returns t if login was successful, nil otherwise."
843 (with-current-buffer buffer
844 (make-local-variable 'imap-username)
845 (make-local-variable 'imap-password)
846 (let (user passwd ret)
847 ;; (condition-case ()
848 (while (or (not user) (not passwd))
849 (setq user (or imap-username
850 (read-from-minibuffer
851 (concat "imap: username for " imap-server
852 " (using stream `" (symbol-name imap-stream)
854 (or user imap-default-user))))
855 (setq passwd (or imap-password
857 (concat "imap: password for " user "@"
858 imap-server " (using authenticator `"
859 (symbol-name imap-auth) "'): "))))
860 (when (and user passwd)
861 (if (funcall loginfunc user passwd)
863 (message "imap: Login successful...")
866 (when (and (not imap-password)
867 (or imap-store-password
868 (y-or-n-p "imap: Store password for this IMAP session? ")))
869 (setq imap-password passwd)))
870 (message "imap: Login failed...")
872 (setq imap-password nil)
874 ;; (quit (with-current-buffer buffer
877 ;; (error (with-current-buffer buffer
882 (defun imap-gssapi-auth-p (buffer)
883 (eq imap-stream 'gssapi))
885 (defun imap-gssapi-auth (buffer)
886 (message "imap: Authenticating using GSSAPI...%s"
887 (if (eq imap-stream 'gssapi) "done" "failed"))
888 (eq imap-stream 'gssapi))
890 (defun imap-kerberos4-auth-p (buffer)
891 (and (imap-capability 'AUTH=KERBEROS_V4 buffer)
892 (eq imap-stream 'kerberos4)))
894 (defun imap-kerberos4-auth (buffer)
895 (message "imap: Authenticating using Kerberos 4...%s"
896 (if (eq imap-stream 'kerberos4) "done" "failed"))
897 (eq imap-stream 'kerberos4))
899 (defun imap-cram-md5-p (buffer)
900 (imap-capability 'AUTH=CRAM-MD5 buffer))
902 (defun imap-cram-md5-auth (buffer)
903 "Login to server using the AUTH CRAM-MD5 method."
904 (message "imap: Authenticating using CRAM-MD5...")
905 (let ((done (imap-interactive-login
907 (lambda (user passwd)
909 (imap-send-command-wait
911 "AUTHENTICATE CRAM-MD5"
913 (let* ((decoded (base64-decode-string challenge))
914 (hash (rfc2104-hash 'md5 64 16 passwd decoded))
915 (response (concat user " " hash))
916 (encoded (base64-encode-string response)))
919 (message "imap: Authenticating using CRAM-MD5...done")
920 (message "imap: Authenticating using CRAM-MD5...failed"))))
922 (defun imap-login-p (buffer)
923 (and (not (imap-capability 'LOGINDISABLED buffer))
924 (not (imap-capability 'X-LOGIN-CMD-DISABLED buffer))))
926 (defun imap-quote-specials (string)
929 (goto-char (point-min))
930 (while (re-search-forward "[\\\"]" nil t)
936 (defun imap-login-auth (buffer)
937 "Login to server using the LOGIN command."
938 (message "imap: Plaintext authentication...")
939 (imap-interactive-login buffer
940 (lambda (user passwd)
941 (imap-ok-p (imap-send-command-wait
943 (imap-quote-specials user)
945 (imap-quote-specials passwd)
948 (defun imap-anonymous-p (buffer)
951 (defun imap-anonymous-auth (buffer)
952 (message "imap: Logging in anonymously...")
953 (with-current-buffer buffer
954 (imap-ok-p (imap-send-command-wait
955 (concat "LOGIN anonymous \"" (concat (user-login-name) "@"
956 (system-name)) "\"")))))
958 ;;; Compiler directives.
960 (defvar imap-sasl-client)
961 (defvar imap-sasl-step)
963 (defun imap-sasl-make-mechanisms (buffer)
966 (let ((name (symbol-name sym)))
967 (if (and (> (length name) 5)
968 (string-equal "AUTH=" (substring name 0 5 )))
969 (setq mecs (cons (substring name 5) mecs)))))
970 (imap-capability nil buffer))
973 (declare-function sasl-find-mechanism "sasl" (mechanism))
974 (declare-function sasl-mechanism-name "sasl" (mechanism))
975 (declare-function sasl-make-client "sasl" (mechanism name service server))
976 (declare-function sasl-next-step "sasl" (client step))
977 (declare-function sasl-step-data "sasl" (step))
978 (declare-function sasl-step-set-data "sasl" (step data))
980 (defun imap-sasl-auth-p (buffer)
981 (and (condition-case ()
984 (sasl-find-mechanism (imap-sasl-make-mechanisms buffer))))
986 (defun imap-sasl-auth (buffer)
987 "Login to server using the SASL method."
988 (message "imap: Authenticating using SASL...")
989 (with-current-buffer buffer
990 (make-local-variable 'imap-username)
991 (make-local-variable 'imap-sasl-client)
992 (make-local-variable 'imap-sasl-step)
993 (let ((mechanism (sasl-find-mechanism (imap-sasl-make-mechanisms buffer)))
996 (setq user (or imap-username
997 (read-from-minibuffer
998 (concat "IMAP username for " imap-server " using SASL "
999 (sasl-mechanism-name mechanism) ": ")
1000 (or user imap-default-user))))
1002 (setq imap-sasl-client (sasl-make-client mechanism user "imap2" imap-server)
1003 imap-sasl-step (sasl-next-step imap-sasl-client nil))
1004 (let ((tag (imap-send-command
1005 (if (sasl-step-data imap-sasl-step)
1006 (format "AUTHENTICATE %s %s"
1007 (sasl-mechanism-name mechanism)
1008 (sasl-step-data imap-sasl-step))
1009 (format "AUTHENTICATE %s" (sasl-mechanism-name mechanism)))
1011 (while (eq (imap-wait-for-tag tag) 'INCOMPLETE)
1012 (sasl-step-set-data imap-sasl-step (base64-decode-string imap-continuation))
1013 (setq imap-continuation nil
1014 imap-sasl-step (sasl-next-step imap-sasl-client imap-sasl-step))
1015 (imap-send-command-1 (if (sasl-step-data imap-sasl-step)
1016 (base64-encode-string (sasl-step-data imap-sasl-step) t)
1018 (if (imap-ok-p (imap-wait-for-tag tag))
1019 (setq imap-username user
1021 (message "Login failed...")
1025 (defun imap-digest-md5-p (buffer)
1026 (and (imap-capability 'AUTH=DIGEST-MD5 buffer)
1028 (require 'digest-md5)
1031 (defun imap-digest-md5-auth (buffer)
1032 "Login to server using the AUTH DIGEST-MD5 method."
1033 (message "imap: Authenticating using DIGEST-MD5...")
1034 (imap-interactive-login
1036 (lambda (user passwd)
1040 "AUTHENTICATE DIGEST-MD5"
1042 (digest-md5-parse-digest-challenge
1043 (base64-decode-string challenge))
1045 (digest-md5-digest-uri
1046 "imap" (digest-md5-challenge 'realm)))
1048 (digest-md5-digest-response
1049 user passwd digest-uri)))
1050 (base64-encode-string response 'no-line-break))))
1052 (if (not (eq (imap-wait-for-tag tag) 'INCOMPLETE))
1054 (setq imap-continuation nil)
1055 (imap-send-command-1 "")
1056 (imap-ok-p (imap-wait-for-tag tag)))))))
1058 ;; Server functions:
1060 (defun imap-open-1 (buffer)
1061 (with-current-buffer buffer
1063 (setq imap-current-mailbox nil
1064 imap-current-message nil
1066 imap-process (condition-case ()
1067 (funcall (nth 2 (assq imap-stream
1069 "imap" buffer imap-server imap-port)
1070 ((error quit) nil)))
1072 (set-process-filter imap-process 'imap-arrival-filter)
1073 (set-process-sentinel imap-process 'imap-sentinel)
1074 (while (and (eq imap-state 'initial)
1075 (memq (process-status imap-process) '(open run)))
1076 (message "Waiting for response from %s..." imap-server)
1077 (accept-process-output imap-process 1))
1078 (message "Waiting for response from %s...done" imap-server)
1079 (and (memq (process-status imap-process) '(open run))
1082 (defun imap-open (server &optional port stream auth buffer)
1083 "Open an IMAP connection to host SERVER at PORT returning a buffer.
1084 If PORT is unspecified, a default value is used (143 except
1085 for SSL which use 993).
1086 STREAM indicates the stream to use, see `imap-streams' for available
1087 streams. If nil, it choices the best stream the server is capable of.
1088 AUTH indicates authenticator to use, see `imap-authenticators' for
1089 available authenticators. If nil, it choices the best stream the
1090 server is capable of.
1091 BUFFER can be a buffer or a name of a buffer, which is created if
1092 necessary. If nil, the buffer name is generated."
1093 (setq buffer (or buffer (format " *imap* %s:%d" server (or port 0))))
1094 (with-current-buffer (get-buffer-create buffer)
1095 (if (imap-opened buffer)
1096 (imap-close buffer))
1097 (mapc 'make-local-variable imap-local-variables)
1098 (imap-disable-multibyte)
1099 (buffer-disable-undo)
1100 (setq imap-server (or server imap-server))
1101 (setq imap-port (or port imap-port))
1102 (setq imap-auth (or auth imap-auth))
1103 (setq imap-stream (or stream imap-stream))
1104 (message "imap: Connecting to %s..." imap-server)
1105 (if (null (let ((imap-stream (or imap-stream imap-default-stream)))
1106 (imap-open-1 buffer)))
1108 (message "imap: Connecting to %s...failed" imap-server)
1110 (when (null imap-stream)
1111 ;; Need to choose stream.
1112 (let ((streams imap-streams))
1113 (while (setq stream (pop streams))
1114 ;; OK to use this stream?
1115 (when (funcall (nth 1 (assq stream imap-stream-alist)) buffer)
1117 (if (not (eq imap-default-stream stream))
1118 (with-current-buffer (get-buffer-create
1119 (generate-new-buffer-name " *temp*"))
1120 (mapc 'make-local-variable imap-local-variables)
1121 (imap-disable-multibyte)
1122 (buffer-disable-undo)
1123 (setq imap-server (or server imap-server))
1124 (setq imap-port (or port imap-port))
1125 (setq imap-auth (or auth imap-auth))
1126 (message "imap: Reconnecting with stream `%s'..." stream)
1127 (if (null (let ((imap-stream stream))
1128 (imap-open-1 (current-buffer))))
1130 (kill-buffer (current-buffer))
1132 "imap: Reconnecting with stream `%s'...failed"
1134 ;; We're done, kill the first connection
1136 (let ((name (if (stringp buffer)
1138 (buffer-name buffer))))
1139 (kill-buffer buffer)
1140 (rename-buffer name)
1141 ;; set the passed buffer to the current one,
1142 ;; so that (imap-opened buffer) later will work
1143 (setq buffer (current-buffer)))
1144 (message "imap: Reconnecting with stream `%s'...done"
1146 (setq imap-stream stream)
1147 (setq imap-capability nil)
1148 (setq streams nil)))
1150 (message "imap: Connecting to %s...done" imap-server)
1151 (setq imap-stream stream)
1152 (setq imap-capability nil)
1153 (setq streams nil))))))
1154 (when (imap-opened buffer)
1155 (setq imap-mailbox-data (make-vector imap-mailbox-prime 0)))
1156 ;; (debug "opened+state+auth+buffer" (imap-opened buffer) imap-state imap-auth buffer)
1160 (defcustom imap-ping-server t
1161 "If non-nil, check if IMAP is open.
1162 See the function `imap-ping-server'."
1163 :version "23.1" ;; No Gnus
1167 (defun imap-opened (&optional buffer)
1168 "Return non-nil if connection to imap server in BUFFER is open.
1169 If BUFFER is nil then the current buffer is used."
1170 (and (setq buffer (get-buffer (or buffer (current-buffer))))
1171 (buffer-live-p buffer)
1172 (with-current-buffer buffer
1174 (memq (process-status imap-process) '(open run))
1175 (if imap-ping-server
1179 (defun imap-ping-server (&optional buffer)
1180 "Ping the IMAP server in BUFFER with a \"NOOP\" command.
1181 Return non-nil if the server responds, and nil if it does not
1182 respond. If BUFFER is nil, the current buffer is used."
1184 (imap-ok-p (imap-send-command-wait "NOOP" buffer))
1187 (defun imap-authenticate (&optional user passwd buffer)
1188 "Authenticate to server in BUFFER, using current buffer if nil.
1189 It uses the authenticator specified when opening the server. If the
1190 authenticator requires username/passwords, they are queried from the
1191 user and optionally stored in the buffer. If USER and/or PASSWD is
1192 specified, the user will not be questioned and the username and/or
1193 password is remembered in the buffer."
1194 (with-current-buffer (or buffer (current-buffer))
1195 (if (not (eq imap-state 'nonauth))
1196 (or (eq imap-state 'auth)
1197 (eq imap-state 'selected)
1198 (eq imap-state 'examine))
1199 (make-local-variable 'imap-username)
1200 (make-local-variable 'imap-password)
1201 (make-local-variable 'imap-last-authenticator)
1202 (when user (setq imap-username user))
1203 (when passwd (setq imap-password passwd))
1205 (and (setq imap-last-authenticator
1206 (assq imap-auth imap-authenticator-alist))
1207 (funcall (nth 2 imap-last-authenticator) (current-buffer))
1208 (setq imap-state 'auth))
1209 ;; Choose authenticator.
1210 (let ((auths imap-authenticators)
1212 (while (setq auth (pop auths))
1213 ;; OK to use authenticator?
1214 (setq imap-last-authenticator
1215 (assq auth imap-authenticator-alist))
1216 (when (funcall (nth 1 imap-last-authenticator) (current-buffer))
1217 (message "imap: Authenticating to `%s' using `%s'..."
1219 (setq imap-auth auth)
1220 (if (funcall (nth 2 imap-last-authenticator) (current-buffer))
1222 (message "imap: Authenticating to `%s' using `%s'...done"
1224 ;; set imap-state correctly on successful auth attempt
1225 (setq imap-state 'auth)
1226 ;; stop iterating through the authenticator list
1228 (message "imap: Authenticating to `%s' using `%s'...failed"
1229 imap-server auth)))))
1232 (defun imap-close (&optional buffer)
1233 "Close connection to server in BUFFER.
1234 If BUFFER is nil, the current buffer is used."
1235 (with-current-buffer (or buffer (current-buffer))
1240 (when (and imap-process
1241 (memq (process-status imap-process) '(open run)))
1242 (delete-process imap-process))
1243 (setq imap-current-mailbox nil
1244 imap-current-message nil
1249 (defun imap-capability (&optional identifier buffer)
1250 "Return a list of identifiers which server in BUFFER support.
1251 If IDENTIFIER, return non-nil if it's among the servers capabilities.
1252 If BUFFER is nil, the current buffer is assumed."
1253 (with-current-buffer (or buffer (current-buffer))
1254 (unless imap-capability
1255 (unless (imap-ok-p (imap-send-command-wait "CAPABILITY"))
1256 (setq imap-capability '(IMAP2))))
1258 (memq (intern (upcase (symbol-name identifier))) imap-capability)
1261 (defun imap-id (&optional list-of-values buffer)
1262 "Identify client to server in BUFFER, and return server identity.
1263 LIST-OF-VALUES is nil, or a plist with identifier and value
1264 strings to send to the server to identify the client.
1266 Return a list of identifiers which server in BUFFER support, or
1267 nil if it doesn't support ID or returns no information.
1269 If BUFFER is nil, the current buffer is assumed."
1270 (with-current-buffer (or buffer (current-buffer))
1271 (when (and (imap-capability 'ID)
1272 (imap-ok-p (imap-send-command-wait
1273 (if (null list-of-values)
1275 (concat "ID (" (mapconcat (lambda (el)
1276 (concat "\"" el "\""))
1281 (defun imap-namespace (&optional buffer)
1282 "Return a namespace hierarchy at server in BUFFER.
1283 If BUFFER is nil, the current buffer is assumed."
1284 (with-current-buffer (or buffer (current-buffer))
1285 (unless imap-namespace
1286 (when (imap-capability 'NAMESPACE)
1287 (imap-send-command-wait "NAMESPACE")))
1290 (defun imap-send-command-wait (command &optional buffer)
1291 (imap-wait-for-tag (imap-send-command command buffer) buffer))
1293 (defun imap-logout (&optional buffer)
1294 (or buffer (setq buffer (current-buffer)))
1295 (if imap-logout-timeout
1296 (with-timeout (imap-logout-timeout
1298 (with-current-buffer buffer
1299 (delete-process imap-process))
1301 (imap-send-command "LOGOUT" buffer))
1302 (imap-send-command "LOGOUT" buffer)))
1304 (defun imap-logout-wait (&optional buffer)
1305 (or buffer (setq buffer (current-buffer)))
1306 (if imap-logout-timeout
1307 (with-timeout (imap-logout-timeout
1309 (with-current-buffer buffer
1310 (delete-process imap-process))
1312 (imap-send-command-wait "LOGOUT" buffer))
1313 (imap-send-command-wait "LOGOUT" buffer)))
1316 ;; Mailbox functions:
1318 (defun imap-mailbox-put (propname value &optional mailbox buffer)
1319 (with-current-buffer (or buffer (current-buffer))
1320 (if imap-mailbox-data
1321 (put (intern (or mailbox imap-current-mailbox) imap-mailbox-data)
1323 (error "Imap-mailbox-data is nil, prop %s value %s mailbox %s buffer %s"
1324 propname value mailbox (current-buffer)))
1327 (defsubst imap-mailbox-get-1 (propname &optional mailbox)
1328 (get (intern-soft (or mailbox imap-current-mailbox) imap-mailbox-data)
1331 (defun imap-mailbox-get (propname &optional mailbox buffer)
1332 (let ((mailbox (imap-utf7-encode mailbox)))
1333 (with-current-buffer (or buffer (current-buffer))
1334 (imap-mailbox-get-1 propname (or mailbox imap-current-mailbox)))))
1336 (defun imap-mailbox-map-1 (func &optional mailbox-decoder buffer)
1337 (with-current-buffer (or buffer (current-buffer))
1341 (push (funcall func (if mailbox-decoder
1342 (funcall mailbox-decoder (symbol-name s))
1343 (symbol-name s))) result))
1347 (defun imap-mailbox-map (func &optional buffer)
1348 "Map a function across each mailbox in `imap-mailbox-data', returning a list.
1349 Function should take a mailbox name (a string) as
1351 (imap-mailbox-map-1 func 'imap-utf7-decode buffer))
1353 (defun imap-current-mailbox (&optional buffer)
1354 (with-current-buffer (or buffer (current-buffer))
1355 (imap-utf7-decode imap-current-mailbox)))
1357 (defun imap-current-mailbox-p-1 (mailbox &optional examine)
1358 (and (string= mailbox imap-current-mailbox)
1360 (eq imap-state 'examine))
1362 (eq imap-state 'selected)))))
1364 (defun imap-current-mailbox-p (mailbox &optional examine buffer)
1365 (with-current-buffer (or buffer (current-buffer))
1366 (imap-current-mailbox-p-1 (imap-utf7-encode mailbox) examine)))
1368 (defun imap-mailbox-select-1 (mailbox &optional examine)
1369 "Select MAILBOX on server in BUFFER.
1370 If EXAMINE is non-nil, do a read-only select."
1371 (if (imap-current-mailbox-p-1 mailbox examine)
1372 imap-current-mailbox
1373 (setq imap-current-mailbox mailbox)
1374 (if (imap-ok-p (imap-send-command-wait
1375 (concat (if examine "EXAMINE" "SELECT") " \""
1378 (setq imap-message-data (make-vector imap-message-prime 0)
1379 imap-state (if examine 'examine 'selected))
1380 imap-current-mailbox)
1381 ;; Failed SELECT/EXAMINE unselects current mailbox
1382 (setq imap-current-mailbox nil))))
1384 (defun imap-mailbox-select (mailbox &optional examine buffer)
1385 (with-current-buffer (or buffer (current-buffer))
1387 (imap-mailbox-select-1 (imap-utf7-encode mailbox) examine))))
1389 (defun imap-mailbox-examine-1 (mailbox &optional buffer)
1390 (with-current-buffer (or buffer (current-buffer))
1391 (imap-mailbox-select-1 mailbox 'examine)))
1393 (defun imap-mailbox-examine (mailbox &optional buffer)
1394 "Examine MAILBOX on server in BUFFER."
1395 (imap-mailbox-select mailbox 'examine buffer))
1397 (defun imap-mailbox-unselect (&optional buffer)
1398 "Close current folder in BUFFER, without expunging articles."
1399 (with-current-buffer (or buffer (current-buffer))
1400 (when (or (eq imap-state 'auth)
1401 (and (imap-capability 'UNSELECT)
1402 (imap-ok-p (imap-send-command-wait "UNSELECT")))
1404 (imap-send-command-wait (concat "EXAMINE \""
1405 imap-current-mailbox
1407 (imap-ok-p (imap-send-command-wait "CLOSE"))))
1408 (setq imap-current-mailbox nil
1409 imap-message-data nil
1413 (defun imap-mailbox-expunge (&optional asynch buffer)
1414 "Expunge articles in current folder in BUFFER.
1415 If ASYNCH, do not wait for successful completion of the command.
1416 If BUFFER is nil the current buffer is assumed."
1417 (with-current-buffer (or buffer (current-buffer))
1418 (when (and imap-current-mailbox (not (eq imap-state 'examine)))
1420 (imap-send-command "EXPUNGE")
1421 (imap-ok-p (imap-send-command-wait "EXPUNGE"))))))
1423 (defun imap-mailbox-close (&optional asynch buffer)
1424 "Expunge articles and close current folder in BUFFER.
1425 If ASYNCH, do not wait for successful completion of the command.
1426 If BUFFER is nil the current buffer is assumed."
1427 (with-current-buffer (or buffer (current-buffer))
1428 (when imap-current-mailbox
1430 (imap-add-callback (imap-send-command "CLOSE")
1431 `(lambda (tag status)
1432 (message "IMAP mailbox `%s' closed... %s"
1433 imap-current-mailbox status)
1434 (when (eq ,imap-current-mailbox
1435 imap-current-mailbox)
1436 ;; Don't wipe out data if another mailbox
1438 (setq imap-current-mailbox nil
1439 imap-message-data nil
1440 imap-state 'auth))))
1441 (when (imap-ok-p (imap-send-command-wait "CLOSE"))
1442 (setq imap-current-mailbox nil
1443 imap-message-data nil
1447 (defun imap-mailbox-create-1 (mailbox)
1448 (imap-ok-p (imap-send-command-wait (list "CREATE \"" mailbox "\""))))
1450 (defun imap-mailbox-create (mailbox &optional buffer)
1451 "Create MAILBOX on server in BUFFER.
1452 If BUFFER is nil the current buffer is assumed."
1453 (with-current-buffer (or buffer (current-buffer))
1454 (imap-mailbox-create-1 (imap-utf7-encode mailbox))))
1456 (defun imap-mailbox-delete (mailbox &optional buffer)
1457 "Delete MAILBOX on server in BUFFER.
1458 If BUFFER is nil the current buffer is assumed."
1459 (let ((mailbox (imap-utf7-encode mailbox)))
1460 (with-current-buffer (or buffer (current-buffer))
1462 (imap-send-command-wait (list "DELETE \"" mailbox "\""))))))
1464 (defun imap-mailbox-rename (oldname newname &optional buffer)
1465 "Rename mailbox OLDNAME to NEWNAME on server in BUFFER.
1466 If BUFFER is nil the current buffer is assumed."
1467 (let ((oldname (imap-utf7-encode oldname))
1468 (newname (imap-utf7-encode newname)))
1469 (with-current-buffer (or buffer (current-buffer))
1471 (imap-send-command-wait (list "RENAME \"" oldname "\" "
1472 "\"" newname "\""))))))
1474 (defun imap-mailbox-lsub (&optional root reference add-delimiter buffer)
1475 "Return a list of subscribed mailboxes on server in BUFFER.
1476 If ROOT is non-nil, only list matching mailboxes. If ADD-DELIMITER is
1477 non-nil, a hierarchy delimiter is added to root. REFERENCE is a
1478 implementation-specific string that has to be passed to lsub command."
1479 (with-current-buffer (or buffer (current-buffer))
1480 ;; Make sure we know the hierarchy separator for root's hierarchy
1481 (when (and add-delimiter (null (imap-mailbox-get-1 'delimiter root)))
1482 (imap-send-command-wait (concat "LIST \"" reference "\" \""
1483 (imap-utf7-encode root) "\"")))
1484 ;; clear list data (NB not delimiter and other stuff)
1485 (imap-mailbox-map-1 (lambda (mailbox)
1486 (imap-mailbox-put 'lsub nil mailbox)))
1488 (imap-send-command-wait
1489 (concat "LSUB \"" reference "\" \"" (imap-utf7-encode root)
1490 (and add-delimiter (imap-mailbox-get-1 'delimiter root))
1493 (imap-mailbox-map-1 (lambda (mailbox)
1494 (when (imap-mailbox-get-1 'lsub mailbox)
1495 (push (imap-utf7-decode mailbox) out))))
1498 (defun imap-mailbox-list (root &optional reference add-delimiter buffer)
1499 "Return a list of mailboxes matching ROOT on server in BUFFER.
1500 If ADD-DELIMITER is non-nil, a hierarchy delimiter is added to
1501 root. REFERENCE is a implementation-specific string that has to be
1502 passed to list command."
1503 (with-current-buffer (or buffer (current-buffer))
1504 ;; Make sure we know the hierarchy separator for root's hierarchy
1505 (when (and add-delimiter (null (imap-mailbox-get-1 'delimiter root)))
1506 (imap-send-command-wait (concat "LIST \"" reference "\" \""
1507 (imap-utf7-encode root) "\"")))
1508 ;; clear list data (NB not delimiter and other stuff)
1509 (imap-mailbox-map-1 (lambda (mailbox)
1510 (imap-mailbox-put 'list nil mailbox)))
1512 (imap-send-command-wait
1513 (concat "LIST \"" reference "\" \"" (imap-utf7-encode root)
1514 (and add-delimiter (imap-mailbox-get-1 'delimiter root))
1517 (imap-mailbox-map-1 (lambda (mailbox)
1518 (when (imap-mailbox-get-1 'list mailbox)
1519 (push (imap-utf7-decode mailbox) out))))
1522 (defun imap-mailbox-subscribe (mailbox &optional buffer)
1523 "Send the SUBSCRIBE command on the MAILBOX to server in BUFFER.
1524 Returns non-nil if successful."
1525 (with-current-buffer (or buffer (current-buffer))
1526 (imap-ok-p (imap-send-command-wait (concat "SUBSCRIBE \""
1527 (imap-utf7-encode mailbox)
1530 (defun imap-mailbox-unsubscribe (mailbox &optional buffer)
1531 "Send the SUBSCRIBE command on the MAILBOX to server in BUFFER.
1532 Returns non-nil if successful."
1533 (with-current-buffer (or buffer (current-buffer))
1534 (imap-ok-p (imap-send-command-wait (concat "UNSUBSCRIBE "
1535 (imap-utf7-encode mailbox)
1538 (defun imap-mailbox-status (mailbox items &optional buffer)
1539 "Get status items ITEM in MAILBOX from server in BUFFER.
1540 ITEMS can be a symbol or a list of symbols, valid symbols are one of
1541 the STATUS data items -- i.e. `messages', `recent', `uidnext', `uidvalidity',
1542 or `unseen'. If ITEMS is a list of symbols, a list of values is
1543 returned, if ITEMS is a symbol only its value is returned."
1544 (with-current-buffer (or buffer (current-buffer))
1546 (imap-send-command-wait (list "STATUS \""
1547 (imap-utf7-encode mailbox)
1555 (mapcar (lambda (item)
1556 (imap-mailbox-get item mailbox))
1558 (imap-mailbox-get items mailbox)))))
1560 (defun imap-mailbox-status-asynch (mailbox items &optional buffer)
1561 "Send status item request ITEM on MAILBOX to server in BUFFER.
1562 ITEMS can be a symbol or a list of symbols, valid symbols are one of
1563 the STATUS data items -- i.e. 'messages, 'recent, 'uidnext, 'uidvalidity
1564 or 'unseen. The IMAP command tag is returned."
1565 (with-current-buffer (or buffer (current-buffer))
1566 (imap-send-command (list "STATUS \""
1567 (imap-utf7-encode mailbox)
1575 (defun imap-mailbox-acl-get (&optional mailbox buffer)
1576 "Get ACL on MAILBOX from server in BUFFER."
1577 (let ((mailbox (imap-utf7-encode mailbox)))
1578 (with-current-buffer (or buffer (current-buffer))
1580 (imap-send-command-wait (list "GETACL \""
1581 (or mailbox imap-current-mailbox)
1583 (imap-mailbox-get-1 'acl (or mailbox imap-current-mailbox))))))
1585 (defun imap-mailbox-acl-set (identifier rights &optional mailbox buffer)
1586 "Change/set ACL for IDENTIFIER to RIGHTS in MAILBOX from server in BUFFER."
1587 (let ((mailbox (imap-utf7-encode mailbox)))
1588 (with-current-buffer (or buffer (current-buffer))
1590 (imap-send-command-wait (list "SETACL \""
1591 (or mailbox imap-current-mailbox)
1597 (defun imap-mailbox-acl-delete (identifier &optional mailbox buffer)
1598 "Remove any <identifier,rights> pair for IDENTIFIER in MAILBOX from server in BUFFER."
1599 (let ((mailbox (imap-utf7-encode mailbox)))
1600 (with-current-buffer (or buffer (current-buffer))
1602 (imap-send-command-wait (list "DELETEACL \""
1603 (or mailbox imap-current-mailbox)
1608 ;; Message functions:
1610 (defun imap-current-message (&optional buffer)
1611 (with-current-buffer (or buffer (current-buffer))
1612 imap-current-message))
1614 (defun imap-list-to-message-set (list)
1615 (mapconcat (lambda (item)
1616 (number-to-string item))
1622 (defun imap-range-to-message-set (range)
1627 (car item) (cdr item))
1628 (format "%d" item)))
1629 (if (and (listp range) (not (listp (cdr range))))
1630 (list range) ;; make (1 . 2) into ((1 . 2))
1634 (defun imap-fetch-asynch (uids props &optional nouidfetch buffer)
1635 (with-current-buffer (or buffer (current-buffer))
1636 (imap-send-command (format "%sFETCH %s %s" (if nouidfetch "" "UID ")
1638 (imap-list-to-message-set uids)
1642 (defun imap-fetch (uids props &optional receive nouidfetch buffer)
1643 "Fetch properties PROPS from message set UIDS from server in BUFFER.
1644 UIDS can be a string, number or a list of numbers. If RECEIVE
1645 is non-nil return these properties."
1646 (with-current-buffer (or buffer (current-buffer))
1647 (when (imap-ok-p (imap-send-command-wait
1648 (format "%sFETCH %s %s" (if nouidfetch "" "UID ")
1650 (imap-list-to-message-set uids)
1653 (if (or (null receive) (stringp uids))
1656 (mapcar (lambda (uid)
1658 (mapcar (lambda (prop)
1659 (imap-message-get uid prop))
1661 (imap-message-get uid receive)))
1663 (imap-message-get uids receive))))))
1665 (defun imap-message-put (uid propname value &optional buffer)
1666 (with-current-buffer (or buffer (current-buffer))
1667 (if imap-message-data
1668 (put (intern (number-to-string uid) imap-message-data)
1670 (error "Imap-message-data is nil, uid %s prop %s value %s buffer %s"
1671 uid propname value (current-buffer)))
1674 (defun imap-message-get (uid propname &optional buffer)
1675 (with-current-buffer (or buffer (current-buffer))
1676 (get (intern-soft (number-to-string uid) imap-message-data)
1679 (defun imap-message-map (func propname &optional buffer)
1680 "Map a function across each message in `imap-message-data', returning a list."
1681 (with-current-buffer (or buffer (current-buffer))
1685 (push (funcall func (get s 'UID) (get s propname)) result))
1689 (defmacro imap-message-envelope-date (uid &optional buffer)
1690 `(with-current-buffer (or ,buffer (current-buffer))
1691 (elt (imap-message-get ,uid 'ENVELOPE) 0)))
1693 (defmacro imap-message-envelope-subject (uid &optional buffer)
1694 `(with-current-buffer (or ,buffer (current-buffer))
1695 (elt (imap-message-get ,uid 'ENVELOPE) 1)))
1697 (defmacro imap-message-envelope-from (uid &optional buffer)
1698 `(with-current-buffer (or ,buffer (current-buffer))
1699 (elt (imap-message-get ,uid 'ENVELOPE) 2)))
1701 (defmacro imap-message-envelope-sender (uid &optional buffer)
1702 `(with-current-buffer (or ,buffer (current-buffer))
1703 (elt (imap-message-get ,uid 'ENVELOPE) 3)))
1705 (defmacro imap-message-envelope-reply-to (uid &optional buffer)
1706 `(with-current-buffer (or ,buffer (current-buffer))
1707 (elt (imap-message-get ,uid 'ENVELOPE) 4)))
1709 (defmacro imap-message-envelope-to (uid &optional buffer)
1710 `(with-current-buffer (or ,buffer (current-buffer))
1711 (elt (imap-message-get ,uid 'ENVELOPE) 5)))
1713 (defmacro imap-message-envelope-cc (uid &optional buffer)
1714 `(with-current-buffer (or ,buffer (current-buffer))
1715 (elt (imap-message-get ,uid 'ENVELOPE) 6)))
1717 (defmacro imap-message-envelope-bcc (uid &optional buffer)
1718 `(with-current-buffer (or ,buffer (current-buffer))
1719 (elt (imap-message-get ,uid 'ENVELOPE) 7)))
1721 (defmacro imap-message-envelope-in-reply-to (uid &optional buffer)
1722 `(with-current-buffer (or ,buffer (current-buffer))
1723 (elt (imap-message-get ,uid 'ENVELOPE) 8)))
1725 (defmacro imap-message-envelope-message-id (uid &optional buffer)
1726 `(with-current-buffer (or ,buffer (current-buffer))
1727 (elt (imap-message-get ,uid 'ENVELOPE) 9)))
1729 (defmacro imap-message-body (uid &optional buffer)
1730 `(with-current-buffer (or ,buffer (current-buffer))
1731 (imap-message-get ,uid 'BODY)))
1733 ;; FIXME: Should this try to use CHARSET? -- fx
1734 (defun imap-search (predicate &optional buffer)
1735 (with-current-buffer (or buffer (current-buffer))
1736 (imap-mailbox-put 'search 'dummy)
1737 (when (imap-ok-p (imap-send-command-wait (concat "UID SEARCH " predicate)))
1738 (if (eq (imap-mailbox-get-1 'search imap-current-mailbox) 'dummy)
1740 (message "Missing SEARCH response to a SEARCH command (server not RFC compliant)...")
1742 (imap-mailbox-get-1 'search imap-current-mailbox)))))
1744 (defun imap-message-flag-permanent-p (flag &optional mailbox buffer)
1745 "Return t if FLAG can be permanently (between IMAP sessions) saved on articles, in MAILBOX on server in BUFFER."
1746 (with-current-buffer (or buffer (current-buffer))
1747 (or (member "\\*" (imap-mailbox-get 'permanentflags mailbox))
1748 (member flag (imap-mailbox-get 'permanentflags mailbox)))))
1750 (defun imap-message-flags-set (articles flags &optional silent buffer)
1751 (when (and articles flags)
1752 (with-current-buffer (or buffer (current-buffer))
1753 (imap-ok-p (imap-send-command-wait
1754 (concat "UID STORE " articles
1755 " FLAGS" (if silent ".SILENT") " (" flags ")"))))))
1757 (defun imap-message-flags-del (articles flags &optional silent buffer)
1758 (when (and articles flags)
1759 (with-current-buffer (or buffer (current-buffer))
1760 (imap-ok-p (imap-send-command-wait
1761 (concat "UID STORE " articles
1762 " -FLAGS" (if silent ".SILENT") " (" flags ")"))))))
1764 (defun imap-message-flags-add (articles flags &optional silent buffer)
1765 (when (and articles flags)
1766 (with-current-buffer (or buffer (current-buffer))
1767 (imap-ok-p (imap-send-command-wait
1768 (concat "UID STORE " articles
1769 " +FLAGS" (if silent ".SILENT") " (" flags ")"))))))
1771 ;; Cf. http://thread.gmane.org/gmane.emacs.gnus.general/65317/focus=65343
1772 ;; Signal an error if we'd get an integer overflow.
1774 ;; FIXME: Identify relevant calls to `string-to-number' and replace them with
1775 ;; `imap-string-to-integer'.
1776 (defun imap-string-to-integer (string &optional base)
1777 (let ((number (string-to-number string base)))
1778 (if (> number most-positive-fixnum)
1780 (format "String %s cannot be converted to a Lisp integer" number))
1783 (defun imap-fetch-safe (uids props &optional receive nouidfetch buffer)
1784 "Like `imap-fetch', but DTRT with Exchange 2007 bug.
1785 However, UIDS here is a cons, where the car is the canonical form
1786 of the UIDS specification, and the cdr is the one which works with
1787 Exchange 2007 or, potentially, other buggy servers.
1788 See `imap-enable-exchange-bug-workaround'."
1789 ;; The first time we get here for a given, we'll try the canonical
1790 ;; form. If we get the known error from the buggy server, set the
1791 ;; flag buffer-locally (to account for connections to multiple
1792 ;; servers), then re-try with the alternative UIDS spec. We don't
1793 ;; unconditionally use the alternative form, since the
1794 ;; currently-used alternatives are seriously inefficient with some
1795 ;; servers (although they are valid).
1797 ;; FIXME: Maybe it would be cleaner to have a flag to not signal
1798 ;; the error (which otherwise gives a message), and test
1799 ;; `imap-failed-tags'. Also, Other IMAP clients use other forms of
1800 ;; request which work with Exchange, e.g. Claws does "UID FETCH 1:*
1801 ;; (UID)" rather than "FETCH UID 1,*". Is there a good reason not
1803 (condition-case data
1804 ;; Binding `debug-on-error' allows us to get the error from
1805 ;; `imap-parse-response' -- it's normally caught by Emacs around
1806 ;; execution of a process filter.
1807 (let ((debug-on-error t))
1808 (imap-fetch (if imap-enable-exchange-bug-workaround
1811 props receive nouidfetch buffer))
1813 (if (and (not imap-enable-exchange-bug-workaround)
1814 ;; This is the Exchange 2007 response. It may be more
1815 ;; robust just to check for a BAD response to the
1817 (string-match "The specified message set is invalid"
1819 (with-current-buffer (or buffer (current-buffer))
1820 (set (make-local-variable 'imap-enable-exchange-bug-workaround)
1822 (imap-fetch (cdr uids) props receive nouidfetch))
1823 (signal (car data) (cdr data))))))
1825 (defun imap-message-copyuid-1 (mailbox)
1826 (if (imap-capability 'UIDPLUS)
1827 (list (nth 0 (imap-mailbox-get-1 'copyuid mailbox))
1828 (string-to-number (nth 2 (imap-mailbox-get-1 'copyuid mailbox))))
1829 (let ((old-mailbox imap-current-mailbox)
1831 (imap-message-data (make-vector 2 0)))
1832 (when (imap-mailbox-examine-1 mailbox)
1834 (and (imap-fetch-safe '("*" . "*:*") "UID")
1835 (list (imap-mailbox-get-1 'uidvalidity mailbox)
1836 (apply 'max (imap-message-map
1837 (lambda (uid prop) uid) 'UID))))
1839 (imap-mailbox-select old-mailbox (eq state 'examine))
1840 (imap-mailbox-unselect)))))))
1842 (defun imap-message-copyuid (mailbox &optional buffer)
1843 (with-current-buffer (or buffer (current-buffer))
1844 (imap-message-copyuid-1 (imap-utf7-decode mailbox))))
1846 (defun imap-message-copy (articles mailbox
1847 &optional dont-create no-copyuid buffer)
1848 "Copy ARTICLES to MAILBOX on server in BUFFER.
1849 ARTICLES is a string message set. Create mailbox if it doesn't exist,
1850 unless DONT-CREATE is non-nil. On success, return a list with
1851 the UIDVALIDITY of the mailbox the article(s) was copied to as the
1852 first element. The rest of list contains the saved articles' UIDs."
1854 (with-current-buffer (or buffer (current-buffer))
1855 (let ((mailbox (imap-utf7-encode mailbox)))
1856 (if (let ((cmd (concat "UID COPY " articles " \"" mailbox "\""))
1857 (imap-current-target-mailbox mailbox))
1858 (if (imap-ok-p (imap-send-command-wait cmd))
1860 (when (and (not dont-create)
1861 ;; removed because of buggy Oracle server
1862 ;; that doesn't send TRYCREATE tags (which
1863 ;; is a MUST according to specifications):
1864 ;;(imap-mailbox-get-1 'trycreate mailbox)
1865 (imap-mailbox-create-1 mailbox))
1866 (imap-ok-p (imap-send-command-wait cmd)))))
1868 (imap-message-copyuid-1 mailbox)))))))
1870 ;; FIXME: Amalgamate with imap-message-copyuid-1, using an extra arg, since it
1871 ;; shares most of the code? -- fx
1872 (defun imap-message-appenduid-1 (mailbox)
1873 (if (imap-capability 'UIDPLUS)
1874 (imap-mailbox-get-1 'appenduid mailbox)
1875 (let ((old-mailbox imap-current-mailbox)
1877 (imap-message-data (make-vector 2 0)))
1878 (when (imap-mailbox-examine-1 mailbox)
1880 (and (imap-fetch-safe '("*" . "*:*") "UID")
1881 (list (imap-mailbox-get-1 'uidvalidity mailbox)
1882 (apply 'max (imap-message-map
1883 (lambda (uid prop) uid) 'UID))))
1885 (imap-mailbox-select old-mailbox (eq state 'examine))
1886 (imap-mailbox-unselect)))))))
1888 (defun imap-message-appenduid (mailbox &optional buffer)
1889 (with-current-buffer (or buffer (current-buffer))
1890 (imap-message-appenduid-1 (imap-utf7-encode mailbox))))
1892 (defun imap-message-append (mailbox article &optional flags date-time buffer)
1893 "Append ARTICLE (a buffer) to MAILBOX on server in BUFFER.
1894 FLAGS and DATE-TIME is currently not used. Return a cons holding
1895 uidvalidity of MAILBOX and UID the newly created article got, or nil
1897 (let ((mailbox (imap-utf7-encode mailbox)))
1898 (with-current-buffer (or buffer (current-buffer))
1899 (and (let ((imap-current-target-mailbox mailbox))
1901 (imap-send-command-wait
1902 (list "APPEND \"" mailbox "\" " article))))
1903 (imap-message-appenduid-1 mailbox)))))
1905 (defun imap-body-lines (body)
1906 "Return number of lines in article by looking at the mime bodystructure BODY."
1908 (if (stringp (car body))
1909 (cond ((and (string= (upcase (car body)) "TEXT")
1910 (numberp (nth 7 body)))
1912 ((and (string= (upcase (car body)) "MESSAGE")
1913 (numberp (nth 9 body)))
1916 (apply '+ (mapcar 'imap-body-lines body)))
1919 (defun imap-envelope-from (from)
1920 "Return a from string line."
1922 (concat (aref from 0)
1923 (if (aref from 0) " <")
1927 (if (aref from 0) ">"))))
1930 ;; Internal functions.
1932 (defun imap-add-callback (tag func)
1933 (setq imap-callbacks (append (list (cons tag func)) imap-callbacks)))
1935 (defun imap-send-command-1 (cmdstr)
1936 (setq cmdstr (concat cmdstr imap-client-eol))
1938 (process-send-string imap-process cmdstr))
1940 (defun imap-send-command (command &optional buffer)
1941 (with-current-buffer (or buffer (current-buffer))
1942 (if (not (listp command)) (setq command (list command)))
1943 (let ((tag (setq imap-tag (1+ imap-tag)))
1945 (setq cmdstr (concat (number-to-string imap-tag) " "))
1946 (while (setq cmd (pop command))
1947 (cond ((stringp cmd)
1948 (setq cmdstr (concat cmdstr cmd)))
1950 (let ((eol imap-client-eol)
1951 (calcfirst imap-calculate-literal-size-first)
1953 (with-current-buffer cmd
1955 (setq size (buffer-size)))
1956 (when (not (equal eol "\r\n"))
1957 ;; XXX modifies buffer!
1958 (goto-char (point-min))
1959 (while (search-forward "\r\n" nil t)
1960 (replace-match eol)))
1962 (setq size (buffer-size))))
1964 (concat cmdstr (format "{%d}" size))))
1967 (imap-send-command-1 cmdstr)
1969 (if (not (eq (imap-wait-for-tag tag) 'INCOMPLETE))
1970 (setq command nil) ;; abort command if no cont-req
1971 (let ((process imap-process)
1972 (stream imap-stream)
1973 (eol imap-client-eol))
1974 (with-current-buffer cmd
1976 (process-send-region process (point-min)
1978 (process-send-string process imap-client-eol))))
1979 (setq imap-continuation nil)))
1981 (imap-send-command-1 cmdstr)
1985 (if (not (eq (imap-wait-for-tag tag) 'INCOMPLETE))
1986 nil ;; abort command if no cont-req
1987 (cons (funcall cmd imap-continuation)
1989 (setq imap-continuation nil)))
1991 (error "Unknown command type"))))
1993 (imap-send-command-1 cmdstr))
1996 (defun imap-wait-for-tag (tag &optional buffer)
1997 (with-current-buffer (or buffer (current-buffer))
1998 (let (imap-have-messaged)
1999 (while (and (null imap-continuation)
2000 (memq (process-status imap-process) '(open run))
2001 (< imap-reached-tag tag))
2002 (let ((len (/ (buffer-size) 1024))
2005 (setq imap-have-messaged t)
2006 (message "imap read: %dk" len))
2007 (accept-process-output imap-process
2008 (truncate imap-read-timeout)
2009 (truncate (* (- imap-read-timeout
2010 (truncate imap-read-timeout))
2012 ;; A process can die _before_ we have processed everything it
2013 ;; has to say. Moreover, this can happen in between the call to
2014 ;; accept-process-output and the call to process-status in an
2015 ;; iteration of the loop above.
2016 (when (and (null imap-continuation)
2017 (< imap-reached-tag tag))
2018 (accept-process-output imap-process 0 0))
2019 (when imap-have-messaged
2021 (and (memq (process-status imap-process) '(open run))
2022 (or (assq tag imap-failed-tags)
2023 (if imap-continuation
2027 (defun imap-sentinel (process string)
2028 (delete-process process))
2030 (defun imap-find-next-line ()
2031 "Return point at end of current line, taking into account literals.
2032 Return nil if no complete line has arrived."
2033 (when (re-search-forward (concat imap-server-eol "\\|{\\([0-9]+\\)}"
2036 (if (match-string 1)
2037 (if (< (point-max) (+ (point) (string-to-number (match-string 1))))
2039 (goto-char (+ (point) (string-to-number (match-string 1))))
2040 (imap-find-next-line))
2043 (defun imap-arrival-filter (proc string)
2044 "IMAP process filter."
2045 ;; Sometimes, we are called even though the process has died.
2046 ;; Better abstain from doing stuff in that case.
2047 (when (buffer-name (process-buffer proc))
2048 (with-current-buffer (process-buffer proc)
2049 (goto-char (point-max))
2053 (goto-char (point-min))
2054 (while (setq end (imap-find-next-line))
2056 (narrow-to-region (point-min) end)
2057 (delete-char (- (length imap-server-eol)))
2058 (goto-char (point-min))
2060 (cond ((eq imap-state 'initial)
2061 (imap-parse-greeting))
2062 ((or (eq imap-state 'auth)
2063 (eq imap-state 'nonauth)
2064 (eq imap-state 'selected)
2065 (eq imap-state 'examine))
2066 (imap-parse-response))
2068 (message "Unknown state %s in arrival filter"
2070 (delete-region (point-min) (point-max)))))))))
2075 (defsubst imap-forward ()
2076 (or (eobp) (forward-char)))
2079 ;; ; Unsigned 32-bit integer
2080 ;; ; (0 <= n < 4,294,967,296)
2082 (defsubst imap-parse-number ()
2083 (when (looking-at "[0-9]+")
2085 (string-to-number (match-string 0))
2086 (goto-char (match-end 0)))))
2088 ;; literal = "{" number "}" CRLF *CHAR8
2089 ;; ; Number represents the number of CHAR8s
2091 (defsubst imap-parse-literal ()
2092 (when (looking-at "{\\([0-9]+\\)}\r\n")
2093 (let ((pos (match-end 0))
2094 (len (string-to-number (match-string 1))))
2095 (if (< (point-max) (+ pos len))
2097 (goto-char (+ pos len))
2098 (buffer-substring pos (+ pos len))))))
2100 ;; string = quoted / literal
2102 ;; quoted = DQUOTE *QUOTED-CHAR DQUOTE
2104 ;; QUOTED-CHAR = <any TEXT-CHAR except quoted-specials> /
2105 ;; "\" quoted-specials
2107 ;; quoted-specials = DQUOTE / "\"
2109 ;; TEXT-CHAR = <any CHAR except CR and LF>
2111 (defsubst imap-parse-string ()
2112 (cond ((eq (char-after) ?\")
2114 (let ((p (point)) (name ""))
2115 (skip-chars-forward "^\"\\\\")
2116 (setq name (buffer-substring p (point)))
2117 (while (eq (char-after) ?\\)
2118 (setq p (1+ (point)))
2120 (skip-chars-forward "^\"\\\\")
2121 (setq name (concat name (buffer-substring p (point)))))
2124 ((eq (char-after) ?{)
2125 (imap-parse-literal))))
2129 (defsubst imap-parse-nil ()
2130 (if (looking-at "NIL")
2131 (goto-char (match-end 0))))
2133 ;; nstring = string / nil
2135 (defsubst imap-parse-nstring ()
2136 (or (imap-parse-string)
2137 (and (imap-parse-nil)
2140 ;; astring = atom / string
2142 ;; atom = 1*ATOM-CHAR
2144 ;; ATOM-CHAR = <any CHAR except atom-specials>
2146 ;; atom-specials = "(" / ")" / "{" / SP / CTL / list-wildcards /
2149 ;; list-wildcards = "%" / "*"
2151 ;; quoted-specials = DQUOTE / "\"
2153 (defsubst imap-parse-astring ()
2154 (or (imap-parse-string)
2155 (buffer-substring (point)
2156 (if (re-search-forward "[(){ \r\n%*\"\\]" nil t)
2157 (goto-char (1- (match-end 0)))
2161 ;; address = "(" addr-name SP addr-adl SP addr-mailbox SP
2164 ;; addr-adl = nstring
2165 ;; ; Holds route from [RFC-822] route-addr if
2168 ;; addr-host = nstring
2169 ;; ; nil indicates [RFC-822] group syntax.
2170 ;; ; Otherwise, holds [RFC-822] domain name
2172 ;; addr-mailbox = nstring
2173 ;; ; nil indicates end of [RFC-822] group; if
2174 ;; ; non-nil and addr-host is nil, holds
2175 ;; ; [RFC-822] group name.
2176 ;; ; Otherwise, holds [RFC-822] local-part
2177 ;; ; after removing [RFC-822] quoting
2179 ;; addr-name = nstring
2180 ;; ; If non-nil, holds phrase from [RFC-822]
2181 ;; ; mailbox after removing [RFC-822] quoting
2184 (defsubst imap-parse-address ()
2186 (when (eq (char-after) ?\()
2188 (setq address (vector (prog1 (imap-parse-nstring)
2190 (prog1 (imap-parse-nstring)
2192 (prog1 (imap-parse-nstring)
2194 (imap-parse-nstring)))
2195 (when (eq (char-after) ?\))
2199 ;; address-list = "(" 1*address ")" / nil
2203 (defsubst imap-parse-address-list ()
2204 (if (eq (char-after) ?\()
2205 (let (address addresses)
2207 (while (and (not (eq (char-after) ?\)))
2208 ;; next line for MS Exchange bug
2209 (progn (and (eq (char-after) ? ) (imap-forward)) t)
2210 (setq address (imap-parse-address)))
2211 (setq addresses (cons address addresses)))
2212 (when (eq (char-after) ?\))
2214 (nreverse addresses)))
2215 ;; With assert, the code might not be eval'd.
2216 ;; (assert (imap-parse-nil) t "In imap-parse-address-list")
2219 ;; mailbox = "INBOX" / astring
2220 ;; ; INBOX is case-insensitive. All case variants of
2221 ;; ; INBOX (e.g. "iNbOx") MUST be interpreted as INBOX
2222 ;; ; not as an astring. An astring which consists of
2223 ;; ; the case-insensitive sequence "I" "N" "B" "O" "X"
2224 ;; ; is considered to be INBOX and not an astring.
2225 ;; ; Refer to section 5.1 for further
2226 ;; ; semantic details of mailbox names.
2228 (defsubst imap-parse-mailbox ()
2229 (let ((mailbox (imap-parse-astring)))
2230 (if (string-equal "INBOX" (upcase mailbox))
2234 ;; greeting = "*" SP (resp-cond-auth / resp-cond-bye) CRLF
2236 ;; resp-cond-auth = ("OK" / "PREAUTH") SP resp-text
2237 ;; ; Authentication condition
2239 ;; resp-cond-bye = "BYE" SP resp-text
2241 (defun imap-parse-greeting ()
2242 "Parse an IMAP greeting."
2243 (cond ((looking-at "\\* OK ")
2244 (setq imap-state 'nonauth))
2245 ((looking-at "\\* PREAUTH ")
2246 (setq imap-state 'auth))
2247 ((looking-at "\\* BYE ")
2248 (setq imap-state 'closed))))
2250 ;; response = *(continue-req / response-data) response-done
2252 ;; continue-req = "+" SP (resp-text / base64) CRLF
2254 ;; response-data = "*" SP (resp-cond-state / resp-cond-bye /
2255 ;; mailbox-data / message-data / capability-data) CRLF
2257 ;; response-done = response-tagged / response-fatal
2259 ;; response-fatal = "*" SP resp-cond-bye CRLF
2260 ;; ; Server closes connection immediately
2262 ;; response-tagged = tag SP resp-cond-state CRLF
2264 ;; resp-cond-state = ("OK" / "NO" / "BAD") SP resp-text
2265 ;; ; Status condition
2267 ;; resp-cond-bye = "BYE" SP resp-text
2269 ;; mailbox-data = "FLAGS" SP flag-list /
2270 ;; "LIST" SP mailbox-list /
2271 ;; "LSUB" SP mailbox-list /
2272 ;; "SEARCH" *(SP nz-number) /
2273 ;; "STATUS" SP mailbox SP "("
2274 ;; [status-att SP number *(SP status-att SP number)] ")" /
2275 ;; number SP "EXISTS" /
2276 ;; number SP "RECENT"
2278 ;; message-data = nz-number SP ("EXPUNGE" / ("FETCH" SP msg-att))
2280 ;; capability-data = "CAPABILITY" *(SP capability) SP "IMAP4rev1"
2282 ;; ; IMAP4rev1 servers which offer RFC 1730
2283 ;; ; compatibility MUST list "IMAP4" as the first
2286 (defun imap-parse-response ()
2287 "Parse a IMAP command response."
2289 (case (setq token (read (current-buffer)))
2290 (+ (setq imap-continuation
2291 (or (buffer-substring (min (point-max) (1+ (point)))
2294 (* (case (prog1 (setq token (read (current-buffer)))
2296 (OK (imap-parse-resp-text))
2297 (NO (imap-parse-resp-text))
2298 (BAD (imap-parse-resp-text))
2299 (BYE (imap-parse-resp-text))
2300 (FLAGS (imap-mailbox-put 'flags (imap-parse-flag-list)))
2301 (LIST (imap-parse-data-list 'list))
2302 (LSUB (imap-parse-data-list 'lsub))
2303 (SEARCH (imap-mailbox-put
2305 (read (concat "(" (buffer-substring (point) (point-max)) ")"))))
2306 (STATUS (imap-parse-status))
2307 (CAPABILITY (setq imap-capability
2308 (read (concat "(" (upcase (buffer-substring
2309 (point) (point-max)))
2311 (ID (setq imap-id (read (buffer-substring (point)
2313 (ACL (imap-parse-acl))
2314 (t (case (prog1 (read (current-buffer))
2316 (EXISTS (imap-mailbox-put 'exists token))
2317 (RECENT (imap-mailbox-put 'recent token))
2319 (FETCH (imap-parse-fetch token))
2320 (t (message "Garbage: %s" (buffer-string)))))))
2322 (if (not (integerp token))
2323 (message "Garbage: %s" (buffer-string))
2324 (case (prog1 (setq status (read (current-buffer)))
2327 (setq imap-reached-tag (max imap-reached-tag token))
2328 (imap-parse-resp-text)))
2330 (setq imap-reached-tag (max imap-reached-tag token))
2332 (imap-parse-resp-text))
2334 (when (eq (char-after) ?\[)
2335 (setq code (buffer-substring (point)
2336 (search-forward "]")))
2338 (setq text (buffer-substring (point) (point-max)))
2339 (push (list token status code text)
2340 imap-failed-tags))))
2342 (setq imap-reached-tag (max imap-reached-tag token))
2344 (imap-parse-resp-text))
2346 (when (eq (char-after) ?\[)
2347 (setq code (buffer-substring (point)
2348 (search-forward "]")))
2350 (setq text (buffer-substring (point) (point-max)))
2351 (push (list token status code text) imap-failed-tags)
2352 (error "Internal error, tag %s status %s code %s text %s"
2353 token status code text))))
2354 (t (message "Garbage: %s" (buffer-string))))
2355 (when (assq token imap-callbacks)
2356 (funcall (cdr (assq token imap-callbacks)) token status)
2357 (setq imap-callbacks
2358 (imap-remassoc token imap-callbacks)))))))))
2360 ;; resp-text = ["[" resp-text-code "]" SP] text
2362 ;; text = 1*TEXT-CHAR
2364 ;; TEXT-CHAR = <any CHAR except CR and LF>
2366 (defun imap-parse-resp-text ()
2367 (imap-parse-resp-text-code))
2369 ;; resp-text-code = "ALERT" /
2370 ;; "BADCHARSET [SP "(" astring *(SP astring) ")" ] /
2371 ;; "NEWNAME" SP string SP string /
2373 ;; "PERMANENTFLAGS" SP "("
2374 ;; [flag-perm *(SP flag-perm)] ")" /
2378 ;; "UIDNEXT" SP nz-number /
2379 ;; "UIDVALIDITY" SP nz-number /
2380 ;; "UNSEEN" SP nz-number /
2381 ;; resp-text-atom [SP 1*<any TEXT-CHAR except "]">]
2383 ;; resp_code_apnd = "APPENDUID" SPACE nz_number SPACE uniqueid
2385 ;; resp_code_copy = "COPYUID" SPACE nz_number SPACE set SPACE set
2387 ;; set = sequence-num / (sequence-num ":" sequence-num) /
2389 ;; ; Identifies a set of messages. For message
2390 ;; ; sequence numbers, these are consecutive
2391 ;; ; numbers from 1 to the number of messages in
2393 ;; ; Comma delimits individual numbers, colon
2394 ;; ; delimits between two numbers inclusive.
2395 ;; ; Example: 2,4:7,9,12:* is 2,4,5,6,7,9,12,13,
2396 ;; ; 14,15 for a mailbox with 15 messages.
2398 ;; sequence-num = nz-number / "*"
2399 ;; ; * is the largest number in use. For message
2400 ;; ; sequence numbers, it is the number of messages
2401 ;; ; in the mailbox. For unique identifiers, it is
2402 ;; ; the unique identifier of the last message in
2405 ;; flag-perm = flag / "\*"
2407 ;; flag = "\Answered" / "\Flagged" / "\Deleted" /
2408 ;; "\Seen" / "\Draft" / flag-keyword / flag-extension
2409 ;; ; Does not include "\Recent"
2411 ;; flag-extension = "\" atom
2412 ;; ; Future expansion. Client implementations
2413 ;; ; MUST accept flag-extension flags. Server
2414 ;; ; implementations MUST NOT generate
2415 ;; ; flag-extension flags except as defined by
2416 ;; ; future standard or standards-track
2417 ;; ; revisions of this specification.
2419 ;; flag-keyword = atom
2421 ;; resp-text-atom = 1*<any ATOM-CHAR except "]">
2423 (defun imap-parse-resp-text-code ()
2424 ;; xxx next line for stalker communigate pro 3.3.1 bug
2425 (when (looking-at " \\[")
2427 (when (eq (char-after) ?\[)
2429 (cond ((search-forward "PERMANENTFLAGS " nil t)
2430 (imap-mailbox-put 'permanentflags (imap-parse-flag-list)))
2431 ((search-forward "UIDNEXT \\([0-9]+\\)" nil t)
2432 (imap-mailbox-put 'uidnext (match-string 1)))
2433 ((search-forward "UNSEEN " nil t)
2434 (imap-mailbox-put 'first-unseen (read (current-buffer))))
2435 ((looking-at "UIDVALIDITY \\([0-9]+\\)")
2436 (imap-mailbox-put 'uidvalidity (match-string 1)))
2437 ((search-forward "READ-ONLY" nil t)
2438 (imap-mailbox-put 'read-only t))
2439 ((search-forward "NEWNAME " nil t)
2440 (let (oldname newname)
2441 (setq oldname (imap-parse-string))
2443 (setq newname (imap-parse-string))
2444 (imap-mailbox-put 'newname newname oldname)))
2445 ((search-forward "TRYCREATE" nil t)
2446 (imap-mailbox-put 'trycreate t imap-current-target-mailbox))
2447 ((looking-at "APPENDUID \\([0-9]+\\) \\([0-9]+\\)")
2448 (imap-mailbox-put 'appenduid
2449 (list (match-string 1)
2450 (string-to-number (match-string 2)))
2451 imap-current-target-mailbox))
2452 ((looking-at "COPYUID \\([0-9]+\\) \\([0-9,:]+\\) \\([0-9,:]+\\)")
2453 (imap-mailbox-put 'copyuid (list (match-string 1)
2456 imap-current-target-mailbox))
2457 ((search-forward "ALERT] " nil t)
2458 (message "Imap server %s information: %s" imap-server
2459 (buffer-substring (point) (point-max)))))))
2461 ;; mailbox-list = "(" [mbx-list-flags] ")" SP
2462 ;; (DQUOTE QUOTED-CHAR DQUOTE / nil) SP mailbox
2464 ;; mbx-list-flags = *(mbx-list-oflag SP) mbx-list-sflag
2465 ;; *(SP mbx-list-oflag) /
2466 ;; mbx-list-oflag *(SP mbx-list-oflag)
2468 ;; mbx-list-oflag = "\Noinferiors" / flag-extension
2469 ;; ; Other flags; multiple possible per LIST response
2471 ;; mbx-list-sflag = "\Noselect" / "\Marked" / "\Unmarked"
2472 ;; ; Selectability flags; only one per LIST response
2474 ;; QUOTED-CHAR = <any TEXT-CHAR except quoted-specials> /
2475 ;; "\" quoted-specials
2477 ;; quoted-specials = DQUOTE / "\"
2479 (defun imap-parse-data-list (type)
2480 (let (flags delimiter mailbox)
2481 (setq flags (imap-parse-flag-list))
2482 (when (looking-at " NIL\\| \"\\\\?\\(.\\)\"")
2483 (setq delimiter (match-string 1))
2484 (goto-char (1+ (match-end 0)))
2485 (when (setq mailbox (imap-parse-mailbox))
2486 (imap-mailbox-put type t mailbox)
2487 (imap-mailbox-put 'list-flags flags mailbox)
2488 (imap-mailbox-put 'delimiter delimiter mailbox)))))
2490 ;; msg_att ::= "(" 1#("ENVELOPE" SPACE envelope /
2491 ;; "FLAGS" SPACE "(" #(flag / "\Recent") ")" /
2492 ;; "INTERNALDATE" SPACE date_time /
2493 ;; "RFC822" [".HEADER" / ".TEXT"] SPACE nstring /
2494 ;; "RFC822.SIZE" SPACE number /
2495 ;; "BODY" ["STRUCTURE"] SPACE body /
2496 ;; "BODY" section ["<" number ">"] SPACE nstring /
2497 ;; "UID" SPACE uniqueid) ")"
2499 ;; date_time ::= <"> date_day_fixed "-" date_month "-" date_year
2500 ;; SPACE time SPACE zone <">
2502 ;; section ::= "[" [section_text / (nz_number *["." nz_number]
2503 ;; ["." (section_text / "MIME")])] "]"
2505 ;; section_text ::= "HEADER" / "HEADER.FIELDS" [".NOT"]
2506 ;; SPACE header_list / "TEXT"
2508 ;; header_fld_name ::= astring
2510 ;; header_list ::= "(" 1#header_fld_name ")"
2512 (defsubst imap-parse-header-list ()
2513 (when (eq (char-after) ?\()
2515 (while (not (eq (char-after) ?\)))
2517 (push (imap-parse-astring) strlist))
2519 (nreverse strlist))))
2521 (defsubst imap-parse-fetch-body-section ()
2523 (buffer-substring (point) (1- (re-search-forward "[] ]" nil t)))))
2524 (if (eq (char-before) ? )
2526 (mapconcat 'identity (cons section (imap-parse-header-list)) " ")
2527 (search-forward "]" nil t))
2530 (defun imap-parse-fetch (response)
2531 (when (eq (char-after) ?\()
2532 (let (uid flags envelope internaldate rfc822 rfc822header rfc822text
2533 rfc822size body bodydetail bodystructure flags-empty)
2534 ;; Courier can insert spurious blank characters which will
2535 ;; confuse `read', so skip past them.
2536 (while (let ((moved (skip-chars-forward " \t")))
2537 (prog1 (not (eq (char-after) ?\)))
2538 (unless (= moved 0) (backward-char))))
2540 (let ((token (read (current-buffer))))
2542 (cond ((eq token 'UID)
2543 (setq uid (condition-case ()
2544 (read (current-buffer))
2547 (setq flags (imap-parse-flag-list))
2549 (setq flags-empty 't)))
2550 ((eq token 'ENVELOPE)
2551 (setq envelope (imap-parse-envelope)))
2552 ((eq token 'INTERNALDATE)
2553 (setq internaldate (imap-parse-string)))
2555 (setq rfc822 (imap-parse-nstring)))
2556 ((eq token 'RFC822.HEADER)
2557 (setq rfc822header (imap-parse-nstring)))
2558 ((eq token 'RFC822.TEXT)
2559 (setq rfc822text (imap-parse-nstring)))
2560 ((eq token 'RFC822.SIZE)
2561 (setq rfc822size (read (current-buffer))))
2563 (if (eq (char-before) ?\[)
2565 (upcase (imap-parse-fetch-body-section))
2566 (and (eq (char-after) ?<)
2567 (buffer-substring (1+ (point))
2568 (search-forward ">" nil t)))
2569 (progn (imap-forward)
2570 (imap-parse-nstring)))
2572 (setq body (imap-parse-body))))
2573 ((eq token 'BODYSTRUCTURE)
2574 (setq bodystructure (imap-parse-body))))))
2576 (setq imap-current-message uid)
2577 (imap-message-put uid 'UID uid)
2578 (and (or flags flags-empty) (imap-message-put uid 'FLAGS flags))
2579 (and envelope (imap-message-put uid 'ENVELOPE envelope))
2580 (and internaldate (imap-message-put uid 'INTERNALDATE internaldate))
2581 (and rfc822 (imap-message-put uid 'RFC822 rfc822))
2582 (and rfc822header (imap-message-put uid 'RFC822.HEADER rfc822header))
2583 (and rfc822text (imap-message-put uid 'RFC822.TEXT rfc822text))
2584 (and rfc822size (imap-message-put uid 'RFC822.SIZE rfc822size))
2585 (and body (imap-message-put uid 'BODY body))
2586 (and bodydetail (imap-message-put uid 'BODYDETAIL bodydetail))
2587 (and bodystructure (imap-message-put uid 'BODYSTRUCTURE bodystructure))
2588 (run-hooks 'imap-fetch-data-hook)))))
2590 ;; mailbox-data = ...
2591 ;; "STATUS" SP mailbox SP "("
2592 ;; [status-att SP number
2593 ;; *(SP status-att SP number)] ")"
2596 ;; status-att = "MESSAGES" / "RECENT" / "UIDNEXT" / "UIDVALIDITY" /
2599 (defun imap-parse-status ()
2600 (let ((mailbox (imap-parse-mailbox)))
2601 (if (eq (char-after) ? )
2603 (when (and mailbox (eq (char-after) ?\())
2604 (while (and (not (eq (char-after) ?\)))
2605 (or (forward-char) t)
2606 (looking-at "\\([A-Za-z]+\\) "))
2607 (let ((token (upcase (match-string 1))))
2608 (goto-char (match-end 0))
2609 (cond ((string= token "MESSAGES")
2610 (imap-mailbox-put 'messages (read (current-buffer)) mailbox))
2611 ((string= token "RECENT")
2612 (imap-mailbox-put 'recent (read (current-buffer)) mailbox))
2613 ((string= token "UIDNEXT")
2614 (and (looking-at "[0-9]+")
2615 (imap-mailbox-put 'uidnext (match-string 0) mailbox)
2616 (goto-char (match-end 0))))
2617 ((string= token "UIDVALIDITY")
2618 (and (looking-at "[0-9]+")
2619 (imap-mailbox-put 'uidvalidity (match-string 0) mailbox)
2620 (goto-char (match-end 0))))
2621 ((string= token "UNSEEN")
2622 (imap-mailbox-put 'unseen (read (current-buffer)) mailbox))
2624 (message "Unknown status data %s in mailbox %s ignored"
2626 (read (current-buffer)))))))))
2628 ;; acl_data ::= "ACL" SPACE mailbox *(SPACE identifier SPACE
2631 ;; identifier ::= astring
2633 ;; rights ::= astring
2635 (defun imap-parse-acl ()
2636 (let ((mailbox (imap-parse-mailbox))
2637 identifier rights acl)
2638 (while (eq (char-after) ?\ )
2640 (setq identifier (imap-parse-astring))
2642 (setq rights (imap-parse-astring))
2643 (setq acl (append acl (list (cons identifier rights)))))
2644 (imap-mailbox-put 'acl acl mailbox)))
2646 ;; flag-list = "(" [flag *(SP flag)] ")"
2648 ;; flag = "\Answered" / "\Flagged" / "\Deleted" /
2649 ;; "\Seen" / "\Draft" / flag-keyword / flag-extension
2650 ;; ; Does not include "\Recent"
2652 ;; flag-keyword = atom
2654 ;; flag-extension = "\" atom
2655 ;; ; Future expansion. Client implementations
2656 ;; ; MUST accept flag-extension flags. Server
2657 ;; ; implementations MUST NOT generate
2658 ;; ; flag-extension flags except as defined by
2659 ;; ; future standard or standards-track
2660 ;; ; revisions of this specification.
2662 (defun imap-parse-flag-list ()
2663 (let (flag-list start)
2664 (assert (eq (char-after) ?\() nil "In imap-parse-flag-list 1")
2665 (while (and (not (eq (char-after) ?\)))
2668 ;; next line for Courier IMAP bug.
2669 (skip-chars-forward " ")
2671 (> (skip-chars-forward "^ )" (point-at-eol)) 0))
2672 (push (buffer-substring start (point)) flag-list))
2673 (assert (eq (char-after) ?\)) nil "In imap-parse-flag-list 2")
2675 (nreverse flag-list)))
2677 ;; envelope = "(" env-date SP env-subject SP env-from SP env-sender SP
2678 ;; env-reply-to SP env-to SP env-cc SP env-bcc SP
2679 ;; env-in-reply-to SP env-message-id ")"
2681 ;; env-bcc = "(" 1*address ")" / nil
2683 ;; env-cc = "(" 1*address ")" / nil
2685 ;; env-date = nstring
2687 ;; env-from = "(" 1*address ")" / nil
2689 ;; env-in-reply-to = nstring
2691 ;; env-message-id = nstring
2693 ;; env-reply-to = "(" 1*address ")" / nil
2695 ;; env-sender = "(" 1*address ")" / nil
2697 ;; env-subject = nstring
2699 ;; env-to = "(" 1*address ")" / nil
2701 (defun imap-parse-envelope ()
2702 (when (eq (char-after) ?\()
2704 (vector (prog1 (imap-parse-nstring) ;; date
2706 (prog1 (imap-parse-nstring) ;; subject
2708 (prog1 (imap-parse-address-list) ;; from
2710 (prog1 (imap-parse-address-list) ;; sender
2712 (prog1 (imap-parse-address-list) ;; reply-to
2714 (prog1 (imap-parse-address-list) ;; to
2716 (prog1 (imap-parse-address-list) ;; cc
2718 (prog1 (imap-parse-address-list) ;; bcc
2720 (prog1 (imap-parse-nstring) ;; in-reply-to
2722 (prog1 (imap-parse-nstring) ;; message-id
2725 ;; body-fld-param = "(" string SP string *(SP string SP string) ")" / nil
2727 (defsubst imap-parse-string-list ()
2728 (cond ((eq (char-after) ?\() ;; body-fld-param
2731 (while (setq str (imap-parse-string))
2733 ;; buggy stalker communigate pro 3.0 doesn't print SPC
2734 ;; between body-fld-param's sometimes
2735 (or (eq (char-after) ?\")
2737 (nreverse strlist)))
2741 ;; body-extension = nstring / number /
2742 ;; "(" body-extension *(SP body-extension) ")"
2743 ;; ; Future expansion. Client implementations
2744 ;; ; MUST accept body-extension fields. Server
2745 ;; ; implementations MUST NOT generate
2746 ;; ; body-extension fields except as defined by
2747 ;; ; future standard or standards-track
2748 ;; ; revisions of this specification.
2750 (defun imap-parse-body-extension ()
2751 (if (eq (char-after) ?\()
2754 (push (imap-parse-body-extension) b-e)
2755 (while (eq (char-after) ?\ )
2757 (push (imap-parse-body-extension) b-e))
2758 (assert (eq (char-after) ?\)) nil "In imap-parse-body-extension")
2761 (or (imap-parse-number)
2762 (imap-parse-nstring))))
2764 ;; body-ext-1part = body-fld-md5 [SP body-fld-dsp [SP body-fld-lang
2765 ;; *(SP body-extension)]]
2766 ;; ; MUST NOT be returned on non-extensible
2769 ;; body-ext-mpart = body-fld-param [SP body-fld-dsp [SP body-fld-lang
2770 ;; *(SP body-extension)]]
2771 ;; ; MUST NOT be returned on non-extensible
2774 (defsubst imap-parse-body-ext ()
2776 (when (eq (char-after) ?\ ) ;; body-fld-dsp
2779 (if (eq (char-after) ?\()
2782 (push (imap-parse-string) dsp)
2784 (push (imap-parse-string-list) dsp)
2786 ;; With assert, the code might not be eval'd.
2787 ;; (assert (imap-parse-nil) t "In imap-parse-body-ext")
2789 (push (nreverse dsp) ext))
2790 (when (eq (char-after) ?\ ) ;; body-fld-lang
2792 (if (eq (char-after) ?\()
2793 (push (imap-parse-string-list) ext)
2794 (push (imap-parse-nstring) ext))
2795 (while (eq (char-after) ?\ ) ;; body-extension
2797 (setq ext (append (imap-parse-body-extension) ext)))))
2800 ;; body = "(" body-type-1part / body-type-mpart ")"
2802 ;; body-ext-1part = body-fld-md5 [SP body-fld-dsp [SP body-fld-lang
2803 ;; *(SP body-extension)]]
2804 ;; ; MUST NOT be returned on non-extensible
2807 ;; body-ext-mpart = body-fld-param [SP body-fld-dsp [SP body-fld-lang
2808 ;; *(SP body-extension)]]
2809 ;; ; MUST NOT be returned on non-extensible
2812 ;; body-fields = body-fld-param SP body-fld-id SP body-fld-desc SP
2813 ;; body-fld-enc SP body-fld-octets
2815 ;; body-fld-desc = nstring
2817 ;; body-fld-dsp = "(" string SP body-fld-param ")" / nil
2819 ;; body-fld-enc = (DQUOTE ("7BIT" / "8BIT" / "BINARY" / "BASE64"/
2820 ;; "QUOTED-PRINTABLE") DQUOTE) / string
2822 ;; body-fld-id = nstring
2824 ;; body-fld-lang = nstring / "(" string *(SP string) ")"
2826 ;; body-fld-lines = number
2828 ;; body-fld-md5 = nstring
2830 ;; body-fld-octets = number
2832 ;; body-fld-param = "(" string SP string *(SP string SP string) ")" / nil
2834 ;; body-type-1part = (body-type-basic / body-type-msg / body-type-text)
2835 ;; [SP body-ext-1part]
2837 ;; body-type-basic = media-basic SP body-fields
2838 ;; ; MESSAGE subtype MUST NOT be "RFC822"
2840 ;; body-type-msg = media-message SP body-fields SP envelope
2841 ;; SP body SP body-fld-lines
2843 ;; body-type-text = media-text SP body-fields SP body-fld-lines
2845 ;; body-type-mpart = 1*body SP media-subtype
2846 ;; [SP body-ext-mpart]
2848 ;; media-basic = ((DQUOTE ("APPLICATION" / "AUDIO" / "IMAGE" /
2849 ;; "MESSAGE" / "VIDEO") DQUOTE) / string) SP media-subtype
2850 ;; ; Defined in [MIME-IMT]
2852 ;; media-message = DQUOTE "MESSAGE" DQUOTE SP DQUOTE "RFC822" DQUOTE
2853 ;; ; Defined in [MIME-IMT]
2855 ;; media-subtype = string
2856 ;; ; Defined in [MIME-IMT]
2858 ;; media-text = DQUOTE "TEXT" DQUOTE SP media-subtype
2859 ;; ; Defined in [MIME-IMT]
2861 (defun imap-parse-body ()
2863 (when (eq (char-after) ?\()
2865 (if (eq (char-after) ?\()
2867 (while (and (eq (char-after) ?\()
2868 (setq subbody (imap-parse-body)))
2869 ;; buggy stalker communigate pro 3.0 inserts a SPC between
2870 ;; parts in multiparts
2871 (when (and (eq (char-after) ?\ )
2872 (eq (char-after (1+ (point))) ?\())
2874 (push subbody body))
2876 (push (imap-parse-string) body) ;; media-subtype
2877 (when (eq (char-after) ?\ ) ;; body-ext-mpart:
2879 (if (eq (char-after) ?\() ;; body-fld-param
2880 (push (imap-parse-string-list) body)
2881 (push (and (imap-parse-nil) nil) body))
2883 (append (imap-parse-body-ext) body))) ;; body-ext-...
2884 (assert (eq (char-after) ?\)) nil "In imap-parse-body")
2888 (push (imap-parse-string) body) ;; media-type
2890 (push (imap-parse-string) body) ;; media-subtype
2892 ;; next line for Sun SIMS bug
2893 (and (eq (char-after) ? ) (imap-forward))
2894 (if (eq (char-after) ?\() ;; body-fld-param
2895 (push (imap-parse-string-list) body)
2896 (push (and (imap-parse-nil) nil) body))
2898 (push (imap-parse-nstring) body) ;; body-fld-id
2900 (push (imap-parse-nstring) body) ;; body-fld-desc
2902 ;; Next `or' for Sun SIMS bug. It regards body-fld-enc as a
2903 ;; nstring and returns nil instead of defaulting back to 7BIT
2904 ;; as the standard says.
2905 ;; Exchange (2007, at least) does this as well.
2906 (push (or (imap-parse-nstring) "7BIT") body) ;; body-fld-enc
2908 ;; Exchange 2007 can return -1, contrary to the spec...
2909 (if (eq (char-after) ?-)
2911 (skip-chars-forward "-0-9")
2913 (push (imap-parse-number) body)) ;; body-fld-octets
2915 ;; Ok, we're done parsing the required parts, what comes now is one of
2918 ;; envelope (then we're parsing body-type-msg)
2919 ;; body-fld-lines (then we're parsing body-type-text)
2920 ;; body-ext-1part (then we're parsing body-type-basic)
2922 ;; The problem is that the two first are in turn optionally followed
2923 ;; by the third. So we parse the first two here (if there are any)...
2925 (when (eq (char-after) ?\ )
2928 (cond ((eq (char-after) ?\() ;; body-type-msg:
2929 (push (imap-parse-envelope) body) ;; envelope
2931 (push (imap-parse-body) body) ;; body
2932 ;; buggy stalker communigate pro 3.0 doesn't print
2933 ;; number of lines in message/rfc822 attachment
2934 (if (eq (char-after) ?\))
2937 (push (imap-parse-number) body))) ;; body-fld-lines
2938 ((setq lines (imap-parse-number)) ;; body-type-text:
2939 (push lines body)) ;; body-fld-lines
2941 (backward-char))))) ;; no match...
2943 ;; ...and then parse the third one here...
2945 (when (eq (char-after) ?\ ) ;; body-ext-1part:
2947 (push (imap-parse-nstring) body) ;; body-fld-md5
2948 (setq body (append (imap-parse-body-ext) body))) ;; body-ext-1part..
2950 (assert (eq (char-after) ?\)) nil "In imap-parse-body 2")
2954 (when imap-debug ; (untrace-all)
2956 (buffer-disable-undo (get-buffer-create imap-debug-buffer))
2957 (mapc (lambda (f) (trace-function-background f imap-debug-buffer))
2968 imap-interactive-login
2985 imap-send-command-wait
2990 imap-current-mailbox
2991 imap-current-mailbox-p-1
2992 imap-current-mailbox-p
2993 imap-mailbox-select-1
2995 imap-mailbox-examine-1
2996 imap-mailbox-examine
2997 imap-mailbox-unselect
2998 imap-mailbox-expunge
3000 imap-mailbox-create-1
3006 imap-mailbox-subscribe
3007 imap-mailbox-unsubscribe
3009 imap-mailbox-acl-get
3010 imap-mailbox-acl-set
3011 imap-mailbox-acl-delete
3012 imap-current-message
3013 imap-list-to-message-set
3021 imap-message-flag-permanent-p
3022 imap-message-flags-set
3023 imap-message-flags-del
3024 imap-message-flags-add
3025 imap-message-copyuid-1
3026 imap-message-copyuid
3028 imap-message-appenduid-1
3029 imap-message-appenduid
3041 imap-parse-resp-text
3042 imap-parse-resp-text-code
3043 imap-parse-data-list
3047 imap-parse-flag-list
3049 imap-parse-body-extension
3055 ;;; imap.el ends here