| blob | cf19e6ca5cf891b263138611fc7240cc85a03b56 |
1 ;;; imap.el --- imap library
3 ;; Copyright (C) 1998-2014 Free Software Foundation, Inc.
5 ;; Author: Simon Josefsson <simon@josefsson.org>
6 ;; Keywords: mail
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
25 ;; imap.el is an elisp library providing an interface for talking to
26 ;; IMAP servers.
27 ;;
28 ;; imap.el is roughly divided in two parts, one that parses IMAP
29 ;; responses from the server and storing data into buffer-local
30 ;; variables, and one for utility functions which send commands to
31 ;; server, waits for an answer, and return information. The latter
32 ;; part is layered on top of the previous.
33 ;;
34 ;; The imap.el API consist of the following functions, other functions
35 ;; in this file should not be called directly and the result of doing
36 ;; so are at best undefined.
37 ;;
38 ;; Global commands:
39 ;;
40 ;; imap-open, imap-opened, imap-authenticate, imap-close,
41 ;; imap-capability, imap-namespace, imap-error-text
42 ;;
43 ;; Mailbox commands:
44 ;;
45 ;; imap-mailbox-get, imap-mailbox-map, imap-current-mailbox,
46 ;; imap-current-mailbox-p, imap-search, imap-mailbox-select,
47 ;; imap-mailbox-examine, imap-mailbox-unselect, imap-mailbox-expunge
48 ;; imap-mailbox-close, imap-mailbox-create, imap-mailbox-delete
49 ;; imap-mailbox-rename, imap-mailbox-lsub, imap-mailbox-list
50 ;; imap-mailbox-subscribe, imap-mailbox-unsubscribe, imap-mailbox-status
51 ;; imap-mailbox-acl-get, imap-mailbox-acl-set, imap-mailbox-acl-delete
52 ;;
53 ;; Message commands:
54 ;;
55 ;; imap-fetch-asynch, imap-fetch,
56 ;; imap-current-message, imap-list-to-message-set,
57 ;; imap-message-get, imap-message-map
58 ;; imap-message-envelope-date, imap-message-envelope-subject,
59 ;; imap-message-envelope-from, imap-message-envelope-sender,
60 ;; imap-message-envelope-reply-to, imap-message-envelope-to,
61 ;; imap-message-envelope-cc, imap-message-envelope-bcc
62 ;; imap-message-envelope-in-reply-to, imap-message-envelope-message-id
63 ;; imap-message-body, imap-message-flag-permanent-p
64 ;; imap-message-flags-set, imap-message-flags-del
65 ;; imap-message-flags-add, imap-message-copyuid
66 ;; imap-message-copy, imap-message-appenduid
67 ;; imap-message-append, imap-envelope-from
68 ;; imap-body-lines
69 ;;
70 ;; It is my hope that these commands should be pretty self
71 ;; explanatory for someone who knows IMAP. All functions have
72 ;; additional documentation on how to invoke them.
73 ;;
74 ;; imap.el supports RFC1730/2060/RFC3501 (IMAP4/IMAP4rev1). The implemented
75 ;; IMAP extensions are RFC2195 (CRAM-MD5), RFC2086 (ACL), RFC2342
76 ;; (NAMESPACE), RFC2359 (UIDPLUS), the IMAP-part of RFC2595 (STARTTLS,
77 ;; LOGINDISABLED) (with use of external library starttls.el and
78 ;; program starttls), and the GSSAPI / Kerberos V4 sections of RFC1731
79 ;; (with use of external program `imtest'), and RFC2971 (ID). It also
80 ;; takes advantage of the UNSELECT extension in Cyrus IMAPD.
81 ;;
82 ;; Without the work of John McClary Prevost and Jim Radford this library
83 ;; would not have seen the light of day. Many thanks.
84 ;;
85 ;; This is a transcript of a short interactive session for demonstration
86 ;; purposes.
87 ;;
88 ;; (imap-open "my.mail.server")
89 ;; => " *imap* my.mail.server:0"
90 ;;
91 ;; The rest are invoked with current buffer as the buffer returned by
92 ;; `imap-open'. It is possible to do it all without this, but it would
93 ;; look ugly here since `buffer' is always the last argument for all
94 ;; imap.el API functions.
95 ;;
96 ;; (imap-authenticate "myusername" "mypassword")
97 ;; => auth
98 ;;
99 ;; (imap-mailbox-lsub "*")
100 ;; => ("INBOX.sentmail" "INBOX.private" "INBOX.draft" "INBOX.spam")
101 ;;
102 ;; (imap-mailbox-list "INBOX.n%")
103 ;; => ("INBOX.namedroppers" "INBOX.nnimap" "INBOX.ntbugtraq")
104 ;;
105 ;; (imap-mailbox-select "INBOX.nnimap")
106 ;; => "INBOX.nnimap"
107 ;;
108 ;; (imap-mailbox-get 'exists)
109 ;; => 166
110 ;;
111 ;; (imap-mailbox-get 'uidvalidity)
112 ;; => "908992622"
113 ;;
114 ;; (imap-search "FLAGGED SINCE 18-DEC-98")
115 ;; => (235 236)
116 ;;
117 ;; (imap-fetch 235 "RFC822.PEEK" 'RFC822)
118 ;; => "X-Sieve: cmu-sieve 1.3^M\nX-Username: <jas@pdc.kth.se>^M\r...."
119 ;;
120 ;; Todo:
121 ;;
122 ;; o Parse UIDs as strings? We need to overcome the 28 bit limit somehow.
123 ;; Use IEEE floats (which are effectively exact)? -- fx
124 ;; o Don't use `read' at all (important places already fixed)
125 ;; o Accept list of articles instead of message set string in most
126 ;; imap-message-* functions.
127 ;; o Send strings as literal if they contain, e.g., ".
128 ;;
129 ;; Revision history:
130 ;;
131 ;; - 19991218 added starttls/digest-md5 patch,
132 ;; by Daiki Ueno <ueno@ueda.info.waseda.ac.jp>
133 ;; NB! you need SLIM for starttls.el and digest-md5.el
134 ;; - 19991023 committed to pgnus
135 ;;
137 ;;; Code:
141 ;; For Emacs <22.2 and XEmacs.
157 ;; User variables.
160 "Low-level IMAP issues."
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."
176 "--mechanism GSSAPI "
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."
188 "openssl s_client -quiet -ssl2 -connect %s:%p"
189 "s_client -quiet -ssl3 -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."
201 "rsh %s imapd"
202 "ssh %g ssh %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."
214 "Value for `process-connection-type' to use for Kerberos4, GSSAPI, shell, 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."
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."
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'."
245 "If non-nil, trace imap- functions into `imap-debug-buffer'.
246 Uses `trace-function-background', so you can turn it off with,
247 say, `untrace-all'.
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'."
260 "Hostname of rlogin proxy."
265 "Default username to use."
272 1.0
274 "How long to wait between checking for the end of output.
275 Shorter values mean quicker response, but is more CPU intensive."
280 "If non-nil, store session password without prompting."
284 ;; Various variables.
300 "Definition of network streams.
302 \(NAME CHECK OPEN)
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
309 kerberos4
310 digest-md5
311 cram-md5
312 ;;sasl
313 login
314 anonymous)
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
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.
352 imap-port
353 imap-client-eol
354 imap-server-eol
355 imap-auth
356 imap-stream
357 imap-username
358 imap-password
359 imap-current-mailbox
360 imap-current-target-mailbox
361 imap-message-data
362 imap-capability
363 imap-id
364 imap-namespace
365 imap-state
366 imap-reached-tag
367 imap-failed-tags
368 imap-tag
369 imap-process
370 imap-calculate-literal-size-first
371 imap-mailbox-data))
375 ;; Internal variables.
386 "IMAP state.
387 Valid states are `closed', `initial', `nonauth', `auth', `selected'
421 "Identity of server.
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
443 "Non-nil indicates that the server emitted a continuation request.
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
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
463 \f
464 ;; Utility functions:
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'."
476 alist)))
479 "Enable multibyte in the current buffer."
489 "imap: Could not UTF7 encode `%s', using it unencoded..."
490 string)
491 string)))
492 string))
500 "imap: Could not UTF7 decode `%s', using it undecoded..."
501 string)
502 string)))
503 string))
507 t
509 nil))
515 \f
516 ;; Server functions; stream stuff:
533 cmd done)
542 name buffer shell-file-name shell-command-switch
544 cmd
546 ?s server
548 ?l imap-default-user))))
549 response)
553 imap-calculate-literal-size-first t)
557 ;; Athena IMTEST can output SSL verify errors
560 t)
563 t)
564 ;; cyrus 1.6.x (13? < x <= 22) queries capabilities
567 t)
568 ;; cyrus 1.6 imtest print "S: " before server greeting
571 t)
573 ;; success in imtest < 1.6:
576 ;; success in imtest 1.6:
591 nil)))))
592 done))
599 cmd done)
608 name buffer shell-file-name shell-command-switch
610 cmd
612 ?s server
614 ?l imap-default-user))))
615 response)
619 imap-calculate-literal-size-first t)
623 ;; Athena IMTEST can output SSL verify errors
626 t)
629 t)
630 ;; cyrus 1.6.x (13? < x <= 22) queries capabilities
633 t)
634 ;; cyrus 1.6 imtest print "S: " before server greeting
637 t)
638 ;; GNU SASL may print 'Trying ...' first.
641 t)
643 ;; success in imtest 1.6:
646 "Client authentication "
648 nil t)
661 nil)))))
662 done))
665 nil)
668 "Open an SSL connection to SERVER."
671 cmd done)
681 'set-process-query-on-exit-flag
683 process)
686 name buffer shell-file-name
687 shell-command-switch
690 ?s server
693 process)
710 done)
712 nil)))
715 nil)
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
739 process))))
742 t)
758 process))))
761 nil)
766 cmd done)
775 name buffer shell-file-name shell-command-switch
777 cmd
779 ?s server
780 ?g imap-shell-host
782 ?l imap-default-user)))))
798 done)
800 nil)))
810 done tls-info)
835 done))
837 ;; Server functions; authenticator stuff:
840 "Login to server in BUFFER.
841 Return t if login was successful, nil otherwise.
843 LOGINFUNC is passed a username and a password. It should return
844 t if it successfully authenticates, nil otherwise."
849 ;; (condition-case ()
860 imap-server " (using authenticator `"
867 imap-username user)
876 ;; (quit (with-current-buffer buffer
877 ;; (setq user nil
878 ;; passwd nil)))
879 ;; (error (with-current-buffer buffer
880 ;; (setq user nil
881 ;; passwd nil))))
882 ret)))
905 "Login to server using the AUTH CRAM-MD5 method."
908 buffer
913 "AUTHENTICATE CRAM-MD5"
919 encoded)))))))))
939 "Login to server using the LOGIN command."
951 t)
960 ;;; Compiler directives.
973 mecs))
989 "Login to server using the SASL method."
996 logged user)
1012 buffer)))
1022 logged t)
1025 logged)))
1034 "Login to server using the AUTH DIGEST-MD5 method."
1037 buffer
1042 "AUTHENTICATE DIGEST-MD5"
1051 user passwd digest-uri)))
1053 )))
1055 nil
1060 ;; Server functions:
1066 imap-current-message nil
1067 imap-state 'initial
1070 imap-stream-alist))
1082 imap-process))))
1085 "Open an IMAP connection to host SERVER at PORT returning a buffer.
1086 If PORT is unspecified, a default value is used (143 except
1087 for SSL which use 993).
1088 STREAM indicates the stream to use, see `imap-streams' for available
1089 streams. If nil, it choices the best stream the server is capable of.
1090 AUTH indicates authenticator to use, see `imap-authenticators' for
1091 available authenticators. If nil, it choices the best stream the
1092 server is capable of.
1093 BUFFER can be a buffer or a name of a buffer, which is created if
1094 necessary. If nil, the buffer name is generated."
1111 nil)
1113 ;; Need to choose stream.
1116 ;; OK to use this stream?
1118 ;; Stream changed?
1134 "imap: Reconnecting with stream `%s'...failed"
1135 stream))
1136 ;; We're done, kill the first connection
1139 buffer
1143 ;; set the passed buffer to the current one,
1144 ;; so that (imap-opened buffer) later will work
1147 stream)
1151 ;; We're done
1158 ;; (debug "opened+state+auth+buffer" (imap-opened buffer) imap-state imap-auth buffer)
1160 buffer))))
1163 "If non-nil, check if IMAP is open.
1164 See the function `imap-ping-server'."
1170 "Return non-nil if connection to imap server in BUFFER is open.
1171 If BUFFER is nil then the current buffer is used."
1179 t)))))
1183 Return non-nil if the server responds, and nil if it does not
1184 respond. If BUFFER is nil, the current buffer is used."
1190 "Authenticate to server in BUFFER, using current buffer if nil.
1191 It uses the authenticator specified when opening the server.
1193 Optional arguments USER and PASSWD specify the username and
1194 password to use if the authenticator requires a username and/or
1195 password. If omitted or nil, the authenticator may query the
1196 user for a username and/or password."
1212 ;; Choose authenticator.
1214 auth)
1216 ;; OK to use authenticator?
1221 imap-server auth)
1226 imap-server auth)
1227 ;; set imap-state correctly on successful auth attempt
1229 ;; stop iterating through the authenticator list
1232 imap-server auth)))))
1233 imap-state))))
1236 "Close connection to server in BUFFER.
1237 If BUFFER is nil, the current buffer is used."
1247 imap-current-message nil
1248 imap-process nil)
1250 t))
1253 "Return a list of identifiers which server in BUFFER support.
1254 If IDENTIFIER, return non-nil if it's among the servers capabilities.
1255 If BUFFER is nil, the current buffer is assumed."
1262 imap-capability)))
1265 "Identify client to server in BUFFER, and return server identity.
1266 LIST-OF-VALUES is nil, or a plist with identifier and value
1267 strings to send to the server to identify the client.
1269 Return a list of identifiers which server in BUFFER support, or
1270 nil if it doesn't support ID or returns no information.
1272 If BUFFER is nil, the current buffer is assumed."
1277 "ID NIL"
1280 list-of-values
1282 imap-id)))
1285 "Return a namespace hierarchy at server in BUFFER.
1286 If BUFFER is nil, the current buffer is assumed."
1291 imap-namespace))
1318 \f
1319 ;; Mailbox functions:
1325 propname value)
1328 t))
1332 propname))
1347 imap-mailbox-data)
1348 result)))
1351 "Map a function across each mailbox in `imap-mailbox-data', returning a list.
1352 Function should take a mailbox name (a string) as
1353 the only argument."
1372 "Select MAILBOX on server in BUFFER.
1373 If EXAMINE is non-nil, do a read-only select."
1375 imap-current-mailbox
1383 imap-current-mailbox)
1384 ;; Failed SELECT/EXAMINE unselects current mailbox
1397 "Examine MAILBOX on server in BUFFER."
1401 "Close current folder in BUFFER, without expunging articles."
1408 imap-current-mailbox
1412 imap-message-data nil
1414 t)))
1417 "Expunge articles in current folder in BUFFER.
1418 If ASYNCH, do not wait for successful completion of the command.
1419 If BUFFER is nil the current buffer is assumed."
1427 "Expunge articles and close current folder in BUFFER.
1428 If ASYNCH, do not wait for successful completion of the command.
1429 If BUFFER is nil the current buffer is assumed."
1436 imap-current-mailbox status)
1438 imap-current-mailbox)
1439 ;; Don't wipe out data if another mailbox
1440 ;; was selected...
1442 imap-message-data nil
1446 imap-message-data nil
1448 t)))
1454 "Create MAILBOX on server in BUFFER.
1455 If BUFFER is nil the current buffer is assumed."
1460 "Delete MAILBOX on server in BUFFER.
1461 If BUFFER is nil the current buffer is assumed."
1468 "Rename mailbox OLDNAME to NEWNAME on server in BUFFER.
1469 If BUFFER is nil the current buffer is assumed."
1478 "Return a list of subscribed mailboxes on server in BUFFER.
1479 If ROOT is non-nil, only list matching mailboxes. If ADD-DELIMITER is
1480 non-nil, a hierarchy delimiter is added to root. REFERENCE is an
1481 implementation-specific string that has to be passed to lsub command."
1483 ;; Make sure we know the hierarchy separator for root's hierarchy
1487 ;; clear list data (NB not delimiter and other stuff)
1502 "Return a list of mailboxes matching ROOT on server in BUFFER.
1503 If ADD-DELIMITER is non-nil, a hierarchy delimiter is added to
1504 root. REFERENCE is an implementation-specific string that has to be
1505 passed to list command."
1507 ;; Make sure we know the hierarchy separator for root's hierarchy
1511 ;; clear list data (NB not delimiter and other stuff)
1526 "Send the SUBSCRIBE command on the MAILBOX to server in BUFFER.
1527 Returns non-nil if successful."
1534 "Send the SUBSCRIBE command on the MAILBOX to server in BUFFER.
1535 Returns non-nil if successful."
1542 "Get status items ITEM in MAILBOX from server in BUFFER.
1543 ITEMS can be a symbol or a list of symbols, valid symbols are one of
1544 the STATUS data items -- i.e. `messages', `recent', `uidnext', `uidvalidity',
1545 or `unseen'. If ITEMS is a list of symbols, a list of values is
1546 returned, if ITEMS is a symbol only its value is returned."
1555 items
1560 items)
1564 "Send status item requests ITEMS on MAILBOX to server in BUFFER.
1565 ITEMS can be a symbol or a list of symbols, valid symbols are one of
1566 the STATUS data items -- i.e. 'messages, 'recent, 'uidnext, 'uidvalidity
1567 or 'unseen. The IMAP command tag is returned."
1575 items
1579 "Get ACL on MAILBOX from server in BUFFER."
1589 "Change/set ACL for IDENTIFIER to RIGHTS in MAILBOX from server in BUFFER."
1596 identifier
1597 " "
1598 rights))))))
1601 "Remove <id,rights> pairs for IDENTIFIER from MAILBOX on server in BUFFER."
1608 identifier))))))
1610 \f
1611 ;; Message functions:
1615 imap-current-message))
1621 list
1634 range)
1642 uids)
1643 props))))
1646 "Fetch properties PROPS from message set UIDS from server in BUFFER.
1647 UIDS can be a string, number or a list of numbers. If RECEIVE is
1648 non-nil, return these properties."
1654 uids)
1655 props)))
1657 t
1663 receive)
1665 uids)
1672 propname value)
1675 t))
1680 propname)))
1683 "Map a function across each message in `imap-message-data', returning a list."
1689 imap-message-data)
1690 result)))
1736 ;; FIXME: Should this try to use CHARSET? -- fx
1744 nil)
1748 "Return t if FLAG can be permanently saved on articles.
1749 MAILBOX specifies a mailbox on the server in BUFFER."
1775 ;; Cf. http://thread.gmane.org/gmane.emacs.gnus.general/65317/focus=65343
1776 ;; Signal an error if we'd get an integer overflow.
1777 ;;
1778 ;; FIXME: Identify relevant calls to `string-to-number' and replace them with
1779 ;; `imap-string-to-integer'.
1785 number)))
1788 "Like `imap-fetch', but DTRT with Exchange 2007 bug.
1789 However, UIDS here is a cons, where the car is the canonical form
1790 of the UIDS specification, and the cdr is the one which works with
1791 Exchange 2007 or, potentially, other buggy servers.
1792 See `imap-enable-exchange-bug-workaround'."
1793 ;; The first time we get here for a given, we'll try the canonical
1794 ;; form. If we get the known error from the buggy server, set the
1795 ;; flag buffer-locally (to account for connections to multiple
1796 ;; servers), then re-try with the alternative UIDS spec. We don't
1797 ;; unconditionally use the alternative form, since the
1798 ;; currently-used alternatives are seriously inefficient with some
1799 ;; servers (although they are valid).
1800 ;;
1801 ;; FIXME: Maybe it would be cleaner to have a flag to not signal
1802 ;; the error (which otherwise gives a message), and test
1803 ;; `imap-failed-tags'. Also, Other IMAP clients use other forms of
1804 ;; request which work with Exchange, e.g. Claws does "UID FETCH 1:*
1805 ;; (UID)" rather than "FETCH UID 1,*". Is there a good reason not
1806 ;; to do the same?
1808 ;; Binding `debug-on-error' allows us to get the error from
1809 ;; `imap-parse-response' -- it's normally caught by Emacs around
1810 ;; execution of a process filter.
1815 props receive nouidfetch buffer))
1818 ;; This is the Exchange 2007 response. It may be more
1819 ;; robust just to check for a BAD response to the
1820 ;; attempted fetch.
1825 t)
1852 "Copy ARTICLES to MAILBOX on server in BUFFER.
1853 ARTICLES is a string message set. Create mailbox if it doesn't exist,
1854 unless DONT-CREATE is non-nil. On success, return a list with
1855 the UIDVALIDITY of the mailbox the article(s) was copied to as the
1856 first element. The rest of list contains the saved articles' UIDs."
1863 t
1865 ;; removed because of buggy Oracle server
1866 ;; that doesn't send TRYCREATE tags (which
1867 ;; is a MUST according to specifications):
1868 ;;(imap-mailbox-get-1 'trycreate mailbox)
1874 ;; FIXME: Amalgamate with imap-message-copyuid-1, using an extra arg, since it
1875 ;; shares most of the code? -- fx
1897 "Append ARTICLE (a buffer) to MAILBOX on server in BUFFER.
1898 FLAGS and DATE-TIME is currently not used. Return a cons holding
1899 uidvalidity of MAILBOX and UID the newly created article got, or nil
1900 on failure."
1910 "Return number of lines in article by looking at the mime bodystructure BODY."
1924 "Return a FROM string line."
1929 "@"
1933 \f
1934 ;; Internal functions.
1948 cmd cmdstr)
1956 size)
1961 ;; XXX modifies buffer!
1990 nil ;; abort command if no cont-req
1992 command)))
1998 tag)))
2007 message-log-max)
2016 ;; A process can die _before_ we have processed everything it
2017 ;; has to say. Moreover, this can happen in between the call to
2018 ;; accept-process-output and the call to process-status in an
2019 ;; iteration of the loop above.
2028 'INCOMPLETE
2035 "Return point at end of current line, taking into account literals.
2036 Return nil if no complete line has arrived."
2038 imap-server-eol)
2039 nil t)
2042 nil
2048 "IMAP process filter."
2049 ;; Sometimes, we are called even though the process has died.
2050 ;; Better abstain from doing stuff in that case.
2073 imap-state)))
2076 \f
2077 ;; Imap parser.
2082 ;; number = 1*DIGIT
2083 ;; ; Unsigned 32-bit integer
2084 ;; ; (0 <= n < 4,294,967,296)
2092 ;; literal = "{" number "}" CRLF *CHAR8
2093 ;; ; Number represents the number of CHAR8s
2100 nil
2104 ;; string = quoted / literal
2105 ;;
2106 ;; quoted = DQUOTE *QUOTED-CHAR DQUOTE
2107 ;;
2108 ;; QUOTED-CHAR = <any TEXT-CHAR except quoted-specials> /
2109 ;; "\" quoted-specials
2110 ;;
2111 ;; quoted-specials = DQUOTE / "\"
2112 ;;
2113 ;; TEXT-CHAR = <any CHAR except CR and LF>
2127 name))
2131 ;; nil = "NIL"
2137 ;; nstring = string / nil
2142 nil)))
2144 ;; astring = atom / string
2145 ;;
2146 ;; atom = 1*ATOM-CHAR
2147 ;;
2148 ;; ATOM-CHAR = <any CHAR except atom-specials>
2149 ;;
2150 ;; atom-specials = "(" / ")" / "{" / SP / CTL / list-wildcards /
2151 ;; quoted-specials
2152 ;;
2153 ;; list-wildcards = "%" / "*"
2154 ;;
2155 ;; quoted-specials = DQUOTE / "\"
2165 ;; address = "(" addr-name SP addr-adl SP addr-mailbox SP
2166 ;; addr-host ")"
2167 ;;
2168 ;; addr-adl = nstring
2169 ;; ; Holds route from [RFC-822] route-addr if
2170 ;; ; non-nil
2171 ;;
2172 ;; addr-host = nstring
2173 ;; ; nil indicates [RFC-822] group syntax.
2174 ;; ; Otherwise, holds [RFC-822] domain name
2175 ;;
2176 ;; addr-mailbox = nstring
2177 ;; ; nil indicates end of [RFC-822] group; if
2178 ;; ; non-nil and addr-host is nil, holds
2179 ;; ; [RFC-822] group name.
2180 ;; ; Otherwise, holds [RFC-822] local-part
2181 ;; ; after removing [RFC-822] quoting
2182 ;;
2183 ;; addr-name = nstring
2184 ;; ; If non-nil, holds phrase from [RFC-822]
2185 ;; ; mailbox after removing [RFC-822] quoting
2186 ;;
2201 address))))
2203 ;; address-list = "(" 1*address ")" / nil
2204 ;;
2205 ;; nil = "NIL"
2212 ;; next line for MS Exchange bug
2219 ;; With assert, the code might not be eval'd.
2220 ;; (assert (imap-parse-nil) t "In imap-parse-address-list")
2223 ;; mailbox = "INBOX" / astring
2224 ;; ; INBOX is case-insensitive. All case variants of
2225 ;; ; INBOX (e.g. "iNbOx") MUST be interpreted as INBOX
2226 ;; ; not as an astring. An astring which consists of
2227 ;; ; the case-insensitive sequence "I" "N" "B" "O" "X"
2228 ;; ; is considered to be INBOX and not an astring.
2229 ;; ; Refer to section 5.1 for further
2230 ;; ; semantic details of mailbox names.
2235 "INBOX"
2236 mailbox)))
2238 ;; greeting = "*" SP (resp-cond-auth / resp-cond-bye) CRLF
2239 ;;
2240 ;; resp-cond-auth = ("OK" / "PREAUTH") SP resp-text
2241 ;; ; Authentication condition
2242 ;;
2243 ;; resp-cond-bye = "BYE" SP resp-text
2246 "Parse an IMAP greeting."
2254 ;; response = *(continue-req / response-data) response-done
2255 ;;
2256 ;; continue-req = "+" SP (resp-text / base64) CRLF
2257 ;;
2258 ;; response-data = "*" SP (resp-cond-state / resp-cond-bye /
2259 ;; mailbox-data / message-data / capability-data) CRLF
2260 ;;
2261 ;; response-done = response-tagged / response-fatal
2262 ;;
2263 ;; response-fatal = "*" SP resp-cond-bye CRLF
2264 ;; ; Server closes connection immediately
2265 ;;
2266 ;; response-tagged = tag SP resp-cond-state CRLF
2267 ;;
2268 ;; resp-cond-state = ("OK" / "NO" / "BAD") SP resp-text
2269 ;; ; Status condition
2270 ;;
2271 ;; resp-cond-bye = "BYE" SP resp-text
2272 ;;
2273 ;; mailbox-data = "FLAGS" SP flag-list /
2274 ;; "LIST" SP mailbox-list /
2275 ;; "LSUB" SP mailbox-list /
2276 ;; "SEARCH" *(SP nz-number) /
2277 ;; "STATUS" SP mailbox SP "("
2278 ;; [status-att SP number *(SP status-att SP number)] ")" /
2279 ;; number SP "EXISTS" /
2280 ;; number SP "RECENT"
2281 ;;
2282 ;; message-data = nz-number SP ("EXPUNGE" / ("FETCH" SP msg-att))
2283 ;;
2284 ;; capability-data = "CAPABILITY" *(SP capability) SP "IMAP4rev1"
2285 ;; *(SP capability)
2286 ;; ; IMAP4rev1 servers which offer RFC 1730
2287 ;; ; compatibility MUST list "IMAP4" as the first
2288 ;; ; capability.
2291 "Parse an IMAP command response."
2297 t)))
2308 'search
2344 imap-failed-tags))))
2357 token status code text))))
2364 ;; resp-text = ["[" resp-text-code "]" SP] text
2365 ;;
2366 ;; text = 1*TEXT-CHAR
2367 ;;
2368 ;; TEXT-CHAR = <any CHAR except CR and LF>
2373 ;; resp-text-code = "ALERT" /
2374 ;; "BADCHARSET [SP "(" astring *(SP astring) ")" ] /
2375 ;; "NEWNAME" SP string SP string /
2376 ;; "PARSE" /
2377 ;; "PERMANENTFLAGS" SP "("
2378 ;; [flag-perm *(SP flag-perm)] ")" /
2379 ;; "READ-ONLY" /
2380 ;; "READ-WRITE" /
2381 ;; "TRYCREATE" /
2382 ;; "UIDNEXT" SP nz-number /
2383 ;; "UIDVALIDITY" SP nz-number /
2384 ;; "UNSEEN" SP nz-number /
2385 ;; resp-text-atom [SP 1*<any TEXT-CHAR except "]">]
2386 ;;
2387 ;; resp_code_apnd = "APPENDUID" SPACE nz_number SPACE uniqueid
2388 ;;
2389 ;; resp_code_copy = "COPYUID" SPACE nz_number SPACE set SPACE set
2390 ;;
2391 ;; set = sequence-num / (sequence-num ":" sequence-num) /
2392 ;; (set "," set)
2393 ;; ; Identifies a set of messages. For message
2394 ;; ; sequence numbers, these are consecutive
2395 ;; ; numbers from 1 to the number of messages in
2396 ;; ; the mailbox
2397 ;; ; Comma delimits individual numbers, colon
2398 ;; ; delimits between two numbers inclusive.
2399 ;; ; Example: 2,4:7,9,12:* is 2,4,5,6,7,9,12,13,
2400 ;; ; 14,15 for a mailbox with 15 messages.
2401 ;;
2402 ;; sequence-num = nz-number / "*"
2403 ;; ; * is the largest number in use. For message
2404 ;; ; sequence numbers, it is the number of messages
2405 ;; ; in the mailbox. For unique identifiers, it is
2406 ;; ; the unique identifier of the last message in
2407 ;; ; the mailbox.
2408 ;;
2409 ;; flag-perm = flag / "\*"
2410 ;;
2411 ;; flag = "\Answered" / "\Flagged" / "\Deleted" /
2412 ;; "\Seen" / "\Draft" / flag-keyword / flag-extension
2413 ;; ; Does not include "\Recent"
2414 ;;
2415 ;; flag-extension = "\" atom
2416 ;; ; Future expansion. Client implementations
2417 ;; ; MUST accept flag-extension flags. Server
2418 ;; ; implementations MUST NOT generate
2419 ;; ; flag-extension flags except as defined by
2420 ;; ; future standard or standards-track
2421 ;; ; revisions of this specification.
2422 ;;
2423 ;; flag-keyword = atom
2424 ;;
2425 ;; resp-text-atom = 1*<any ATOM-CHAR except "]">
2428 ;; xxx next line for stalker communigate pro 3.3.1 bug
2455 imap-current-target-mailbox))
2460 imap-current-target-mailbox))
2465 ;; mailbox-list = "(" [mbx-list-flags] ")" SP
2466 ;; (DQUOTE QUOTED-CHAR DQUOTE / nil) SP mailbox
2467 ;;
2468 ;; mbx-list-flags = *(mbx-list-oflag SP) mbx-list-sflag
2469 ;; *(SP mbx-list-oflag) /
2470 ;; mbx-list-oflag *(SP mbx-list-oflag)
2471 ;;
2472 ;; mbx-list-oflag = "\Noinferiors" / flag-extension
2473 ;; ; Other flags; multiple possible per LIST response
2474 ;;
2475 ;; mbx-list-sflag = "\Noselect" / "\Marked" / "\Unmarked"
2476 ;; ; Selectability flags; only one per LIST response
2477 ;;
2478 ;; QUOTED-CHAR = <any TEXT-CHAR except quoted-specials> /
2479 ;; "\" quoted-specials
2480 ;;
2481 ;; quoted-specials = DQUOTE / "\"
2494 ;; msg_att ::= "(" 1#("ENVELOPE" SPACE envelope /
2495 ;; "FLAGS" SPACE "(" #(flag / "\Recent") ")" /
2496 ;; "INTERNALDATE" SPACE date_time /
2497 ;; "RFC822" [".HEADER" / ".TEXT"] SPACE nstring /
2498 ;; "RFC822.SIZE" SPACE number /
2499 ;; "BODY" ["STRUCTURE"] SPACE body /
2500 ;; "BODY" section ["<" number ">"] SPACE nstring /
2501 ;; "UID" SPACE uniqueid) ")"
2502 ;;
2503 ;; date_time ::= <"> date_day_fixed "-" date_month "-" date_year
2504 ;; SPACE time SPACE zone <">
2505 ;;
2506 ;; section ::= "[" [section_text / (nz_number *["." nz_number]
2507 ;; ["." (section_text / "MIME")])] "]"
2508 ;;
2509 ;; section_text ::= "HEADER" / "HEADER.FIELDS" [".NOT"]
2510 ;; SPACE header_list / "TEXT"
2511 ;;
2512 ;; header_fld_name ::= astring
2513 ;;
2514 ;; header_list ::= "(" 1#header_fld_name ")"
2532 section)))
2537 rfc822size body bodydetail bodystructure flags-empty)
2538 ;; Courier can insert spurious blank characters which will
2539 ;; confuse `read', so skip past them.
2575 bodydetail)
2594 ;; mailbox-data = ...
2595 ;; "STATUS" SP mailbox SP "("
2596 ;; [status-att SP number
2597 ;; *(SP status-att SP number)] ")"
2598 ;; ...
2599 ;;
2600 ;; status-att = "MESSAGES" / "RECENT" / "UIDNEXT" / "UIDVALIDITY" /
2601 ;; "UNSEEN"
2629 token mailbox)
2632 ;; acl_data ::= "ACL" SPACE mailbox *(SPACE identifier SPACE
2633 ;; rights)
2634 ;;
2635 ;; identifier ::= astring
2636 ;;
2637 ;; rights ::= astring
2641 identifier rights acl)
2650 ;; flag-list = "(" [flag *(SP flag)] ")"
2651 ;;
2652 ;; flag = "\Answered" / "\Flagged" / "\Deleted" /
2653 ;; "\Seen" / "\Draft" / flag-keyword / flag-extension
2654 ;; ; Does not include "\Recent"
2655 ;;
2656 ;; flag-keyword = atom
2657 ;;
2658 ;; flag-extension = "\" atom
2659 ;; ; Future expansion. Client implementations
2660 ;; ; MUST accept flag-extension flags. Server
2661 ;; ; implementations MUST NOT generate
2662 ;; ; flag-extension flags except as defined by
2663 ;; ; future standard or standards-track
2664 ;; ; revisions of this specification.
2672 ;; next line for Courier IMAP bug.
2681 ;; envelope = "(" env-date SP env-subject SP env-from SP env-sender SP
2682 ;; env-reply-to SP env-to SP env-cc SP env-bcc SP
2683 ;; env-in-reply-to SP env-message-id ")"
2684 ;;
2685 ;; env-bcc = "(" 1*address ")" / nil
2686 ;;
2687 ;; env-cc = "(" 1*address ")" / nil
2688 ;;
2689 ;; env-date = nstring
2690 ;;
2691 ;; env-from = "(" 1*address ")" / nil
2692 ;;
2693 ;; env-in-reply-to = nstring
2694 ;;
2695 ;; env-message-id = nstring
2696 ;;
2697 ;; env-reply-to = "(" 1*address ")" / nil
2698 ;;
2699 ;; env-sender = "(" 1*address ")" / nil
2700 ;;
2701 ;; env-subject = nstring
2702 ;;
2703 ;; env-to = "(" 1*address ")" / nil
2729 ;; body-fld-param = "(" string SP string *(SP string SP string) ")" / nil
2737 ;; buggy stalker communigate pro 3.0 doesn't print SPC
2738 ;; between body-fld-param's sometimes
2743 nil)))
2745 ;; body-extension = nstring / number /
2746 ;; "(" body-extension *(SP body-extension) ")"
2747 ;; ; Future expansion. Client implementations
2748 ;; ; MUST accept body-extension fields. Server
2749 ;; ; implementations MUST NOT generate
2750 ;; ; body-extension fields except as defined by
2751 ;; ; future standard or standards-track
2752 ;; ; revisions of this specification.
2768 ;; body-ext-1part = body-fld-md5 [SP body-fld-dsp [SP body-fld-lang
2769 ;; *(SP body-extension)]]
2770 ;; ; MUST NOT be returned on non-extensible
2771 ;; ; "BODY" fetch
2772 ;;
2773 ;; body-ext-mpart = body-fld-param [SP body-fld-dsp [SP body-fld-lang
2774 ;; *(SP body-extension)]]
2775 ;; ; MUST NOT be returned on non-extensible
2776 ;; ; "BODY" fetch
2790 ;; With assert, the code might not be eval'd.
2791 ;; (assert (imap-parse-nil) t "In imap-parse-body-ext")
2802 ext))
2804 ;; body = "(" body-type-1part / body-type-mpart ")"
2805 ;;
2806 ;; body-ext-1part = body-fld-md5 [SP body-fld-dsp [SP body-fld-lang
2807 ;; *(SP body-extension)]]
2808 ;; ; MUST NOT be returned on non-extensible
2809 ;; ; "BODY" fetch
2810 ;;
2811 ;; body-ext-mpart = body-fld-param [SP body-fld-dsp [SP body-fld-lang
2812 ;; *(SP body-extension)]]
2813 ;; ; MUST NOT be returned on non-extensible
2814 ;; ; "BODY" fetch
2815 ;;
2816 ;; body-fields = body-fld-param SP body-fld-id SP body-fld-desc SP
2817 ;; body-fld-enc SP body-fld-octets
2818 ;;
2819 ;; body-fld-desc = nstring
2820 ;;
2821 ;; body-fld-dsp = "(" string SP body-fld-param ")" / nil
2822 ;;
2823 ;; body-fld-enc = (DQUOTE ("7BIT" / "8BIT" / "BINARY" / "BASE64"/
2824 ;; "QUOTED-PRINTABLE") DQUOTE) / string
2825 ;;
2826 ;; body-fld-id = nstring
2827 ;;
2828 ;; body-fld-lang = nstring / "(" string *(SP string) ")"
2829 ;;
2830 ;; body-fld-lines = number
2831 ;;
2832 ;; body-fld-md5 = nstring
2833 ;;
2834 ;; body-fld-octets = number
2835 ;;
2836 ;; body-fld-param = "(" string SP string *(SP string SP string) ")" / nil
2837 ;;
2838 ;; body-type-1part = (body-type-basic / body-type-msg / body-type-text)
2839 ;; [SP body-ext-1part]
2840 ;;
2841 ;; body-type-basic = media-basic SP body-fields
2842 ;; ; MESSAGE subtype MUST NOT be "RFC822"
2843 ;;
2844 ;; body-type-msg = media-message SP body-fields SP envelope
2845 ;; SP body SP body-fld-lines
2846 ;;
2847 ;; body-type-text = media-text SP body-fields SP body-fld-lines
2848 ;;
2849 ;; body-type-mpart = 1*body SP media-subtype
2850 ;; [SP body-ext-mpart]
2851 ;;
2852 ;; media-basic = ((DQUOTE ("APPLICATION" / "AUDIO" / "IMAGE" /
2853 ;; "MESSAGE" / "VIDEO") DQUOTE) / string) SP media-subtype
2854 ;; ; Defined in [MIME-IMT]
2855 ;;
2856 ;; media-message = DQUOTE "MESSAGE" DQUOTE SP DQUOTE "RFC822" DQUOTE
2857 ;; ; Defined in [MIME-IMT]
2858 ;;
2859 ;; media-subtype = string
2860 ;; ; Defined in [MIME-IMT]
2861 ;;
2862 ;; media-text = DQUOTE "TEXT" DQUOTE SP media-subtype
2863 ;; ; Defined in [MIME-IMT]
2873 ;; buggy stalker communigate pro 3.0 inserts a SPC between
2874 ;; parts in multiparts
2896 ;; next line for Sun SIMS bug
2906 ;; Next `or' for Sun SIMS bug. It regards body-fld-enc as a
2907 ;; nstring and returns nil instead of defaulting back to 7BIT
2908 ;; as the standard says.
2909 ;; Exchange (2007, at least) does this as well.
2912 ;; Exchange 2007 can return -1, contrary to the spec...
2919 ;; Ok, we're done parsing the required parts, what comes now is one of
2920 ;; three things:
2921 ;;
2922 ;; envelope (then we're parsing body-type-msg)
2923 ;; body-fld-lines (then we're parsing body-type-text)
2924 ;; body-ext-1part (then we're parsing body-type-basic)
2925 ;;
2926 ;; The problem is that the two first are in turn optionally followed
2927 ;; by the third. So we parse the first two here (if there are any)...
2936 ;; buggy stalker communigate pro 3.0 doesn't print
2937 ;; number of lines in message/rfc822 attachment
2947 ;; ...and then parse the third one here...
2962 '(
2963 imap-utf7-encode
2964 imap-utf7-decode
2965 imap-error-text
2966 imap-kerberos4s-p
2967 imap-kerberos4-open
2968 imap-ssl-p
2969 imap-ssl-open
2970 imap-network-p
2971 imap-network-open
2972 imap-interactive-login
2973 imap-kerberos4a-p
2974 imap-kerberos4-auth
2975 imap-cram-md5-p
2976 imap-cram-md5-auth
2977 imap-login-p
2978 imap-login-auth
2979 imap-anonymous-p
2980 imap-anonymous-auth
2981 imap-open-1
2982 imap-open
2983 imap-opened
2984 imap-ping-server
2985 imap-authenticate
2986 imap-close
2987 imap-capability
2988 imap-namespace
2989 imap-send-command-wait
2990 imap-mailbox-put
2991 imap-mailbox-get
2992 imap-mailbox-map-1
2993 imap-mailbox-map
2994 imap-current-mailbox
2995 imap-current-mailbox-p-1
2996 imap-current-mailbox-p
2997 imap-mailbox-select-1
2998 imap-mailbox-select
2999 imap-mailbox-examine-1
3000 imap-mailbox-examine
3001 imap-mailbox-unselect
3002 imap-mailbox-expunge
3003 imap-mailbox-close
3004 imap-mailbox-create-1
3005 imap-mailbox-create
3006 imap-mailbox-delete
3007 imap-mailbox-rename
3008 imap-mailbox-lsub
3009 imap-mailbox-list
3010 imap-mailbox-subscribe
3011 imap-mailbox-unsubscribe
3012 imap-mailbox-status
3013 imap-mailbox-acl-get
3014 imap-mailbox-acl-set
3015 imap-mailbox-acl-delete
3016 imap-current-message
3017 imap-list-to-message-set
3018 imap-fetch-asynch
3019 imap-fetch
3020 imap-fetch-safe
3021 imap-message-put
3022 imap-message-get
3023 imap-message-map
3024 imap-search
3025 imap-message-flag-permanent-p
3026 imap-message-flags-set
3027 imap-message-flags-del
3028 imap-message-flags-add
3029 imap-message-copyuid-1
3030 imap-message-copyuid
3031 imap-message-copy
3032 imap-message-appenduid-1
3033 imap-message-appenduid
3034 imap-message-append
3035 imap-body-lines
3036 imap-envelope-from
3037 imap-send-command-1
3038 imap-send-command
3039 imap-wait-for-tag
3040 imap-sentinel
3041 imap-find-next-line
3042 imap-arrival-filter
3043 imap-parse-greeting
3044 imap-parse-response
3045 imap-parse-resp-text
3046 imap-parse-resp-text-code
3047 imap-parse-data-list
3048 imap-parse-fetch
3049 imap-parse-status
3050 imap-parse-acl
3051 imap-parse-flag-list
3052 imap-parse-envelope
3053 imap-parse-body-extension
3054 imap-parse-body
3055 )))
3059 ;;; imap.el ends here