| blob | 88e897fa32ec199364def6ad95739b762e7730e2 |
1 ;;; imap.el --- imap library
3 ;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007, 2008, 2009 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.
385 "IMAP state.
386 Valid states are `closed', `initial', `nonauth', `auth', `selected'
420 "Identity of server.
430 "Alist of tags that failed.
431 Each element is a list with four elements; tag (a integer), response
432 state (a symbol, `OK', `NO' or `BAD'), response code (a string), and
442 "Non-nil indicates that the server emitted a continuation request.
446 "List of response tags and callbacks, on the form `(number . function)'.
447 The function should take two arguments, the first the IMAP tag and the
451 "Send FETCH UID commands as *:* instead of *.
453 When non-nil, use an alternative UIDS form. Enabling appears to
454 be required for some servers (e.g., Microsoft Exchange 2007)
455 which otherwise would trigger a response 'BAD The specified
456 message set is invalid.'. We don't unconditionally use this
457 form, since this is said to be significantly inefficient.
459 This variable is set to t automatically per server if the
462 \f
463 ;; Utility functions:
466 "Delete by side effect any elements of ALIST whose car is `equal' to KEY.
467 The modified ALIST is returned. If the first member
468 of ALIST has a car that is `equal' to KEY, there is no way to remove it
469 by side effect; therefore, write `(setq foo (remassoc key foo))' to be
470 sure of changing the value of `foo'."
475 alist)))
478 "Enable multibyte in the current buffer."
488 "imap: Could not UTF7 encode `%s', using it unencoded..."
489 string)
490 string)))
491 string))
499 "imap: Could not UTF7 decode `%s', using it undecoded..."
500 string)
501 string)))
502 string))
506 t
508 nil))
514 \f
515 ;; Server functions; stream stuff:
522 cmd done)
531 name buffer shell-file-name shell-command-switch
533 cmd
535 ?s server
537 ?l imap-default-user))))
538 response)
542 imap-calculate-literal-size-first t)
546 ;; Athena IMTEST can output SSL verify errors
549 t)
552 t)
553 ;; cyrus 1.6.x (13? < x <= 22) queries capabilities
556 t)
557 ;; cyrus 1.6 imtest print "S: " before server greeting
560 t)
562 ;; success in imtest < 1.6:
565 ;; success in imtest 1.6:
586 nil)))))
587 done))
594 cmd done)
603 name buffer shell-file-name shell-command-switch
605 cmd
607 ?s server
609 ?l imap-default-user))))
610 response)
614 imap-calculate-literal-size-first t)
618 ;; Athena IMTEST can output SSL verify errors
621 t)
624 t)
625 ;; cyrus 1.6.x (13? < x <= 22) queries capabilities
628 t)
629 ;; cyrus 1.6 imtest print "S: " before server greeting
632 t)
633 ;; GNU SASL may print 'Trying ...' first.
636 t)
638 ;; success in imtest 1.6:
641 "Client authentication "
643 nil t)
661 nil)))))
662 done))
665 nil)
668 "Open an SSL connection to SERVER."
671 cmd done)
681 'set-process-query-on-exit-flag
683 process)
686 name buffer shell-file-name
687 shell-command-switch
690 ?s server
693 process)
715 done)
717 nil)))
720 nil)
729 ;; FIXME: Per the "blue moon" comment, the process/buffer
730 ;; handling here, and elsewhere in functions which open
731 ;; streams, looks confused. Obviously we can change buffers
732 ;; if a different process handler kicks in from
733 ;; `accept-process-output' or `sit-for' below, and TRT seems
734 ;; to be to `save-buffer' around those calls. (I wonder why
735 ;; `sit-for' is used with a non-zero wait.) -- fx
749 process))))
752 t)
773 process))))
776 nil)
781 cmd done)
789 name buffer shell-file-name shell-command-switch
791 cmd
793 ?s server
794 ?g imap-shell-host
796 ?l imap-default-user)))))
817 done)
819 nil)))
829 done tls-info)
858 done))
860 ;; Server functions; authenticator stuff:
863 "Login to server in BUFFER.
864 LOGINFUNC is passed a username and a password, it should return t if
865 it where successful authenticating itself to the server, nil otherwise.
866 Returns t if login was successful, nil otherwise."
871 ;; (condition-case ()
882 imap-server " (using authenticator `"
888 imap-username user)
897 ;; (quit (with-current-buffer buffer
898 ;; (setq user nil
899 ;; passwd nil)))
900 ;; (error (with-current-buffer buffer
901 ;; (setq user nil
902 ;; passwd nil))))
903 ret)))
926 "Login to server using the AUTH CRAM-MD5 method."
929 buffer
934 "AUTHENTICATE CRAM-MD5"
940 encoded)))))))))
960 "Login to server using the LOGIN command."
972 t)
981 ;;; Compiler directives.
994 mecs))
1010 "Login to server using the SASL method."
1017 logged user)
1033 buffer)))
1043 logged t)
1046 logged)))
1055 "Login to server using the AUTH DIGEST-MD5 method."
1058 buffer
1063 "AUTHENTICATE DIGEST-MD5"
1072 user passwd digest-uri)))
1074 )))
1076 nil
1081 ;; Server functions:
1087 imap-current-message nil
1088 imap-state 'initial
1091 imap-stream-alist))
1103 imap-process))))
1106 "Open an IMAP connection to host SERVER at PORT returning a buffer.
1107 If PORT is unspecified, a default value is used (143 except
1108 for SSL which use 993).
1109 STREAM indicates the stream to use, see `imap-streams' for available
1110 streams. If nil, it choices the best stream the server is capable of.
1111 AUTH indicates authenticator to use, see `imap-authenticators' for
1112 available authenticators. If nil, it choices the best stream the
1113 server is capable of.
1114 BUFFER can be a buffer or a name of a buffer, which is created if
1115 necessary. If nil, the buffer name is generated."
1132 nil)
1134 ;; Need to choose stream.
1137 ;; OK to use this stream?
1139 ;; Stream changed?
1155 "imap: Reconnecting with stream `%s'...failed"
1156 stream))
1157 ;; We're done, kill the first connection
1160 buffer
1165 stream)
1169 ;; We're done
1177 buffer))))
1180 "If non-nil, check if IMAP is open.
1181 See the function `imap-ping-server'."
1187 "Return non-nil if connection to imap server in BUFFER is open.
1188 If BUFFER is nil then the current buffer is used."
1196 t)))))
1200 Return non-nil if the server responds, and nil if it does not
1201 respond. If BUFFER is nil, the current buffer is used."
1207 "Authenticate to server in BUFFER, using current buffer if nil.
1208 It uses the authenticator specified when opening the server. If the
1209 authenticator requires username/passwords, they are queried from the
1210 user and optionally stored in the buffer. If USER and/or PASSWD is
1211 specified, the user will not be questioned and the username and/or
1212 password is remembered in the buffer."
1226 ;; Choose authenticator.
1228 auth)
1230 ;; OK to use authenticator?
1233 imap-server auth)
1238 imap-server auth)
1241 imap-server auth)))))
1242 imap-state))))
1245 "Close connection to server in BUFFER.
1246 If BUFFER is nil, the current buffer is used."
1256 imap-current-message nil
1257 imap-process nil)
1259 t))
1262 "Return a list of identifiers which server in BUFFER support.
1263 If IDENTIFIER, return non-nil if it's among the servers capabilities.
1264 If BUFFER is nil, the current buffer is assumed."
1271 imap-capability)))
1274 "Identify client to server in BUFFER, and return server identity.
1275 LIST-OF-VALUES is nil, or a plist with identifier and value
1276 strings to send to the server to identify the client.
1278 Return a list of identifiers which server in BUFFER support, or
1279 nil if it doesn't support ID or returns no information.
1281 If BUFFER is nil, the current buffer is assumed."
1286 "ID NIL"
1289 list-of-values
1291 imap-id)))
1294 "Return a namespace hierarchy at server in BUFFER.
1295 If BUFFER is nil, the current buffer is assumed."
1300 imap-namespace))
1327 \f
1328 ;; Mailbox functions:
1334 propname value)
1337 t))
1341 propname))
1356 imap-mailbox-data)
1357 result)))
1360 "Map a function across each mailbox in `imap-mailbox-data', returning a list.
1361 Function should take a mailbox name (a string) as
1362 the only argument."
1381 "Select MAILBOX on server in BUFFER.
1382 If EXAMINE is non-nil, do a read-only select."
1384 imap-current-mailbox
1392 imap-current-mailbox)
1393 ;; Failed SELECT/EXAMINE unselects current mailbox
1406 "Examine MAILBOX on server in BUFFER."
1410 "Close current folder in BUFFER, without expunging articles."
1417 imap-current-mailbox
1421 imap-message-data nil
1423 t)))
1426 "Expunge articles in current folder in BUFFER.
1427 If ASYNCH, do not wait for successful completion of the command.
1428 If BUFFER is nil the current buffer is assumed."
1436 "Expunge articles and close current folder in BUFFER.
1437 If ASYNCH, do not wait for successful completion of the command.
1438 If BUFFER is nil the current buffer is assumed."
1445 imap-current-mailbox status)
1447 imap-current-mailbox)
1448 ;; Don't wipe out data if another mailbox
1449 ;; was selected...
1451 imap-message-data nil
1455 imap-message-data nil
1457 t)))
1463 "Create MAILBOX on server in BUFFER.
1464 If BUFFER is nil the current buffer is assumed."
1469 "Delete MAILBOX on server in BUFFER.
1470 If BUFFER is nil the current buffer is assumed."
1477 "Rename mailbox OLDNAME to NEWNAME on server in BUFFER.
1478 If BUFFER is nil the current buffer is assumed."
1487 "Return a list of subscribed mailboxes on server in BUFFER.
1488 If ROOT is non-nil, only list matching mailboxes. If ADD-DELIMITER is
1489 non-nil, a hierarchy delimiter is added to root. REFERENCE is a
1490 implementation-specific string that has to be passed to lsub command."
1492 ;; Make sure we know the hierarchy separator for root's hierarchy
1496 ;; clear list data (NB not delimiter and other stuff)
1511 "Return a list of mailboxes matching ROOT on server in BUFFER.
1512 If ADD-DELIMITER is non-nil, a hierarchy delimiter is added to
1513 root. REFERENCE is a implementation-specific string that has to be
1514 passed to list command."
1516 ;; Make sure we know the hierarchy separator for root's hierarchy
1520 ;; clear list data (NB not delimiter and other stuff)
1535 "Send the SUBSCRIBE command on the MAILBOX to server in BUFFER.
1536 Returns non-nil if successful."
1543 "Send the SUBSCRIBE command on the MAILBOX to server in BUFFER.
1544 Returns non-nil if successful."
1551 "Get status items ITEM in MAILBOX from server in BUFFER.
1552 ITEMS can be a symbol or a list of symbols, valid symbols are one of
1553 the STATUS data items -- i.e. `messages', `recent', `uidnext', `uidvalidity',
1554 or `unseen'. If ITEMS is a list of symbols, a list of values is
1555 returned, if ITEMS is a symbol only its value is returned."
1564 items
1569 items)
1573 "Send status item request ITEM on MAILBOX to server in BUFFER.
1574 ITEMS can be a symbol or a list of symbols, valid symbols are one of
1575 the STATUS data items -- i.e. 'messages, 'recent, 'uidnext, 'uidvalidity
1576 or 'unseen. The IMAP command tag is returned."
1584 items
1588 "Get ACL on MAILBOX from server in BUFFER."
1598 "Change/set ACL for IDENTIFIER to RIGHTS in MAILBOX from server in BUFFER."
1605 identifier
1606 " "
1607 rights))))))
1610 "Remove any <identifier,rights> pair for IDENTIFIER in MAILBOX from server in BUFFER."
1617 identifier))))))
1619 \f
1620 ;; Message functions:
1624 imap-current-message))
1630 list
1643 range)
1651 uids)
1652 props))))
1655 "Fetch properties PROPS from message set UIDS from server in BUFFER.
1656 UIDS can be a string, number or a list of numbers. If RECEIVE
1657 is non-nil return these properties."
1663 uids)
1664 props)))
1666 t
1672 receive)
1674 uids)
1681 propname value)
1684 t))
1689 propname)))
1692 "Map a function across each mailbox in `imap-message-data', returning a list."
1698 imap-message-data)
1699 result)))
1745 ;; FIXME: Should this try to use CHARSET? -- fx
1753 nil)
1757 "Return t if FLAG can be permanently (between IMAP sessions) saved on articles, in MAILBOX on server in BUFFER."
1783 ;; Cf. http://thread.gmane.org/gmane.emacs.gnus.general/65317/focus=65343
1784 ;; Signal an error if we'd get an integer overflow.
1785 ;;
1786 ;; FIXME: Identify relevant calls to `string-to-number' and replace them with
1787 ;; `imap-string-to-integer'.
1793 number)))
1796 "Like `imap-fetch', but DTRT with Exchange 2007 bug.
1797 However, UIDS here is a cons, where the car is the canonical form
1798 of the UIDS specification, and the cdr is the one which works with
1799 Exchange 2007 or, potentially, other buggy servers.
1800 See `imap-enable-exchange-bug-workaround'."
1801 ;; The first time we get here for a given, we'll try the canonical
1802 ;; form. If we get the known error from the buggy server, set the
1803 ;; flag buffer-locally (to account for connections to multiple
1804 ;; servers), then re-try with the alternative UIDS spec. We don't
1805 ;; unconditionally use the alternative form, since the
1806 ;; currently-used alternatives are seriously inefficient with some
1807 ;; servers (although they are valid).
1808 ;;
1809 ;; FIXME: Maybe it would be cleaner to have a flag to not signal
1810 ;; the error (which otherwise gives a message), and test
1811 ;; `imap-failed-tags'. Also, Other IMAP clients use other forms of
1812 ;; request which work with Exchange, e.g. Claws does "UID FETCH 1:*
1813 ;; (UID)" rather than "FETCH UID 1,*". Is there a good reason not
1814 ;; to do the same?
1816 ;; Binding `debug-on-error' allows us to get the error from
1817 ;; `imap-parse-response' -- it's normally caught by Emacs around
1818 ;; execution of a process filter.
1823 props receive nouidfetch buffer))
1826 ;; This is the Exchange 2007 response. It may be more
1827 ;; robust just to check for a BAD response to the
1828 ;; attempted fetch.
1833 t)
1860 "Copy ARTICLES to MAILBOX on server in BUFFER.
1861 ARTICLES is a string message set. Create mailbox if it doesn't exist,
1862 unless DONT-CREATE is non-nil. On success, return a list with
1863 the UIDVALIDITY of the mailbox the article(s) was copied to as the
1864 first element. The rest of list contains the saved articles' UIDs."
1871 t
1873 ;; removed because of buggy Oracle server
1874 ;; that doesn't send TRYCREATE tags (which
1875 ;; is a MUST according to specifications):
1876 ;;(imap-mailbox-get-1 'trycreate mailbox)
1882 ;; FIXME: Amalgamate with imap-message-copyuid-1, using an extra arg, since it
1883 ;; shares most of the code? -- fx
1905 "Append ARTICLE (a buffer) to MAILBOX on server in BUFFER.
1906 FLAGS and DATE-TIME is currently not used. Return a cons holding
1907 uidvalidity of MAILBOX and UID the newly created article got, or nil
1908 on failure."
1918 "Return number of lines in article by looking at the mime bodystructure BODY."
1932 "Return a from string line."
1937 "@"
1941 \f
1942 ;; Internal functions.
1961 cmd cmdstr)
1969 size)
1974 ;; XXX modifies buffer!
1994 imap-log-buffer)
2010 command)))
2016 tag)))
2025 message-log-max)
2034 ;; A process can die _before_ we have processed everything it
2035 ;; has to say. Moreover, this can happen in between the call to
2036 ;; accept-process-output and the call to process-status in an
2037 ;; iteration of the loop above.
2046 'INCOMPLETE
2053 "Return point at end of current line, taking into account literals.
2054 Return nil if no complete line has arrived."
2056 imap-server-eol)
2057 nil t)
2060 nil
2066 "IMAP process filter."
2067 ;; Sometimes, we are called even though the process has died.
2068 ;; Better abstain from doing stuff in that case.
2096 imap-state)))
2099 \f
2100 ;; Imap parser.
2105 ;; number = 1*DIGIT
2106 ;; ; Unsigned 32-bit integer
2107 ;; ; (0 <= n < 4,294,967,296)
2115 ;; literal = "{" number "}" CRLF *CHAR8
2116 ;; ; Number represents the number of CHAR8s
2123 nil
2127 ;; string = quoted / literal
2128 ;;
2129 ;; quoted = DQUOTE *QUOTED-CHAR DQUOTE
2130 ;;
2131 ;; QUOTED-CHAR = <any TEXT-CHAR except quoted-specials> /
2132 ;; "\" quoted-specials
2133 ;;
2134 ;; quoted-specials = DQUOTE / "\"
2135 ;;
2136 ;; TEXT-CHAR = <any CHAR except CR and LF>
2150 name))
2154 ;; nil = "NIL"
2160 ;; nstring = string / nil
2165 nil)))
2167 ;; astring = atom / string
2168 ;;
2169 ;; atom = 1*ATOM-CHAR
2170 ;;
2171 ;; ATOM-CHAR = <any CHAR except atom-specials>
2172 ;;
2173 ;; atom-specials = "(" / ")" / "{" / SP / CTL / list-wildcards /
2174 ;; quoted-specials
2175 ;;
2176 ;; list-wildcards = "%" / "*"
2177 ;;
2178 ;; quoted-specials = DQUOTE / "\"
2188 ;; address = "(" addr-name SP addr-adl SP addr-mailbox SP
2189 ;; addr-host ")"
2190 ;;
2191 ;; addr-adl = nstring
2192 ;; ; Holds route from [RFC-822] route-addr if
2193 ;; ; non-nil
2194 ;;
2195 ;; addr-host = nstring
2196 ;; ; nil indicates [RFC-822] group syntax.
2197 ;; ; Otherwise, holds [RFC-822] domain name
2198 ;;
2199 ;; addr-mailbox = nstring
2200 ;; ; nil indicates end of [RFC-822] group; if
2201 ;; ; non-nil and addr-host is nil, holds
2202 ;; ; [RFC-822] group name.
2203 ;; ; Otherwise, holds [RFC-822] local-part
2204 ;; ; after removing [RFC-822] quoting
2205 ;;
2206 ;; addr-name = nstring
2207 ;; ; If non-nil, holds phrase from [RFC-822]
2208 ;; ; mailbox after removing [RFC-822] quoting
2209 ;;
2224 address))))
2226 ;; address-list = "(" 1*address ")" / nil
2227 ;;
2228 ;; nil = "NIL"
2235 ;; next line for MS Exchange bug
2242 ;; With assert, the code might not be eval'd.
2243 ;; (assert (imap-parse-nil) t "In imap-parse-address-list")
2246 ;; mailbox = "INBOX" / astring
2247 ;; ; INBOX is case-insensitive. All case variants of
2248 ;; ; INBOX (e.g. "iNbOx") MUST be interpreted as INBOX
2249 ;; ; not as an astring. An astring which consists of
2250 ;; ; the case-insensitive sequence "I" "N" "B" "O" "X"
2251 ;; ; is considered to be INBOX and not an astring.
2252 ;; ; Refer to section 5.1 for further
2253 ;; ; semantic details of mailbox names.
2258 "INBOX"
2259 mailbox)))
2261 ;; greeting = "*" SP (resp-cond-auth / resp-cond-bye) CRLF
2262 ;;
2263 ;; resp-cond-auth = ("OK" / "PREAUTH") SP resp-text
2264 ;; ; Authentication condition
2265 ;;
2266 ;; resp-cond-bye = "BYE" SP resp-text
2269 "Parse an IMAP greeting."
2277 ;; response = *(continue-req / response-data) response-done
2278 ;;
2279 ;; continue-req = "+" SP (resp-text / base64) CRLF
2280 ;;
2281 ;; response-data = "*" SP (resp-cond-state / resp-cond-bye /
2282 ;; mailbox-data / message-data / capability-data) CRLF
2283 ;;
2284 ;; response-done = response-tagged / response-fatal
2285 ;;
2286 ;; response-fatal = "*" SP resp-cond-bye CRLF
2287 ;; ; Server closes connection immediately
2288 ;;
2289 ;; response-tagged = tag SP resp-cond-state CRLF
2290 ;;
2291 ;; resp-cond-state = ("OK" / "NO" / "BAD") SP resp-text
2292 ;; ; Status condition
2293 ;;
2294 ;; resp-cond-bye = "BYE" SP resp-text
2295 ;;
2296 ;; mailbox-data = "FLAGS" SP flag-list /
2297 ;; "LIST" SP mailbox-list /
2298 ;; "LSUB" SP mailbox-list /
2299 ;; "SEARCH" *(SP nz-number) /
2300 ;; "STATUS" SP mailbox SP "("
2301 ;; [status-att SP number *(SP status-att SP number)] ")" /
2302 ;; number SP "EXISTS" /
2303 ;; number SP "RECENT"
2304 ;;
2305 ;; message-data = nz-number SP ("EXPUNGE" / ("FETCH" SP msg-att))
2306 ;;
2307 ;; capability-data = "CAPABILITY" *(SP capability) SP "IMAP4rev1"
2308 ;; *(SP capability)
2309 ;; ; IMAP4rev1 servers which offer RFC 1730
2310 ;; ; compatibility MUST list "IMAP4" as the first
2311 ;; ; capability.
2314 "Parse a IMAP command response."
2320 t)))
2331 'search
2367 imap-failed-tags))))
2380 token status code text))))
2387 ;; resp-text = ["[" resp-text-code "]" SP] text
2388 ;;
2389 ;; text = 1*TEXT-CHAR
2390 ;;
2391 ;; TEXT-CHAR = <any CHAR except CR and LF>
2396 ;; resp-text-code = "ALERT" /
2397 ;; "BADCHARSET [SP "(" astring *(SP astring) ")" ] /
2398 ;; "NEWNAME" SP string SP string /
2399 ;; "PARSE" /
2400 ;; "PERMANENTFLAGS" SP "("
2401 ;; [flag-perm *(SP flag-perm)] ")" /
2402 ;; "READ-ONLY" /
2403 ;; "READ-WRITE" /
2404 ;; "TRYCREATE" /
2405 ;; "UIDNEXT" SP nz-number /
2406 ;; "UIDVALIDITY" SP nz-number /
2407 ;; "UNSEEN" SP nz-number /
2408 ;; resp-text-atom [SP 1*<any TEXT-CHAR except "]">]
2409 ;;
2410 ;; resp_code_apnd = "APPENDUID" SPACE nz_number SPACE uniqueid
2411 ;;
2412 ;; resp_code_copy = "COPYUID" SPACE nz_number SPACE set SPACE set
2413 ;;
2414 ;; set = sequence-num / (sequence-num ":" sequence-num) /
2415 ;; (set "," set)
2416 ;; ; Identifies a set of messages. For message
2417 ;; ; sequence numbers, these are consecutive
2418 ;; ; numbers from 1 to the number of messages in
2419 ;; ; the mailbox
2420 ;; ; Comma delimits individual numbers, colon
2421 ;; ; delimits between two numbers inclusive.
2422 ;; ; Example: 2,4:7,9,12:* is 2,4,5,6,7,9,12,13,
2423 ;; ; 14,15 for a mailbox with 15 messages.
2424 ;;
2425 ;; sequence-num = nz-number / "*"
2426 ;; ; * is the largest number in use. For message
2427 ;; ; sequence numbers, it is the number of messages
2428 ;; ; in the mailbox. For unique identifiers, it is
2429 ;; ; the unique identifier of the last message in
2430 ;; ; the mailbox.
2431 ;;
2432 ;; flag-perm = flag / "\*"
2433 ;;
2434 ;; flag = "\Answered" / "\Flagged" / "\Deleted" /
2435 ;; "\Seen" / "\Draft" / flag-keyword / flag-extension
2436 ;; ; Does not include "\Recent"
2437 ;;
2438 ;; flag-extension = "\" atom
2439 ;; ; Future expansion. Client implementations
2440 ;; ; MUST accept flag-extension flags. Server
2441 ;; ; implementations MUST NOT generate
2442 ;; ; flag-extension flags except as defined by
2443 ;; ; future standard or standards-track
2444 ;; ; revisions of this specification.
2445 ;;
2446 ;; flag-keyword = atom
2447 ;;
2448 ;; resp-text-atom = 1*<any ATOM-CHAR except "]">
2451 ;; xxx next line for stalker communigate pro 3.3.1 bug
2478 imap-current-target-mailbox))
2483 imap-current-target-mailbox))
2488 ;; mailbox-list = "(" [mbx-list-flags] ")" SP
2489 ;; (DQUOTE QUOTED-CHAR DQUOTE / nil) SP mailbox
2490 ;;
2491 ;; mbx-list-flags = *(mbx-list-oflag SP) mbx-list-sflag
2492 ;; *(SP mbx-list-oflag) /
2493 ;; mbx-list-oflag *(SP mbx-list-oflag)
2494 ;;
2495 ;; mbx-list-oflag = "\Noinferiors" / flag-extension
2496 ;; ; Other flags; multiple possible per LIST response
2497 ;;
2498 ;; mbx-list-sflag = "\Noselect" / "\Marked" / "\Unmarked"
2499 ;; ; Selectability flags; only one per LIST response
2500 ;;
2501 ;; QUOTED-CHAR = <any TEXT-CHAR except quoted-specials> /
2502 ;; "\" quoted-specials
2503 ;;
2504 ;; quoted-specials = DQUOTE / "\"
2517 ;; msg_att ::= "(" 1#("ENVELOPE" SPACE envelope /
2518 ;; "FLAGS" SPACE "(" #(flag / "\Recent") ")" /
2519 ;; "INTERNALDATE" SPACE date_time /
2520 ;; "RFC822" [".HEADER" / ".TEXT"] SPACE nstring /
2521 ;; "RFC822.SIZE" SPACE number /
2522 ;; "BODY" ["STRUCTURE"] SPACE body /
2523 ;; "BODY" section ["<" number ">"] SPACE nstring /
2524 ;; "UID" SPACE uniqueid) ")"
2525 ;;
2526 ;; date_time ::= <"> date_day_fixed "-" date_month "-" date_year
2527 ;; SPACE time SPACE zone <">
2528 ;;
2529 ;; section ::= "[" [section_text / (nz_number *["." nz_number]
2530 ;; ["." (section_text / "MIME")])] "]"
2531 ;;
2532 ;; section_text ::= "HEADER" / "HEADER.FIELDS" [".NOT"]
2533 ;; SPACE header_list / "TEXT"
2534 ;;
2535 ;; header_fld_name ::= astring
2536 ;;
2537 ;; header_list ::= "(" 1#header_fld_name ")"
2555 section)))
2560 rfc822size body bodydetail bodystructure flags-empty)
2561 ;; Courier can insert spurious blank characters which will
2562 ;; confuse `read', so skip past them.
2598 bodydetail)
2617 ;; mailbox-data = ...
2618 ;; "STATUS" SP mailbox SP "("
2619 ;; [status-att SP number
2620 ;; *(SP status-att SP number)] ")"
2621 ;; ...
2622 ;;
2623 ;; status-att = "MESSAGES" / "RECENT" / "UIDNEXT" / "UIDVALIDITY" /
2624 ;; "UNSEEN"
2652 token mailbox)
2655 ;; acl_data ::= "ACL" SPACE mailbox *(SPACE identifier SPACE
2656 ;; rights)
2657 ;;
2658 ;; identifier ::= astring
2659 ;;
2660 ;; rights ::= astring
2664 identifier rights acl)
2673 ;; flag-list = "(" [flag *(SP flag)] ")"
2674 ;;
2675 ;; flag = "\Answered" / "\Flagged" / "\Deleted" /
2676 ;; "\Seen" / "\Draft" / flag-keyword / flag-extension
2677 ;; ; Does not include "\Recent"
2678 ;;
2679 ;; flag-keyword = atom
2680 ;;
2681 ;; flag-extension = "\" atom
2682 ;; ; Future expansion. Client implementations
2683 ;; ; MUST accept flag-extension flags. Server
2684 ;; ; implementations MUST NOT generate
2685 ;; ; flag-extension flags except as defined by
2686 ;; ; future standard or standards-track
2687 ;; ; revisions of this specification.
2695 ;; next line for Courier IMAP bug.
2704 ;; envelope = "(" env-date SP env-subject SP env-from SP env-sender SP
2705 ;; env-reply-to SP env-to SP env-cc SP env-bcc SP
2706 ;; env-in-reply-to SP env-message-id ")"
2707 ;;
2708 ;; env-bcc = "(" 1*address ")" / nil
2709 ;;
2710 ;; env-cc = "(" 1*address ")" / nil
2711 ;;
2712 ;; env-date = nstring
2713 ;;
2714 ;; env-from = "(" 1*address ")" / nil
2715 ;;
2716 ;; env-in-reply-to = nstring
2717 ;;
2718 ;; env-message-id = nstring
2719 ;;
2720 ;; env-reply-to = "(" 1*address ")" / nil
2721 ;;
2722 ;; env-sender = "(" 1*address ")" / nil
2723 ;;
2724 ;; env-subject = nstring
2725 ;;
2726 ;; env-to = "(" 1*address ")" / nil
2752 ;; body-fld-param = "(" string SP string *(SP string SP string) ")" / nil
2760 ;; buggy stalker communigate pro 3.0 doesn't print SPC
2761 ;; between body-fld-param's sometimes
2766 nil)))
2768 ;; body-extension = nstring / number /
2769 ;; "(" body-extension *(SP body-extension) ")"
2770 ;; ; Future expansion. Client implementations
2771 ;; ; MUST accept body-extension fields. Server
2772 ;; ; implementations MUST NOT generate
2773 ;; ; body-extension fields except as defined by
2774 ;; ; future standard or standards-track
2775 ;; ; revisions of this specification.
2791 ;; body-ext-1part = body-fld-md5 [SP body-fld-dsp [SP body-fld-lang
2792 ;; *(SP body-extension)]]
2793 ;; ; MUST NOT be returned on non-extensible
2794 ;; ; "BODY" fetch
2795 ;;
2796 ;; body-ext-mpart = body-fld-param [SP body-fld-dsp [SP body-fld-lang
2797 ;; *(SP body-extension)]]
2798 ;; ; MUST NOT be returned on non-extensible
2799 ;; ; "BODY" fetch
2813 ;; With assert, the code might not be eval'd.
2814 ;; (assert (imap-parse-nil) t "In imap-parse-body-ext")
2825 ext))
2827 ;; body = "(" body-type-1part / body-type-mpart ")"
2828 ;;
2829 ;; body-ext-1part = body-fld-md5 [SP body-fld-dsp [SP body-fld-lang
2830 ;; *(SP body-extension)]]
2831 ;; ; MUST NOT be returned on non-extensible
2832 ;; ; "BODY" fetch
2833 ;;
2834 ;; body-ext-mpart = body-fld-param [SP body-fld-dsp [SP body-fld-lang
2835 ;; *(SP body-extension)]]
2836 ;; ; MUST NOT be returned on non-extensible
2837 ;; ; "BODY" fetch
2838 ;;
2839 ;; body-fields = body-fld-param SP body-fld-id SP body-fld-desc SP
2840 ;; body-fld-enc SP body-fld-octets
2841 ;;
2842 ;; body-fld-desc = nstring
2843 ;;
2844 ;; body-fld-dsp = "(" string SP body-fld-param ")" / nil
2845 ;;
2846 ;; body-fld-enc = (DQUOTE ("7BIT" / "8BIT" / "BINARY" / "BASE64"/
2847 ;; "QUOTED-PRINTABLE") DQUOTE) / string
2848 ;;
2849 ;; body-fld-id = nstring
2850 ;;
2851 ;; body-fld-lang = nstring / "(" string *(SP string) ")"
2852 ;;
2853 ;; body-fld-lines = number
2854 ;;
2855 ;; body-fld-md5 = nstring
2856 ;;
2857 ;; body-fld-octets = number
2858 ;;
2859 ;; body-fld-param = "(" string SP string *(SP string SP string) ")" / nil
2860 ;;
2861 ;; body-type-1part = (body-type-basic / body-type-msg / body-type-text)
2862 ;; [SP body-ext-1part]
2863 ;;
2864 ;; body-type-basic = media-basic SP body-fields
2865 ;; ; MESSAGE subtype MUST NOT be "RFC822"
2866 ;;
2867 ;; body-type-msg = media-message SP body-fields SP envelope
2868 ;; SP body SP body-fld-lines
2869 ;;
2870 ;; body-type-text = media-text SP body-fields SP body-fld-lines
2871 ;;
2872 ;; body-type-mpart = 1*body SP media-subtype
2873 ;; [SP body-ext-mpart]
2874 ;;
2875 ;; media-basic = ((DQUOTE ("APPLICATION" / "AUDIO" / "IMAGE" /
2876 ;; "MESSAGE" / "VIDEO") DQUOTE) / string) SP media-subtype
2877 ;; ; Defined in [MIME-IMT]
2878 ;;
2879 ;; media-message = DQUOTE "MESSAGE" DQUOTE SP DQUOTE "RFC822" DQUOTE
2880 ;; ; Defined in [MIME-IMT]
2881 ;;
2882 ;; media-subtype = string
2883 ;; ; Defined in [MIME-IMT]
2884 ;;
2885 ;; media-text = DQUOTE "TEXT" DQUOTE SP media-subtype
2886 ;; ; Defined in [MIME-IMT]
2896 ;; buggy stalker communigate pro 3.0 inserts a SPC between
2897 ;; parts in multiparts
2919 ;; next line for Sun SIMS bug
2929 ;; Next `or' for Sun SIMS bug. It regards body-fld-enc as a
2930 ;; nstring and returns nil instead of defaulting back to 7BIT
2931 ;; as the standard says.
2932 ;; Exchange (2007, at least) does this as well.
2935 ;; Exchange 2007 can return -1, contrary to the spec...
2942 ;; Ok, we're done parsing the required parts, what comes now is one of
2943 ;; three things:
2944 ;;
2945 ;; envelope (then we're parsing body-type-msg)
2946 ;; body-fld-lines (then we're parsing body-type-text)
2947 ;; body-ext-1part (then we're parsing body-type-basic)
2948 ;;
2949 ;; The problem is that the two first are in turn optionally followed
2950 ;; by the third. So we parse the first two here (if there are any)...
2959 ;; buggy stalker communigate pro 3.0 doesn't print
2960 ;; number of lines in message/rfc822 attachment
2970 ;; ...and then parse the third one here...
2985 '(
2986 imap-utf7-encode
2987 imap-utf7-decode
2988 imap-error-text
2989 imap-kerberos4s-p
2990 imap-kerberos4-open
2991 imap-ssl-p
2992 imap-ssl-open
2993 imap-network-p
2994 imap-network-open
2995 imap-interactive-login
2996 imap-kerberos4a-p
2997 imap-kerberos4-auth
2998 imap-cram-md5-p
2999 imap-cram-md5-auth
3000 imap-login-p
3001 imap-login-auth
3002 imap-anonymous-p
3003 imap-anonymous-auth
3004 imap-open-1
3005 imap-open
3006 imap-opened
3007 imap-ping-server
3008 imap-authenticate
3009 imap-close
3010 imap-capability
3011 imap-namespace
3012 imap-send-command-wait
3013 imap-mailbox-put
3014 imap-mailbox-get
3015 imap-mailbox-map-1
3016 imap-mailbox-map
3017 imap-current-mailbox
3018 imap-current-mailbox-p-1
3019 imap-current-mailbox-p
3020 imap-mailbox-select-1
3021 imap-mailbox-select
3022 imap-mailbox-examine-1
3023 imap-mailbox-examine
3024 imap-mailbox-unselect
3025 imap-mailbox-expunge
3026 imap-mailbox-close
3027 imap-mailbox-create-1
3028 imap-mailbox-create
3029 imap-mailbox-delete
3030 imap-mailbox-rename
3031 imap-mailbox-lsub
3032 imap-mailbox-list
3033 imap-mailbox-subscribe
3034 imap-mailbox-unsubscribe
3035 imap-mailbox-status
3036 imap-mailbox-acl-get
3037 imap-mailbox-acl-set
3038 imap-mailbox-acl-delete
3039 imap-current-message
3040 imap-list-to-message-set
3041 imap-fetch-asynch
3042 imap-fetch
3043 imap-fetch-safe
3044 imap-message-put
3045 imap-message-get
3046 imap-message-map
3047 imap-search
3048 imap-message-flag-permanent-p
3049 imap-message-flags-set
3050 imap-message-flags-del
3051 imap-message-flags-add
3052 imap-message-copyuid-1
3053 imap-message-copyuid
3054 imap-message-copy
3055 imap-message-appenduid-1
3056 imap-message-appenduid
3057 imap-message-append
3058 imap-body-lines
3059 imap-envelope-from
3060 imap-send-command-1
3061 imap-send-command
3062 imap-wait-for-tag
3063 imap-sentinel
3064 imap-find-next-line
3065 imap-arrival-filter
3066 imap-parse-greeting
3067 imap-parse-response
3068 imap-parse-resp-text
3069 imap-parse-resp-text-code
3070 imap-parse-data-list
3071 imap-parse-fetch
3072 imap-parse-status
3073 imap-parse-acl
3074 imap-parse-flag-list
3075 imap-parse-envelope
3076 imap-parse-body-extension
3077 imap-parse-body
3078 )))
3082 ;; arch-tag: 27369ed6-33e4-482f-96f1-8bb906ba70f7
3083 ;;; imap.el ends here