| blob | 2a2ce8b9c973aa19967a160fe4c39f0bb4bca4fc |
1 ;;; imap.el --- imap library -*- lexical-binding:t -*-
3 ;; Copyright (C) 1998-2018 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 <https://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), and the GSSAPI / Kerberos V4 sections of RFC1731
78 ;; (with use of external program `imtest'), and RFC2971 (ID). It also
79 ;; takes advantage of the UNSELECT extension in Cyrus IMAPD.
80 ;;
81 ;; Without the work of John McClary Prevost and Jim Radford this library
82 ;; would not have seen the light of day. Many thanks.
83 ;;
84 ;; This is a transcript of a short interactive session for demonstration
85 ;; purposes.
86 ;;
87 ;; (imap-open "my.mail.server")
88 ;; => " *imap* my.mail.server:0"
89 ;;
90 ;; The rest are invoked with current buffer as the buffer returned by
91 ;; `imap-open'. It is possible to do it all without this, but it would
92 ;; look ugly here since `buffer' is always the last argument for all
93 ;; imap.el API functions.
94 ;;
95 ;; (imap-authenticate "myusername" "mypassword")
96 ;; => auth
97 ;;
98 ;; (imap-mailbox-lsub "*")
99 ;; => ("INBOX.sentmail" "INBOX.private" "INBOX.draft" "INBOX.spam")
100 ;;
101 ;; (imap-mailbox-list "INBOX.n%")
102 ;; => ("INBOX.namedroppers" "INBOX.nnimap" "INBOX.ntbugtraq")
103 ;;
104 ;; (imap-mailbox-select "INBOX.nnimap")
105 ;; => "INBOX.nnimap"
106 ;;
107 ;; (imap-mailbox-get 'exists)
108 ;; => 166
109 ;;
110 ;; (imap-mailbox-get 'uidvalidity)
111 ;; => "908992622"
112 ;;
113 ;; (imap-search "FLAGGED SINCE 18-DEC-98")
114 ;; => (235 236)
115 ;;
116 ;; (imap-fetch 235 "RFC822.PEEK" 'RFC822)
117 ;; => "X-Sieve: cmu-sieve 1.3^M\nX-Username: <jas@pdc.kth.se>^M\r...."
118 ;;
119 ;; Todo:
120 ;;
121 ;; o Parse UIDs as strings? We need to overcome the 28 bit limit somehow.
122 ;; Use IEEE floats (which are effectively exact)? -- fx
123 ;; o Don't use `read' at all (important places already fixed)
124 ;; o Accept list of articles instead of message set string in most
125 ;; imap-message-* functions.
126 ;; o Send strings as literal if they contain, e.g., ".
127 ;;
128 ;; Revision history:
129 ;;
130 ;; - 19991218 added starttls/digest-md5 patch,
131 ;; by Daiki Ueno <ueno@ueda.info.waseda.ac.jp>
132 ;; NB! you need SLIM for starttls.el and digest-md5.el
133 ;; - 19991023 committed to pgnus
134 ;;
136 ;;; Code:
142 ;; Hmm... digest-md5 is not part of Emacs.
143 ;; FIXME: Should/can we use sasl-digest.el instead?
149 ;; User variables.
152 "Low-level IMAP issues."
158 "List of strings containing commands for Kerberos 4 authentication.
159 %s is replaced with server hostname, %p with port to connect to, and
160 %l with the value of `imap-default-user'. The program should accept
161 IMAP commands on stdin and return responses to stdout. Each entry in
162 the list is tried until a successful connection is made."
168 "--mechanism GSSAPI "
171 "List of strings containing commands for GSSAPI (krb5) authentication.
172 %s is replaced with server hostname, %p with port to connect to, and
173 %l with the value of `imap-default-user'. The program should accept
174 IMAP commands on stdin and return responses to stdout. Each entry in
175 the list is tried until a successful connection is made."
180 "rsh %s imapd"
181 "ssh %g ssh %s imapd"
183 "A list of strings, containing commands for IMAP connection.
184 Within a string, %s is replaced with the server address, %p with port
185 number on server, %g with `imap-shell-host', and %l with
186 `imap-default-user'. The program should read IMAP commands from stdin
187 and write IMAP response to stdout. Each entry in the list is tried
188 until a successful connection is made."
193 "Value for `process-connection-type' to use for Kerberos4, GSSAPI, shell, and SSL.
194 The `process-connection-type' variable controls the type of device
195 used to communicate with subprocesses. Values are nil to use a
196 pipe, or t or `pty' to use a pty. The value has no effect if the
197 system has no ptys or if all ptys are busy: then a pipe is used
198 in any case. The value takes effect when an IMAP server is
199 opened; changing it after that has no effect."
205 "If non-nil, do utf7 encoding/decoding of mailbox names.
206 Since the UTF7 decoding currently only decodes into ISO-8859-1
207 characters, you may disable this decoding if you need to access UTF7
208 encoded mailboxes which doesn't translate into ISO-8859-1."
213 "If non-nil, an imap session trace is placed in `imap-log-buffer'.
214 Note that username, passwords and other privacy sensitive
215 information (such as e-mail) may be stored in the buffer.
216 It is not written to disk, however. Do not enable this
217 variable unless you are comfortable with that.
219 See also `imap-debug'."
224 "If non-nil, trace imap- functions into `imap-debug-buffer'.
225 Uses `trace-function-background', so you can turn it off with,
226 say, `untrace-all'.
228 Note that username, passwords and other privacy sensitive
229 information (such as e-mail) may be stored in the buffer.
230 It is not written to disk, however. Do not enable this
231 variable unless you are comfortable with that.
233 This variable only takes effect when loading the `imap' library.
234 See also `imap-log'."
239 "Hostname of rlogin proxy."
244 "Default username to use."
249 1.0
251 "How long to wait between checking for the end of output.
252 Shorter values mean quicker response, but is more CPU intensive."
257 "If non-nil, store session password without prompting."
261 ;; Various variables.
277 "Definition of network streams.
279 \(NAME CHECK OPEN)
281 NAME names the stream, CHECK is a function returning non-nil if the
282 server support the stream and OPEN is a function for opening the
286 kerberos4
287 digest-md5
288 cram-md5
289 ;;sasl
290 login
291 anonymous)
302 "Definition of authenticators.
304 \(NAME CHECK AUTHENTICATE)
306 NAME names the authenticator. CHECK is a function returning non-nil if
307 the server support the authenticator and AUTHENTICATE is a function
314 "Close server immediately if it can't logout in this number of seconds.
315 If it is nil, never close server until logout completes. Normally,
316 the value of this variable will be bound to a certain value to which
317 an application program that uses this module specifies on a per-server
320 ;; Internal constants. Change these and die.
329 imap-port
330 imap-client-eol
331 imap-server-eol
332 imap-auth
333 imap-stream
334 imap-username
335 imap-password
336 imap-current-mailbox
337 imap-current-target-mailbox
338 imap-message-data
339 imap-capability
340 imap-id
341 imap-namespace
342 imap-state
343 imap-reached-tag
344 imap-failed-tags
345 imap-tag
346 imap-process
347 imap-calculate-literal-size-first
348 imap-mailbox-data))
352 ;; Internal variables.
363 "IMAP state.
364 Valid states are `closed', `initial', `nonauth', `auth', `selected'
398 "Identity of server.
408 "Alist of tags that failed.
409 Each element is a list with four elements; tag (a integer), response
410 state (a symbol, `OK', `NO' or `BAD'), response code (a string), and
420 "Non-nil indicates that the server emitted a continuation request.
424 "List of response tags and callbacks, on the form `(number . function)'.
425 The function should take two arguments, the first the IMAP tag and the
429 "Send FETCH UID commands as *:* instead of *.
431 When non-nil, use an alternative UIDS form. Enabling appears to
432 be required for some servers (e.g., Microsoft Exchange 2007)
433 which otherwise would trigger a response `BAD The specified
434 message set is invalid.'. We don't unconditionally use this
435 form, since this is said to be significantly inefficient.
437 This variable is set to t automatically per server if the
440 \f
441 ;; Utility functions:
444 "Delete by side effect any elements of ALIST whose car is `equal' to KEY.
445 The modified ALIST is returned. If the first member
446 of ALIST has a car that is `equal' to KEY, there is no way to remove it
447 by side effect; therefore, write `(setq foo (remassoc key foo))' to be
448 sure of changing the value of `foo'."
453 alist)))
456 "Enable multibyte in the current buffer."
466 "imap: Could not UTF7 encode `%s', using it unencoded..."
467 string)
468 string)))
469 string))
477 "imap: Could not UTF7 decode `%s', using it undecoded..."
478 string)
479 string)))
480 string))
484 t
486 nil))
492 \f
493 ;; Server functions; stream stuff:
510 cmd done)
519 name buffer shell-file-name shell-command-switch
521 cmd
523 ?s server
525 ?l imap-default-user))))
526 response)
530 imap-calculate-literal-size-first t)
534 ;; Athena IMTEST can output SSL verify errors
537 t)
540 t)
541 ;; cyrus 1.6.x (13? < x <= 22) queries capabilities
544 t)
545 ;; cyrus 1.6 imtest print "S: " before server greeting
548 t)
550 ;; success in imtest < 1.6:
553 ;; success in imtest 1.6:
568 nil)))))
569 done))
576 cmd done)
585 name buffer shell-file-name shell-command-switch
587 cmd
589 ?s server
591 ?l imap-default-user))))
592 response)
596 imap-calculate-literal-size-first t)
600 ;; Athena IMTEST can output SSL verify errors
603 t)
606 t)
607 ;; cyrus 1.6.x (13? < x <= 22) queries capabilities
610 t)
611 ;; cyrus 1.6 imtest print "S: " before server greeting
614 t)
615 ;; GNU SASL may print 'Trying ...' first.
618 t)
620 ;; success in imtest 1.6:
623 "Client authentication "
625 nil t)
638 nil)))))
639 done))
642 nil)
652 ;; FIXME: Per the "blue moon" comment, the process/buffer
653 ;; handling here, and elsewhere in functions which open
654 ;; streams, looks confused. Obviously we can change buffers
655 ;; if a different process handler kicks in from
656 ;; `accept-process-output' or `sit-for' below, and TRT seems
657 ;; to be to `save-buffer' around those calls. (I wonder why
658 ;; `sit-for' is used with a non-zero wait.) -- fx
667 process))))
670 t)
686 process))))
689 nil)
694 cmd done)
703 name buffer shell-file-name shell-command-switch
705 cmd
707 ?s server
708 ?g imap-shell-host
710 ?l imap-default-user)))))
726 done)
728 nil)))
739 name buffer server port
742 :always-query-capabilities t
745 :starttls-function
749 done)
758 done))
760 ;; Server functions; authenticator stuff:
763 "Login to server in BUFFER.
764 Return t if login was successful, nil otherwise.
766 LOGINFUNC is passed a username and a password. It should return
767 t if it successfully authenticates, nil otherwise."
772 ;; (condition-case ()
777 "imap: username for %s (using stream `%s'): "
778 imap-server imap-stream)
784 "imap: password for %s@%s (using authenticator `%s'): "
785 user imap-server imap-auth))))
791 imap-username user)
800 ;; (quit (with-current-buffer buffer
801 ;; (setq user nil
802 ;; passwd nil)))
803 ;; (error (with-current-buffer buffer
804 ;; (setq user nil
805 ;; passwd nil))))
806 ret)))
829 "Login to server using the AUTH CRAM-MD5 method."
832 buffer
837 "AUTHENTICATE CRAM-MD5"
843 encoded)))))))))
863 "Login to server using the LOGIN command."
875 t)
884 ;;; Compiler directives.
897 mecs))
913 "Login to server using the SASL method."
920 logged user)
936 buffer)))
946 logged t)
949 logged)))
958 "Login to server using the AUTH DIGEST-MD5 method."
961 buffer
966 "AUTHENTICATE DIGEST-MD5"
975 user passwd digest-uri)))
977 )))
979 nil
984 ;; Server functions:
990 imap-current-message nil
991 imap-state 'initial
994 imap-stream-alist))
1006 imap-process))))
1009 "Open an IMAP connection to host SERVER at PORT returning a buffer.
1010 If PORT is unspecified, a default value is used (143 except
1011 for SSL which use 993).
1012 STREAM indicates the stream to use, see `imap-streams' for available
1013 streams. If nil, it choices the best stream the server is capable of.
1014 AUTH indicates authenticator to use, see `imap-authenticators' for
1015 available authenticators. If nil, it choices the best stream the
1016 server is capable of.
1017 BUFFER can be a buffer or a name of a buffer, which is created if
1018 necessary. If nil, the buffer name is generated."
1035 nil)
1037 ;; Need to choose stream.
1040 ;; OK to use this stream?
1042 ;; Stream changed?
1058 "imap: Reconnecting with stream `%s'...failed"
1059 stream))
1060 ;; We're done, kill the first connection
1063 buffer
1067 ;; set the passed buffer to the current one,
1068 ;; so that (imap-opened buffer) later will work
1071 stream)
1075 ;; We're done
1082 ;; (debug "opened+state+auth+buffer" (imap-opened buffer) imap-state imap-auth buffer)
1084 buffer))))
1087 "If non-nil, check if IMAP is open.
1088 See the function `imap-ping-server'."
1094 "Return non-nil if connection to imap server in BUFFER is open.
1095 If BUFFER is nil then the current buffer is used."
1103 t)))))
1107 Return non-nil if the server responds, and nil if it does not
1108 respond. If BUFFER is nil, the current buffer is used."
1114 "Authenticate to server in BUFFER, using current buffer if nil.
1115 It uses the authenticator specified when opening the server.
1117 Optional arguments USER and PASSWD specify the username and
1118 password to use if the authenticator requires a username and/or
1119 password. If omitted or nil, the authenticator may query the
1120 user for a username and/or password."
1136 ;; Choose authenticator.
1138 auth)
1140 ;; OK to use authenticator?
1145 imap-server auth)
1150 imap-server auth)
1151 ;; set imap-state correctly on successful auth attempt
1153 ;; stop iterating through the authenticator list
1156 imap-server auth)))))
1157 imap-state))))
1160 "Close connection to server in BUFFER.
1161 If BUFFER is nil, the current buffer is used."
1171 imap-current-message nil
1172 imap-process nil)
1174 t))
1177 "Return a list of identifiers which server in BUFFER support.
1178 If IDENTIFIER, return non-nil if it's among the servers capabilities.
1179 If BUFFER is nil, the current buffer is assumed."
1186 imap-capability)))
1189 "Identify client to server in BUFFER, and return server identity.
1190 LIST-OF-VALUES is nil, or a plist with identifier and value
1191 strings to send to the server to identify the client.
1193 Return a list of identifiers which server in BUFFER support, or
1194 nil if it doesn't support ID or returns no information.
1196 If BUFFER is nil, the current buffer is assumed."
1201 "ID NIL"
1204 list-of-values
1206 imap-id)))
1209 "Return a namespace hierarchy at server in BUFFER.
1210 If BUFFER is nil, the current buffer is assumed."
1215 imap-namespace))
1242 \f
1243 ;; Mailbox functions:
1249 propname value)
1252 t))
1256 propname))
1271 imap-mailbox-data)
1272 result)))
1275 "Map a function across each mailbox in `imap-mailbox-data', returning a list.
1276 Function should take a mailbox name (a string) as
1277 the only argument."
1296 "Select MAILBOX on server in BUFFER.
1297 If EXAMINE is non-nil, do a read-only select."
1299 imap-current-mailbox
1307 imap-current-mailbox)
1308 ;; Failed SELECT/EXAMINE unselects current mailbox
1321 "Examine MAILBOX on server in BUFFER."
1325 "Close current folder in BUFFER, without expunging articles."
1332 imap-current-mailbox
1336 imap-message-data nil
1338 t)))
1341 "Expunge articles in current folder in BUFFER.
1342 If ASYNCH, do not wait for successful completion of the command.
1343 If BUFFER is nil the current buffer is assumed."
1351 "Expunge articles and close current folder in BUFFER.
1352 If ASYNCH, do not wait for successful completion of the command.
1353 If BUFFER is nil the current buffer is assumed."
1360 imap-current-mailbox status)
1362 imap-current-mailbox)
1363 ;; Don't wipe out data if another mailbox
1364 ;; was selected...
1366 imap-message-data nil
1370 imap-message-data nil
1372 t)))
1378 "Create MAILBOX on server in BUFFER.
1379 If BUFFER is nil the current buffer is assumed."
1384 "Delete MAILBOX on server in BUFFER.
1385 If BUFFER is nil the current buffer is assumed."
1392 "Rename mailbox OLDNAME to NEWNAME on server in BUFFER.
1393 If BUFFER is nil the current buffer is assumed."
1402 "Return a list of subscribed mailboxes on server in BUFFER.
1403 If ROOT is non-nil, only list matching mailboxes. If ADD-DELIMITER is
1404 non-nil, a hierarchy delimiter is added to root. REFERENCE is an
1405 implementation-specific string that has to be passed to lsub command."
1407 ;; Make sure we know the hierarchy separator for root's hierarchy
1411 ;; clear list data (NB not delimiter and other stuff)
1426 "Return a list of mailboxes matching ROOT on server in BUFFER.
1427 If ADD-DELIMITER is non-nil, a hierarchy delimiter is added to
1428 root. REFERENCE is an implementation-specific string that has to be
1429 passed to list command."
1431 ;; Make sure we know the hierarchy separator for root's hierarchy
1435 ;; clear list data (NB not delimiter and other stuff)
1450 "Send the SUBSCRIBE command on the MAILBOX to server in BUFFER.
1451 Returns non-nil if successful."
1458 "Send the SUBSCRIBE command on the MAILBOX to server in BUFFER.
1459 Returns non-nil if successful."
1466 "Get status items ITEM in MAILBOX from server in BUFFER.
1467 ITEMS can be a symbol or a list of symbols, valid symbols are one of
1468 the STATUS data items -- i.e. `messages', `recent', `uidnext', `uidvalidity',
1469 or `unseen'. If ITEMS is a list of symbols, a list of values is
1470 returned, if ITEMS is a symbol only its value is returned."
1479 items
1484 items)
1488 "Send status item requests ITEMS on MAILBOX to server in BUFFER.
1489 ITEMS can be a symbol or a list of symbols, valid symbols are one of
1490 the STATUS data items -- i.e., `messages', `recent', `uidnext', `uidvalidity'
1491 or `unseen'. The IMAP command tag is returned."
1499 items
1503 "Get ACL on MAILBOX from server in BUFFER."
1513 "Change/set ACL for IDENTIFIER to RIGHTS in MAILBOX from server in BUFFER."
1520 identifier
1521 " "
1522 rights))))))
1525 "Remove <id,rights> pairs for IDENTIFIER from MAILBOX on server in BUFFER."
1532 identifier))))))
1534 \f
1535 ;; Message functions:
1539 imap-current-message))
1545 list
1558 range)
1566 uids)
1567 props))))
1570 "Fetch properties PROPS from message set UIDS from server in BUFFER.
1571 UIDS can be a string, number or a list of numbers. If RECEIVE is
1572 non-nil, return these properties."
1578 uids)
1579 props)))
1581 t
1587 receive)
1589 uids)
1596 propname value)
1599 t))
1604 propname)))
1607 "Map a function across each message in `imap-message-data', returning a list."
1613 imap-message-data)
1614 result)))
1660 ;; FIXME: Should this try to use CHARSET? -- fx
1668 nil)
1672 "Return t if FLAG can be permanently saved on articles.
1673 MAILBOX specifies a mailbox on the server in BUFFER."
1699 ;; Cf. http://thread.gmane.org/gmane.emacs.gnus.general/65317/focus=65343
1700 ;; Signal an error if we'd get an integer overflow.
1701 ;;
1702 ;; FIXME: Identify relevant calls to `string-to-number' and replace them with
1703 ;; `imap-string-to-integer'.
1709 number)))
1712 "Like `imap-fetch', but DTRT with Exchange 2007 bug.
1713 However, UIDS here is a cons, where the car is the canonical form
1714 of the UIDS specification, and the cdr is the one which works with
1715 Exchange 2007 or, potentially, other buggy servers.
1716 See `imap-enable-exchange-bug-workaround'."
1717 ;; The first time we get here for a given, we'll try the canonical
1718 ;; form. If we get the known error from the buggy server, set the
1719 ;; flag buffer-locally (to account for connections to multiple
1720 ;; servers), then re-try with the alternative UIDS spec. We don't
1721 ;; unconditionally use the alternative form, since the
1722 ;; currently-used alternatives are seriously inefficient with some
1723 ;; servers (although they are valid).
1724 ;;
1725 ;; FIXME: Maybe it would be cleaner to have a flag to not signal
1726 ;; the error (which otherwise gives a message), and test
1727 ;; `imap-failed-tags'. Also, Other IMAP clients use other forms of
1728 ;; request which work with Exchange, e.g. Claws does "UID FETCH 1:*
1729 ;; (UID)" rather than "FETCH UID 1,*". Is there a good reason not
1730 ;; to do the same?
1732 ;; Binding `debug-on-error' allows us to get the error from
1733 ;; `imap-parse-response' -- it's normally caught by Emacs around
1734 ;; execution of a process filter.
1739 props receive nouidfetch buffer))
1742 ;; This is the Exchange 2007 response. It may be more
1743 ;; robust just to check for a BAD response to the
1744 ;; attempted fetch.
1749 t)
1776 "Copy ARTICLES to MAILBOX on server in BUFFER.
1777 ARTICLES is a string message set. Create mailbox if it doesn't exist,
1778 unless DONT-CREATE is non-nil. On success, return a list with
1779 the UIDVALIDITY of the mailbox the article(s) was copied to as the
1780 first element. The rest of list contains the saved articles' UIDs."
1787 t
1789 ;; removed because of buggy Oracle server
1790 ;; that doesn't send TRYCREATE tags (which
1791 ;; is a MUST according to specifications):
1792 ;;(imap-mailbox-get-1 'trycreate mailbox)
1798 ;; FIXME: Amalgamate with imap-message-copyuid-1, using an extra arg, since it
1799 ;; shares most of the code? -- fx
1821 "Append ARTICLE (a buffer) to MAILBOX on server in BUFFER.
1822 FLAGS and DATE-TIME is currently not used. Return a cons holding
1823 uidvalidity of MAILBOX and UID the newly created article got, or nil
1824 on failure."
1834 "Return number of lines in article by looking at the mime bodystructure BODY."
1848 "Return a FROM string line."
1853 "@"
1857 \f
1858 ;; Internal functions.
1872 cmd cmdstr)
1880 size)
1885 ;; XXX modifies buffer!
1912 nil ;; abort command if no cont-req
1914 command)))
1920 tag)))
1929 message-log-max)
1938 ;; A process can die _before_ we have processed everything it
1939 ;; has to say. Moreover, this can happen in between the call to
1940 ;; accept-process-output and the call to process-status in an
1941 ;; iteration of the loop above.
1950 'INCOMPLETE
1957 "Return point at end of current line, taking into account literals.
1958 Return nil if no complete line has arrived."
1960 imap-server-eol)
1961 nil t)
1964 nil
1970 "IMAP process filter."
1971 ;; Sometimes, we are called even though the process has died.
1972 ;; Better abstain from doing stuff in that case.
1995 imap-state)))
1998 \f
1999 ;; Imap parser.
2004 ;; number = 1*DIGIT
2005 ;; ; Unsigned 32-bit integer
2006 ;; ; (0 <= n < 4,294,967,296)
2014 ;; literal = "{" number "}" CRLF *CHAR8
2015 ;; ; Number represents the number of CHAR8s
2022 nil
2026 ;; string = quoted / literal
2027 ;;
2028 ;; quoted = DQUOTE *QUOTED-CHAR DQUOTE
2029 ;;
2030 ;; QUOTED-CHAR = <any TEXT-CHAR except quoted-specials> /
2031 ;; "\" quoted-specials
2032 ;;
2033 ;; quoted-specials = DQUOTE / "\"
2034 ;;
2035 ;; TEXT-CHAR = <any CHAR except CR and LF>
2049 name))
2053 ;; nil = "NIL"
2059 ;; nstring = string / nil
2064 nil)))
2066 ;; astring = atom / string
2067 ;;
2068 ;; atom = 1*ATOM-CHAR
2069 ;;
2070 ;; ATOM-CHAR = <any CHAR except atom-specials>
2071 ;;
2072 ;; atom-specials = "(" / ")" / "{" / SP / CTL / list-wildcards /
2073 ;; quoted-specials
2074 ;;
2075 ;; list-wildcards = "%" / "*"
2076 ;;
2077 ;; quoted-specials = DQUOTE / "\"
2087 ;; address = "(" addr-name SP addr-adl SP addr-mailbox SP
2088 ;; addr-host ")"
2089 ;;
2090 ;; addr-adl = nstring
2091 ;; ; Holds route from [RFC-822] route-addr if
2092 ;; ; non-nil
2093 ;;
2094 ;; addr-host = nstring
2095 ;; ; nil indicates [RFC-822] group syntax.
2096 ;; ; Otherwise, holds [RFC-822] domain name
2097 ;;
2098 ;; addr-mailbox = nstring
2099 ;; ; nil indicates end of [RFC-822] group; if
2100 ;; ; non-nil and addr-host is nil, holds
2101 ;; ; [RFC-822] group name.
2102 ;; ; Otherwise, holds [RFC-822] local-part
2103 ;; ; after removing [RFC-822] quoting
2104 ;;
2105 ;; addr-name = nstring
2106 ;; ; If non-nil, holds phrase from [RFC-822]
2107 ;; ; mailbox after removing [RFC-822] quoting
2108 ;;
2123 address))))
2125 ;; address-list = "(" 1*address ")" / nil
2126 ;;
2127 ;; nil = "NIL"
2134 ;; next line for MS Exchange bug
2141 ;; With assert, the code might not be eval'd.
2142 ;; (cl-assert (imap-parse-nil) t "In imap-parse-address-list")
2145 ;; mailbox = "INBOX" / astring
2146 ;; ; INBOX is case-insensitive. All case variants of
2147 ;; ; INBOX (e.g. "iNbOx") MUST be interpreted as INBOX
2148 ;; ; not as an astring. An astring which consists of
2149 ;; ; the case-insensitive sequence "I" "N" "B" "O" "X"
2150 ;; ; is considered to be INBOX and not an astring.
2151 ;; ; Refer to section 5.1 for further
2152 ;; ; semantic details of mailbox names.
2157 "INBOX"
2158 mailbox)))
2160 ;; greeting = "*" SP (resp-cond-auth / resp-cond-bye) CRLF
2161 ;;
2162 ;; resp-cond-auth = ("OK" / "PREAUTH") SP resp-text
2163 ;; ; Authentication condition
2164 ;;
2165 ;; resp-cond-bye = "BYE" SP resp-text
2168 "Parse an IMAP greeting."
2176 ;; response = *(continue-req / response-data) response-done
2177 ;;
2178 ;; continue-req = "+" SP (resp-text / base64) CRLF
2179 ;;
2180 ;; response-data = "*" SP (resp-cond-state / resp-cond-bye /
2181 ;; mailbox-data / message-data / capability-data) CRLF
2182 ;;
2183 ;; response-done = response-tagged / response-fatal
2184 ;;
2185 ;; response-fatal = "*" SP resp-cond-bye CRLF
2186 ;; ; Server closes connection immediately
2187 ;;
2188 ;; response-tagged = tag SP resp-cond-state CRLF
2189 ;;
2190 ;; resp-cond-state = ("OK" / "NO" / "BAD") SP resp-text
2191 ;; ; Status condition
2192 ;;
2193 ;; resp-cond-bye = "BYE" SP resp-text
2194 ;;
2195 ;; mailbox-data = "FLAGS" SP flag-list /
2196 ;; "LIST" SP mailbox-list /
2197 ;; "LSUB" SP mailbox-list /
2198 ;; "SEARCH" *(SP nz-number) /
2199 ;; "STATUS" SP mailbox SP "("
2200 ;; [status-att SP number *(SP status-att SP number)] ")" /
2201 ;; number SP "EXISTS" /
2202 ;; number SP "RECENT"
2203 ;;
2204 ;; message-data = nz-number SP ("EXPUNGE" / ("FETCH" SP msg-att))
2205 ;;
2206 ;; capability-data = "CAPABILITY" *(SP capability) SP "IMAP4rev1"
2207 ;; *(SP capability)
2208 ;; ; IMAP4rev1 servers which offer RFC 1730
2209 ;; ; compatibility MUST list "IMAP4" as the first
2210 ;; ; capability.
2213 "Parse an IMAP command response."
2219 t)))
2230 'search
2266 imap-failed-tags))))
2279 token status code text))))
2286 ;; resp-text = ["[" resp-text-code "]" SP] text
2287 ;;
2288 ;; text = 1*TEXT-CHAR
2289 ;;
2290 ;; TEXT-CHAR = <any CHAR except CR and LF>
2295 ;; resp-text-code = "ALERT" /
2296 ;; "BADCHARSET [SP "(" astring *(SP astring) ")" ] /
2297 ;; "NEWNAME" SP string SP string /
2298 ;; "PARSE" /
2299 ;; "PERMANENTFLAGS" SP "("
2300 ;; [flag-perm *(SP flag-perm)] ")" /
2301 ;; "READ-ONLY" /
2302 ;; "READ-WRITE" /
2303 ;; "TRYCREATE" /
2304 ;; "UIDNEXT" SP nz-number /
2305 ;; "UIDVALIDITY" SP nz-number /
2306 ;; "UNSEEN" SP nz-number /
2307 ;; resp-text-atom [SP 1*<any TEXT-CHAR except "]">]
2308 ;;
2309 ;; resp_code_apnd = "APPENDUID" SPACE nz_number SPACE uniqueid
2310 ;;
2311 ;; resp_code_copy = "COPYUID" SPACE nz_number SPACE set SPACE set
2312 ;;
2313 ;; set = sequence-num / (sequence-num ":" sequence-num) /
2314 ;; (set "," set)
2315 ;; ; Identifies a set of messages. For message
2316 ;; ; sequence numbers, these are consecutive
2317 ;; ; numbers from 1 to the number of messages in
2318 ;; ; the mailbox
2319 ;; ; Comma delimits individual numbers, colon
2320 ;; ; delimits between two numbers inclusive.
2321 ;; ; Example: 2,4:7,9,12:* is 2,4,5,6,7,9,12,13,
2322 ;; ; 14,15 for a mailbox with 15 messages.
2323 ;;
2324 ;; sequence-num = nz-number / "*"
2325 ;; ; * is the largest number in use. For message
2326 ;; ; sequence numbers, it is the number of messages
2327 ;; ; in the mailbox. For unique identifiers, it is
2328 ;; ; the unique identifier of the last message in
2329 ;; ; the mailbox.
2330 ;;
2331 ;; flag-perm = flag / "\*"
2332 ;;
2333 ;; flag = "\Answered" / "\Flagged" / "\Deleted" /
2334 ;; "\Seen" / "\Draft" / flag-keyword / flag-extension
2335 ;; ; Does not include "\Recent"
2336 ;;
2337 ;; flag-extension = "\" atom
2338 ;; ; Future expansion. Client implementations
2339 ;; ; MUST accept flag-extension flags. Server
2340 ;; ; implementations MUST NOT generate
2341 ;; ; flag-extension flags except as defined by
2342 ;; ; future standard or standards-track
2343 ;; ; revisions of this specification.
2344 ;;
2345 ;; flag-keyword = atom
2346 ;;
2347 ;; resp-text-atom = 1*<any ATOM-CHAR except "]">
2350 ;; xxx next line for stalker communigate pro 3.3.1 bug
2377 imap-current-target-mailbox))
2382 imap-current-target-mailbox))
2387 ;; mailbox-list = "(" [mbx-list-flags] ")" SP
2388 ;; (DQUOTE QUOTED-CHAR DQUOTE / nil) SP mailbox
2389 ;;
2390 ;; mbx-list-flags = *(mbx-list-oflag SP) mbx-list-sflag
2391 ;; *(SP mbx-list-oflag) /
2392 ;; mbx-list-oflag *(SP mbx-list-oflag)
2393 ;;
2394 ;; mbx-list-oflag = "\Noinferiors" / flag-extension
2395 ;; ; Other flags; multiple possible per LIST response
2396 ;;
2397 ;; mbx-list-sflag = "\Noselect" / "\Marked" / "\Unmarked"
2398 ;; ; Selectability flags; only one per LIST response
2399 ;;
2400 ;; QUOTED-CHAR = <any TEXT-CHAR except quoted-specials> /
2401 ;; "\" quoted-specials
2402 ;;
2403 ;; quoted-specials = DQUOTE / "\"
2416 ;; msg_att ::= "(" 1#("ENVELOPE" SPACE envelope /
2417 ;; "FLAGS" SPACE "(" #(flag / "\Recent") ")" /
2418 ;; "INTERNALDATE" SPACE date_time /
2419 ;; "RFC822" [".HEADER" / ".TEXT"] SPACE nstring /
2420 ;; "RFC822.SIZE" SPACE number /
2421 ;; "BODY" ["STRUCTURE"] SPACE body /
2422 ;; "BODY" section ["<" number ">"] SPACE nstring /
2423 ;; "UID" SPACE uniqueid) ")"
2424 ;;
2425 ;; date_time ::= <"> date_day_fixed "-" date_month "-" date_year
2426 ;; SPACE time SPACE zone <">
2427 ;;
2428 ;; section ::= "[" [section_text / (nz_number *["." nz_number]
2429 ;; ["." (section_text / "MIME")])] "]"
2430 ;;
2431 ;; section_text ::= "HEADER" / "HEADER.FIELDS" [".NOT"]
2432 ;; SPACE header_list / "TEXT"
2433 ;;
2434 ;; header_fld_name ::= astring
2435 ;;
2436 ;; header_list ::= "(" 1#header_fld_name ")"
2454 section)))
2459 rfc822size body bodydetail bodystructure flags-empty)
2460 ;; Courier can insert spurious blank characters which will
2461 ;; confuse `read', so skip past them.
2497 bodydetail)
2516 ;; mailbox-data = ...
2517 ;; "STATUS" SP mailbox SP "("
2518 ;; [status-att SP number
2519 ;; *(SP status-att SP number)] ")"
2520 ;; ...
2521 ;;
2522 ;; status-att = "MESSAGES" / "RECENT" / "UIDNEXT" / "UIDVALIDITY" /
2523 ;; "UNSEEN"
2551 token mailbox)
2554 ;; acl_data ::= "ACL" SPACE mailbox *(SPACE identifier SPACE
2555 ;; rights)
2556 ;;
2557 ;; identifier ::= astring
2558 ;;
2559 ;; rights ::= astring
2563 identifier rights acl)
2572 ;; flag-list = "(" [flag *(SP flag)] ")"
2573 ;;
2574 ;; flag = "\Answered" / "\Flagged" / "\Deleted" /
2575 ;; "\Seen" / "\Draft" / flag-keyword / flag-extension
2576 ;; ; Does not include "\Recent"
2577 ;;
2578 ;; flag-keyword = atom
2579 ;;
2580 ;; flag-extension = "\" atom
2581 ;; ; Future expansion. Client implementations
2582 ;; ; MUST accept flag-extension flags. Server
2583 ;; ; implementations MUST NOT generate
2584 ;; ; flag-extension flags except as defined by
2585 ;; ; future standard or standards-track
2586 ;; ; revisions of this specification.
2594 ;; next line for Courier IMAP bug.
2603 ;; envelope = "(" env-date SP env-subject SP env-from SP env-sender SP
2604 ;; env-reply-to SP env-to SP env-cc SP env-bcc SP
2605 ;; env-in-reply-to SP env-message-id ")"
2606 ;;
2607 ;; env-bcc = "(" 1*address ")" / nil
2608 ;;
2609 ;; env-cc = "(" 1*address ")" / nil
2610 ;;
2611 ;; env-date = nstring
2612 ;;
2613 ;; env-from = "(" 1*address ")" / nil
2614 ;;
2615 ;; env-in-reply-to = nstring
2616 ;;
2617 ;; env-message-id = nstring
2618 ;;
2619 ;; env-reply-to = "(" 1*address ")" / nil
2620 ;;
2621 ;; env-sender = "(" 1*address ")" / nil
2622 ;;
2623 ;; env-subject = nstring
2624 ;;
2625 ;; env-to = "(" 1*address ")" / nil
2651 ;; body-fld-param = "(" string SP string *(SP string SP string) ")" / nil
2659 ;; buggy stalker communigate pro 3.0 doesn't print SPC
2660 ;; between body-fld-param's sometimes
2665 nil)))
2667 ;; body-extension = nstring / number /
2668 ;; "(" body-extension *(SP body-extension) ")"
2669 ;; ; Future expansion. Client implementations
2670 ;; ; MUST accept body-extension fields. Server
2671 ;; ; implementations MUST NOT generate
2672 ;; ; body-extension fields except as defined by
2673 ;; ; future standard or standards-track
2674 ;; ; revisions of this specification.
2690 ;; body-ext-1part = body-fld-md5 [SP body-fld-dsp [SP body-fld-lang
2691 ;; *(SP body-extension)]]
2692 ;; ; MUST NOT be returned on non-extensible
2693 ;; ; "BODY" fetch
2694 ;;
2695 ;; body-ext-mpart = body-fld-param [SP body-fld-dsp [SP body-fld-lang
2696 ;; *(SP body-extension)]]
2697 ;; ; MUST NOT be returned on non-extensible
2698 ;; ; "BODY" fetch
2712 ;; With assert, the code might not be eval'd.
2713 ;; (cl-assert (imap-parse-nil) t "In imap-parse-body-ext")
2724 ext))
2726 ;; body = "(" body-type-1part / body-type-mpart ")"
2727 ;;
2728 ;; body-ext-1part = body-fld-md5 [SP body-fld-dsp [SP body-fld-lang
2729 ;; *(SP body-extension)]]
2730 ;; ; MUST NOT be returned on non-extensible
2731 ;; ; "BODY" fetch
2732 ;;
2733 ;; body-ext-mpart = body-fld-param [SP body-fld-dsp [SP body-fld-lang
2734 ;; *(SP body-extension)]]
2735 ;; ; MUST NOT be returned on non-extensible
2736 ;; ; "BODY" fetch
2737 ;;
2738 ;; body-fields = body-fld-param SP body-fld-id SP body-fld-desc SP
2739 ;; body-fld-enc SP body-fld-octets
2740 ;;
2741 ;; body-fld-desc = nstring
2742 ;;
2743 ;; body-fld-dsp = "(" string SP body-fld-param ")" / nil
2744 ;;
2745 ;; body-fld-enc = (DQUOTE ("7BIT" / "8BIT" / "BINARY" / "BASE64"/
2746 ;; "QUOTED-PRINTABLE") DQUOTE) / string
2747 ;;
2748 ;; body-fld-id = nstring
2749 ;;
2750 ;; body-fld-lang = nstring / "(" string *(SP string) ")"
2751 ;;
2752 ;; body-fld-lines = number
2753 ;;
2754 ;; body-fld-md5 = nstring
2755 ;;
2756 ;; body-fld-octets = number
2757 ;;
2758 ;; body-fld-param = "(" string SP string *(SP string SP string) ")" / nil
2759 ;;
2760 ;; body-type-1part = (body-type-basic / body-type-msg / body-type-text)
2761 ;; [SP body-ext-1part]
2762 ;;
2763 ;; body-type-basic = media-basic SP body-fields
2764 ;; ; MESSAGE subtype MUST NOT be "RFC822"
2765 ;;
2766 ;; body-type-msg = media-message SP body-fields SP envelope
2767 ;; SP body SP body-fld-lines
2768 ;;
2769 ;; body-type-text = media-text SP body-fields SP body-fld-lines
2770 ;;
2771 ;; body-type-mpart = 1*body SP media-subtype
2772 ;; [SP body-ext-mpart]
2773 ;;
2774 ;; media-basic = ((DQUOTE ("APPLICATION" / "AUDIO" / "IMAGE" /
2775 ;; "MESSAGE" / "VIDEO") DQUOTE) / string) SP media-subtype
2776 ;; ; Defined in [MIME-IMT]
2777 ;;
2778 ;; media-message = DQUOTE "MESSAGE" DQUOTE SP DQUOTE "RFC822" DQUOTE
2779 ;; ; Defined in [MIME-IMT]
2780 ;;
2781 ;; media-subtype = string
2782 ;; ; Defined in [MIME-IMT]
2783 ;;
2784 ;; media-text = DQUOTE "TEXT" DQUOTE SP media-subtype
2785 ;; ; Defined in [MIME-IMT]
2795 ;; buggy stalker communigate pro 3.0 inserts a SPC between
2796 ;; parts in multiparts
2818 ;; next line for Sun SIMS bug
2828 ;; Next `or' for Sun SIMS bug. It regards body-fld-enc as a
2829 ;; nstring and returns nil instead of defaulting back to 7BIT
2830 ;; as the standard says.
2831 ;; Exchange (2007, at least) does this as well.
2834 ;; Exchange 2007 can return -1, contrary to the spec...
2841 ;; Ok, we're done parsing the required parts, what comes now is one of
2842 ;; three things:
2843 ;;
2844 ;; envelope (then we're parsing body-type-msg)
2845 ;; body-fld-lines (then we're parsing body-type-text)
2846 ;; body-ext-1part (then we're parsing body-type-basic)
2847 ;;
2848 ;; The problem is that the two first are in turn optionally followed
2849 ;; by the third. So we parse the first two here (if there are any)...
2858 ;; buggy stalker communigate pro 3.0 doesn't print
2859 ;; number of lines in message/rfc822 attachment
2869 ;; ...and then parse the third one here...
2884 '(
2885 imap-utf7-encode
2886 imap-utf7-decode
2887 imap-error-text
2888 imap-kerberos4s-p
2889 imap-kerberos4-open
2890 imap-network-p
2891 imap-network-open
2892 imap-interactive-login
2893 imap-kerberos4a-p
2894 imap-kerberos4-auth
2895 imap-cram-md5-p
2896 imap-cram-md5-auth
2897 imap-login-p
2898 imap-login-auth
2899 imap-anonymous-p
2900 imap-anonymous-auth
2901 imap-open-1
2902 imap-open
2903 imap-opened
2904 imap-ping-server
2905 imap-authenticate
2906 imap-close
2907 imap-capability
2908 imap-namespace
2909 imap-send-command-wait
2910 imap-mailbox-put
2911 imap-mailbox-get
2912 imap-mailbox-map-1
2913 imap-mailbox-map
2914 imap-current-mailbox
2915 imap-current-mailbox-p-1
2916 imap-current-mailbox-p
2917 imap-mailbox-select-1
2918 imap-mailbox-select
2919 imap-mailbox-examine-1
2920 imap-mailbox-examine
2921 imap-mailbox-unselect
2922 imap-mailbox-expunge
2923 imap-mailbox-close
2924 imap-mailbox-create-1
2925 imap-mailbox-create
2926 imap-mailbox-delete
2927 imap-mailbox-rename
2928 imap-mailbox-lsub
2929 imap-mailbox-list
2930 imap-mailbox-subscribe
2931 imap-mailbox-unsubscribe
2932 imap-mailbox-status
2933 imap-mailbox-acl-get
2934 imap-mailbox-acl-set
2935 imap-mailbox-acl-delete
2936 imap-current-message
2937 imap-list-to-message-set
2938 imap-fetch-asynch
2939 imap-fetch
2940 imap-fetch-safe
2941 imap-message-put
2942 imap-message-get
2943 imap-message-map
2944 imap-search
2945 imap-message-flag-permanent-p
2946 imap-message-flags-set
2947 imap-message-flags-del
2948 imap-message-flags-add
2949 imap-message-copyuid-1
2950 imap-message-copyuid
2951 imap-message-copy
2952 imap-message-appenduid-1
2953 imap-message-appenduid
2954 imap-message-append
2955 imap-body-lines
2956 imap-envelope-from
2957 imap-send-command-1
2958 imap-send-command
2959 imap-wait-for-tag
2960 imap-sentinel
2961 imap-find-next-line
2962 imap-arrival-filter
2963 imap-parse-greeting
2964 imap-parse-response
2965 imap-parse-resp-text
2966 imap-parse-resp-text-code
2967 imap-parse-data-list
2968 imap-parse-fetch
2969 imap-parse-status
2970 imap-parse-acl
2971 imap-parse-flag-list
2972 imap-parse-envelope
2973 imap-parse-body-extension
2974 imap-parse-body
2975 )))
2979 ;;; imap.el ends here