| blob | 853839c206105a9703e469984555f52f06b3936b |
1 ;;; imap.el --- imap library
3 ;; Copyright (C) 1998-2012 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 that know 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 LOGINFUNC is passed a username and a password, it should return t if
842 it where successful authenticating itself to the server, nil otherwise.
843 Returns t if login was successful, nil otherwise."
848 ;; (condition-case ()
859 imap-server " (using authenticator `"
866 imap-username user)
875 ;; (quit (with-current-buffer buffer
876 ;; (setq user nil
877 ;; passwd nil)))
878 ;; (error (with-current-buffer buffer
879 ;; (setq user nil
880 ;; passwd nil))))
881 ret)))
904 "Login to server using the AUTH CRAM-MD5 method."
907 buffer
912 "AUTHENTICATE CRAM-MD5"
918 encoded)))))))))
938 "Login to server using the LOGIN command."
950 t)
959 ;;; Compiler directives.
972 mecs))
988 "Login to server using the SASL method."
995 logged user)
1011 buffer)))
1021 logged t)
1024 logged)))
1033 "Login to server using the AUTH DIGEST-MD5 method."
1036 buffer
1041 "AUTHENTICATE DIGEST-MD5"
1050 user passwd digest-uri)))
1052 )))
1054 nil
1059 ;; Server functions:
1065 imap-current-message nil
1066 imap-state 'initial
1069 imap-stream-alist))
1081 imap-process))))
1084 "Open an IMAP connection to host SERVER at PORT returning a buffer.
1085 If PORT is unspecified, a default value is used (143 except
1086 for SSL which use 993).
1087 STREAM indicates the stream to use, see `imap-streams' for available
1088 streams. If nil, it choices the best stream the server is capable of.
1089 AUTH indicates authenticator to use, see `imap-authenticators' for
1090 available authenticators. If nil, it choices the best stream the
1091 server is capable of.
1092 BUFFER can be a buffer or a name of a buffer, which is created if
1093 necessary. If nil, the buffer name is generated."
1110 nil)
1112 ;; Need to choose stream.
1115 ;; OK to use this stream?
1117 ;; Stream changed?
1133 "imap: Reconnecting with stream `%s'...failed"
1134 stream))
1135 ;; We're done, kill the first connection
1138 buffer
1142 ;; set the passed buffer to the current one,
1143 ;; so that (imap-opened buffer) later will work
1146 stream)
1150 ;; We're done
1157 ;; (debug "opened+state+auth+buffer" (imap-opened buffer) imap-state imap-auth buffer)
1159 buffer))))
1162 "If non-nil, check if IMAP is open.
1163 See the function `imap-ping-server'."
1169 "Return non-nil if connection to imap server in BUFFER is open.
1170 If BUFFER is nil then the current buffer is used."
1178 t)))))
1182 Return non-nil if the server responds, and nil if it does not
1183 respond. If BUFFER is nil, the current buffer is used."
1189 "Authenticate to server in BUFFER, using current buffer if nil.
1190 It uses the authenticator specified when opening the server. If the
1191 authenticator requires username/passwords, they are queried from the
1192 user and optionally stored in the buffer. If USER and/or PASSWD is
1193 specified, the user will not be questioned and the username and/or
1194 password is remembered in the buffer."
1210 ;; Choose authenticator.
1212 auth)
1214 ;; OK to use authenticator?
1219 imap-server auth)
1224 imap-server auth)
1225 ;; set imap-state correctly on successful auth attempt
1227 ;; stop iterating through the authenticator list
1230 imap-server auth)))))
1231 imap-state))))
1234 "Close connection to server in BUFFER.
1235 If BUFFER is nil, the current buffer is used."
1245 imap-current-message nil
1246 imap-process nil)
1248 t))
1251 "Return a list of identifiers which server in BUFFER support.
1252 If IDENTIFIER, return non-nil if it's among the servers capabilities.
1253 If BUFFER is nil, the current buffer is assumed."
1260 imap-capability)))
1263 "Identify client to server in BUFFER, and return server identity.
1264 LIST-OF-VALUES is nil, or a plist with identifier and value
1265 strings to send to the server to identify the client.
1267 Return a list of identifiers which server in BUFFER support, or
1268 nil if it doesn't support ID or returns no information.
1270 If BUFFER is nil, the current buffer is assumed."
1275 "ID NIL"
1278 list-of-values
1280 imap-id)))
1283 "Return a namespace hierarchy at server in BUFFER.
1284 If BUFFER is nil, the current buffer is assumed."
1289 imap-namespace))
1316 \f
1317 ;; Mailbox functions:
1323 propname value)
1326 t))
1330 propname))
1345 imap-mailbox-data)
1346 result)))
1349 "Map a function across each mailbox in `imap-mailbox-data', returning a list.
1350 Function should take a mailbox name (a string) as
1351 the only argument."
1370 "Select MAILBOX on server in BUFFER.
1371 If EXAMINE is non-nil, do a read-only select."
1373 imap-current-mailbox
1381 imap-current-mailbox)
1382 ;; Failed SELECT/EXAMINE unselects current mailbox
1395 "Examine MAILBOX on server in BUFFER."
1399 "Close current folder in BUFFER, without expunging articles."
1406 imap-current-mailbox
1410 imap-message-data nil
1412 t)))
1415 "Expunge articles in current folder in BUFFER.
1416 If ASYNCH, do not wait for successful completion of the command.
1417 If BUFFER is nil the current buffer is assumed."
1425 "Expunge articles and close current folder in BUFFER.
1426 If ASYNCH, do not wait for successful completion of the command.
1427 If BUFFER is nil the current buffer is assumed."
1434 imap-current-mailbox status)
1436 imap-current-mailbox)
1437 ;; Don't wipe out data if another mailbox
1438 ;; was selected...
1440 imap-message-data nil
1444 imap-message-data nil
1446 t)))
1452 "Create MAILBOX on server in BUFFER.
1453 If BUFFER is nil the current buffer is assumed."
1458 "Delete MAILBOX on server in BUFFER.
1459 If BUFFER is nil the current buffer is assumed."
1466 "Rename mailbox OLDNAME to NEWNAME on server in BUFFER.
1467 If BUFFER is nil the current buffer is assumed."
1476 "Return a list of subscribed mailboxes on server in BUFFER.
1477 If ROOT is non-nil, only list matching mailboxes. If ADD-DELIMITER is
1478 non-nil, a hierarchy delimiter is added to root. REFERENCE is a
1479 implementation-specific string that has to be passed to lsub command."
1481 ;; Make sure we know the hierarchy separator for root's hierarchy
1485 ;; clear list data (NB not delimiter and other stuff)
1500 "Return a list of mailboxes matching ROOT on server in BUFFER.
1501 If ADD-DELIMITER is non-nil, a hierarchy delimiter is added to
1502 root. REFERENCE is a implementation-specific string that has to be
1503 passed to list command."
1505 ;; Make sure we know the hierarchy separator for root's hierarchy
1509 ;; clear list data (NB not delimiter and other stuff)
1524 "Send the SUBSCRIBE command on the MAILBOX to server in BUFFER.
1525 Returns non-nil if successful."
1532 "Send the SUBSCRIBE command on the MAILBOX to server in BUFFER.
1533 Returns non-nil if successful."
1540 "Get status items ITEM in MAILBOX from server in BUFFER.
1541 ITEMS can be a symbol or a list of symbols, valid symbols are one of
1542 the STATUS data items -- i.e. `messages', `recent', `uidnext', `uidvalidity',
1543 or `unseen'. If ITEMS is a list of symbols, a list of values is
1544 returned, if ITEMS is a symbol only its value is returned."
1553 items
1558 items)
1562 "Send status item request ITEM on MAILBOX to server in BUFFER.
1563 ITEMS can be a symbol or a list of symbols, valid symbols are one of
1564 the STATUS data items -- i.e. 'messages, 'recent, 'uidnext, 'uidvalidity
1565 or 'unseen. The IMAP command tag is returned."
1573 items
1577 "Get ACL on MAILBOX from server in BUFFER."
1587 "Change/set ACL for IDENTIFIER to RIGHTS in MAILBOX from server in BUFFER."
1594 identifier
1595 " "
1596 rights))))))
1599 "Remove any <identifier,rights> pair for IDENTIFIER in MAILBOX from server in BUFFER."
1606 identifier))))))
1608 \f
1609 ;; Message functions:
1613 imap-current-message))
1619 list
1632 range)
1640 uids)
1641 props))))
1644 "Fetch properties PROPS from message set UIDS from server in BUFFER.
1645 UIDS can be a string, number or a list of numbers. If RECEIVE
1646 is non-nil return these properties."
1652 uids)
1653 props)))
1655 t
1661 receive)
1663 uids)
1670 propname value)
1673 t))
1678 propname)))
1681 "Map a function across each message in `imap-message-data', returning a list."
1687 imap-message-data)
1688 result)))
1734 ;; FIXME: Should this try to use CHARSET? -- fx
1742 nil)
1746 "Return t if FLAG can be permanently (between IMAP sessions) saved on articles, in MAILBOX on server in BUFFER."
1772 ;; Cf. http://thread.gmane.org/gmane.emacs.gnus.general/65317/focus=65343
1773 ;; Signal an error if we'd get an integer overflow.
1774 ;;
1775 ;; FIXME: Identify relevant calls to `string-to-number' and replace them with
1776 ;; `imap-string-to-integer'.
1782 number)))
1785 "Like `imap-fetch', but DTRT with Exchange 2007 bug.
1786 However, UIDS here is a cons, where the car is the canonical form
1787 of the UIDS specification, and the cdr is the one which works with
1788 Exchange 2007 or, potentially, other buggy servers.
1789 See `imap-enable-exchange-bug-workaround'."
1790 ;; The first time we get here for a given, we'll try the canonical
1791 ;; form. If we get the known error from the buggy server, set the
1792 ;; flag buffer-locally (to account for connections to multiple
1793 ;; servers), then re-try with the alternative UIDS spec. We don't
1794 ;; unconditionally use the alternative form, since the
1795 ;; currently-used alternatives are seriously inefficient with some
1796 ;; servers (although they are valid).
1797 ;;
1798 ;; FIXME: Maybe it would be cleaner to have a flag to not signal
1799 ;; the error (which otherwise gives a message), and test
1800 ;; `imap-failed-tags'. Also, Other IMAP clients use other forms of
1801 ;; request which work with Exchange, e.g. Claws does "UID FETCH 1:*
1802 ;; (UID)" rather than "FETCH UID 1,*". Is there a good reason not
1803 ;; to do the same?
1805 ;; Binding `debug-on-error' allows us to get the error from
1806 ;; `imap-parse-response' -- it's normally caught by Emacs around
1807 ;; execution of a process filter.
1812 props receive nouidfetch buffer))
1815 ;; This is the Exchange 2007 response. It may be more
1816 ;; robust just to check for a BAD response to the
1817 ;; attempted fetch.
1822 t)
1849 "Copy ARTICLES to MAILBOX on server in BUFFER.
1850 ARTICLES is a string message set. Create mailbox if it doesn't exist,
1851 unless DONT-CREATE is non-nil. On success, return a list with
1852 the UIDVALIDITY of the mailbox the article(s) was copied to as the
1853 first element. The rest of list contains the saved articles' UIDs."
1860 t
1862 ;; removed because of buggy Oracle server
1863 ;; that doesn't send TRYCREATE tags (which
1864 ;; is a MUST according to specifications):
1865 ;;(imap-mailbox-get-1 'trycreate mailbox)
1871 ;; FIXME: Amalgamate with imap-message-copyuid-1, using an extra arg, since it
1872 ;; shares most of the code? -- fx
1894 "Append ARTICLE (a buffer) to MAILBOX on server in BUFFER.
1895 FLAGS and DATE-TIME is currently not used. Return a cons holding
1896 uidvalidity of MAILBOX and UID the newly created article got, or nil
1897 on failure."
1907 "Return number of lines in article by looking at the mime bodystructure BODY."
1921 "Return a from string line."
1926 "@"
1930 \f
1931 ;; Internal functions.
1945 cmd cmdstr)
1953 size)
1958 ;; XXX modifies buffer!
1987 nil ;; abort command if no cont-req
1989 command)))
1995 tag)))
2004 message-log-max)
2013 ;; A process can die _before_ we have processed everything it
2014 ;; has to say. Moreover, this can happen in between the call to
2015 ;; accept-process-output and the call to process-status in an
2016 ;; iteration of the loop above.
2025 'INCOMPLETE
2032 "Return point at end of current line, taking into account literals.
2033 Return nil if no complete line has arrived."
2035 imap-server-eol)
2036 nil t)
2039 nil
2045 "IMAP process filter."
2046 ;; Sometimes, we are called even though the process has died.
2047 ;; Better abstain from doing stuff in that case.
2070 imap-state)))
2073 \f
2074 ;; Imap parser.
2079 ;; number = 1*DIGIT
2080 ;; ; Unsigned 32-bit integer
2081 ;; ; (0 <= n < 4,294,967,296)
2089 ;; literal = "{" number "}" CRLF *CHAR8
2090 ;; ; Number represents the number of CHAR8s
2097 nil
2101 ;; string = quoted / literal
2102 ;;
2103 ;; quoted = DQUOTE *QUOTED-CHAR DQUOTE
2104 ;;
2105 ;; QUOTED-CHAR = <any TEXT-CHAR except quoted-specials> /
2106 ;; "\" quoted-specials
2107 ;;
2108 ;; quoted-specials = DQUOTE / "\"
2109 ;;
2110 ;; TEXT-CHAR = <any CHAR except CR and LF>
2124 name))
2128 ;; nil = "NIL"
2134 ;; nstring = string / nil
2139 nil)))
2141 ;; astring = atom / string
2142 ;;
2143 ;; atom = 1*ATOM-CHAR
2144 ;;
2145 ;; ATOM-CHAR = <any CHAR except atom-specials>
2146 ;;
2147 ;; atom-specials = "(" / ")" / "{" / SP / CTL / list-wildcards /
2148 ;; quoted-specials
2149 ;;
2150 ;; list-wildcards = "%" / "*"
2151 ;;
2152 ;; quoted-specials = DQUOTE / "\"
2162 ;; address = "(" addr-name SP addr-adl SP addr-mailbox SP
2163 ;; addr-host ")"
2164 ;;
2165 ;; addr-adl = nstring
2166 ;; ; Holds route from [RFC-822] route-addr if
2167 ;; ; non-nil
2168 ;;
2169 ;; addr-host = nstring
2170 ;; ; nil indicates [RFC-822] group syntax.
2171 ;; ; Otherwise, holds [RFC-822] domain name
2172 ;;
2173 ;; addr-mailbox = nstring
2174 ;; ; nil indicates end of [RFC-822] group; if
2175 ;; ; non-nil and addr-host is nil, holds
2176 ;; ; [RFC-822] group name.
2177 ;; ; Otherwise, holds [RFC-822] local-part
2178 ;; ; after removing [RFC-822] quoting
2179 ;;
2180 ;; addr-name = nstring
2181 ;; ; If non-nil, holds phrase from [RFC-822]
2182 ;; ; mailbox after removing [RFC-822] quoting
2183 ;;
2198 address))))
2200 ;; address-list = "(" 1*address ")" / nil
2201 ;;
2202 ;; nil = "NIL"
2209 ;; next line for MS Exchange bug
2216 ;; With assert, the code might not be eval'd.
2217 ;; (assert (imap-parse-nil) t "In imap-parse-address-list")
2220 ;; mailbox = "INBOX" / astring
2221 ;; ; INBOX is case-insensitive. All case variants of
2222 ;; ; INBOX (e.g. "iNbOx") MUST be interpreted as INBOX
2223 ;; ; not as an astring. An astring which consists of
2224 ;; ; the case-insensitive sequence "I" "N" "B" "O" "X"
2225 ;; ; is considered to be INBOX and not an astring.
2226 ;; ; Refer to section 5.1 for further
2227 ;; ; semantic details of mailbox names.
2232 "INBOX"
2233 mailbox)))
2235 ;; greeting = "*" SP (resp-cond-auth / resp-cond-bye) CRLF
2236 ;;
2237 ;; resp-cond-auth = ("OK" / "PREAUTH") SP resp-text
2238 ;; ; Authentication condition
2239 ;;
2240 ;; resp-cond-bye = "BYE" SP resp-text
2243 "Parse an IMAP greeting."
2251 ;; response = *(continue-req / response-data) response-done
2252 ;;
2253 ;; continue-req = "+" SP (resp-text / base64) CRLF
2254 ;;
2255 ;; response-data = "*" SP (resp-cond-state / resp-cond-bye /
2256 ;; mailbox-data / message-data / capability-data) CRLF
2257 ;;
2258 ;; response-done = response-tagged / response-fatal
2259 ;;
2260 ;; response-fatal = "*" SP resp-cond-bye CRLF
2261 ;; ; Server closes connection immediately
2262 ;;
2263 ;; response-tagged = tag SP resp-cond-state CRLF
2264 ;;
2265 ;; resp-cond-state = ("OK" / "NO" / "BAD") SP resp-text
2266 ;; ; Status condition
2267 ;;
2268 ;; resp-cond-bye = "BYE" SP resp-text
2269 ;;
2270 ;; mailbox-data = "FLAGS" SP flag-list /
2271 ;; "LIST" SP mailbox-list /
2272 ;; "LSUB" SP mailbox-list /
2273 ;; "SEARCH" *(SP nz-number) /
2274 ;; "STATUS" SP mailbox SP "("
2275 ;; [status-att SP number *(SP status-att SP number)] ")" /
2276 ;; number SP "EXISTS" /
2277 ;; number SP "RECENT"
2278 ;;
2279 ;; message-data = nz-number SP ("EXPUNGE" / ("FETCH" SP msg-att))
2280 ;;
2281 ;; capability-data = "CAPABILITY" *(SP capability) SP "IMAP4rev1"
2282 ;; *(SP capability)
2283 ;; ; IMAP4rev1 servers which offer RFC 1730
2284 ;; ; compatibility MUST list "IMAP4" as the first
2285 ;; ; capability.
2288 "Parse a IMAP command response."
2294 t)))
2305 'search
2341 imap-failed-tags))))
2354 token status code text))))
2361 ;; resp-text = ["[" resp-text-code "]" SP] text
2362 ;;
2363 ;; text = 1*TEXT-CHAR
2364 ;;
2365 ;; TEXT-CHAR = <any CHAR except CR and LF>
2370 ;; resp-text-code = "ALERT" /
2371 ;; "BADCHARSET [SP "(" astring *(SP astring) ")" ] /
2372 ;; "NEWNAME" SP string SP string /
2373 ;; "PARSE" /
2374 ;; "PERMANENTFLAGS" SP "("
2375 ;; [flag-perm *(SP flag-perm)] ")" /
2376 ;; "READ-ONLY" /
2377 ;; "READ-WRITE" /
2378 ;; "TRYCREATE" /
2379 ;; "UIDNEXT" SP nz-number /
2380 ;; "UIDVALIDITY" SP nz-number /
2381 ;; "UNSEEN" SP nz-number /
2382 ;; resp-text-atom [SP 1*<any TEXT-CHAR except "]">]
2383 ;;
2384 ;; resp_code_apnd = "APPENDUID" SPACE nz_number SPACE uniqueid
2385 ;;
2386 ;; resp_code_copy = "COPYUID" SPACE nz_number SPACE set SPACE set
2387 ;;
2388 ;; set = sequence-num / (sequence-num ":" sequence-num) /
2389 ;; (set "," set)
2390 ;; ; Identifies a set of messages. For message
2391 ;; ; sequence numbers, these are consecutive
2392 ;; ; numbers from 1 to the number of messages in
2393 ;; ; the mailbox
2394 ;; ; Comma delimits individual numbers, colon
2395 ;; ; delimits between two numbers inclusive.
2396 ;; ; Example: 2,4:7,9,12:* is 2,4,5,6,7,9,12,13,
2397 ;; ; 14,15 for a mailbox with 15 messages.
2398 ;;
2399 ;; sequence-num = nz-number / "*"
2400 ;; ; * is the largest number in use. For message
2401 ;; ; sequence numbers, it is the number of messages
2402 ;; ; in the mailbox. For unique identifiers, it is
2403 ;; ; the unique identifier of the last message in
2404 ;; ; the mailbox.
2405 ;;
2406 ;; flag-perm = flag / "\*"
2407 ;;
2408 ;; flag = "\Answered" / "\Flagged" / "\Deleted" /
2409 ;; "\Seen" / "\Draft" / flag-keyword / flag-extension
2410 ;; ; Does not include "\Recent"
2411 ;;
2412 ;; flag-extension = "\" atom
2413 ;; ; Future expansion. Client implementations
2414 ;; ; MUST accept flag-extension flags. Server
2415 ;; ; implementations MUST NOT generate
2416 ;; ; flag-extension flags except as defined by
2417 ;; ; future standard or standards-track
2418 ;; ; revisions of this specification.
2419 ;;
2420 ;; flag-keyword = atom
2421 ;;
2422 ;; resp-text-atom = 1*<any ATOM-CHAR except "]">
2425 ;; xxx next line for stalker communigate pro 3.3.1 bug
2452 imap-current-target-mailbox))
2457 imap-current-target-mailbox))
2462 ;; mailbox-list = "(" [mbx-list-flags] ")" SP
2463 ;; (DQUOTE QUOTED-CHAR DQUOTE / nil) SP mailbox
2464 ;;
2465 ;; mbx-list-flags = *(mbx-list-oflag SP) mbx-list-sflag
2466 ;; *(SP mbx-list-oflag) /
2467 ;; mbx-list-oflag *(SP mbx-list-oflag)
2468 ;;
2469 ;; mbx-list-oflag = "\Noinferiors" / flag-extension
2470 ;; ; Other flags; multiple possible per LIST response
2471 ;;
2472 ;; mbx-list-sflag = "\Noselect" / "\Marked" / "\Unmarked"
2473 ;; ; Selectability flags; only one per LIST response
2474 ;;
2475 ;; QUOTED-CHAR = <any TEXT-CHAR except quoted-specials> /
2476 ;; "\" quoted-specials
2477 ;;
2478 ;; quoted-specials = DQUOTE / "\"
2491 ;; msg_att ::= "(" 1#("ENVELOPE" SPACE envelope /
2492 ;; "FLAGS" SPACE "(" #(flag / "\Recent") ")" /
2493 ;; "INTERNALDATE" SPACE date_time /
2494 ;; "RFC822" [".HEADER" / ".TEXT"] SPACE nstring /
2495 ;; "RFC822.SIZE" SPACE number /
2496 ;; "BODY" ["STRUCTURE"] SPACE body /
2497 ;; "BODY" section ["<" number ">"] SPACE nstring /
2498 ;; "UID" SPACE uniqueid) ")"
2499 ;;
2500 ;; date_time ::= <"> date_day_fixed "-" date_month "-" date_year
2501 ;; SPACE time SPACE zone <">
2502 ;;
2503 ;; section ::= "[" [section_text / (nz_number *["." nz_number]
2504 ;; ["." (section_text / "MIME")])] "]"
2505 ;;
2506 ;; section_text ::= "HEADER" / "HEADER.FIELDS" [".NOT"]
2507 ;; SPACE header_list / "TEXT"
2508 ;;
2509 ;; header_fld_name ::= astring
2510 ;;
2511 ;; header_list ::= "(" 1#header_fld_name ")"
2529 section)))
2534 rfc822size body bodydetail bodystructure flags-empty)
2535 ;; Courier can insert spurious blank characters which will
2536 ;; confuse `read', so skip past them.
2572 bodydetail)
2591 ;; mailbox-data = ...
2592 ;; "STATUS" SP mailbox SP "("
2593 ;; [status-att SP number
2594 ;; *(SP status-att SP number)] ")"
2595 ;; ...
2596 ;;
2597 ;; status-att = "MESSAGES" / "RECENT" / "UIDNEXT" / "UIDVALIDITY" /
2598 ;; "UNSEEN"
2626 token mailbox)
2629 ;; acl_data ::= "ACL" SPACE mailbox *(SPACE identifier SPACE
2630 ;; rights)
2631 ;;
2632 ;; identifier ::= astring
2633 ;;
2634 ;; rights ::= astring
2638 identifier rights acl)
2647 ;; flag-list = "(" [flag *(SP flag)] ")"
2648 ;;
2649 ;; flag = "\Answered" / "\Flagged" / "\Deleted" /
2650 ;; "\Seen" / "\Draft" / flag-keyword / flag-extension
2651 ;; ; Does not include "\Recent"
2652 ;;
2653 ;; flag-keyword = atom
2654 ;;
2655 ;; flag-extension = "\" atom
2656 ;; ; Future expansion. Client implementations
2657 ;; ; MUST accept flag-extension flags. Server
2658 ;; ; implementations MUST NOT generate
2659 ;; ; flag-extension flags except as defined by
2660 ;; ; future standard or standards-track
2661 ;; ; revisions of this specification.
2669 ;; next line for Courier IMAP bug.
2678 ;; envelope = "(" env-date SP env-subject SP env-from SP env-sender SP
2679 ;; env-reply-to SP env-to SP env-cc SP env-bcc SP
2680 ;; env-in-reply-to SP env-message-id ")"
2681 ;;
2682 ;; env-bcc = "(" 1*address ")" / nil
2683 ;;
2684 ;; env-cc = "(" 1*address ")" / nil
2685 ;;
2686 ;; env-date = nstring
2687 ;;
2688 ;; env-from = "(" 1*address ")" / nil
2689 ;;
2690 ;; env-in-reply-to = nstring
2691 ;;
2692 ;; env-message-id = nstring
2693 ;;
2694 ;; env-reply-to = "(" 1*address ")" / nil
2695 ;;
2696 ;; env-sender = "(" 1*address ")" / nil
2697 ;;
2698 ;; env-subject = nstring
2699 ;;
2700 ;; env-to = "(" 1*address ")" / nil
2726 ;; body-fld-param = "(" string SP string *(SP string SP string) ")" / nil
2734 ;; buggy stalker communigate pro 3.0 doesn't print SPC
2735 ;; between body-fld-param's sometimes
2740 nil)))
2742 ;; body-extension = nstring / number /
2743 ;; "(" body-extension *(SP body-extension) ")"
2744 ;; ; Future expansion. Client implementations
2745 ;; ; MUST accept body-extension fields. Server
2746 ;; ; implementations MUST NOT generate
2747 ;; ; body-extension fields except as defined by
2748 ;; ; future standard or standards-track
2749 ;; ; revisions of this specification.
2765 ;; body-ext-1part = body-fld-md5 [SP body-fld-dsp [SP body-fld-lang
2766 ;; *(SP body-extension)]]
2767 ;; ; MUST NOT be returned on non-extensible
2768 ;; ; "BODY" fetch
2769 ;;
2770 ;; body-ext-mpart = body-fld-param [SP body-fld-dsp [SP body-fld-lang
2771 ;; *(SP body-extension)]]
2772 ;; ; MUST NOT be returned on non-extensible
2773 ;; ; "BODY" fetch
2787 ;; With assert, the code might not be eval'd.
2788 ;; (assert (imap-parse-nil) t "In imap-parse-body-ext")
2799 ext))
2801 ;; body = "(" body-type-1part / body-type-mpart ")"
2802 ;;
2803 ;; body-ext-1part = body-fld-md5 [SP body-fld-dsp [SP body-fld-lang
2804 ;; *(SP body-extension)]]
2805 ;; ; MUST NOT be returned on non-extensible
2806 ;; ; "BODY" fetch
2807 ;;
2808 ;; body-ext-mpart = body-fld-param [SP body-fld-dsp [SP body-fld-lang
2809 ;; *(SP body-extension)]]
2810 ;; ; MUST NOT be returned on non-extensible
2811 ;; ; "BODY" fetch
2812 ;;
2813 ;; body-fields = body-fld-param SP body-fld-id SP body-fld-desc SP
2814 ;; body-fld-enc SP body-fld-octets
2815 ;;
2816 ;; body-fld-desc = nstring
2817 ;;
2818 ;; body-fld-dsp = "(" string SP body-fld-param ")" / nil
2819 ;;
2820 ;; body-fld-enc = (DQUOTE ("7BIT" / "8BIT" / "BINARY" / "BASE64"/
2821 ;; "QUOTED-PRINTABLE") DQUOTE) / string
2822 ;;
2823 ;; body-fld-id = nstring
2824 ;;
2825 ;; body-fld-lang = nstring / "(" string *(SP string) ")"
2826 ;;
2827 ;; body-fld-lines = number
2828 ;;
2829 ;; body-fld-md5 = nstring
2830 ;;
2831 ;; body-fld-octets = number
2832 ;;
2833 ;; body-fld-param = "(" string SP string *(SP string SP string) ")" / nil
2834 ;;
2835 ;; body-type-1part = (body-type-basic / body-type-msg / body-type-text)
2836 ;; [SP body-ext-1part]
2837 ;;
2838 ;; body-type-basic = media-basic SP body-fields
2839 ;; ; MESSAGE subtype MUST NOT be "RFC822"
2840 ;;
2841 ;; body-type-msg = media-message SP body-fields SP envelope
2842 ;; SP body SP body-fld-lines
2843 ;;
2844 ;; body-type-text = media-text SP body-fields SP body-fld-lines
2845 ;;
2846 ;; body-type-mpart = 1*body SP media-subtype
2847 ;; [SP body-ext-mpart]
2848 ;;
2849 ;; media-basic = ((DQUOTE ("APPLICATION" / "AUDIO" / "IMAGE" /
2850 ;; "MESSAGE" / "VIDEO") DQUOTE) / string) SP media-subtype
2851 ;; ; Defined in [MIME-IMT]
2852 ;;
2853 ;; media-message = DQUOTE "MESSAGE" DQUOTE SP DQUOTE "RFC822" DQUOTE
2854 ;; ; Defined in [MIME-IMT]
2855 ;;
2856 ;; media-subtype = string
2857 ;; ; Defined in [MIME-IMT]
2858 ;;
2859 ;; media-text = DQUOTE "TEXT" DQUOTE SP media-subtype
2860 ;; ; Defined in [MIME-IMT]
2870 ;; buggy stalker communigate pro 3.0 inserts a SPC between
2871 ;; parts in multiparts
2893 ;; next line for Sun SIMS bug
2903 ;; Next `or' for Sun SIMS bug. It regards body-fld-enc as a
2904 ;; nstring and returns nil instead of defaulting back to 7BIT
2905 ;; as the standard says.
2906 ;; Exchange (2007, at least) does this as well.
2909 ;; Exchange 2007 can return -1, contrary to the spec...
2916 ;; Ok, we're done parsing the required parts, what comes now is one of
2917 ;; three things:
2918 ;;
2919 ;; envelope (then we're parsing body-type-msg)
2920 ;; body-fld-lines (then we're parsing body-type-text)
2921 ;; body-ext-1part (then we're parsing body-type-basic)
2922 ;;
2923 ;; The problem is that the two first are in turn optionally followed
2924 ;; by the third. So we parse the first two here (if there are any)...
2933 ;; buggy stalker communigate pro 3.0 doesn't print
2934 ;; number of lines in message/rfc822 attachment
2944 ;; ...and then parse the third one here...
2959 '(
2960 imap-utf7-encode
2961 imap-utf7-decode
2962 imap-error-text
2963 imap-kerberos4s-p
2964 imap-kerberos4-open
2965 imap-ssl-p
2966 imap-ssl-open
2967 imap-network-p
2968 imap-network-open
2969 imap-interactive-login
2970 imap-kerberos4a-p
2971 imap-kerberos4-auth
2972 imap-cram-md5-p
2973 imap-cram-md5-auth
2974 imap-login-p
2975 imap-login-auth
2976 imap-anonymous-p
2977 imap-anonymous-auth
2978 imap-open-1
2979 imap-open
2980 imap-opened
2981 imap-ping-server
2982 imap-authenticate
2983 imap-close
2984 imap-capability
2985 imap-namespace
2986 imap-send-command-wait
2987 imap-mailbox-put
2988 imap-mailbox-get
2989 imap-mailbox-map-1
2990 imap-mailbox-map
2991 imap-current-mailbox
2992 imap-current-mailbox-p-1
2993 imap-current-mailbox-p
2994 imap-mailbox-select-1
2995 imap-mailbox-select
2996 imap-mailbox-examine-1
2997 imap-mailbox-examine
2998 imap-mailbox-unselect
2999 imap-mailbox-expunge
3000 imap-mailbox-close
3001 imap-mailbox-create-1
3002 imap-mailbox-create
3003 imap-mailbox-delete
3004 imap-mailbox-rename
3005 imap-mailbox-lsub
3006 imap-mailbox-list
3007 imap-mailbox-subscribe
3008 imap-mailbox-unsubscribe
3009 imap-mailbox-status
3010 imap-mailbox-acl-get
3011 imap-mailbox-acl-set
3012 imap-mailbox-acl-delete
3013 imap-current-message
3014 imap-list-to-message-set
3015 imap-fetch-asynch
3016 imap-fetch
3017 imap-fetch-safe
3018 imap-message-put
3019 imap-message-get
3020 imap-message-map
3021 imap-search
3022 imap-message-flag-permanent-p
3023 imap-message-flags-set
3024 imap-message-flags-del
3025 imap-message-flags-add
3026 imap-message-copyuid-1
3027 imap-message-copyuid
3028 imap-message-copy
3029 imap-message-appenduid-1
3030 imap-message-appenduid
3031 imap-message-append
3032 imap-body-lines
3033 imap-envelope-from
3034 imap-send-command-1
3035 imap-send-command
3036 imap-wait-for-tag
3037 imap-sentinel
3038 imap-find-next-line
3039 imap-arrival-filter
3040 imap-parse-greeting
3041 imap-parse-response
3042 imap-parse-resp-text
3043 imap-parse-resp-text-code
3044 imap-parse-data-list
3045 imap-parse-fetch
3046 imap-parse-status
3047 imap-parse-acl
3048 imap-parse-flag-list
3049 imap-parse-envelope
3050 imap-parse-body-extension
3051 imap-parse-body
3052 )))
3056 ;;; imap.el ends here