| blob | e5a14d75dee27103258188a6de00eb6e3b997c69 |
1 ;;; imap.el --- imap library
3 ;; Copyright (C) 1998-2016 Free Software Foundation, Inc.
5 ;; Author: Simon Josefsson <simon@josefsson.org>
6 ;; Keywords: mail
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
25 ;; imap.el is an elisp library providing an interface for talking to
26 ;; IMAP servers.
27 ;;
28 ;; imap.el is roughly divided in two parts, one that parses IMAP
29 ;; responses from the server and storing data into buffer-local
30 ;; variables, and one for utility functions which send commands to
31 ;; server, waits for an answer, and return information. The latter
32 ;; part is layered on top of the previous.
33 ;;
34 ;; The imap.el API consist of the following functions, other functions
35 ;; in this file should not be called directly and the result of doing
36 ;; so are at best undefined.
37 ;;
38 ;; Global commands:
39 ;;
40 ;; imap-open, imap-opened, imap-authenticate, imap-close,
41 ;; imap-capability, imap-namespace, imap-error-text
42 ;;
43 ;; Mailbox commands:
44 ;;
45 ;; imap-mailbox-get, imap-mailbox-map, imap-current-mailbox,
46 ;; imap-current-mailbox-p, imap-search, imap-mailbox-select,
47 ;; imap-mailbox-examine, imap-mailbox-unselect, imap-mailbox-expunge
48 ;; imap-mailbox-close, imap-mailbox-create, imap-mailbox-delete
49 ;; imap-mailbox-rename, imap-mailbox-lsub, imap-mailbox-list
50 ;; imap-mailbox-subscribe, imap-mailbox-unsubscribe, imap-mailbox-status
51 ;; imap-mailbox-acl-get, imap-mailbox-acl-set, imap-mailbox-acl-delete
52 ;;
53 ;; Message commands:
54 ;;
55 ;; imap-fetch-asynch, imap-fetch,
56 ;; imap-current-message, imap-list-to-message-set,
57 ;; imap-message-get, imap-message-map
58 ;; imap-message-envelope-date, imap-message-envelope-subject,
59 ;; imap-message-envelope-from, imap-message-envelope-sender,
60 ;; imap-message-envelope-reply-to, imap-message-envelope-to,
61 ;; imap-message-envelope-cc, imap-message-envelope-bcc
62 ;; imap-message-envelope-in-reply-to, imap-message-envelope-message-id
63 ;; imap-message-body, imap-message-flag-permanent-p
64 ;; imap-message-flags-set, imap-message-flags-del
65 ;; imap-message-flags-add, imap-message-copyuid
66 ;; imap-message-copy, imap-message-appenduid
67 ;; imap-message-append, imap-envelope-from
68 ;; imap-body-lines
69 ;;
70 ;; It is my hope that these commands should be pretty self
71 ;; explanatory for someone 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."
255 1.0
257 "How long to wait between checking for the end of output.
258 Shorter values mean quicker response, but is more CPU intensive."
263 "If non-nil, store session password without prompting."
267 ;; Various variables.
283 "Definition of network streams.
285 \(NAME CHECK OPEN)
287 NAME names the stream, CHECK is a function returning non-nil if the
288 server support the stream and OPEN is a function for opening the
292 kerberos4
293 digest-md5
294 cram-md5
295 ;;sasl
296 login
297 anonymous)
308 "Definition of authenticators.
310 \(NAME CHECK AUTHENTICATE)
312 NAME names the authenticator. CHECK is a function returning non-nil if
313 the server support the authenticator and AUTHENTICATE is a function
320 "Close server immediately if it can't logout in this number of seconds.
321 If it is nil, never close server until logout completes. Normally,
322 the value of this variable will be bound to a certain value to which
323 an application program that uses this module specifies on a per-server
326 ;; Internal constants. Change these and die.
335 imap-port
336 imap-client-eol
337 imap-server-eol
338 imap-auth
339 imap-stream
340 imap-username
341 imap-password
342 imap-current-mailbox
343 imap-current-target-mailbox
344 imap-message-data
345 imap-capability
346 imap-id
347 imap-namespace
348 imap-state
349 imap-reached-tag
350 imap-failed-tags
351 imap-tag
352 imap-process
353 imap-calculate-literal-size-first
354 imap-mailbox-data))
358 ;; Internal variables.
369 "IMAP state.
370 Valid states are `closed', `initial', `nonauth', `auth', `selected'
404 "Identity of server.
414 "Alist of tags that failed.
415 Each element is a list with four elements; tag (a integer), response
416 state (a symbol, `OK', `NO' or `BAD'), response code (a string), and
426 "Non-nil indicates that the server emitted a continuation request.
430 "List of response tags and callbacks, on the form `(number . function)'.
431 The function should take two arguments, the first the IMAP tag and the
435 "Send FETCH UID commands as *:* instead of *.
437 When non-nil, use an alternative UIDS form. Enabling appears to
438 be required for some servers (e.g., Microsoft Exchange 2007)
439 which otherwise would trigger a response `BAD The specified
440 message set is invalid.'. We don't unconditionally use this
441 form, since this is said to be significantly inefficient.
443 This variable is set to t automatically per server if the
446 \f
447 ;; Utility functions:
450 "Delete by side effect any elements of ALIST whose car is `equal' to KEY.
451 The modified ALIST is returned. If the first member
452 of ALIST has a car that is `equal' to KEY, there is no way to remove it
453 by side effect; therefore, write `(setq foo (remassoc key foo))' to be
454 sure of changing the value of `foo'."
459 alist)))
462 "Enable multibyte in the current buffer."
472 "imap: Could not UTF7 encode `%s', using it unencoded..."
473 string)
474 string)))
475 string))
483 "imap: Could not UTF7 decode `%s', using it undecoded..."
484 string)
485 string)))
486 string))
490 t
492 nil))
498 \f
499 ;; Server functions; stream stuff:
516 cmd done)
525 name buffer shell-file-name shell-command-switch
527 cmd
529 ?s server
531 ?l imap-default-user))))
532 response)
536 imap-calculate-literal-size-first t)
540 ;; Athena IMTEST can output SSL verify errors
543 t)
546 t)
547 ;; cyrus 1.6.x (13? < x <= 22) queries capabilities
550 t)
551 ;; cyrus 1.6 imtest print "S: " before server greeting
554 t)
556 ;; success in imtest < 1.6:
559 ;; success in imtest 1.6:
574 nil)))))
575 done))
582 cmd done)
591 name buffer shell-file-name shell-command-switch
593 cmd
595 ?s server
597 ?l imap-default-user))))
598 response)
602 imap-calculate-literal-size-first t)
606 ;; Athena IMTEST can output SSL verify errors
609 t)
612 t)
613 ;; cyrus 1.6.x (13? < x <= 22) queries capabilities
616 t)
617 ;; cyrus 1.6 imtest print "S: " before server greeting
620 t)
621 ;; GNU SASL may print 'Trying ...' first.
624 t)
626 ;; success in imtest 1.6:
629 "Client authentication "
631 nil t)
644 nil)))))
645 done))
648 nil)
658 ;; FIXME: Per the "blue moon" comment, the process/buffer
659 ;; handling here, and elsewhere in functions which open
660 ;; streams, looks confused. Obviously we can change buffers
661 ;; if a different process handler kicks in from
662 ;; `accept-process-output' or `sit-for' below, and TRT seems
663 ;; to be to `save-buffer' around those calls. (I wonder why
664 ;; `sit-for' is used with a non-zero wait.) -- fx
673 process))))
676 t)
692 process))))
695 nil)
700 cmd done)
709 name buffer shell-file-name shell-command-switch
711 cmd
713 ?s server
714 ?g imap-shell-host
716 ?l imap-default-user)))))
732 done)
734 nil)))
745 name buffer server port
748 :always-query-capabilities t
751 :starttls-function
755 done)
764 done))
766 ;; Server functions; authenticator stuff:
769 "Login to server in BUFFER.
770 Return t if login was successful, nil otherwise.
772 LOGINFUNC is passed a username and a password. It should return
773 t if it successfully authenticates, nil otherwise."
778 ;; (condition-case ()
783 "imap: username for %s (using stream `%s'): "
784 imap-server imap-stream)
790 "imap: password for %s@%s (using authenticator `%s'): "
791 user imap-server imap-auth))))
797 imap-username user)
806 ;; (quit (with-current-buffer buffer
807 ;; (setq user nil
808 ;; passwd nil)))
809 ;; (error (with-current-buffer buffer
810 ;; (setq user nil
811 ;; passwd nil))))
812 ret)))
835 "Login to server using the AUTH CRAM-MD5 method."
838 buffer
843 "AUTHENTICATE CRAM-MD5"
849 encoded)))))))))
869 "Login to server using the LOGIN command."
881 t)
890 ;;; Compiler directives.
903 mecs))
919 "Login to server using the SASL method."
926 logged user)
942 buffer)))
952 logged t)
955 logged)))
964 "Login to server using the AUTH DIGEST-MD5 method."
967 buffer
972 "AUTHENTICATE DIGEST-MD5"
981 user passwd digest-uri)))
983 )))
985 nil
990 ;; Server functions:
996 imap-current-message nil
997 imap-state 'initial
1000 imap-stream-alist))
1012 imap-process))))
1015 "Open an IMAP connection to host SERVER at PORT returning a buffer.
1016 If PORT is unspecified, a default value is used (143 except
1017 for SSL which use 993).
1018 STREAM indicates the stream to use, see `imap-streams' for available
1019 streams. If nil, it choices the best stream the server is capable of.
1020 AUTH indicates authenticator to use, see `imap-authenticators' for
1021 available authenticators. If nil, it choices the best stream the
1022 server is capable of.
1023 BUFFER can be a buffer or a name of a buffer, which is created if
1024 necessary. If nil, the buffer name is generated."
1041 nil)
1043 ;; Need to choose stream.
1046 ;; OK to use this stream?
1048 ;; Stream changed?
1064 "imap: Reconnecting with stream `%s'...failed"
1065 stream))
1066 ;; We're done, kill the first connection
1069 buffer
1073 ;; set the passed buffer to the current one,
1074 ;; so that (imap-opened buffer) later will work
1077 stream)
1081 ;; We're done
1088 ;; (debug "opened+state+auth+buffer" (imap-opened buffer) imap-state imap-auth buffer)
1090 buffer))))
1093 "If non-nil, check if IMAP is open.
1094 See the function `imap-ping-server'."
1100 "Return non-nil if connection to imap server in BUFFER is open.
1101 If BUFFER is nil then the current buffer is used."
1109 t)))))
1113 Return non-nil if the server responds, and nil if it does not
1114 respond. If BUFFER is nil, the current buffer is used."
1120 "Authenticate to server in BUFFER, using current buffer if nil.
1121 It uses the authenticator specified when opening the server.
1123 Optional arguments USER and PASSWD specify the username and
1124 password to use if the authenticator requires a username and/or
1125 password. If omitted or nil, the authenticator may query the
1126 user for a username and/or password."
1142 ;; Choose authenticator.
1144 auth)
1146 ;; OK to use authenticator?
1151 imap-server auth)
1156 imap-server auth)
1157 ;; set imap-state correctly on successful auth attempt
1159 ;; stop iterating through the authenticator list
1162 imap-server auth)))))
1163 imap-state))))
1166 "Close connection to server in BUFFER.
1167 If BUFFER is nil, the current buffer is used."
1177 imap-current-message nil
1178 imap-process nil)
1180 t))
1183 "Return a list of identifiers which server in BUFFER support.
1184 If IDENTIFIER, return non-nil if it's among the servers capabilities.
1185 If BUFFER is nil, the current buffer is assumed."
1192 imap-capability)))
1195 "Identify client to server in BUFFER, and return server identity.
1196 LIST-OF-VALUES is nil, or a plist with identifier and value
1197 strings to send to the server to identify the client.
1199 Return a list of identifiers which server in BUFFER support, or
1200 nil if it doesn't support ID or returns no information.
1202 If BUFFER is nil, the current buffer is assumed."
1207 "ID NIL"
1210 list-of-values
1212 imap-id)))
1215 "Return a namespace hierarchy at server in BUFFER.
1216 If BUFFER is nil, the current buffer is assumed."
1221 imap-namespace))
1248 \f
1249 ;; Mailbox functions:
1255 propname value)
1258 t))
1262 propname))
1277 imap-mailbox-data)
1278 result)))
1281 "Map a function across each mailbox in `imap-mailbox-data', returning a list.
1282 Function should take a mailbox name (a string) as
1283 the only argument."
1302 "Select MAILBOX on server in BUFFER.
1303 If EXAMINE is non-nil, do a read-only select."
1305 imap-current-mailbox
1313 imap-current-mailbox)
1314 ;; Failed SELECT/EXAMINE unselects current mailbox
1327 "Examine MAILBOX on server in BUFFER."
1331 "Close current folder in BUFFER, without expunging articles."
1338 imap-current-mailbox
1342 imap-message-data nil
1344 t)))
1347 "Expunge articles in current folder in BUFFER.
1348 If ASYNCH, do not wait for successful completion of the command.
1349 If BUFFER is nil the current buffer is assumed."
1357 "Expunge articles and close current folder in BUFFER.
1358 If ASYNCH, do not wait for successful completion of the command.
1359 If BUFFER is nil the current buffer is assumed."
1366 imap-current-mailbox status)
1368 imap-current-mailbox)
1369 ;; Don't wipe out data if another mailbox
1370 ;; was selected...
1372 imap-message-data nil
1376 imap-message-data nil
1378 t)))
1384 "Create MAILBOX on server in BUFFER.
1385 If BUFFER is nil the current buffer is assumed."
1390 "Delete MAILBOX on server in BUFFER.
1391 If BUFFER is nil the current buffer is assumed."
1398 "Rename mailbox OLDNAME to NEWNAME on server in BUFFER.
1399 If BUFFER is nil the current buffer is assumed."
1408 "Return a list of subscribed mailboxes on server in BUFFER.
1409 If ROOT is non-nil, only list matching mailboxes. If ADD-DELIMITER is
1410 non-nil, a hierarchy delimiter is added to root. REFERENCE is an
1411 implementation-specific string that has to be passed to lsub command."
1413 ;; Make sure we know the hierarchy separator for root's hierarchy
1417 ;; clear list data (NB not delimiter and other stuff)
1432 "Return a list of mailboxes matching ROOT on server in BUFFER.
1433 If ADD-DELIMITER is non-nil, a hierarchy delimiter is added to
1434 root. REFERENCE is an implementation-specific string that has to be
1435 passed to list command."
1437 ;; Make sure we know the hierarchy separator for root's hierarchy
1441 ;; clear list data (NB not delimiter and other stuff)
1456 "Send the SUBSCRIBE command on the MAILBOX to server in BUFFER.
1457 Returns non-nil if successful."
1464 "Send the SUBSCRIBE command on the MAILBOX to server in BUFFER.
1465 Returns non-nil if successful."
1472 "Get status items ITEM in MAILBOX from server in BUFFER.
1473 ITEMS can be a symbol or a list of symbols, valid symbols are one of
1474 the STATUS data items -- i.e. `messages', `recent', `uidnext', `uidvalidity',
1475 or `unseen'. If ITEMS is a list of symbols, a list of values is
1476 returned, if ITEMS is a symbol only its value is returned."
1485 items
1490 items)
1494 "Send status item requests ITEMS on MAILBOX to server in BUFFER.
1495 ITEMS can be a symbol or a list of symbols, valid symbols are one of
1496 the STATUS data items -- i.e., `messages', `recent', `uidnext', `uidvalidity'
1497 or `unseen'. The IMAP command tag is returned."
1505 items
1509 "Get ACL on MAILBOX from server in BUFFER."
1519 "Change/set ACL for IDENTIFIER to RIGHTS in MAILBOX from server in BUFFER."
1526 identifier
1527 " "
1528 rights))))))
1531 "Remove <id,rights> pairs for IDENTIFIER from MAILBOX on server in BUFFER."
1538 identifier))))))
1540 \f
1541 ;; Message functions:
1545 imap-current-message))
1551 list
1564 range)
1572 uids)
1573 props))))
1576 "Fetch properties PROPS from message set UIDS from server in BUFFER.
1577 UIDS can be a string, number or a list of numbers. If RECEIVE is
1578 non-nil, return these properties."
1584 uids)
1585 props)))
1587 t
1593 receive)
1595 uids)
1602 propname value)
1605 t))
1610 propname)))
1613 "Map a function across each message in `imap-message-data', returning a list."
1619 imap-message-data)
1620 result)))
1666 ;; FIXME: Should this try to use CHARSET? -- fx
1674 nil)
1678 "Return t if FLAG can be permanently saved on articles.
1679 MAILBOX specifies a mailbox on the server in BUFFER."
1705 ;; Cf. http://thread.gmane.org/gmane.emacs.gnus.general/65317/focus=65343
1706 ;; Signal an error if we'd get an integer overflow.
1707 ;;
1708 ;; FIXME: Identify relevant calls to `string-to-number' and replace them with
1709 ;; `imap-string-to-integer'.
1715 number)))
1718 "Like `imap-fetch', but DTRT with Exchange 2007 bug.
1719 However, UIDS here is a cons, where the car is the canonical form
1720 of the UIDS specification, and the cdr is the one which works with
1721 Exchange 2007 or, potentially, other buggy servers.
1722 See `imap-enable-exchange-bug-workaround'."
1723 ;; The first time we get here for a given, we'll try the canonical
1724 ;; form. If we get the known error from the buggy server, set the
1725 ;; flag buffer-locally (to account for connections to multiple
1726 ;; servers), then re-try with the alternative UIDS spec. We don't
1727 ;; unconditionally use the alternative form, since the
1728 ;; currently-used alternatives are seriously inefficient with some
1729 ;; servers (although they are valid).
1730 ;;
1731 ;; FIXME: Maybe it would be cleaner to have a flag to not signal
1732 ;; the error (which otherwise gives a message), and test
1733 ;; `imap-failed-tags'. Also, Other IMAP clients use other forms of
1734 ;; request which work with Exchange, e.g. Claws does "UID FETCH 1:*
1735 ;; (UID)" rather than "FETCH UID 1,*". Is there a good reason not
1736 ;; to do the same?
1738 ;; Binding `debug-on-error' allows us to get the error from
1739 ;; `imap-parse-response' -- it's normally caught by Emacs around
1740 ;; execution of a process filter.
1745 props receive nouidfetch buffer))
1748 ;; This is the Exchange 2007 response. It may be more
1749 ;; robust just to check for a BAD response to the
1750 ;; attempted fetch.
1755 t)
1782 "Copy ARTICLES to MAILBOX on server in BUFFER.
1783 ARTICLES is a string message set. Create mailbox if it doesn't exist,
1784 unless DONT-CREATE is non-nil. On success, return a list with
1785 the UIDVALIDITY of the mailbox the article(s) was copied to as the
1786 first element. The rest of list contains the saved articles' UIDs."
1793 t
1795 ;; removed because of buggy Oracle server
1796 ;; that doesn't send TRYCREATE tags (which
1797 ;; is a MUST according to specifications):
1798 ;;(imap-mailbox-get-1 'trycreate mailbox)
1804 ;; FIXME: Amalgamate with imap-message-copyuid-1, using an extra arg, since it
1805 ;; shares most of the code? -- fx
1827 "Append ARTICLE (a buffer) to MAILBOX on server in BUFFER.
1828 FLAGS and DATE-TIME is currently not used. Return a cons holding
1829 uidvalidity of MAILBOX and UID the newly created article got, or nil
1830 on failure."
1840 "Return number of lines in article by looking at the mime bodystructure BODY."
1854 "Return a FROM string line."
1859 "@"
1863 \f
1864 ;; Internal functions.
1878 cmd cmdstr)
1886 size)
1891 ;; XXX modifies buffer!
1920 nil ;; abort command if no cont-req
1922 command)))
1928 tag)))
1937 message-log-max)
1946 ;; A process can die _before_ we have processed everything it
1947 ;; has to say. Moreover, this can happen in between the call to
1948 ;; accept-process-output and the call to process-status in an
1949 ;; iteration of the loop above.
1958 'INCOMPLETE
1965 "Return point at end of current line, taking into account literals.
1966 Return nil if no complete line has arrived."
1968 imap-server-eol)
1969 nil t)
1972 nil
1978 "IMAP process filter."
1979 ;; Sometimes, we are called even though the process has died.
1980 ;; Better abstain from doing stuff in that case.
2003 imap-state)))
2006 \f
2007 ;; Imap parser.
2012 ;; number = 1*DIGIT
2013 ;; ; Unsigned 32-bit integer
2014 ;; ; (0 <= n < 4,294,967,296)
2022 ;; literal = "{" number "}" CRLF *CHAR8
2023 ;; ; Number represents the number of CHAR8s
2030 nil
2034 ;; string = quoted / literal
2035 ;;
2036 ;; quoted = DQUOTE *QUOTED-CHAR DQUOTE
2037 ;;
2038 ;; QUOTED-CHAR = <any TEXT-CHAR except quoted-specials> /
2039 ;; "\" quoted-specials
2040 ;;
2041 ;; quoted-specials = DQUOTE / "\"
2042 ;;
2043 ;; TEXT-CHAR = <any CHAR except CR and LF>
2057 name))
2061 ;; nil = "NIL"
2067 ;; nstring = string / nil
2072 nil)))
2074 ;; astring = atom / string
2075 ;;
2076 ;; atom = 1*ATOM-CHAR
2077 ;;
2078 ;; ATOM-CHAR = <any CHAR except atom-specials>
2079 ;;
2080 ;; atom-specials = "(" / ")" / "{" / SP / CTL / list-wildcards /
2081 ;; quoted-specials
2082 ;;
2083 ;; list-wildcards = "%" / "*"
2084 ;;
2085 ;; quoted-specials = DQUOTE / "\"
2095 ;; address = "(" addr-name SP addr-adl SP addr-mailbox SP
2096 ;; addr-host ")"
2097 ;;
2098 ;; addr-adl = nstring
2099 ;; ; Holds route from [RFC-822] route-addr if
2100 ;; ; non-nil
2101 ;;
2102 ;; addr-host = nstring
2103 ;; ; nil indicates [RFC-822] group syntax.
2104 ;; ; Otherwise, holds [RFC-822] domain name
2105 ;;
2106 ;; addr-mailbox = nstring
2107 ;; ; nil indicates end of [RFC-822] group; if
2108 ;; ; non-nil and addr-host is nil, holds
2109 ;; ; [RFC-822] group name.
2110 ;; ; Otherwise, holds [RFC-822] local-part
2111 ;; ; after removing [RFC-822] quoting
2112 ;;
2113 ;; addr-name = nstring
2114 ;; ; If non-nil, holds phrase from [RFC-822]
2115 ;; ; mailbox after removing [RFC-822] quoting
2116 ;;
2131 address))))
2133 ;; address-list = "(" 1*address ")" / nil
2134 ;;
2135 ;; nil = "NIL"
2142 ;; next line for MS Exchange bug
2149 ;; With assert, the code might not be eval'd.
2150 ;; (assert (imap-parse-nil) t "In imap-parse-address-list")
2153 ;; mailbox = "INBOX" / astring
2154 ;; ; INBOX is case-insensitive. All case variants of
2155 ;; ; INBOX (e.g. "iNbOx") MUST be interpreted as INBOX
2156 ;; ; not as an astring. An astring which consists of
2157 ;; ; the case-insensitive sequence "I" "N" "B" "O" "X"
2158 ;; ; is considered to be INBOX and not an astring.
2159 ;; ; Refer to section 5.1 for further
2160 ;; ; semantic details of mailbox names.
2165 "INBOX"
2166 mailbox)))
2168 ;; greeting = "*" SP (resp-cond-auth / resp-cond-bye) CRLF
2169 ;;
2170 ;; resp-cond-auth = ("OK" / "PREAUTH") SP resp-text
2171 ;; ; Authentication condition
2172 ;;
2173 ;; resp-cond-bye = "BYE" SP resp-text
2176 "Parse an IMAP greeting."
2184 ;; response = *(continue-req / response-data) response-done
2185 ;;
2186 ;; continue-req = "+" SP (resp-text / base64) CRLF
2187 ;;
2188 ;; response-data = "*" SP (resp-cond-state / resp-cond-bye /
2189 ;; mailbox-data / message-data / capability-data) CRLF
2190 ;;
2191 ;; response-done = response-tagged / response-fatal
2192 ;;
2193 ;; response-fatal = "*" SP resp-cond-bye CRLF
2194 ;; ; Server closes connection immediately
2195 ;;
2196 ;; response-tagged = tag SP resp-cond-state CRLF
2197 ;;
2198 ;; resp-cond-state = ("OK" / "NO" / "BAD") SP resp-text
2199 ;; ; Status condition
2200 ;;
2201 ;; resp-cond-bye = "BYE" SP resp-text
2202 ;;
2203 ;; mailbox-data = "FLAGS" SP flag-list /
2204 ;; "LIST" SP mailbox-list /
2205 ;; "LSUB" SP mailbox-list /
2206 ;; "SEARCH" *(SP nz-number) /
2207 ;; "STATUS" SP mailbox SP "("
2208 ;; [status-att SP number *(SP status-att SP number)] ")" /
2209 ;; number SP "EXISTS" /
2210 ;; number SP "RECENT"
2211 ;;
2212 ;; message-data = nz-number SP ("EXPUNGE" / ("FETCH" SP msg-att))
2213 ;;
2214 ;; capability-data = "CAPABILITY" *(SP capability) SP "IMAP4rev1"
2215 ;; *(SP capability)
2216 ;; ; IMAP4rev1 servers which offer RFC 1730
2217 ;; ; compatibility MUST list "IMAP4" as the first
2218 ;; ; capability.
2221 "Parse an IMAP command response."
2227 t)))
2238 'search
2274 imap-failed-tags))))
2287 token status code text))))
2294 ;; resp-text = ["[" resp-text-code "]" SP] text
2295 ;;
2296 ;; text = 1*TEXT-CHAR
2297 ;;
2298 ;; TEXT-CHAR = <any CHAR except CR and LF>
2303 ;; resp-text-code = "ALERT" /
2304 ;; "BADCHARSET [SP "(" astring *(SP astring) ")" ] /
2305 ;; "NEWNAME" SP string SP string /
2306 ;; "PARSE" /
2307 ;; "PERMANENTFLAGS" SP "("
2308 ;; [flag-perm *(SP flag-perm)] ")" /
2309 ;; "READ-ONLY" /
2310 ;; "READ-WRITE" /
2311 ;; "TRYCREATE" /
2312 ;; "UIDNEXT" SP nz-number /
2313 ;; "UIDVALIDITY" SP nz-number /
2314 ;; "UNSEEN" SP nz-number /
2315 ;; resp-text-atom [SP 1*<any TEXT-CHAR except "]">]
2316 ;;
2317 ;; resp_code_apnd = "APPENDUID" SPACE nz_number SPACE uniqueid
2318 ;;
2319 ;; resp_code_copy = "COPYUID" SPACE nz_number SPACE set SPACE set
2320 ;;
2321 ;; set = sequence-num / (sequence-num ":" sequence-num) /
2322 ;; (set "," set)
2323 ;; ; Identifies a set of messages. For message
2324 ;; ; sequence numbers, these are consecutive
2325 ;; ; numbers from 1 to the number of messages in
2326 ;; ; the mailbox
2327 ;; ; Comma delimits individual numbers, colon
2328 ;; ; delimits between two numbers inclusive.
2329 ;; ; Example: 2,4:7,9,12:* is 2,4,5,6,7,9,12,13,
2330 ;; ; 14,15 for a mailbox with 15 messages.
2331 ;;
2332 ;; sequence-num = nz-number / "*"
2333 ;; ; * is the largest number in use. For message
2334 ;; ; sequence numbers, it is the number of messages
2335 ;; ; in the mailbox. For unique identifiers, it is
2336 ;; ; the unique identifier of the last message in
2337 ;; ; the mailbox.
2338 ;;
2339 ;; flag-perm = flag / "\*"
2340 ;;
2341 ;; flag = "\Answered" / "\Flagged" / "\Deleted" /
2342 ;; "\Seen" / "\Draft" / flag-keyword / flag-extension
2343 ;; ; Does not include "\Recent"
2344 ;;
2345 ;; flag-extension = "\" atom
2346 ;; ; Future expansion. Client implementations
2347 ;; ; MUST accept flag-extension flags. Server
2348 ;; ; implementations MUST NOT generate
2349 ;; ; flag-extension flags except as defined by
2350 ;; ; future standard or standards-track
2351 ;; ; revisions of this specification.
2352 ;;
2353 ;; flag-keyword = atom
2354 ;;
2355 ;; resp-text-atom = 1*<any ATOM-CHAR except "]">
2358 ;; xxx next line for stalker communigate pro 3.3.1 bug
2385 imap-current-target-mailbox))
2390 imap-current-target-mailbox))
2395 ;; mailbox-list = "(" [mbx-list-flags] ")" SP
2396 ;; (DQUOTE QUOTED-CHAR DQUOTE / nil) SP mailbox
2397 ;;
2398 ;; mbx-list-flags = *(mbx-list-oflag SP) mbx-list-sflag
2399 ;; *(SP mbx-list-oflag) /
2400 ;; mbx-list-oflag *(SP mbx-list-oflag)
2401 ;;
2402 ;; mbx-list-oflag = "\Noinferiors" / flag-extension
2403 ;; ; Other flags; multiple possible per LIST response
2404 ;;
2405 ;; mbx-list-sflag = "\Noselect" / "\Marked" / "\Unmarked"
2406 ;; ; Selectability flags; only one per LIST response
2407 ;;
2408 ;; QUOTED-CHAR = <any TEXT-CHAR except quoted-specials> /
2409 ;; "\" quoted-specials
2410 ;;
2411 ;; quoted-specials = DQUOTE / "\"
2424 ;; msg_att ::= "(" 1#("ENVELOPE" SPACE envelope /
2425 ;; "FLAGS" SPACE "(" #(flag / "\Recent") ")" /
2426 ;; "INTERNALDATE" SPACE date_time /
2427 ;; "RFC822" [".HEADER" / ".TEXT"] SPACE nstring /
2428 ;; "RFC822.SIZE" SPACE number /
2429 ;; "BODY" ["STRUCTURE"] SPACE body /
2430 ;; "BODY" section ["<" number ">"] SPACE nstring /
2431 ;; "UID" SPACE uniqueid) ")"
2432 ;;
2433 ;; date_time ::= <"> date_day_fixed "-" date_month "-" date_year
2434 ;; SPACE time SPACE zone <">
2435 ;;
2436 ;; section ::= "[" [section_text / (nz_number *["." nz_number]
2437 ;; ["." (section_text / "MIME")])] "]"
2438 ;;
2439 ;; section_text ::= "HEADER" / "HEADER.FIELDS" [".NOT"]
2440 ;; SPACE header_list / "TEXT"
2441 ;;
2442 ;; header_fld_name ::= astring
2443 ;;
2444 ;; header_list ::= "(" 1#header_fld_name ")"
2462 section)))
2467 rfc822size body bodydetail bodystructure flags-empty)
2468 ;; Courier can insert spurious blank characters which will
2469 ;; confuse `read', so skip past them.
2505 bodydetail)
2524 ;; mailbox-data = ...
2525 ;; "STATUS" SP mailbox SP "("
2526 ;; [status-att SP number
2527 ;; *(SP status-att SP number)] ")"
2528 ;; ...
2529 ;;
2530 ;; status-att = "MESSAGES" / "RECENT" / "UIDNEXT" / "UIDVALIDITY" /
2531 ;; "UNSEEN"
2559 token mailbox)
2562 ;; acl_data ::= "ACL" SPACE mailbox *(SPACE identifier SPACE
2563 ;; rights)
2564 ;;
2565 ;; identifier ::= astring
2566 ;;
2567 ;; rights ::= astring
2571 identifier rights acl)
2580 ;; flag-list = "(" [flag *(SP flag)] ")"
2581 ;;
2582 ;; flag = "\Answered" / "\Flagged" / "\Deleted" /
2583 ;; "\Seen" / "\Draft" / flag-keyword / flag-extension
2584 ;; ; Does not include "\Recent"
2585 ;;
2586 ;; flag-keyword = atom
2587 ;;
2588 ;; flag-extension = "\" atom
2589 ;; ; Future expansion. Client implementations
2590 ;; ; MUST accept flag-extension flags. Server
2591 ;; ; implementations MUST NOT generate
2592 ;; ; flag-extension flags except as defined by
2593 ;; ; future standard or standards-track
2594 ;; ; revisions of this specification.
2602 ;; next line for Courier IMAP bug.
2611 ;; envelope = "(" env-date SP env-subject SP env-from SP env-sender SP
2612 ;; env-reply-to SP env-to SP env-cc SP env-bcc SP
2613 ;; env-in-reply-to SP env-message-id ")"
2614 ;;
2615 ;; env-bcc = "(" 1*address ")" / nil
2616 ;;
2617 ;; env-cc = "(" 1*address ")" / nil
2618 ;;
2619 ;; env-date = nstring
2620 ;;
2621 ;; env-from = "(" 1*address ")" / nil
2622 ;;
2623 ;; env-in-reply-to = nstring
2624 ;;
2625 ;; env-message-id = nstring
2626 ;;
2627 ;; env-reply-to = "(" 1*address ")" / nil
2628 ;;
2629 ;; env-sender = "(" 1*address ")" / nil
2630 ;;
2631 ;; env-subject = nstring
2632 ;;
2633 ;; env-to = "(" 1*address ")" / nil
2659 ;; body-fld-param = "(" string SP string *(SP string SP string) ")" / nil
2667 ;; buggy stalker communigate pro 3.0 doesn't print SPC
2668 ;; between body-fld-param's sometimes
2673 nil)))
2675 ;; body-extension = nstring / number /
2676 ;; "(" body-extension *(SP body-extension) ")"
2677 ;; ; Future expansion. Client implementations
2678 ;; ; MUST accept body-extension fields. Server
2679 ;; ; implementations MUST NOT generate
2680 ;; ; body-extension fields except as defined by
2681 ;; ; future standard or standards-track
2682 ;; ; revisions of this specification.
2698 ;; body-ext-1part = body-fld-md5 [SP body-fld-dsp [SP body-fld-lang
2699 ;; *(SP body-extension)]]
2700 ;; ; MUST NOT be returned on non-extensible
2701 ;; ; "BODY" fetch
2702 ;;
2703 ;; body-ext-mpart = body-fld-param [SP body-fld-dsp [SP body-fld-lang
2704 ;; *(SP body-extension)]]
2705 ;; ; MUST NOT be returned on non-extensible
2706 ;; ; "BODY" fetch
2720 ;; With assert, the code might not be eval'd.
2721 ;; (assert (imap-parse-nil) t "In imap-parse-body-ext")
2732 ext))
2734 ;; body = "(" body-type-1part / body-type-mpart ")"
2735 ;;
2736 ;; body-ext-1part = body-fld-md5 [SP body-fld-dsp [SP body-fld-lang
2737 ;; *(SP body-extension)]]
2738 ;; ; MUST NOT be returned on non-extensible
2739 ;; ; "BODY" fetch
2740 ;;
2741 ;; body-ext-mpart = body-fld-param [SP body-fld-dsp [SP body-fld-lang
2742 ;; *(SP body-extension)]]
2743 ;; ; MUST NOT be returned on non-extensible
2744 ;; ; "BODY" fetch
2745 ;;
2746 ;; body-fields = body-fld-param SP body-fld-id SP body-fld-desc SP
2747 ;; body-fld-enc SP body-fld-octets
2748 ;;
2749 ;; body-fld-desc = nstring
2750 ;;
2751 ;; body-fld-dsp = "(" string SP body-fld-param ")" / nil
2752 ;;
2753 ;; body-fld-enc = (DQUOTE ("7BIT" / "8BIT" / "BINARY" / "BASE64"/
2754 ;; "QUOTED-PRINTABLE") DQUOTE) / string
2755 ;;
2756 ;; body-fld-id = nstring
2757 ;;
2758 ;; body-fld-lang = nstring / "(" string *(SP string) ")"
2759 ;;
2760 ;; body-fld-lines = number
2761 ;;
2762 ;; body-fld-md5 = nstring
2763 ;;
2764 ;; body-fld-octets = number
2765 ;;
2766 ;; body-fld-param = "(" string SP string *(SP string SP string) ")" / nil
2767 ;;
2768 ;; body-type-1part = (body-type-basic / body-type-msg / body-type-text)
2769 ;; [SP body-ext-1part]
2770 ;;
2771 ;; body-type-basic = media-basic SP body-fields
2772 ;; ; MESSAGE subtype MUST NOT be "RFC822"
2773 ;;
2774 ;; body-type-msg = media-message SP body-fields SP envelope
2775 ;; SP body SP body-fld-lines
2776 ;;
2777 ;; body-type-text = media-text SP body-fields SP body-fld-lines
2778 ;;
2779 ;; body-type-mpart = 1*body SP media-subtype
2780 ;; [SP body-ext-mpart]
2781 ;;
2782 ;; media-basic = ((DQUOTE ("APPLICATION" / "AUDIO" / "IMAGE" /
2783 ;; "MESSAGE" / "VIDEO") DQUOTE) / string) SP media-subtype
2784 ;; ; Defined in [MIME-IMT]
2785 ;;
2786 ;; media-message = DQUOTE "MESSAGE" DQUOTE SP DQUOTE "RFC822" DQUOTE
2787 ;; ; Defined in [MIME-IMT]
2788 ;;
2789 ;; media-subtype = string
2790 ;; ; Defined in [MIME-IMT]
2791 ;;
2792 ;; media-text = DQUOTE "TEXT" DQUOTE SP media-subtype
2793 ;; ; Defined in [MIME-IMT]
2803 ;; buggy stalker communigate pro 3.0 inserts a SPC between
2804 ;; parts in multiparts
2826 ;; next line for Sun SIMS bug
2836 ;; Next `or' for Sun SIMS bug. It regards body-fld-enc as a
2837 ;; nstring and returns nil instead of defaulting back to 7BIT
2838 ;; as the standard says.
2839 ;; Exchange (2007, at least) does this as well.
2842 ;; Exchange 2007 can return -1, contrary to the spec...
2849 ;; Ok, we're done parsing the required parts, what comes now is one of
2850 ;; three things:
2851 ;;
2852 ;; envelope (then we're parsing body-type-msg)
2853 ;; body-fld-lines (then we're parsing body-type-text)
2854 ;; body-ext-1part (then we're parsing body-type-basic)
2855 ;;
2856 ;; The problem is that the two first are in turn optionally followed
2857 ;; by the third. So we parse the first two here (if there are any)...
2866 ;; buggy stalker communigate pro 3.0 doesn't print
2867 ;; number of lines in message/rfc822 attachment
2877 ;; ...and then parse the third one here...
2892 '(
2893 imap-utf7-encode
2894 imap-utf7-decode
2895 imap-error-text
2896 imap-kerberos4s-p
2897 imap-kerberos4-open
2898 imap-network-p
2899 imap-network-open
2900 imap-interactive-login
2901 imap-kerberos4a-p
2902 imap-kerberos4-auth
2903 imap-cram-md5-p
2904 imap-cram-md5-auth
2905 imap-login-p
2906 imap-login-auth
2907 imap-anonymous-p
2908 imap-anonymous-auth
2909 imap-open-1
2910 imap-open
2911 imap-opened
2912 imap-ping-server
2913 imap-authenticate
2914 imap-close
2915 imap-capability
2916 imap-namespace
2917 imap-send-command-wait
2918 imap-mailbox-put
2919 imap-mailbox-get
2920 imap-mailbox-map-1
2921 imap-mailbox-map
2922 imap-current-mailbox
2923 imap-current-mailbox-p-1
2924 imap-current-mailbox-p
2925 imap-mailbox-select-1
2926 imap-mailbox-select
2927 imap-mailbox-examine-1
2928 imap-mailbox-examine
2929 imap-mailbox-unselect
2930 imap-mailbox-expunge
2931 imap-mailbox-close
2932 imap-mailbox-create-1
2933 imap-mailbox-create
2934 imap-mailbox-delete
2935 imap-mailbox-rename
2936 imap-mailbox-lsub
2937 imap-mailbox-list
2938 imap-mailbox-subscribe
2939 imap-mailbox-unsubscribe
2940 imap-mailbox-status
2941 imap-mailbox-acl-get
2942 imap-mailbox-acl-set
2943 imap-mailbox-acl-delete
2944 imap-current-message
2945 imap-list-to-message-set
2946 imap-fetch-asynch
2947 imap-fetch
2948 imap-fetch-safe
2949 imap-message-put
2950 imap-message-get
2951 imap-message-map
2952 imap-search
2953 imap-message-flag-permanent-p
2954 imap-message-flags-set
2955 imap-message-flags-del
2956 imap-message-flags-add
2957 imap-message-copyuid-1
2958 imap-message-copyuid
2959 imap-message-copy
2960 imap-message-appenduid-1
2961 imap-message-appenduid
2962 imap-message-append
2963 imap-body-lines
2964 imap-envelope-from
2965 imap-send-command-1
2966 imap-send-command
2967 imap-wait-for-tag
2968 imap-sentinel
2969 imap-find-next-line
2970 imap-arrival-filter
2971 imap-parse-greeting
2972 imap-parse-response
2973 imap-parse-resp-text
2974 imap-parse-resp-text-code
2975 imap-parse-data-list
2976 imap-parse-fetch
2977 imap-parse-status
2978 imap-parse-acl
2979 imap-parse-flag-list
2980 imap-parse-envelope
2981 imap-parse-body-extension
2982 imap-parse-body
2983 )))
2987 ;;; imap.el ends here