| blob | 3d2a4f948bc58988e38aa65d8c677c9f9d2ab046 |
1 ;;; imap.el --- imap library
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:
140 ;; For Emacs <22.2 and XEmacs.
153 ;; User variables.
156 "Low-level IMAP issues."
162 "List of strings containing commands for Kerberos 4 authentication.
163 %s is replaced with server hostname, %p with port to connect to, and
164 %l with the value of `imap-default-user'. The program should accept
165 IMAP commands on stdin and return responses to stdout. Each entry in
166 the list is tried until a successful connection is made."
172 "--mechanism GSSAPI "
175 "List of strings containing commands for GSSAPI (krb5) authentication.
176 %s is replaced with server hostname, %p with port to connect to, and
177 %l with the value of `imap-default-user'. The program should accept
178 IMAP commands on stdin and return responses to stdout. Each entry in
179 the list is tried until a successful connection is made."
184 "rsh %s imapd"
185 "ssh %g ssh %s imapd"
187 "A list of strings, containing commands for IMAP connection.
188 Within a string, %s is replaced with the server address, %p with port
189 number on server, %g with `imap-shell-host', and %l with
190 `imap-default-user'. The program should read IMAP commands from stdin
191 and write IMAP response to stdout. Each entry in the list is tried
192 until a successful connection is made."
197 "Value for `process-connection-type' to use for Kerberos4, GSSAPI, shell, and SSL.
198 The `process-connection-type' variable controls the type of device
199 used to communicate with subprocesses. Values are nil to use a
200 pipe, or t or `pty' to use a pty. The value has no effect if the
201 system has no ptys or if all ptys are busy: then a pipe is used
202 in any case. The value takes effect when an IMAP server is
203 opened; changing it after that has no effect."
209 "If non-nil, do utf7 encoding/decoding of mailbox names.
210 Since the UTF7 decoding currently only decodes into ISO-8859-1
211 characters, you may disable this decoding if you need to access UTF7
212 encoded mailboxes which doesn't translate into ISO-8859-1."
217 "If non-nil, an imap session trace is placed in `imap-log-buffer'.
218 Note that username, passwords and other privacy sensitive
219 information (such as e-mail) may be stored in the buffer.
220 It is not written to disk, however. Do not enable this
221 variable unless you are comfortable with that.
223 See also `imap-debug'."
228 "If non-nil, trace imap- functions into `imap-debug-buffer'.
229 Uses `trace-function-background', so you can turn it off with,
230 say, `untrace-all'.
232 Note that username, passwords and other privacy sensitive
233 information (such as e-mail) may be stored in the buffer.
234 It is not written to disk, however. Do not enable this
235 variable unless you are comfortable with that.
237 This variable only takes effect when loading the `imap' library.
238 See also `imap-log'."
243 "Hostname of rlogin proxy."
248 "Default username to use."
253 1.0
255 "How long to wait between checking for the end of output.
256 Shorter values mean quicker response, but is more CPU intensive."
261 "If non-nil, store session password without prompting."
265 ;; Various variables.
281 "Definition of network streams.
283 \(NAME CHECK OPEN)
285 NAME names the stream, CHECK is a function returning non-nil if the
286 server support the stream and OPEN is a function for opening the
290 kerberos4
291 digest-md5
292 cram-md5
293 ;;sasl
294 login
295 anonymous)
306 "Definition of authenticators.
308 \(NAME CHECK AUTHENTICATE)
310 NAME names the authenticator. CHECK is a function returning non-nil if
311 the server support the authenticator and AUTHENTICATE is a function
318 "Close server immediately if it can't logout in this number of seconds.
319 If it is nil, never close server until logout completes. Normally,
320 the value of this variable will be bound to a certain value to which
321 an application program that uses this module specifies on a per-server
324 ;; Internal constants. Change these and die.
333 imap-port
334 imap-client-eol
335 imap-server-eol
336 imap-auth
337 imap-stream
338 imap-username
339 imap-password
340 imap-current-mailbox
341 imap-current-target-mailbox
342 imap-message-data
343 imap-capability
344 imap-id
345 imap-namespace
346 imap-state
347 imap-reached-tag
348 imap-failed-tags
349 imap-tag
350 imap-process
351 imap-calculate-literal-size-first
352 imap-mailbox-data))
356 ;; Internal variables.
367 "IMAP state.
368 Valid states are `closed', `initial', `nonauth', `auth', `selected'
402 "Identity of server.
412 "Alist of tags that failed.
413 Each element is a list with four elements; tag (a integer), response
414 state (a symbol, `OK', `NO' or `BAD'), response code (a string), and
424 "Non-nil indicates that the server emitted a continuation request.
428 "List of response tags and callbacks, on the form `(number . function)'.
429 The function should take two arguments, the first the IMAP tag and the
433 "Send FETCH UID commands as *:* instead of *.
435 When non-nil, use an alternative UIDS form. Enabling appears to
436 be required for some servers (e.g., Microsoft Exchange 2007)
437 which otherwise would trigger a response `BAD The specified
438 message set is invalid.'. We don't unconditionally use this
439 form, since this is said to be significantly inefficient.
441 This variable is set to t automatically per server if the
444 \f
445 ;; Utility functions:
448 "Delete by side effect any elements of ALIST whose car is `equal' to KEY.
449 The modified ALIST is returned. If the first member
450 of ALIST has a car that is `equal' to KEY, there is no way to remove it
451 by side effect; therefore, write `(setq foo (remassoc key foo))' to be
452 sure of changing the value of `foo'."
457 alist)))
460 "Enable multibyte in the current buffer."
470 "imap: Could not UTF7 encode `%s', using it unencoded..."
471 string)
472 string)))
473 string))
481 "imap: Could not UTF7 decode `%s', using it undecoded..."
482 string)
483 string)))
484 string))
488 t
490 nil))
496 \f
497 ;; Server functions; stream stuff:
514 cmd done)
523 name buffer shell-file-name shell-command-switch
525 cmd
527 ?s server
529 ?l imap-default-user))))
530 response)
534 imap-calculate-literal-size-first t)
538 ;; Athena IMTEST can output SSL verify errors
541 t)
544 t)
545 ;; cyrus 1.6.x (13? < x <= 22) queries capabilities
548 t)
549 ;; cyrus 1.6 imtest print "S: " before server greeting
552 t)
554 ;; success in imtest < 1.6:
557 ;; success in imtest 1.6:
572 nil)))))
573 done))
580 cmd done)
589 name buffer shell-file-name shell-command-switch
591 cmd
593 ?s server
595 ?l imap-default-user))))
596 response)
600 imap-calculate-literal-size-first t)
604 ;; Athena IMTEST can output SSL verify errors
607 t)
610 t)
611 ;; cyrus 1.6.x (13? < x <= 22) queries capabilities
614 t)
615 ;; cyrus 1.6 imtest print "S: " before server greeting
618 t)
619 ;; GNU SASL may print 'Trying ...' first.
622 t)
624 ;; success in imtest 1.6:
627 "Client authentication "
629 nil t)
642 nil)))))
643 done))
646 nil)
656 ;; FIXME: Per the "blue moon" comment, the process/buffer
657 ;; handling here, and elsewhere in functions which open
658 ;; streams, looks confused. Obviously we can change buffers
659 ;; if a different process handler kicks in from
660 ;; `accept-process-output' or `sit-for' below, and TRT seems
661 ;; to be to `save-buffer' around those calls. (I wonder why
662 ;; `sit-for' is used with a non-zero wait.) -- fx
671 process))))
674 t)
690 process))))
693 nil)
698 cmd done)
707 name buffer shell-file-name shell-command-switch
709 cmd
711 ?s server
712 ?g imap-shell-host
714 ?l imap-default-user)))))
730 done)
732 nil)))
743 name buffer server port
746 :always-query-capabilities t
749 :starttls-function
753 done)
762 done))
764 ;; Server functions; authenticator stuff:
767 "Login to server in BUFFER.
768 Return t if login was successful, nil otherwise.
770 LOGINFUNC is passed a username and a password. It should return
771 t if it successfully authenticates, nil otherwise."
776 ;; (condition-case ()
781 "imap: username for %s (using stream `%s'): "
782 imap-server imap-stream)
788 "imap: password for %s@%s (using authenticator `%s'): "
789 user imap-server imap-auth))))
795 imap-username user)
804 ;; (quit (with-current-buffer buffer
805 ;; (setq user nil
806 ;; passwd nil)))
807 ;; (error (with-current-buffer buffer
808 ;; (setq user nil
809 ;; passwd nil))))
810 ret)))
833 "Login to server using the AUTH CRAM-MD5 method."
836 buffer
841 "AUTHENTICATE CRAM-MD5"
847 encoded)))))))))
867 "Login to server using the LOGIN command."
879 t)
888 ;;; Compiler directives.
901 mecs))
917 "Login to server using the SASL method."
924 logged user)
940 buffer)))
950 logged t)
953 logged)))
962 "Login to server using the AUTH DIGEST-MD5 method."
965 buffer
970 "AUTHENTICATE DIGEST-MD5"
979 user passwd digest-uri)))
981 )))
983 nil
988 ;; Server functions:
994 imap-current-message nil
995 imap-state 'initial
998 imap-stream-alist))
1010 imap-process))))
1013 "Open an IMAP connection to host SERVER at PORT returning a buffer.
1014 If PORT is unspecified, a default value is used (143 except
1015 for SSL which use 993).
1016 STREAM indicates the stream to use, see `imap-streams' for available
1017 streams. If nil, it choices the best stream the server is capable of.
1018 AUTH indicates authenticator to use, see `imap-authenticators' for
1019 available authenticators. If nil, it choices the best stream the
1020 server is capable of.
1021 BUFFER can be a buffer or a name of a buffer, which is created if
1022 necessary. If nil, the buffer name is generated."
1039 nil)
1041 ;; Need to choose stream.
1044 ;; OK to use this stream?
1046 ;; Stream changed?
1062 "imap: Reconnecting with stream `%s'...failed"
1063 stream))
1064 ;; We're done, kill the first connection
1067 buffer
1071 ;; set the passed buffer to the current one,
1072 ;; so that (imap-opened buffer) later will work
1075 stream)
1079 ;; We're done
1086 ;; (debug "opened+state+auth+buffer" (imap-opened buffer) imap-state imap-auth buffer)
1088 buffer))))
1091 "If non-nil, check if IMAP is open.
1092 See the function `imap-ping-server'."
1098 "Return non-nil if connection to imap server in BUFFER is open.
1099 If BUFFER is nil then the current buffer is used."
1107 t)))))
1111 Return non-nil if the server responds, and nil if it does not
1112 respond. If BUFFER is nil, the current buffer is used."
1118 "Authenticate to server in BUFFER, using current buffer if nil.
1119 It uses the authenticator specified when opening the server.
1121 Optional arguments USER and PASSWD specify the username and
1122 password to use if the authenticator requires a username and/or
1123 password. If omitted or nil, the authenticator may query the
1124 user for a username and/or password."
1140 ;; Choose authenticator.
1142 auth)
1144 ;; OK to use authenticator?
1149 imap-server auth)
1154 imap-server auth)
1155 ;; set imap-state correctly on successful auth attempt
1157 ;; stop iterating through the authenticator list
1160 imap-server auth)))))
1161 imap-state))))
1164 "Close connection to server in BUFFER.
1165 If BUFFER is nil, the current buffer is used."
1175 imap-current-message nil
1176 imap-process nil)
1178 t))
1181 "Return a list of identifiers which server in BUFFER support.
1182 If IDENTIFIER, return non-nil if it's among the servers capabilities.
1183 If BUFFER is nil, the current buffer is assumed."
1190 imap-capability)))
1193 "Identify client to server in BUFFER, and return server identity.
1194 LIST-OF-VALUES is nil, or a plist with identifier and value
1195 strings to send to the server to identify the client.
1197 Return a list of identifiers which server in BUFFER support, or
1198 nil if it doesn't support ID or returns no information.
1200 If BUFFER is nil, the current buffer is assumed."
1205 "ID NIL"
1208 list-of-values
1210 imap-id)))
1213 "Return a namespace hierarchy at server in BUFFER.
1214 If BUFFER is nil, the current buffer is assumed."
1219 imap-namespace))
1246 \f
1247 ;; Mailbox functions:
1253 propname value)
1256 t))
1260 propname))
1275 imap-mailbox-data)
1276 result)))
1279 "Map a function across each mailbox in `imap-mailbox-data', returning a list.
1280 Function should take a mailbox name (a string) as
1281 the only argument."
1300 "Select MAILBOX on server in BUFFER.
1301 If EXAMINE is non-nil, do a read-only select."
1303 imap-current-mailbox
1311 imap-current-mailbox)
1312 ;; Failed SELECT/EXAMINE unselects current mailbox
1325 "Examine MAILBOX on server in BUFFER."
1329 "Close current folder in BUFFER, without expunging articles."
1336 imap-current-mailbox
1340 imap-message-data nil
1342 t)))
1345 "Expunge articles in current folder in BUFFER.
1346 If ASYNCH, do not wait for successful completion of the command.
1347 If BUFFER is nil the current buffer is assumed."
1355 "Expunge articles and close current folder in BUFFER.
1356 If ASYNCH, do not wait for successful completion of the command.
1357 If BUFFER is nil the current buffer is assumed."
1364 imap-current-mailbox status)
1366 imap-current-mailbox)
1367 ;; Don't wipe out data if another mailbox
1368 ;; was selected...
1370 imap-message-data nil
1374 imap-message-data nil
1376 t)))
1382 "Create MAILBOX on server in BUFFER.
1383 If BUFFER is nil the current buffer is assumed."
1388 "Delete MAILBOX on server in BUFFER.
1389 If BUFFER is nil the current buffer is assumed."
1396 "Rename mailbox OLDNAME to NEWNAME on server in BUFFER.
1397 If BUFFER is nil the current buffer is assumed."
1406 "Return a list of subscribed mailboxes on server in BUFFER.
1407 If ROOT is non-nil, only list matching mailboxes. If ADD-DELIMITER is
1408 non-nil, a hierarchy delimiter is added to root. REFERENCE is an
1409 implementation-specific string that has to be passed to lsub command."
1411 ;; Make sure we know the hierarchy separator for root's hierarchy
1415 ;; clear list data (NB not delimiter and other stuff)
1430 "Return a list of mailboxes matching ROOT on server in BUFFER.
1431 If ADD-DELIMITER is non-nil, a hierarchy delimiter is added to
1432 root. REFERENCE is an implementation-specific string that has to be
1433 passed to list command."
1435 ;; Make sure we know the hierarchy separator for root's hierarchy
1439 ;; clear list data (NB not delimiter and other stuff)
1454 "Send the SUBSCRIBE command on the MAILBOX to server in BUFFER.
1455 Returns non-nil if successful."
1462 "Send the SUBSCRIBE command on the MAILBOX to server in BUFFER.
1463 Returns non-nil if successful."
1470 "Get status items ITEM in MAILBOX from server in BUFFER.
1471 ITEMS can be a symbol or a list of symbols, valid symbols are one of
1472 the STATUS data items -- i.e. `messages', `recent', `uidnext', `uidvalidity',
1473 or `unseen'. If ITEMS is a list of symbols, a list of values is
1474 returned, if ITEMS is a symbol only its value is returned."
1483 items
1488 items)
1492 "Send status item requests ITEMS on MAILBOX to server in BUFFER.
1493 ITEMS can be a symbol or a list of symbols, valid symbols are one of
1494 the STATUS data items -- i.e., `messages', `recent', `uidnext', `uidvalidity'
1495 or `unseen'. The IMAP command tag is returned."
1503 items
1507 "Get ACL on MAILBOX from server in BUFFER."
1517 "Change/set ACL for IDENTIFIER to RIGHTS in MAILBOX from server in BUFFER."
1524 identifier
1525 " "
1526 rights))))))
1529 "Remove <id,rights> pairs for IDENTIFIER from MAILBOX on server in BUFFER."
1536 identifier))))))
1538 \f
1539 ;; Message functions:
1543 imap-current-message))
1549 list
1562 range)
1570 uids)
1571 props))))
1574 "Fetch properties PROPS from message set UIDS from server in BUFFER.
1575 UIDS can be a string, number or a list of numbers. If RECEIVE is
1576 non-nil, return these properties."
1582 uids)
1583 props)))
1585 t
1591 receive)
1593 uids)
1600 propname value)
1603 t))
1608 propname)))
1611 "Map a function across each message in `imap-message-data', returning a list."
1617 imap-message-data)
1618 result)))
1664 ;; FIXME: Should this try to use CHARSET? -- fx
1672 nil)
1676 "Return t if FLAG can be permanently saved on articles.
1677 MAILBOX specifies a mailbox on the server in BUFFER."
1703 ;; Cf. http://thread.gmane.org/gmane.emacs.gnus.general/65317/focus=65343
1704 ;; Signal an error if we'd get an integer overflow.
1705 ;;
1706 ;; FIXME: Identify relevant calls to `string-to-number' and replace them with
1707 ;; `imap-string-to-integer'.
1713 number)))
1716 "Like `imap-fetch', but DTRT with Exchange 2007 bug.
1717 However, UIDS here is a cons, where the car is the canonical form
1718 of the UIDS specification, and the cdr is the one which works with
1719 Exchange 2007 or, potentially, other buggy servers.
1720 See `imap-enable-exchange-bug-workaround'."
1721 ;; The first time we get here for a given, we'll try the canonical
1722 ;; form. If we get the known error from the buggy server, set the
1723 ;; flag buffer-locally (to account for connections to multiple
1724 ;; servers), then re-try with the alternative UIDS spec. We don't
1725 ;; unconditionally use the alternative form, since the
1726 ;; currently-used alternatives are seriously inefficient with some
1727 ;; servers (although they are valid).
1728 ;;
1729 ;; FIXME: Maybe it would be cleaner to have a flag to not signal
1730 ;; the error (which otherwise gives a message), and test
1731 ;; `imap-failed-tags'. Also, Other IMAP clients use other forms of
1732 ;; request which work with Exchange, e.g. Claws does "UID FETCH 1:*
1733 ;; (UID)" rather than "FETCH UID 1,*". Is there a good reason not
1734 ;; to do the same?
1736 ;; Binding `debug-on-error' allows us to get the error from
1737 ;; `imap-parse-response' -- it's normally caught by Emacs around
1738 ;; execution of a process filter.
1743 props receive nouidfetch buffer))
1746 ;; This is the Exchange 2007 response. It may be more
1747 ;; robust just to check for a BAD response to the
1748 ;; attempted fetch.
1753 t)
1780 "Copy ARTICLES to MAILBOX on server in BUFFER.
1781 ARTICLES is a string message set. Create mailbox if it doesn't exist,
1782 unless DONT-CREATE is non-nil. On success, return a list with
1783 the UIDVALIDITY of the mailbox the article(s) was copied to as the
1784 first element. The rest of list contains the saved articles' UIDs."
1791 t
1793 ;; removed because of buggy Oracle server
1794 ;; that doesn't send TRYCREATE tags (which
1795 ;; is a MUST according to specifications):
1796 ;;(imap-mailbox-get-1 'trycreate mailbox)
1802 ;; FIXME: Amalgamate with imap-message-copyuid-1, using an extra arg, since it
1803 ;; shares most of the code? -- fx
1825 "Append ARTICLE (a buffer) to MAILBOX on server in BUFFER.
1826 FLAGS and DATE-TIME is currently not used. Return a cons holding
1827 uidvalidity of MAILBOX and UID the newly created article got, or nil
1828 on failure."
1838 "Return number of lines in article by looking at the mime bodystructure BODY."
1852 "Return a FROM string line."
1857 "@"
1861 \f
1862 ;; Internal functions.
1876 cmd cmdstr)
1884 size)
1889 ;; XXX modifies buffer!
1918 nil ;; abort command if no cont-req
1920 command)))
1926 tag)))
1935 message-log-max)
1944 ;; A process can die _before_ we have processed everything it
1945 ;; has to say. Moreover, this can happen in between the call to
1946 ;; accept-process-output and the call to process-status in an
1947 ;; iteration of the loop above.
1956 'INCOMPLETE
1963 "Return point at end of current line, taking into account literals.
1964 Return nil if no complete line has arrived."
1966 imap-server-eol)
1967 nil t)
1970 nil
1976 "IMAP process filter."
1977 ;; Sometimes, we are called even though the process has died.
1978 ;; Better abstain from doing stuff in that case.
2001 imap-state)))
2004 \f
2005 ;; Imap parser.
2010 ;; number = 1*DIGIT
2011 ;; ; Unsigned 32-bit integer
2012 ;; ; (0 <= n < 4,294,967,296)
2020 ;; literal = "{" number "}" CRLF *CHAR8
2021 ;; ; Number represents the number of CHAR8s
2028 nil
2032 ;; string = quoted / literal
2033 ;;
2034 ;; quoted = DQUOTE *QUOTED-CHAR DQUOTE
2035 ;;
2036 ;; QUOTED-CHAR = <any TEXT-CHAR except quoted-specials> /
2037 ;; "\" quoted-specials
2038 ;;
2039 ;; quoted-specials = DQUOTE / "\"
2040 ;;
2041 ;; TEXT-CHAR = <any CHAR except CR and LF>
2055 name))
2059 ;; nil = "NIL"
2065 ;; nstring = string / nil
2070 nil)))
2072 ;; astring = atom / string
2073 ;;
2074 ;; atom = 1*ATOM-CHAR
2075 ;;
2076 ;; ATOM-CHAR = <any CHAR except atom-specials>
2077 ;;
2078 ;; atom-specials = "(" / ")" / "{" / SP / CTL / list-wildcards /
2079 ;; quoted-specials
2080 ;;
2081 ;; list-wildcards = "%" / "*"
2082 ;;
2083 ;; quoted-specials = DQUOTE / "\"
2093 ;; address = "(" addr-name SP addr-adl SP addr-mailbox SP
2094 ;; addr-host ")"
2095 ;;
2096 ;; addr-adl = nstring
2097 ;; ; Holds route from [RFC-822] route-addr if
2098 ;; ; non-nil
2099 ;;
2100 ;; addr-host = nstring
2101 ;; ; nil indicates [RFC-822] group syntax.
2102 ;; ; Otherwise, holds [RFC-822] domain name
2103 ;;
2104 ;; addr-mailbox = nstring
2105 ;; ; nil indicates end of [RFC-822] group; if
2106 ;; ; non-nil and addr-host is nil, holds
2107 ;; ; [RFC-822] group name.
2108 ;; ; Otherwise, holds [RFC-822] local-part
2109 ;; ; after removing [RFC-822] quoting
2110 ;;
2111 ;; addr-name = nstring
2112 ;; ; If non-nil, holds phrase from [RFC-822]
2113 ;; ; mailbox after removing [RFC-822] quoting
2114 ;;
2129 address))))
2131 ;; address-list = "(" 1*address ")" / nil
2132 ;;
2133 ;; nil = "NIL"
2140 ;; next line for MS Exchange bug
2147 ;; With assert, the code might not be eval'd.
2148 ;; (assert (imap-parse-nil) t "In imap-parse-address-list")
2151 ;; mailbox = "INBOX" / astring
2152 ;; ; INBOX is case-insensitive. All case variants of
2153 ;; ; INBOX (e.g. "iNbOx") MUST be interpreted as INBOX
2154 ;; ; not as an astring. An astring which consists of
2155 ;; ; the case-insensitive sequence "I" "N" "B" "O" "X"
2156 ;; ; is considered to be INBOX and not an astring.
2157 ;; ; Refer to section 5.1 for further
2158 ;; ; semantic details of mailbox names.
2163 "INBOX"
2164 mailbox)))
2166 ;; greeting = "*" SP (resp-cond-auth / resp-cond-bye) CRLF
2167 ;;
2168 ;; resp-cond-auth = ("OK" / "PREAUTH") SP resp-text
2169 ;; ; Authentication condition
2170 ;;
2171 ;; resp-cond-bye = "BYE" SP resp-text
2174 "Parse an IMAP greeting."
2182 ;; response = *(continue-req / response-data) response-done
2183 ;;
2184 ;; continue-req = "+" SP (resp-text / base64) CRLF
2185 ;;
2186 ;; response-data = "*" SP (resp-cond-state / resp-cond-bye /
2187 ;; mailbox-data / message-data / capability-data) CRLF
2188 ;;
2189 ;; response-done = response-tagged / response-fatal
2190 ;;
2191 ;; response-fatal = "*" SP resp-cond-bye CRLF
2192 ;; ; Server closes connection immediately
2193 ;;
2194 ;; response-tagged = tag SP resp-cond-state CRLF
2195 ;;
2196 ;; resp-cond-state = ("OK" / "NO" / "BAD") SP resp-text
2197 ;; ; Status condition
2198 ;;
2199 ;; resp-cond-bye = "BYE" SP resp-text
2200 ;;
2201 ;; mailbox-data = "FLAGS" SP flag-list /
2202 ;; "LIST" SP mailbox-list /
2203 ;; "LSUB" SP mailbox-list /
2204 ;; "SEARCH" *(SP nz-number) /
2205 ;; "STATUS" SP mailbox SP "("
2206 ;; [status-att SP number *(SP status-att SP number)] ")" /
2207 ;; number SP "EXISTS" /
2208 ;; number SP "RECENT"
2209 ;;
2210 ;; message-data = nz-number SP ("EXPUNGE" / ("FETCH" SP msg-att))
2211 ;;
2212 ;; capability-data = "CAPABILITY" *(SP capability) SP "IMAP4rev1"
2213 ;; *(SP capability)
2214 ;; ; IMAP4rev1 servers which offer RFC 1730
2215 ;; ; compatibility MUST list "IMAP4" as the first
2216 ;; ; capability.
2219 "Parse an IMAP command response."
2225 t)))
2236 'search
2272 imap-failed-tags))))
2285 token status code text))))
2292 ;; resp-text = ["[" resp-text-code "]" SP] text
2293 ;;
2294 ;; text = 1*TEXT-CHAR
2295 ;;
2296 ;; TEXT-CHAR = <any CHAR except CR and LF>
2301 ;; resp-text-code = "ALERT" /
2302 ;; "BADCHARSET [SP "(" astring *(SP astring) ")" ] /
2303 ;; "NEWNAME" SP string SP string /
2304 ;; "PARSE" /
2305 ;; "PERMANENTFLAGS" SP "("
2306 ;; [flag-perm *(SP flag-perm)] ")" /
2307 ;; "READ-ONLY" /
2308 ;; "READ-WRITE" /
2309 ;; "TRYCREATE" /
2310 ;; "UIDNEXT" SP nz-number /
2311 ;; "UIDVALIDITY" SP nz-number /
2312 ;; "UNSEEN" SP nz-number /
2313 ;; resp-text-atom [SP 1*<any TEXT-CHAR except "]">]
2314 ;;
2315 ;; resp_code_apnd = "APPENDUID" SPACE nz_number SPACE uniqueid
2316 ;;
2317 ;; resp_code_copy = "COPYUID" SPACE nz_number SPACE set SPACE set
2318 ;;
2319 ;; set = sequence-num / (sequence-num ":" sequence-num) /
2320 ;; (set "," set)
2321 ;; ; Identifies a set of messages. For message
2322 ;; ; sequence numbers, these are consecutive
2323 ;; ; numbers from 1 to the number of messages in
2324 ;; ; the mailbox
2325 ;; ; Comma delimits individual numbers, colon
2326 ;; ; delimits between two numbers inclusive.
2327 ;; ; Example: 2,4:7,9,12:* is 2,4,5,6,7,9,12,13,
2328 ;; ; 14,15 for a mailbox with 15 messages.
2329 ;;
2330 ;; sequence-num = nz-number / "*"
2331 ;; ; * is the largest number in use. For message
2332 ;; ; sequence numbers, it is the number of messages
2333 ;; ; in the mailbox. For unique identifiers, it is
2334 ;; ; the unique identifier of the last message in
2335 ;; ; the mailbox.
2336 ;;
2337 ;; flag-perm = flag / "\*"
2338 ;;
2339 ;; flag = "\Answered" / "\Flagged" / "\Deleted" /
2340 ;; "\Seen" / "\Draft" / flag-keyword / flag-extension
2341 ;; ; Does not include "\Recent"
2342 ;;
2343 ;; flag-extension = "\" atom
2344 ;; ; Future expansion. Client implementations
2345 ;; ; MUST accept flag-extension flags. Server
2346 ;; ; implementations MUST NOT generate
2347 ;; ; flag-extension flags except as defined by
2348 ;; ; future standard or standards-track
2349 ;; ; revisions of this specification.
2350 ;;
2351 ;; flag-keyword = atom
2352 ;;
2353 ;; resp-text-atom = 1*<any ATOM-CHAR except "]">
2356 ;; xxx next line for stalker communigate pro 3.3.1 bug
2383 imap-current-target-mailbox))
2388 imap-current-target-mailbox))
2393 ;; mailbox-list = "(" [mbx-list-flags] ")" SP
2394 ;; (DQUOTE QUOTED-CHAR DQUOTE / nil) SP mailbox
2395 ;;
2396 ;; mbx-list-flags = *(mbx-list-oflag SP) mbx-list-sflag
2397 ;; *(SP mbx-list-oflag) /
2398 ;; mbx-list-oflag *(SP mbx-list-oflag)
2399 ;;
2400 ;; mbx-list-oflag = "\Noinferiors" / flag-extension
2401 ;; ; Other flags; multiple possible per LIST response
2402 ;;
2403 ;; mbx-list-sflag = "\Noselect" / "\Marked" / "\Unmarked"
2404 ;; ; Selectability flags; only one per LIST response
2405 ;;
2406 ;; QUOTED-CHAR = <any TEXT-CHAR except quoted-specials> /
2407 ;; "\" quoted-specials
2408 ;;
2409 ;; quoted-specials = DQUOTE / "\"
2422 ;; msg_att ::= "(" 1#("ENVELOPE" SPACE envelope /
2423 ;; "FLAGS" SPACE "(" #(flag / "\Recent") ")" /
2424 ;; "INTERNALDATE" SPACE date_time /
2425 ;; "RFC822" [".HEADER" / ".TEXT"] SPACE nstring /
2426 ;; "RFC822.SIZE" SPACE number /
2427 ;; "BODY" ["STRUCTURE"] SPACE body /
2428 ;; "BODY" section ["<" number ">"] SPACE nstring /
2429 ;; "UID" SPACE uniqueid) ")"
2430 ;;
2431 ;; date_time ::= <"> date_day_fixed "-" date_month "-" date_year
2432 ;; SPACE time SPACE zone <">
2433 ;;
2434 ;; section ::= "[" [section_text / (nz_number *["." nz_number]
2435 ;; ["." (section_text / "MIME")])] "]"
2436 ;;
2437 ;; section_text ::= "HEADER" / "HEADER.FIELDS" [".NOT"]
2438 ;; SPACE header_list / "TEXT"
2439 ;;
2440 ;; header_fld_name ::= astring
2441 ;;
2442 ;; header_list ::= "(" 1#header_fld_name ")"
2460 section)))
2465 rfc822size body bodydetail bodystructure flags-empty)
2466 ;; Courier can insert spurious blank characters which will
2467 ;; confuse `read', so skip past them.
2503 bodydetail)
2522 ;; mailbox-data = ...
2523 ;; "STATUS" SP mailbox SP "("
2524 ;; [status-att SP number
2525 ;; *(SP status-att SP number)] ")"
2526 ;; ...
2527 ;;
2528 ;; status-att = "MESSAGES" / "RECENT" / "UIDNEXT" / "UIDVALIDITY" /
2529 ;; "UNSEEN"
2557 token mailbox)
2560 ;; acl_data ::= "ACL" SPACE mailbox *(SPACE identifier SPACE
2561 ;; rights)
2562 ;;
2563 ;; identifier ::= astring
2564 ;;
2565 ;; rights ::= astring
2569 identifier rights acl)
2578 ;; flag-list = "(" [flag *(SP flag)] ")"
2579 ;;
2580 ;; flag = "\Answered" / "\Flagged" / "\Deleted" /
2581 ;; "\Seen" / "\Draft" / flag-keyword / flag-extension
2582 ;; ; Does not include "\Recent"
2583 ;;
2584 ;; flag-keyword = atom
2585 ;;
2586 ;; flag-extension = "\" atom
2587 ;; ; Future expansion. Client implementations
2588 ;; ; MUST accept flag-extension flags. Server
2589 ;; ; implementations MUST NOT generate
2590 ;; ; flag-extension flags except as defined by
2591 ;; ; future standard or standards-track
2592 ;; ; revisions of this specification.
2600 ;; next line for Courier IMAP bug.
2609 ;; envelope = "(" env-date SP env-subject SP env-from SP env-sender SP
2610 ;; env-reply-to SP env-to SP env-cc SP env-bcc SP
2611 ;; env-in-reply-to SP env-message-id ")"
2612 ;;
2613 ;; env-bcc = "(" 1*address ")" / nil
2614 ;;
2615 ;; env-cc = "(" 1*address ")" / nil
2616 ;;
2617 ;; env-date = nstring
2618 ;;
2619 ;; env-from = "(" 1*address ")" / nil
2620 ;;
2621 ;; env-in-reply-to = nstring
2622 ;;
2623 ;; env-message-id = nstring
2624 ;;
2625 ;; env-reply-to = "(" 1*address ")" / nil
2626 ;;
2627 ;; env-sender = "(" 1*address ")" / nil
2628 ;;
2629 ;; env-subject = nstring
2630 ;;
2631 ;; env-to = "(" 1*address ")" / nil
2657 ;; body-fld-param = "(" string SP string *(SP string SP string) ")" / nil
2665 ;; buggy stalker communigate pro 3.0 doesn't print SPC
2666 ;; between body-fld-param's sometimes
2671 nil)))
2673 ;; body-extension = nstring / number /
2674 ;; "(" body-extension *(SP body-extension) ")"
2675 ;; ; Future expansion. Client implementations
2676 ;; ; MUST accept body-extension fields. Server
2677 ;; ; implementations MUST NOT generate
2678 ;; ; body-extension fields except as defined by
2679 ;; ; future standard or standards-track
2680 ;; ; revisions of this specification.
2696 ;; body-ext-1part = body-fld-md5 [SP body-fld-dsp [SP body-fld-lang
2697 ;; *(SP body-extension)]]
2698 ;; ; MUST NOT be returned on non-extensible
2699 ;; ; "BODY" fetch
2700 ;;
2701 ;; body-ext-mpart = body-fld-param [SP body-fld-dsp [SP body-fld-lang
2702 ;; *(SP body-extension)]]
2703 ;; ; MUST NOT be returned on non-extensible
2704 ;; ; "BODY" fetch
2718 ;; With assert, the code might not be eval'd.
2719 ;; (assert (imap-parse-nil) t "In imap-parse-body-ext")
2730 ext))
2732 ;; body = "(" body-type-1part / body-type-mpart ")"
2733 ;;
2734 ;; body-ext-1part = body-fld-md5 [SP body-fld-dsp [SP body-fld-lang
2735 ;; *(SP body-extension)]]
2736 ;; ; MUST NOT be returned on non-extensible
2737 ;; ; "BODY" fetch
2738 ;;
2739 ;; body-ext-mpart = body-fld-param [SP body-fld-dsp [SP body-fld-lang
2740 ;; *(SP body-extension)]]
2741 ;; ; MUST NOT be returned on non-extensible
2742 ;; ; "BODY" fetch
2743 ;;
2744 ;; body-fields = body-fld-param SP body-fld-id SP body-fld-desc SP
2745 ;; body-fld-enc SP body-fld-octets
2746 ;;
2747 ;; body-fld-desc = nstring
2748 ;;
2749 ;; body-fld-dsp = "(" string SP body-fld-param ")" / nil
2750 ;;
2751 ;; body-fld-enc = (DQUOTE ("7BIT" / "8BIT" / "BINARY" / "BASE64"/
2752 ;; "QUOTED-PRINTABLE") DQUOTE) / string
2753 ;;
2754 ;; body-fld-id = nstring
2755 ;;
2756 ;; body-fld-lang = nstring / "(" string *(SP string) ")"
2757 ;;
2758 ;; body-fld-lines = number
2759 ;;
2760 ;; body-fld-md5 = nstring
2761 ;;
2762 ;; body-fld-octets = number
2763 ;;
2764 ;; body-fld-param = "(" string SP string *(SP string SP string) ")" / nil
2765 ;;
2766 ;; body-type-1part = (body-type-basic / body-type-msg / body-type-text)
2767 ;; [SP body-ext-1part]
2768 ;;
2769 ;; body-type-basic = media-basic SP body-fields
2770 ;; ; MESSAGE subtype MUST NOT be "RFC822"
2771 ;;
2772 ;; body-type-msg = media-message SP body-fields SP envelope
2773 ;; SP body SP body-fld-lines
2774 ;;
2775 ;; body-type-text = media-text SP body-fields SP body-fld-lines
2776 ;;
2777 ;; body-type-mpart = 1*body SP media-subtype
2778 ;; [SP body-ext-mpart]
2779 ;;
2780 ;; media-basic = ((DQUOTE ("APPLICATION" / "AUDIO" / "IMAGE" /
2781 ;; "MESSAGE" / "VIDEO") DQUOTE) / string) SP media-subtype
2782 ;; ; Defined in [MIME-IMT]
2783 ;;
2784 ;; media-message = DQUOTE "MESSAGE" DQUOTE SP DQUOTE "RFC822" DQUOTE
2785 ;; ; Defined in [MIME-IMT]
2786 ;;
2787 ;; media-subtype = string
2788 ;; ; Defined in [MIME-IMT]
2789 ;;
2790 ;; media-text = DQUOTE "TEXT" DQUOTE SP media-subtype
2791 ;; ; Defined in [MIME-IMT]
2801 ;; buggy stalker communigate pro 3.0 inserts a SPC between
2802 ;; parts in multiparts
2824 ;; next line for Sun SIMS bug
2834 ;; Next `or' for Sun SIMS bug. It regards body-fld-enc as a
2835 ;; nstring and returns nil instead of defaulting back to 7BIT
2836 ;; as the standard says.
2837 ;; Exchange (2007, at least) does this as well.
2840 ;; Exchange 2007 can return -1, contrary to the spec...
2847 ;; Ok, we're done parsing the required parts, what comes now is one of
2848 ;; three things:
2849 ;;
2850 ;; envelope (then we're parsing body-type-msg)
2851 ;; body-fld-lines (then we're parsing body-type-text)
2852 ;; body-ext-1part (then we're parsing body-type-basic)
2853 ;;
2854 ;; The problem is that the two first are in turn optionally followed
2855 ;; by the third. So we parse the first two here (if there are any)...
2864 ;; buggy stalker communigate pro 3.0 doesn't print
2865 ;; number of lines in message/rfc822 attachment
2875 ;; ...and then parse the third one here...
2890 '(
2891 imap-utf7-encode
2892 imap-utf7-decode
2893 imap-error-text
2894 imap-kerberos4s-p
2895 imap-kerberos4-open
2896 imap-network-p
2897 imap-network-open
2898 imap-interactive-login
2899 imap-kerberos4a-p
2900 imap-kerberos4-auth
2901 imap-cram-md5-p
2902 imap-cram-md5-auth
2903 imap-login-p
2904 imap-login-auth
2905 imap-anonymous-p
2906 imap-anonymous-auth
2907 imap-open-1
2908 imap-open
2909 imap-opened
2910 imap-ping-server
2911 imap-authenticate
2912 imap-close
2913 imap-capability
2914 imap-namespace
2915 imap-send-command-wait
2916 imap-mailbox-put
2917 imap-mailbox-get
2918 imap-mailbox-map-1
2919 imap-mailbox-map
2920 imap-current-mailbox
2921 imap-current-mailbox-p-1
2922 imap-current-mailbox-p
2923 imap-mailbox-select-1
2924 imap-mailbox-select
2925 imap-mailbox-examine-1
2926 imap-mailbox-examine
2927 imap-mailbox-unselect
2928 imap-mailbox-expunge
2929 imap-mailbox-close
2930 imap-mailbox-create-1
2931 imap-mailbox-create
2932 imap-mailbox-delete
2933 imap-mailbox-rename
2934 imap-mailbox-lsub
2935 imap-mailbox-list
2936 imap-mailbox-subscribe
2937 imap-mailbox-unsubscribe
2938 imap-mailbox-status
2939 imap-mailbox-acl-get
2940 imap-mailbox-acl-set
2941 imap-mailbox-acl-delete
2942 imap-current-message
2943 imap-list-to-message-set
2944 imap-fetch-asynch
2945 imap-fetch
2946 imap-fetch-safe
2947 imap-message-put
2948 imap-message-get
2949 imap-message-map
2950 imap-search
2951 imap-message-flag-permanent-p
2952 imap-message-flags-set
2953 imap-message-flags-del
2954 imap-message-flags-add
2955 imap-message-copyuid-1
2956 imap-message-copyuid
2957 imap-message-copy
2958 imap-message-appenduid-1
2959 imap-message-appenduid
2960 imap-message-append
2961 imap-body-lines
2962 imap-envelope-from
2963 imap-send-command-1
2964 imap-send-command
2965 imap-wait-for-tag
2966 imap-sentinel
2967 imap-find-next-line
2968 imap-arrival-filter
2969 imap-parse-greeting
2970 imap-parse-response
2971 imap-parse-resp-text
2972 imap-parse-resp-text-code
2973 imap-parse-data-list
2974 imap-parse-fetch
2975 imap-parse-status
2976 imap-parse-acl
2977 imap-parse-flag-list
2978 imap-parse-envelope
2979 imap-parse-body-extension
2980 imap-parse-body
2981 )))
2985 ;;; imap.el ends here