| blob | a47822533e568840a292fc8fe95d8840eae33106 |
1 ;;; imap.el --- imap library
3 ;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
6 ;; Author: Simon Josefsson <simon@josefsson.org>
7 ;; Keywords: mail
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; imap.el is an elisp library providing an interface for talking to
27 ;; IMAP servers.
28 ;;
29 ;; imap.el is roughly divided in two parts, one that parses IMAP
30 ;; responses from the server and storing data into buffer-local
31 ;; variables, and one for utility functions which send commands to
32 ;; server, waits for an answer, and return information. The latter
33 ;; part is layered on top of the previous.
34 ;;
35 ;; The imap.el API consist of the following functions, other functions
36 ;; in this file should not be called directly and the result of doing
37 ;; so are at best undefined.
38 ;;
39 ;; Global commands:
40 ;;
41 ;; imap-open, imap-opened, imap-authenticate, imap-close,
42 ;; imap-capability, imap-namespace, imap-error-text
43 ;;
44 ;; Mailbox commands:
45 ;;
46 ;; imap-mailbox-get, imap-mailbox-map, imap-current-mailbox,
47 ;; imap-current-mailbox-p, imap-search, imap-mailbox-select,
48 ;; imap-mailbox-examine, imap-mailbox-unselect, imap-mailbox-expunge
49 ;; imap-mailbox-close, imap-mailbox-create, imap-mailbox-delete
50 ;; imap-mailbox-rename, imap-mailbox-lsub, imap-mailbox-list
51 ;; imap-mailbox-subscribe, imap-mailbox-unsubscribe, imap-mailbox-status
52 ;; imap-mailbox-acl-get, imap-mailbox-acl-set, imap-mailbox-acl-delete
53 ;;
54 ;; Message commands:
55 ;;
56 ;; imap-fetch-asynch, imap-fetch,
57 ;; imap-current-message, imap-list-to-message-set,
58 ;; imap-message-get, imap-message-map
59 ;; imap-message-envelope-date, imap-message-envelope-subject,
60 ;; imap-message-envelope-from, imap-message-envelope-sender,
61 ;; imap-message-envelope-reply-to, imap-message-envelope-to,
62 ;; imap-message-envelope-cc, imap-message-envelope-bcc
63 ;; imap-message-envelope-in-reply-to, imap-message-envelope-message-id
64 ;; imap-message-body, imap-message-flag-permanent-p
65 ;; imap-message-flags-set, imap-message-flags-del
66 ;; imap-message-flags-add, imap-message-copyuid
67 ;; imap-message-copy, imap-message-appenduid
68 ;; imap-message-append, imap-envelope-from
69 ;; imap-body-lines
70 ;;
71 ;; It is my hope that these commands should be pretty self
72 ;; explanatory for someone that know IMAP. All functions have
73 ;; additional documentation on how to invoke them.
74 ;;
75 ;; imap.el supports RFC1730/2060/RFC3501 (IMAP4/IMAP4rev1). The implemented
76 ;; IMAP extensions are RFC2195 (CRAM-MD5), RFC2086 (ACL), RFC2342
77 ;; (NAMESPACE), RFC2359 (UIDPLUS), the IMAP-part of RFC2595 (STARTTLS,
78 ;; LOGINDISABLED) (with use of external library starttls.el and
79 ;; program starttls), and the GSSAPI / Kerberos V4 sections of RFC1731
80 ;; (with use of external program `imtest'), and RFC2971 (ID). It also
81 ;; takes advantage of the UNSELECT extension in Cyrus IMAPD.
82 ;;
83 ;; Without the work of John McClary Prevost and Jim Radford this library
84 ;; would not have seen the light of day. Many thanks.
85 ;;
86 ;; This is a transcript of a short interactive session for demonstration
87 ;; purposes.
88 ;;
89 ;; (imap-open "my.mail.server")
90 ;; => " *imap* my.mail.server:0"
91 ;;
92 ;; The rest are invoked with current buffer as the buffer returned by
93 ;; `imap-open'. It is possible to do it all without this, but it would
94 ;; look ugly here since `buffer' is always the last argument for all
95 ;; imap.el API functions.
96 ;;
97 ;; (imap-authenticate "myusername" "mypassword")
98 ;; => auth
99 ;;
100 ;; (imap-mailbox-lsub "*")
101 ;; => ("INBOX.sentmail" "INBOX.private" "INBOX.draft" "INBOX.spam")
102 ;;
103 ;; (imap-mailbox-list "INBOX.n%")
104 ;; => ("INBOX.namedroppers" "INBOX.nnimap" "INBOX.ntbugtraq")
105 ;;
106 ;; (imap-mailbox-select "INBOX.nnimap")
107 ;; => "INBOX.nnimap"
108 ;;
109 ;; (imap-mailbox-get 'exists)
110 ;; => 166
111 ;;
112 ;; (imap-mailbox-get 'uidvalidity)
113 ;; => "908992622"
114 ;;
115 ;; (imap-search "FLAGGED SINCE 18-DEC-98")
116 ;; => (235 236)
117 ;;
118 ;; (imap-fetch 235 "RFC822.PEEK" 'RFC822)
119 ;; => "X-Sieve: cmu-sieve 1.3^M\nX-Username: <jas@pdc.kth.se>^M\r...."
120 ;;
121 ;; Todo:
122 ;;
123 ;; o Parse UIDs as strings? We need to overcome the 28 bit limit somehow.
124 ;; Use IEEE floats (which are effectively exact)? -- fx
125 ;; o Don't use `read' at all (important places already fixed)
126 ;; o Accept list of articles instead of message set string in most
127 ;; imap-message-* functions.
128 ;; o Send strings as literal if they contain, e.g., ".
129 ;;
130 ;; Revision history:
131 ;;
132 ;; - 19991218 added starttls/digest-md5 patch,
133 ;; by Daiki Ueno <ueno@ueda.info.waseda.ac.jp>
134 ;; NB! you need SLIM for starttls.el and digest-md5.el
135 ;; - 19991023 committed to pgnus
136 ;;
138 ;;; Code:
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 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:
523 cmd done)
532 name buffer shell-file-name shell-command-switch
534 cmd
536 ?s server
538 ?l imap-default-user))))
539 response)
543 imap-calculate-literal-size-first t)
547 ;; Athena IMTEST can output SSL verify errors
550 t)
553 t)
554 ;; cyrus 1.6.x (13? < x <= 22) queries capabilities
557 t)
558 ;; cyrus 1.6 imtest print "S: " before server greeting
561 t)
563 ;; success in imtest < 1.6:
566 ;; success in imtest 1.6:
587 nil)))))
588 done))
595 cmd done)
604 name buffer shell-file-name shell-command-switch
606 cmd
608 ?s server
610 ?l imap-default-user))))
611 response)
615 imap-calculate-literal-size-first t)
619 ;; Athena IMTEST can output SSL verify errors
622 t)
625 t)
626 ;; cyrus 1.6.x (13? < x <= 22) queries capabilities
629 t)
630 ;; cyrus 1.6 imtest print "S: " before server greeting
633 t)
634 ;; GNU SASL may print 'Trying ...' first.
637 t)
639 ;; success in imtest 1.6:
642 "Client authentication "
644 nil t)
662 nil)))))
663 done))
666 nil)
669 "Open an SSL connection to SERVER."
672 cmd done)
682 'set-process-query-on-exit-flag
684 process)
687 name buffer shell-file-name
688 shell-command-switch
691 ?s server
694 process)
716 done)
718 nil)))
721 nil)
730 ;; FIXME: Per the "blue moon" comment, the process/buffer
731 ;; handling here, and elsewhere in functions which open
732 ;; streams, looks confused. Obviously we can change buffers
733 ;; if a different process handler kicks in from
734 ;; `accept-process-output' or `sit-for' below, and TRT seems
735 ;; to be to `save-buffer' around those calls. (I wonder why
736 ;; `sit-for' is used with a non-zero wait.) -- fx
750 process))))
753 t)
774 process))))
777 nil)
782 cmd done)
790 name buffer shell-file-name shell-command-switch
792 cmd
794 ?s server
795 ?g imap-shell-host
797 ?l imap-default-user)))))
818 done)
820 nil)))
830 done tls-info)
859 done))
861 ;; Server functions; authenticator stuff:
864 "Login to server in BUFFER.
865 LOGINFUNC is passed a username and a password, it should return t if
866 it where successful authenticating itself to the server, nil otherwise.
867 Returns t if login was successful, nil otherwise."
872 ;; (condition-case ()
883 imap-server " (using authenticator `"
890 imap-username user)
899 ;; (quit (with-current-buffer buffer
900 ;; (setq user nil
901 ;; passwd nil)))
902 ;; (error (with-current-buffer buffer
903 ;; (setq user nil
904 ;; passwd nil))))
905 ret)))
928 "Login to server using the AUTH CRAM-MD5 method."
931 buffer
936 "AUTHENTICATE CRAM-MD5"
942 encoded)))))))))
962 "Login to server using the LOGIN command."
974 t)
983 ;;; Compiler directives.
996 mecs))
1012 "Login to server using the SASL method."
1019 logged user)
1035 buffer)))
1045 logged t)
1048 logged)))
1057 "Login to server using the AUTH DIGEST-MD5 method."
1060 buffer
1065 "AUTHENTICATE DIGEST-MD5"
1074 user passwd digest-uri)))
1076 )))
1078 nil
1083 ;; Server functions:
1089 imap-current-message nil
1090 imap-state 'initial
1093 imap-stream-alist))
1105 imap-process))))
1108 "Open an IMAP connection to host SERVER at PORT returning a buffer.
1109 If PORT is unspecified, a default value is used (143 except
1110 for SSL which use 993).
1111 STREAM indicates the stream to use, see `imap-streams' for available
1112 streams. If nil, it choices the best stream the server is capable of.
1113 AUTH indicates authenticator to use, see `imap-authenticators' for
1114 available authenticators. If nil, it choices the best stream the
1115 server is capable of.
1116 BUFFER can be a buffer or a name of a buffer, which is created if
1117 necessary. If nil, the buffer name is generated."
1134 nil)
1136 ;; Need to choose stream.
1139 ;; OK to use this stream?
1141 ;; Stream changed?
1157 "imap: Reconnecting with stream `%s'...failed"
1158 stream))
1159 ;; We're done, kill the first connection
1162 buffer
1166 ;; set the passed buffer to the current one,
1167 ;; so that (imap-opened buffer) later will work
1170 stream)
1174 ;; We're done
1181 ;; (debug "opened+state+auth+buffer" (imap-opened buffer) imap-state imap-auth buffer)
1183 buffer))))
1186 "If non-nil, check if IMAP is open.
1187 See the function `imap-ping-server'."
1193 "Return non-nil if connection to imap server in BUFFER is open.
1194 If BUFFER is nil then the current buffer is used."
1202 t)))))
1206 Return non-nil if the server responds, and nil if it does not
1207 respond. If BUFFER is nil, the current buffer is used."
1213 "Authenticate to server in BUFFER, using current buffer if nil.
1214 It uses the authenticator specified when opening the server. If the
1215 authenticator requires username/passwords, they are queried from the
1216 user and optionally stored in the buffer. If USER and/or PASSWD is
1217 specified, the user will not be questioned and the username and/or
1218 password is remembered in the buffer."
1234 ;; Choose authenticator.
1236 auth)
1238 ;; OK to use authenticator?
1243 imap-server auth)
1248 imap-server auth)
1249 ;; set imap-state correctly on successful auth attempt
1251 ;; stop iterating through the authenticator list
1254 imap-server auth)))))
1255 imap-state))))
1258 "Close connection to server in BUFFER.
1259 If BUFFER is nil, the current buffer is used."
1269 imap-current-message nil
1270 imap-process nil)
1272 t))
1275 "Return a list of identifiers which server in BUFFER support.
1276 If IDENTIFIER, return non-nil if it's among the servers capabilities.
1277 If BUFFER is nil, the current buffer is assumed."
1284 imap-capability)))
1287 "Identify client to server in BUFFER, and return server identity.
1288 LIST-OF-VALUES is nil, or a plist with identifier and value
1289 strings to send to the server to identify the client.
1291 Return a list of identifiers which server in BUFFER support, or
1292 nil if it doesn't support ID or returns no information.
1294 If BUFFER is nil, the current buffer is assumed."
1299 "ID NIL"
1302 list-of-values
1304 imap-id)))
1307 "Return a namespace hierarchy at server in BUFFER.
1308 If BUFFER is nil, the current buffer is assumed."
1313 imap-namespace))
1340 \f
1341 ;; Mailbox functions:
1347 propname value)
1350 t))
1354 propname))
1369 imap-mailbox-data)
1370 result)))
1373 "Map a function across each mailbox in `imap-mailbox-data', returning a list.
1374 Function should take a mailbox name (a string) as
1375 the only argument."
1394 "Select MAILBOX on server in BUFFER.
1395 If EXAMINE is non-nil, do a read-only select."
1397 imap-current-mailbox
1405 imap-current-mailbox)
1406 ;; Failed SELECT/EXAMINE unselects current mailbox
1419 "Examine MAILBOX on server in BUFFER."
1423 "Close current folder in BUFFER, without expunging articles."
1430 imap-current-mailbox
1434 imap-message-data nil
1436 t)))
1439 "Expunge articles in current folder in BUFFER.
1440 If ASYNCH, do not wait for successful completion of the command.
1441 If BUFFER is nil the current buffer is assumed."
1449 "Expunge articles and close current folder in BUFFER.
1450 If ASYNCH, do not wait for successful completion of the command.
1451 If BUFFER is nil the current buffer is assumed."
1458 imap-current-mailbox status)
1460 imap-current-mailbox)
1461 ;; Don't wipe out data if another mailbox
1462 ;; was selected...
1464 imap-message-data nil
1468 imap-message-data nil
1470 t)))
1476 "Create MAILBOX on server in BUFFER.
1477 If BUFFER is nil the current buffer is assumed."
1482 "Delete MAILBOX on server in BUFFER.
1483 If BUFFER is nil the current buffer is assumed."
1490 "Rename mailbox OLDNAME to NEWNAME on server in BUFFER.
1491 If BUFFER is nil the current buffer is assumed."
1500 "Return a list of subscribed mailboxes on server in BUFFER.
1501 If ROOT is non-nil, only list matching mailboxes. If ADD-DELIMITER is
1502 non-nil, a hierarchy delimiter is added to root. REFERENCE is a
1503 implementation-specific string that has to be passed to lsub command."
1505 ;; Make sure we know the hierarchy separator for root's hierarchy
1509 ;; clear list data (NB not delimiter and other stuff)
1524 "Return a list of mailboxes matching ROOT on server in BUFFER.
1525 If ADD-DELIMITER is non-nil, a hierarchy delimiter is added to
1526 root. REFERENCE is a implementation-specific string that has to be
1527 passed to list command."
1529 ;; Make sure we know the hierarchy separator for root's hierarchy
1533 ;; clear list data (NB not delimiter and other stuff)
1548 "Send the SUBSCRIBE command on the MAILBOX to server in BUFFER.
1549 Returns non-nil if successful."
1556 "Send the SUBSCRIBE command on the MAILBOX to server in BUFFER.
1557 Returns non-nil if successful."
1564 "Get status items ITEM in MAILBOX from server in BUFFER.
1565 ITEMS can be a symbol or a list of symbols, valid symbols are one of
1566 the STATUS data items -- i.e. `messages', `recent', `uidnext', `uidvalidity',
1567 or `unseen'. If ITEMS is a list of symbols, a list of values is
1568 returned, if ITEMS is a symbol only its value is returned."
1577 items
1582 items)
1586 "Send status item request ITEM on MAILBOX to server in BUFFER.
1587 ITEMS can be a symbol or a list of symbols, valid symbols are one of
1588 the STATUS data items -- i.e. 'messages, 'recent, 'uidnext, 'uidvalidity
1589 or 'unseen. The IMAP command tag is returned."
1597 items
1601 "Get ACL on MAILBOX from server in BUFFER."
1611 "Change/set ACL for IDENTIFIER to RIGHTS in MAILBOX from server in BUFFER."
1618 identifier
1619 " "
1620 rights))))))
1623 "Remove any <identifier,rights> pair for IDENTIFIER in MAILBOX from server in BUFFER."
1630 identifier))))))
1632 \f
1633 ;; Message functions:
1637 imap-current-message))
1643 list
1656 range)
1664 uids)
1665 props))))
1668 "Fetch properties PROPS from message set UIDS from server in BUFFER.
1669 UIDS can be a string, number or a list of numbers. If RECEIVE
1670 is non-nil return these properties."
1676 uids)
1677 props)))
1679 t
1685 receive)
1687 uids)
1694 propname value)
1697 t))
1702 propname)))
1705 "Map a function across each message in `imap-message-data', returning a list."
1711 imap-message-data)
1712 result)))
1758 ;; FIXME: Should this try to use CHARSET? -- fx
1766 nil)
1770 "Return t if FLAG can be permanently (between IMAP sessions) saved on articles, in MAILBOX on server in BUFFER."
1796 ;; Cf. http://thread.gmane.org/gmane.emacs.gnus.general/65317/focus=65343
1797 ;; Signal an error if we'd get an integer overflow.
1798 ;;
1799 ;; FIXME: Identify relevant calls to `string-to-number' and replace them with
1800 ;; `imap-string-to-integer'.
1806 number)))
1809 "Like `imap-fetch', but DTRT with Exchange 2007 bug.
1810 However, UIDS here is a cons, where the car is the canonical form
1811 of the UIDS specification, and the cdr is the one which works with
1812 Exchange 2007 or, potentially, other buggy servers.
1813 See `imap-enable-exchange-bug-workaround'."
1814 ;; The first time we get here for a given, we'll try the canonical
1815 ;; form. If we get the known error from the buggy server, set the
1816 ;; flag buffer-locally (to account for connections to multiple
1817 ;; servers), then re-try with the alternative UIDS spec. We don't
1818 ;; unconditionally use the alternative form, since the
1819 ;; currently-used alternatives are seriously inefficient with some
1820 ;; servers (although they are valid).
1821 ;;
1822 ;; FIXME: Maybe it would be cleaner to have a flag to not signal
1823 ;; the error (which otherwise gives a message), and test
1824 ;; `imap-failed-tags'. Also, Other IMAP clients use other forms of
1825 ;; request which work with Exchange, e.g. Claws does "UID FETCH 1:*
1826 ;; (UID)" rather than "FETCH UID 1,*". Is there a good reason not
1827 ;; to do the same?
1829 ;; Binding `debug-on-error' allows us to get the error from
1830 ;; `imap-parse-response' -- it's normally caught by Emacs around
1831 ;; execution of a process filter.
1836 props receive nouidfetch buffer))
1839 ;; This is the Exchange 2007 response. It may be more
1840 ;; robust just to check for a BAD response to the
1841 ;; attempted fetch.
1846 t)
1873 "Copy ARTICLES to MAILBOX on server in BUFFER.
1874 ARTICLES is a string message set. Create mailbox if it doesn't exist,
1875 unless DONT-CREATE is non-nil. On success, return a list with
1876 the UIDVALIDITY of the mailbox the article(s) was copied to as the
1877 first element. The rest of list contains the saved articles' UIDs."
1884 t
1886 ;; removed because of buggy Oracle server
1887 ;; that doesn't send TRYCREATE tags (which
1888 ;; is a MUST according to specifications):
1889 ;;(imap-mailbox-get-1 'trycreate mailbox)
1895 ;; FIXME: Amalgamate with imap-message-copyuid-1, using an extra arg, since it
1896 ;; shares most of the code? -- fx
1918 "Append ARTICLE (a buffer) to MAILBOX on server in BUFFER.
1919 FLAGS and DATE-TIME is currently not used. Return a cons holding
1920 uidvalidity of MAILBOX and UID the newly created article got, or nil
1921 on failure."
1931 "Return number of lines in article by looking at the mime bodystructure BODY."
1945 "Return a from string line."
1950 "@"
1954 \f
1955 ;; Internal functions.
1974 cmd cmdstr)
1982 size)
1987 ;; XXX modifies buffer!
2007 imap-log-buffer)
2022 nil ;; abort command if no cont-req
2024 command)))
2030 tag)))
2039 message-log-max)
2048 ;; A process can die _before_ we have processed everything it
2049 ;; has to say. Moreover, this can happen in between the call to
2050 ;; accept-process-output and the call to process-status in an
2051 ;; iteration of the loop above.
2060 'INCOMPLETE
2067 "Return point at end of current line, taking into account literals.
2068 Return nil if no complete line has arrived."
2070 imap-server-eol)
2071 nil t)
2074 nil
2080 "IMAP process filter."
2081 ;; Sometimes, we are called even though the process has died.
2082 ;; Better abstain from doing stuff in that case.
2110 imap-state)))
2113 \f
2114 ;; Imap parser.
2119 ;; number = 1*DIGIT
2120 ;; ; Unsigned 32-bit integer
2121 ;; ; (0 <= n < 4,294,967,296)
2129 ;; literal = "{" number "}" CRLF *CHAR8
2130 ;; ; Number represents the number of CHAR8s
2137 nil
2141 ;; string = quoted / literal
2142 ;;
2143 ;; quoted = DQUOTE *QUOTED-CHAR DQUOTE
2144 ;;
2145 ;; QUOTED-CHAR = <any TEXT-CHAR except quoted-specials> /
2146 ;; "\" quoted-specials
2147 ;;
2148 ;; quoted-specials = DQUOTE / "\"
2149 ;;
2150 ;; TEXT-CHAR = <any CHAR except CR and LF>
2164 name))
2168 ;; nil = "NIL"
2174 ;; nstring = string / nil
2179 nil)))
2181 ;; astring = atom / string
2182 ;;
2183 ;; atom = 1*ATOM-CHAR
2184 ;;
2185 ;; ATOM-CHAR = <any CHAR except atom-specials>
2186 ;;
2187 ;; atom-specials = "(" / ")" / "{" / SP / CTL / list-wildcards /
2188 ;; quoted-specials
2189 ;;
2190 ;; list-wildcards = "%" / "*"
2191 ;;
2192 ;; quoted-specials = DQUOTE / "\"
2202 ;; address = "(" addr-name SP addr-adl SP addr-mailbox SP
2203 ;; addr-host ")"
2204 ;;
2205 ;; addr-adl = nstring
2206 ;; ; Holds route from [RFC-822] route-addr if
2207 ;; ; non-nil
2208 ;;
2209 ;; addr-host = nstring
2210 ;; ; nil indicates [RFC-822] group syntax.
2211 ;; ; Otherwise, holds [RFC-822] domain name
2212 ;;
2213 ;; addr-mailbox = nstring
2214 ;; ; nil indicates end of [RFC-822] group; if
2215 ;; ; non-nil and addr-host is nil, holds
2216 ;; ; [RFC-822] group name.
2217 ;; ; Otherwise, holds [RFC-822] local-part
2218 ;; ; after removing [RFC-822] quoting
2219 ;;
2220 ;; addr-name = nstring
2221 ;; ; If non-nil, holds phrase from [RFC-822]
2222 ;; ; mailbox after removing [RFC-822] quoting
2223 ;;
2238 address))))
2240 ;; address-list = "(" 1*address ")" / nil
2241 ;;
2242 ;; nil = "NIL"
2249 ;; next line for MS Exchange bug
2256 ;; With assert, the code might not be eval'd.
2257 ;; (assert (imap-parse-nil) t "In imap-parse-address-list")
2260 ;; mailbox = "INBOX" / astring
2261 ;; ; INBOX is case-insensitive. All case variants of
2262 ;; ; INBOX (e.g. "iNbOx") MUST be interpreted as INBOX
2263 ;; ; not as an astring. An astring which consists of
2264 ;; ; the case-insensitive sequence "I" "N" "B" "O" "X"
2265 ;; ; is considered to be INBOX and not an astring.
2266 ;; ; Refer to section 5.1 for further
2267 ;; ; semantic details of mailbox names.
2272 "INBOX"
2273 mailbox)))
2275 ;; greeting = "*" SP (resp-cond-auth / resp-cond-bye) CRLF
2276 ;;
2277 ;; resp-cond-auth = ("OK" / "PREAUTH") SP resp-text
2278 ;; ; Authentication condition
2279 ;;
2280 ;; resp-cond-bye = "BYE" SP resp-text
2283 "Parse an IMAP greeting."
2291 ;; response = *(continue-req / response-data) response-done
2292 ;;
2293 ;; continue-req = "+" SP (resp-text / base64) CRLF
2294 ;;
2295 ;; response-data = "*" SP (resp-cond-state / resp-cond-bye /
2296 ;; mailbox-data / message-data / capability-data) CRLF
2297 ;;
2298 ;; response-done = response-tagged / response-fatal
2299 ;;
2300 ;; response-fatal = "*" SP resp-cond-bye CRLF
2301 ;; ; Server closes connection immediately
2302 ;;
2303 ;; response-tagged = tag SP resp-cond-state CRLF
2304 ;;
2305 ;; resp-cond-state = ("OK" / "NO" / "BAD") SP resp-text
2306 ;; ; Status condition
2307 ;;
2308 ;; resp-cond-bye = "BYE" SP resp-text
2309 ;;
2310 ;; mailbox-data = "FLAGS" SP flag-list /
2311 ;; "LIST" SP mailbox-list /
2312 ;; "LSUB" SP mailbox-list /
2313 ;; "SEARCH" *(SP nz-number) /
2314 ;; "STATUS" SP mailbox SP "("
2315 ;; [status-att SP number *(SP status-att SP number)] ")" /
2316 ;; number SP "EXISTS" /
2317 ;; number SP "RECENT"
2318 ;;
2319 ;; message-data = nz-number SP ("EXPUNGE" / ("FETCH" SP msg-att))
2320 ;;
2321 ;; capability-data = "CAPABILITY" *(SP capability) SP "IMAP4rev1"
2322 ;; *(SP capability)
2323 ;; ; IMAP4rev1 servers which offer RFC 1730
2324 ;; ; compatibility MUST list "IMAP4" as the first
2325 ;; ; capability.
2328 "Parse a IMAP command response."
2334 t)))
2345 'search
2381 imap-failed-tags))))
2394 token status code text))))
2401 ;; resp-text = ["[" resp-text-code "]" SP] text
2402 ;;
2403 ;; text = 1*TEXT-CHAR
2404 ;;
2405 ;; TEXT-CHAR = <any CHAR except CR and LF>
2410 ;; resp-text-code = "ALERT" /
2411 ;; "BADCHARSET [SP "(" astring *(SP astring) ")" ] /
2412 ;; "NEWNAME" SP string SP string /
2413 ;; "PARSE" /
2414 ;; "PERMANENTFLAGS" SP "("
2415 ;; [flag-perm *(SP flag-perm)] ")" /
2416 ;; "READ-ONLY" /
2417 ;; "READ-WRITE" /
2418 ;; "TRYCREATE" /
2419 ;; "UIDNEXT" SP nz-number /
2420 ;; "UIDVALIDITY" SP nz-number /
2421 ;; "UNSEEN" SP nz-number /
2422 ;; resp-text-atom [SP 1*<any TEXT-CHAR except "]">]
2423 ;;
2424 ;; resp_code_apnd = "APPENDUID" SPACE nz_number SPACE uniqueid
2425 ;;
2426 ;; resp_code_copy = "COPYUID" SPACE nz_number SPACE set SPACE set
2427 ;;
2428 ;; set = sequence-num / (sequence-num ":" sequence-num) /
2429 ;; (set "," set)
2430 ;; ; Identifies a set of messages. For message
2431 ;; ; sequence numbers, these are consecutive
2432 ;; ; numbers from 1 to the number of messages in
2433 ;; ; the mailbox
2434 ;; ; Comma delimits individual numbers, colon
2435 ;; ; delimits between two numbers inclusive.
2436 ;; ; Example: 2,4:7,9,12:* is 2,4,5,6,7,9,12,13,
2437 ;; ; 14,15 for a mailbox with 15 messages.
2438 ;;
2439 ;; sequence-num = nz-number / "*"
2440 ;; ; * is the largest number in use. For message
2441 ;; ; sequence numbers, it is the number of messages
2442 ;; ; in the mailbox. For unique identifiers, it is
2443 ;; ; the unique identifier of the last message in
2444 ;; ; the mailbox.
2445 ;;
2446 ;; flag-perm = flag / "\*"
2447 ;;
2448 ;; flag = "\Answered" / "\Flagged" / "\Deleted" /
2449 ;; "\Seen" / "\Draft" / flag-keyword / flag-extension
2450 ;; ; Does not include "\Recent"
2451 ;;
2452 ;; flag-extension = "\" atom
2453 ;; ; Future expansion. Client implementations
2454 ;; ; MUST accept flag-extension flags. Server
2455 ;; ; implementations MUST NOT generate
2456 ;; ; flag-extension flags except as defined by
2457 ;; ; future standard or standards-track
2458 ;; ; revisions of this specification.
2459 ;;
2460 ;; flag-keyword = atom
2461 ;;
2462 ;; resp-text-atom = 1*<any ATOM-CHAR except "]">
2465 ;; xxx next line for stalker communigate pro 3.3.1 bug
2492 imap-current-target-mailbox))
2497 imap-current-target-mailbox))
2502 ;; mailbox-list = "(" [mbx-list-flags] ")" SP
2503 ;; (DQUOTE QUOTED-CHAR DQUOTE / nil) SP mailbox
2504 ;;
2505 ;; mbx-list-flags = *(mbx-list-oflag SP) mbx-list-sflag
2506 ;; *(SP mbx-list-oflag) /
2507 ;; mbx-list-oflag *(SP mbx-list-oflag)
2508 ;;
2509 ;; mbx-list-oflag = "\Noinferiors" / flag-extension
2510 ;; ; Other flags; multiple possible per LIST response
2511 ;;
2512 ;; mbx-list-sflag = "\Noselect" / "\Marked" / "\Unmarked"
2513 ;; ; Selectability flags; only one per LIST response
2514 ;;
2515 ;; QUOTED-CHAR = <any TEXT-CHAR except quoted-specials> /
2516 ;; "\" quoted-specials
2517 ;;
2518 ;; quoted-specials = DQUOTE / "\"
2531 ;; msg_att ::= "(" 1#("ENVELOPE" SPACE envelope /
2532 ;; "FLAGS" SPACE "(" #(flag / "\Recent") ")" /
2533 ;; "INTERNALDATE" SPACE date_time /
2534 ;; "RFC822" [".HEADER" / ".TEXT"] SPACE nstring /
2535 ;; "RFC822.SIZE" SPACE number /
2536 ;; "BODY" ["STRUCTURE"] SPACE body /
2537 ;; "BODY" section ["<" number ">"] SPACE nstring /
2538 ;; "UID" SPACE uniqueid) ")"
2539 ;;
2540 ;; date_time ::= <"> date_day_fixed "-" date_month "-" date_year
2541 ;; SPACE time SPACE zone <">
2542 ;;
2543 ;; section ::= "[" [section_text / (nz_number *["." nz_number]
2544 ;; ["." (section_text / "MIME")])] "]"
2545 ;;
2546 ;; section_text ::= "HEADER" / "HEADER.FIELDS" [".NOT"]
2547 ;; SPACE header_list / "TEXT"
2548 ;;
2549 ;; header_fld_name ::= astring
2550 ;;
2551 ;; header_list ::= "(" 1#header_fld_name ")"
2569 section)))
2574 rfc822size body bodydetail bodystructure flags-empty)
2575 ;; Courier can insert spurious blank characters which will
2576 ;; confuse `read', so skip past them.
2612 bodydetail)
2631 ;; mailbox-data = ...
2632 ;; "STATUS" SP mailbox SP "("
2633 ;; [status-att SP number
2634 ;; *(SP status-att SP number)] ")"
2635 ;; ...
2636 ;;
2637 ;; status-att = "MESSAGES" / "RECENT" / "UIDNEXT" / "UIDVALIDITY" /
2638 ;; "UNSEEN"
2666 token mailbox)
2669 ;; acl_data ::= "ACL" SPACE mailbox *(SPACE identifier SPACE
2670 ;; rights)
2671 ;;
2672 ;; identifier ::= astring
2673 ;;
2674 ;; rights ::= astring
2678 identifier rights acl)
2687 ;; flag-list = "(" [flag *(SP flag)] ")"
2688 ;;
2689 ;; flag = "\Answered" / "\Flagged" / "\Deleted" /
2690 ;; "\Seen" / "\Draft" / flag-keyword / flag-extension
2691 ;; ; Does not include "\Recent"
2692 ;;
2693 ;; flag-keyword = atom
2694 ;;
2695 ;; flag-extension = "\" atom
2696 ;; ; Future expansion. Client implementations
2697 ;; ; MUST accept flag-extension flags. Server
2698 ;; ; implementations MUST NOT generate
2699 ;; ; flag-extension flags except as defined by
2700 ;; ; future standard or standards-track
2701 ;; ; revisions of this specification.
2709 ;; next line for Courier IMAP bug.
2718 ;; envelope = "(" env-date SP env-subject SP env-from SP env-sender SP
2719 ;; env-reply-to SP env-to SP env-cc SP env-bcc SP
2720 ;; env-in-reply-to SP env-message-id ")"
2721 ;;
2722 ;; env-bcc = "(" 1*address ")" / nil
2723 ;;
2724 ;; env-cc = "(" 1*address ")" / nil
2725 ;;
2726 ;; env-date = nstring
2727 ;;
2728 ;; env-from = "(" 1*address ")" / nil
2729 ;;
2730 ;; env-in-reply-to = nstring
2731 ;;
2732 ;; env-message-id = nstring
2733 ;;
2734 ;; env-reply-to = "(" 1*address ")" / nil
2735 ;;
2736 ;; env-sender = "(" 1*address ")" / nil
2737 ;;
2738 ;; env-subject = nstring
2739 ;;
2740 ;; env-to = "(" 1*address ")" / nil
2766 ;; body-fld-param = "(" string SP string *(SP string SP string) ")" / nil
2774 ;; buggy stalker communigate pro 3.0 doesn't print SPC
2775 ;; between body-fld-param's sometimes
2780 nil)))
2782 ;; body-extension = nstring / number /
2783 ;; "(" body-extension *(SP body-extension) ")"
2784 ;; ; Future expansion. Client implementations
2785 ;; ; MUST accept body-extension fields. Server
2786 ;; ; implementations MUST NOT generate
2787 ;; ; body-extension fields except as defined by
2788 ;; ; future standard or standards-track
2789 ;; ; revisions of this specification.
2805 ;; body-ext-1part = body-fld-md5 [SP body-fld-dsp [SP body-fld-lang
2806 ;; *(SP body-extension)]]
2807 ;; ; MUST NOT be returned on non-extensible
2808 ;; ; "BODY" fetch
2809 ;;
2810 ;; body-ext-mpart = body-fld-param [SP body-fld-dsp [SP body-fld-lang
2811 ;; *(SP body-extension)]]
2812 ;; ; MUST NOT be returned on non-extensible
2813 ;; ; "BODY" fetch
2827 ;; With assert, the code might not be eval'd.
2828 ;; (assert (imap-parse-nil) t "In imap-parse-body-ext")
2839 ext))
2841 ;; body = "(" body-type-1part / body-type-mpart ")"
2842 ;;
2843 ;; body-ext-1part = body-fld-md5 [SP body-fld-dsp [SP body-fld-lang
2844 ;; *(SP body-extension)]]
2845 ;; ; MUST NOT be returned on non-extensible
2846 ;; ; "BODY" fetch
2847 ;;
2848 ;; body-ext-mpart = body-fld-param [SP body-fld-dsp [SP body-fld-lang
2849 ;; *(SP body-extension)]]
2850 ;; ; MUST NOT be returned on non-extensible
2851 ;; ; "BODY" fetch
2852 ;;
2853 ;; body-fields = body-fld-param SP body-fld-id SP body-fld-desc SP
2854 ;; body-fld-enc SP body-fld-octets
2855 ;;
2856 ;; body-fld-desc = nstring
2857 ;;
2858 ;; body-fld-dsp = "(" string SP body-fld-param ")" / nil
2859 ;;
2860 ;; body-fld-enc = (DQUOTE ("7BIT" / "8BIT" / "BINARY" / "BASE64"/
2861 ;; "QUOTED-PRINTABLE") DQUOTE) / string
2862 ;;
2863 ;; body-fld-id = nstring
2864 ;;
2865 ;; body-fld-lang = nstring / "(" string *(SP string) ")"
2866 ;;
2867 ;; body-fld-lines = number
2868 ;;
2869 ;; body-fld-md5 = nstring
2870 ;;
2871 ;; body-fld-octets = number
2872 ;;
2873 ;; body-fld-param = "(" string SP string *(SP string SP string) ")" / nil
2874 ;;
2875 ;; body-type-1part = (body-type-basic / body-type-msg / body-type-text)
2876 ;; [SP body-ext-1part]
2877 ;;
2878 ;; body-type-basic = media-basic SP body-fields
2879 ;; ; MESSAGE subtype MUST NOT be "RFC822"
2880 ;;
2881 ;; body-type-msg = media-message SP body-fields SP envelope
2882 ;; SP body SP body-fld-lines
2883 ;;
2884 ;; body-type-text = media-text SP body-fields SP body-fld-lines
2885 ;;
2886 ;; body-type-mpart = 1*body SP media-subtype
2887 ;; [SP body-ext-mpart]
2888 ;;
2889 ;; media-basic = ((DQUOTE ("APPLICATION" / "AUDIO" / "IMAGE" /
2890 ;; "MESSAGE" / "VIDEO") DQUOTE) / string) SP media-subtype
2891 ;; ; Defined in [MIME-IMT]
2892 ;;
2893 ;; media-message = DQUOTE "MESSAGE" DQUOTE SP DQUOTE "RFC822" DQUOTE
2894 ;; ; Defined in [MIME-IMT]
2895 ;;
2896 ;; media-subtype = string
2897 ;; ; Defined in [MIME-IMT]
2898 ;;
2899 ;; media-text = DQUOTE "TEXT" DQUOTE SP media-subtype
2900 ;; ; Defined in [MIME-IMT]
2910 ;; buggy stalker communigate pro 3.0 inserts a SPC between
2911 ;; parts in multiparts
2933 ;; next line for Sun SIMS bug
2943 ;; Next `or' for Sun SIMS bug. It regards body-fld-enc as a
2944 ;; nstring and returns nil instead of defaulting back to 7BIT
2945 ;; as the standard says.
2946 ;; Exchange (2007, at least) does this as well.
2949 ;; Exchange 2007 can return -1, contrary to the spec...
2956 ;; Ok, we're done parsing the required parts, what comes now is one of
2957 ;; three things:
2958 ;;
2959 ;; envelope (then we're parsing body-type-msg)
2960 ;; body-fld-lines (then we're parsing body-type-text)
2961 ;; body-ext-1part (then we're parsing body-type-basic)
2962 ;;
2963 ;; The problem is that the two first are in turn optionally followed
2964 ;; by the third. So we parse the first two here (if there are any)...
2973 ;; buggy stalker communigate pro 3.0 doesn't print
2974 ;; number of lines in message/rfc822 attachment
2984 ;; ...and then parse the third one here...
2999 '(
3000 imap-utf7-encode
3001 imap-utf7-decode
3002 imap-error-text
3003 imap-kerberos4s-p
3004 imap-kerberos4-open
3005 imap-ssl-p
3006 imap-ssl-open
3007 imap-network-p
3008 imap-network-open
3009 imap-interactive-login
3010 imap-kerberos4a-p
3011 imap-kerberos4-auth
3012 imap-cram-md5-p
3013 imap-cram-md5-auth
3014 imap-login-p
3015 imap-login-auth
3016 imap-anonymous-p
3017 imap-anonymous-auth
3018 imap-open-1
3019 imap-open
3020 imap-opened
3021 imap-ping-server
3022 imap-authenticate
3023 imap-close
3024 imap-capability
3025 imap-namespace
3026 imap-send-command-wait
3027 imap-mailbox-put
3028 imap-mailbox-get
3029 imap-mailbox-map-1
3030 imap-mailbox-map
3031 imap-current-mailbox
3032 imap-current-mailbox-p-1
3033 imap-current-mailbox-p
3034 imap-mailbox-select-1
3035 imap-mailbox-select
3036 imap-mailbox-examine-1
3037 imap-mailbox-examine
3038 imap-mailbox-unselect
3039 imap-mailbox-expunge
3040 imap-mailbox-close
3041 imap-mailbox-create-1
3042 imap-mailbox-create
3043 imap-mailbox-delete
3044 imap-mailbox-rename
3045 imap-mailbox-lsub
3046 imap-mailbox-list
3047 imap-mailbox-subscribe
3048 imap-mailbox-unsubscribe
3049 imap-mailbox-status
3050 imap-mailbox-acl-get
3051 imap-mailbox-acl-set
3052 imap-mailbox-acl-delete
3053 imap-current-message
3054 imap-list-to-message-set
3055 imap-fetch-asynch
3056 imap-fetch
3057 imap-fetch-safe
3058 imap-message-put
3059 imap-message-get
3060 imap-message-map
3061 imap-search
3062 imap-message-flag-permanent-p
3063 imap-message-flags-set
3064 imap-message-flags-del
3065 imap-message-flags-add
3066 imap-message-copyuid-1
3067 imap-message-copyuid
3068 imap-message-copy
3069 imap-message-appenduid-1
3070 imap-message-appenduid
3071 imap-message-append
3072 imap-body-lines
3073 imap-envelope-from
3074 imap-send-command-1
3075 imap-send-command
3076 imap-wait-for-tag
3077 imap-sentinel
3078 imap-find-next-line
3079 imap-arrival-filter
3080 imap-parse-greeting
3081 imap-parse-response
3082 imap-parse-resp-text
3083 imap-parse-resp-text-code
3084 imap-parse-data-list
3085 imap-parse-fetch
3086 imap-parse-status
3087 imap-parse-acl
3088 imap-parse-flag-list
3089 imap-parse-envelope
3090 imap-parse-body-extension
3091 imap-parse-body
3092 )))
3096 ;; arch-tag: 27369ed6-33e4-482f-96f1-8bb906ba70f7
3097 ;;; imap.el ends here