| blob | 8cb248aa513d366836f98211227cd1a41a005c48 |
1 ;;; imap.el --- imap library
3 ;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
6 ;; Author: Simon Josefsson <jas@pdc.kth.se>
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 a 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 support RFC1730/2060/RFC3501 (IMAP4/IMAP4rev1), 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'), 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 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 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 ;; o Don't use `read' at all (important places already fixed)
125 ;; o Accept list of articles instead of message set string in most
126 ;; imap-message-* functions.
127 ;; o Send strings as literal if they contain, e.g., ".
128 ;;
129 ;; Revision history:
130 ;;
131 ;; - 19991218 added starttls/digest-md5 patch,
132 ;; by Daiki Ueno <ueno@ueda.info.waseda.ac.jp>
133 ;; NB! you need SLIM for starttls.el and digest-md5.el
134 ;; - 19991023 commited to pgnus
135 ;;
137 ;;; Code:
156 ;; User variables.
159 "Low-level IMAP issues."
165 "List of strings containing commands for Kerberos 4 authentication.
166 %s is replaced with server hostname, %p with port to connect to, and
167 %l with the value of `imap-default-user'. The program should accept
168 IMAP commands on stdin and return responses to stdout. Each entry in
169 the list is tried until a successful connection is made."
175 "--mechanism GSSAPI "
178 "List of strings containing commands for GSSAPI (krb5) authentication.
179 %s is replaced with server hostname, %p with port to connect to, and
180 %l with the value of `imap-default-user'. The program should accept
181 IMAP commands on stdin and return responses to stdout. Each entry in
182 the list is tried until a successful connection is made."
187 "openssl s_client -quiet -ssl2 -connect %s:%p"
188 "s_client -quiet -ssl3 -connect %s:%p"
190 "A string, or list of strings, containing commands for SSL connections.
191 Within a string, %s is replaced with the server address and %p with
192 port number on server. The program should accept IMAP commands on
193 stdin and return responses to stdout. Each entry in the list is tried
194 until a successful connection is made."
200 "rsh %s imapd"
201 "ssh %g ssh %s imapd"
203 "A list of strings, containing commands for IMAP connection.
204 Within a string, %s is replaced with the server address, %p with port
205 number on server, %g with `imap-shell-host', and %l with
206 `imap-default-user'. The program should read IMAP commands from stdin
207 and write IMAP response to stdout. Each entry in the list is tried
208 until a successful connection is made."
213 "*Value for `process-connection-type' to use for Kerberos4, GSSAPI and SSL.
214 The `process-connection-type' variable control type of device
215 used to communicate with subprocesses. Values are nil to use a
216 pipe, or t or `pty' to use a pty. The value has no effect if the
217 system has no ptys or if all ptys are busy: then a pipe is used
218 in any case. The value takes effect when a IMAP server is
219 opened, changing it after that has no effect."
225 "If non-nil, do utf7 encoding/decoding of mailbox names.
226 Since the UTF7 decoding currently only decodes into ISO-8859-1
227 characters, you may disable this decoding if you need to access UTF7
228 encoded mailboxes which doesn't translate into ISO-8859-1."
233 "If non-nil, a imap session trace is placed in *imap-log* buffer.
234 Note that username, passwords and other privacy sensitive
235 information (such as e-mail) may be stored in the *imap-log*
236 buffer. It is not written to disk, however. Do not enable this
237 variable unless you are comfortable with that."
242 "If non-nil, random debug spews are placed in *imap-debug* buffer.
243 Note that username, passwords and other privacy sensitive
244 information (such as e-mail) may be stored in the *imap-debug*
245 buffer. It is not written to disk, however. Do not enable this
246 variable unless you are comfortable with that."
251 "Hostname of rlogin proxy."
256 "Default username to use."
263 1.0
265 "*How long to wait between checking for the end of output.
266 Shorter values mean quicker response, but is more CPU intensive."
271 "If non-nil, store session password without promting."
275 ;; Various variables.
291 "Definition of network streams.
293 \(NAME CHECK OPEN)
295 NAME names the stream, CHECK is a function returning non-nil if the
296 server support the stream and OPEN is a function for opening the
300 kerberos4
301 digest-md5
302 cram-md5
303 ;;sasl
304 login
305 anonymous)
316 "Definition of authenticators.
318 \(NAME CHECK AUTHENTICATE)
320 NAME names the authenticator. CHECK is a function returning non-nil if
321 the server support the authenticator and AUTHENTICATE is a function
328 "Close server immediately if it can't logout in this number of seconds.
329 If it is nil, never close server until logout completes. Normally,
330 the value of this variable will be bound to a certain value to which
331 an application program that uses this module specifies on a per-server
334 ;; Internal constants. Change these and die.
343 imap-port
344 imap-client-eol
345 imap-server-eol
346 imap-auth
347 imap-stream
348 imap-username
349 imap-password
350 imap-current-mailbox
351 imap-current-target-mailbox
352 imap-message-data
353 imap-capability
354 imap-id
355 imap-namespace
356 imap-state
357 imap-reached-tag
358 imap-failed-tags
359 imap-tag
360 imap-process
361 imap-calculate-literal-size-first
362 imap-mailbox-data))
366 ;; Internal variables.
376 "IMAP state.
377 Valid states are `closed', `initial', `nonauth', `auth', `selected'
411 "Identity of server.
421 "Alist of tags that failed.
422 Each element is a list with four elements; tag (a integer), response
423 state (a symbol, `OK', `NO' or `BAD'), response code (a string), and
433 "Non-nil indicates that the server emitted a continuation request.
437 "List of response tags and callbacks, on the form `(number . function)'.
438 The function should take two arguments, the first the IMAP tag and the
442 "Send FETCH UID commands as *:* instead of *.
443 Enabling this appears to be required for some servers (e.g.,
444 Microsoft Exchange) which otherwise would trigger a response 'BAD
447 \f
448 ;; Utility functions:
451 "Delete by side effect any elements of LIST whose car is `equal' to KEY.
452 The modified LIST is returned. If the first member
453 of LIST has a car that is `equal' to KEY, there is no way to remove it
454 by side effect; therefore, write `(setq foo (remassoc key foo))' to be
455 sure of changing the value of `foo'."
460 alist)))
463 "Enable multibyte in the current buffer."
473 "imap: Could not UTF7 encode `%s', using it unencoded..."
474 string)
475 string)))
476 string))
484 "imap: Could not UTF7 decode `%s', using it undecoded..."
485 string)
486 string)))
487 string))
491 t
493 nil))
499 \f
500 ;; Server functions; stream stuff:
507 cmd done)
516 name buffer shell-file-name shell-command-switch
518 cmd
520 ?s server
522 ?l imap-default-user))))
523 response)
527 imap-calculate-literal-size-first t)
531 ;; Athena IMTEST can output SSL verify errors
534 t)
537 t)
538 ;; cyrus 1.6.x (13? < x <= 22) queries capabilities
541 t)
542 ;; cyrus 1.6 imtest print "S: " before server greeting
545 t)
547 ;; success in imtest < 1.6:
550 ;; success in imtest 1.6:
571 nil)))))
572 done))
579 cmd done)
588 name buffer shell-file-name shell-command-switch
590 cmd
592 ?s server
594 ?l imap-default-user))))
595 response)
599 imap-calculate-literal-size-first t)
603 ;; Athena IMTEST can output SSL verify errors
606 t)
609 t)
610 ;; cyrus 1.6.x (13? < x <= 22) queries capabilities
613 t)
614 ;; cyrus 1.6 imtest print "S: " before server greeting
617 t)
618 ;; GNU SASL may print 'Trying ...' first.
621 t)
623 ;; success in imtest 1.6:
626 "Client authentication "
628 nil t)
646 nil)))))
647 done))
650 nil)
653 "Open a SSL connection to server."
656 cmd done)
666 'set-process-query-on-exit-flag
668 process)
671 name buffer shell-file-name
672 shell-command-switch
675 ?s server
678 process)
700 done)
702 nil)))
705 nil)
727 process))))
730 t)
751 process))))
754 nil)
759 cmd done)
767 name buffer shell-file-name shell-command-switch
769 cmd
771 ?s server
772 ?g imap-shell-host
774 ?l imap-default-user)))))
795 done)
797 nil)))
807 done tls-info)
836 done))
838 ;; Server functions; authenticator stuff:
841 "Login to server in BUFFER.
842 LOGINFUNC is passed a username and a password, it should return t if
843 it where successful authenticating itself to the server, nil otherwise.
844 Returns t if login was successful, nil otherwise."
849 ;; (condition-case ()
860 imap-server " (using authenticator `"
866 imap-username user)
875 ;; (quit (with-current-buffer buffer
876 ;; (setq user nil
877 ;; passwd nil)))
878 ;; (error (with-current-buffer buffer
879 ;; (setq user nil
880 ;; passwd nil))))
881 ret)))
904 "Login to server using the AUTH CRAM-MD5 method."
907 buffer
912 "AUTHENTICATE CRAM-MD5"
918 encoded)))))))))
938 "Login to server using the LOGIN command."
950 t)
959 ;;; Compiler directives.
972 mecs))
988 "Login to server using the SASL method."
995 logged user)
1011 buffer)))
1021 logged t)
1024 logged)))
1033 "Login to server using the AUTH DIGEST-MD5 method."
1036 buffer
1041 "AUTHENTICATE DIGEST-MD5"
1050 user passwd digest-uri)))
1052 )))
1054 nil
1059 ;; Server functions:
1065 imap-current-message nil
1066 imap-state 'initial
1069 imap-stream-alist))
1081 imap-process))))
1084 "Open a IMAP connection to host SERVER at PORT returning a buffer.
1085 If PORT is unspecified, a default value is used (143 except
1086 for SSL which use 993).
1087 STREAM indicates the stream to use, see `imap-streams' for available
1088 streams. If nil, it choices the best stream the server is capable of.
1089 AUTH indicates authenticator to use, see `imap-authenticators' for
1090 available authenticators. If nil, it choices the best stream the
1091 server is capable of.
1092 BUFFER can be a buffer or a name of a buffer, which is created if
1093 necessary. If nil, the buffer name is generated."
1110 nil)
1112 ;; Need to choose stream.
1115 ;; OK to use this stream?
1117 ;; Stream changed?
1133 "imap: Reconnecting with stream `%s'...failed"
1134 stream))
1135 ;; We're done, kill the first connection
1138 buffer
1143 stream)
1147 ;; We're done
1155 buffer))))
1158 "If non-nil, check if IMAP is open.
1159 See the function `imap-ping-server'."
1165 "Return non-nil if connection to imap server in BUFFER is open.
1166 If BUFFER is nil then the current buffer is used."
1174 t)))))
1178 Return non-nil if the server responds, and nil if it does not
1179 respond. If BUFFER is nil, the current buffer is used."
1185 "Authenticate to server in BUFFER, using current buffer if nil.
1186 It uses the authenticator specified when opening the server. If the
1187 authenticator requires username/passwords, they are queried from the
1188 user and optionally stored in the buffer. If USER and/or PASSWD is
1189 specified, the user will not be questioned and the username and/or
1190 password is remembered in the buffer."
1204 ;; Choose authenticator.
1206 auth)
1208 ;; OK to use authenticator?
1211 imap-server auth)
1216 imap-server auth)
1219 imap-server auth)))))
1220 imap-state))))
1223 "Close connection to server in BUFFER.
1224 If BUFFER is nil, the current buffer is used."
1234 imap-current-message nil
1235 imap-process nil)
1237 t))
1240 "Return a list of identifiers which server in BUFFER support.
1241 If IDENTIFIER, return non-nil if it's among the servers capabilities.
1242 If BUFFER is nil, the current buffer is assumed."
1249 imap-capability)))
1252 "Identify client to server in BUFFER, and return server identity.
1253 LIST-OF-VALUES is nil, or a plist with identifier and value
1254 strings to send to the server to identify the client.
1256 Return a list of identifiers which server in BUFFER support, or
1257 nil if it doesn't support ID or returns no information.
1259 If BUFFER is nil, the current buffer is assumed."
1264 "ID NIL"
1267 list-of-values
1269 imap-id)))
1272 "Return a namespace hierarchy at server in BUFFER.
1273 If BUFFER is nil, the current buffer is assumed."
1278 imap-namespace))
1305 \f
1306 ;; Mailbox functions:
1312 propname value)
1315 t))
1319 propname))
1334 imap-mailbox-data)
1335 result)))
1338 "Map a function across each mailbox in `imap-mailbox-data', returning a list.
1339 Function should take a mailbox name (a string) as
1340 the only argument."
1359 "Select MAILBOX on server in BUFFER.
1360 If EXAMINE is non-nil, do a read-only select."
1362 imap-current-mailbox
1370 imap-current-mailbox)
1371 ;; Failed SELECT/EXAMINE unselects current mailbox
1384 "Examine MAILBOX on server in BUFFER."
1388 "Close current folder in BUFFER, without expunging articles."
1395 imap-current-mailbox
1399 imap-message-data nil
1401 t)))
1404 "Expunge articles in current folder in BUFFER.
1405 If ASYNCH, do not wait for succesful completion of the command.
1406 If BUFFER is nil the current buffer is assumed."
1414 "Expunge articles and close current folder in BUFFER.
1415 If ASYNCH, do not wait for succesful completion of the command.
1416 If BUFFER is nil the current buffer is assumed."
1423 imap-current-mailbox status)
1425 imap-current-mailbox)
1426 ;; Don't wipe out data if another mailbox
1427 ;; was selected...
1429 imap-message-data nil
1433 imap-message-data nil
1435 t)))
1441 "Create MAILBOX on server in BUFFER.
1442 If BUFFER is nil the current buffer is assumed."
1447 "Delete MAILBOX on server in BUFFER.
1448 If BUFFER is nil the current buffer is assumed."
1455 "Rename mailbox OLDNAME to NEWNAME on server in BUFFER.
1456 If BUFFER is nil the current buffer is assumed."
1465 "Return a list of subscribed mailboxes on server in BUFFER.
1466 If ROOT is non-nil, only list matching mailboxes. If ADD-DELIMITER is
1467 non-nil, a hierarchy delimiter is added to root. REFERENCE is a
1468 implementation-specific string that has to be passed to lsub command."
1470 ;; Make sure we know the hierarchy separator for root's hierarchy
1474 ;; clear list data (NB not delimiter and other stuff)
1489 "Return a list of mailboxes matching ROOT on server in BUFFER.
1490 If ADD-DELIMITER is non-nil, a hierarchy delimiter is added to
1491 root. REFERENCE is a implementation-specific string that has to be
1492 passed to list command."
1494 ;; Make sure we know the hierarchy separator for root's hierarchy
1498 ;; clear list data (NB not delimiter and other stuff)
1513 "Send the SUBSCRIBE command on the mailbox to server in BUFFER.
1514 Returns non-nil if successful."
1521 "Send the SUBSCRIBE command on the mailbox to server in BUFFER.
1522 Returns non-nil if successful."
1529 "Get status items ITEM in MAILBOX from server in BUFFER.
1530 ITEMS can be a symbol or a list of symbols, valid symbols are one of
1531 the STATUS data items -- ie 'messages, 'recent, 'uidnext, 'uidvalidity
1532 or 'unseen. If ITEMS is a list of symbols, a list of values is
1533 returned, if ITEMS is a symbol only its value is returned."
1542 items
1547 items)
1551 "Send status item request ITEM on MAILBOX to server in BUFFER.
1552 ITEMS can be a symbol or a list of symbols, valid symbols are one of
1553 the STATUS data items -- ie 'messages, 'recent, 'uidnext, 'uidvalidity
1554 or 'unseen. The IMAP command tag is returned."
1562 items
1566 "Get ACL on mailbox from server in BUFFER."
1576 "Change/set ACL for IDENTIFIER to RIGHTS in MAILBOX from server in BUFFER."
1583 identifier
1584 " "
1585 rights))))))
1588 "Removes any <identifier,rights> pair for IDENTIFIER in MAILBOX from server in BUFFER."
1595 identifier))))))
1597 \f
1598 ;; Message functions:
1602 imap-current-message))
1608 list
1621 range)
1629 uids)
1630 props))))
1633 "Fetch properties PROPS from message set UIDS from server in BUFFER.
1634 UIDS can be a string, number or a list of numbers. If RECEIVE
1635 is non-nil return these properties."
1641 uids)
1642 props)))
1644 t
1650 receive)
1652 uids)
1659 propname value)
1662 t))
1667 propname)))
1670 "Map a function across each mailbox in `imap-message-data', returning a list."
1676 imap-message-data)
1677 result)))
1730 nil)
1734 "Return t if FLAG can be permanently (between IMAP sessions) saved on articles, in MAILBOX on server in BUFFER."
1760 ;; Cf. http://thread.gmane.org/gmane.emacs.gnus.general/65317/focus=65343
1761 ;; Signal an error if we'd get an integer overflow.
1762 ;;
1763 ;; FIXME: Identify relevant calls to `string-to-number' and replace them with
1764 ;; `imap-string-to-integer'.
1770 number)))
1796 "Copy ARTICLES (a string message set) to MAILBOX on server in
1797 BUFFER, creating mailbox if it doesn't exist. If dont-create is
1798 non-nil, it will not create a mailbox. On success, return a list with
1799 the UIDVALIDITY of the mailbox the article(s) was copied to as the
1800 first element, rest of list contain the saved articles' UIDs."
1807 t
1809 ;; removed because of buggy Oracle server
1810 ;; that doesn't send TRYCREATE tags (which
1811 ;; is a MUST according to specifications):
1812 ;;(imap-mailbox-get-1 'trycreate mailbox)
1840 "Append ARTICLE (a buffer) to MAILBOX on server in BUFFER.
1841 FLAGS and DATE-TIME is currently not used. Return a cons holding
1842 uidvalidity of MAILBOX and UID the newly created article got, or nil
1843 on failure."
1853 "Return number of lines in article by looking at the mime bodystructure BODY."
1867 "Return a from string line."
1872 "@"
1876 \f
1877 ;; Internal functions.
1896 cmd cmdstr)
1904 size)
1909 ;; XXX modifies buffer!
1929 imap-log-buffer)
1945 command)))
1951 tag)))
1960 message-log-max)
1969 ;; A process can die _before_ we have processed everything it
1970 ;; has to say. Moreover, this can happen in between the call to
1971 ;; accept-process-output and the call to process-status in an
1972 ;; iteration of the loop above.
1981 'INCOMPLETE
1988 "Return point at end of current line, taking into account literals.
1989 Return nil if no complete line has arrived."
1991 imap-server-eol)
1992 nil t)
1995 nil
2001 "IMAP process filter."
2002 ;; Sometimes, we are called even though the process has died.
2003 ;; Better abstain from doing stuff in that case.
2031 imap-state)))
2034 \f
2035 ;; Imap parser.
2040 ;; number = 1*DIGIT
2041 ;; ; Unsigned 32-bit integer
2042 ;; ; (0 <= n < 4,294,967,296)
2050 ;; literal = "{" number "}" CRLF *CHAR8
2051 ;; ; Number represents the number of CHAR8s
2058 nil
2062 ;; string = quoted / literal
2063 ;;
2064 ;; quoted = DQUOTE *QUOTED-CHAR DQUOTE
2065 ;;
2066 ;; QUOTED-CHAR = <any TEXT-CHAR except quoted-specials> /
2067 ;; "\" quoted-specials
2068 ;;
2069 ;; quoted-specials = DQUOTE / "\"
2070 ;;
2071 ;; TEXT-CHAR = <any CHAR except CR and LF>
2085 name))
2089 ;; nil = "NIL"
2095 ;; nstring = string / nil
2100 nil)))
2102 ;; astring = atom / string
2103 ;;
2104 ;; atom = 1*ATOM-CHAR
2105 ;;
2106 ;; ATOM-CHAR = <any CHAR except atom-specials>
2107 ;;
2108 ;; atom-specials = "(" / ")" / "{" / SP / CTL / list-wildcards /
2109 ;; quoted-specials
2110 ;;
2111 ;; list-wildcards = "%" / "*"
2112 ;;
2113 ;; quoted-specials = DQUOTE / "\"
2123 ;; address = "(" addr-name SP addr-adl SP addr-mailbox SP
2124 ;; addr-host ")"
2125 ;;
2126 ;; addr-adl = nstring
2127 ;; ; Holds route from [RFC-822] route-addr if
2128 ;; ; non-nil
2129 ;;
2130 ;; addr-host = nstring
2131 ;; ; nil indicates [RFC-822] group syntax.
2132 ;; ; Otherwise, holds [RFC-822] domain name
2133 ;;
2134 ;; addr-mailbox = nstring
2135 ;; ; nil indicates end of [RFC-822] group; if
2136 ;; ; non-nil and addr-host is nil, holds
2137 ;; ; [RFC-822] group name.
2138 ;; ; Otherwise, holds [RFC-822] local-part
2139 ;; ; after removing [RFC-822] quoting
2140 ;;
2141 ;; addr-name = nstring
2142 ;; ; If non-nil, holds phrase from [RFC-822]
2143 ;; ; mailbox after removing [RFC-822] quoting
2144 ;;
2159 address))))
2161 ;; address-list = "(" 1*address ")" / nil
2162 ;;
2163 ;; nil = "NIL"
2170 ;; next line for MS Exchange bug
2177 ;; With assert, the code might not be eval'd.
2178 ;; (assert (imap-parse-nil) t "In imap-parse-address-list")
2181 ;; mailbox = "INBOX" / astring
2182 ;; ; INBOX is case-insensitive. All case variants of
2183 ;; ; INBOX (e.g. "iNbOx") MUST be interpreted as INBOX
2184 ;; ; not as an astring. An astring which consists of
2185 ;; ; the case-insensitive sequence "I" "N" "B" "O" "X"
2186 ;; ; is considered to be INBOX and not an astring.
2187 ;; ; Refer to section 5.1 for further
2188 ;; ; semantic details of mailbox names.
2193 "INBOX"
2194 mailbox)))
2196 ;; greeting = "*" SP (resp-cond-auth / resp-cond-bye) CRLF
2197 ;;
2198 ;; resp-cond-auth = ("OK" / "PREAUTH") SP resp-text
2199 ;; ; Authentication condition
2200 ;;
2201 ;; resp-cond-bye = "BYE" SP resp-text
2204 "Parse a IMAP greeting."
2212 ;; response = *(continue-req / response-data) response-done
2213 ;;
2214 ;; continue-req = "+" SP (resp-text / base64) CRLF
2215 ;;
2216 ;; response-data = "*" SP (resp-cond-state / resp-cond-bye /
2217 ;; mailbox-data / message-data / capability-data) CRLF
2218 ;;
2219 ;; response-done = response-tagged / response-fatal
2220 ;;
2221 ;; response-fatal = "*" SP resp-cond-bye CRLF
2222 ;; ; Server closes connection immediately
2223 ;;
2224 ;; response-tagged = tag SP resp-cond-state CRLF
2225 ;;
2226 ;; resp-cond-state = ("OK" / "NO" / "BAD") SP resp-text
2227 ;; ; Status condition
2228 ;;
2229 ;; resp-cond-bye = "BYE" SP resp-text
2230 ;;
2231 ;; mailbox-data = "FLAGS" SP flag-list /
2232 ;; "LIST" SP mailbox-list /
2233 ;; "LSUB" SP mailbox-list /
2234 ;; "SEARCH" *(SP nz-number) /
2235 ;; "STATUS" SP mailbox SP "("
2236 ;; [status-att SP number *(SP status-att SP number)] ")" /
2237 ;; number SP "EXISTS" /
2238 ;; number SP "RECENT"
2239 ;;
2240 ;; message-data = nz-number SP ("EXPUNGE" / ("FETCH" SP msg-att))
2241 ;;
2242 ;; capability-data = "CAPABILITY" *(SP capability) SP "IMAP4rev1"
2243 ;; *(SP capability)
2244 ;; ; IMAP4rev1 servers which offer RFC 1730
2245 ;; ; compatibility MUST list "IMAP4" as the first
2246 ;; ; capability.
2249 "Parse a IMAP command response."
2255 t)))
2266 'search
2302 imap-failed-tags))))
2315 token status code text))))
2322 ;; resp-text = ["[" resp-text-code "]" SP] text
2323 ;;
2324 ;; text = 1*TEXT-CHAR
2325 ;;
2326 ;; TEXT-CHAR = <any CHAR except CR and LF>
2331 ;; resp-text-code = "ALERT" /
2332 ;; "BADCHARSET [SP "(" astring *(SP astring) ")" ] /
2333 ;; "NEWNAME" SP string SP string /
2334 ;; "PARSE" /
2335 ;; "PERMANENTFLAGS" SP "("
2336 ;; [flag-perm *(SP flag-perm)] ")" /
2337 ;; "READ-ONLY" /
2338 ;; "READ-WRITE" /
2339 ;; "TRYCREATE" /
2340 ;; "UIDNEXT" SP nz-number /
2341 ;; "UIDVALIDITY" SP nz-number /
2342 ;; "UNSEEN" SP nz-number /
2343 ;; resp-text-atom [SP 1*<any TEXT-CHAR except "]">]
2344 ;;
2345 ;; resp_code_apnd = "APPENDUID" SPACE nz_number SPACE uniqueid
2346 ;;
2347 ;; resp_code_copy = "COPYUID" SPACE nz_number SPACE set SPACE set
2348 ;;
2349 ;; set = sequence-num / (sequence-num ":" sequence-num) /
2350 ;; (set "," set)
2351 ;; ; Identifies a set of messages. For message
2352 ;; ; sequence numbers, these are consecutive
2353 ;; ; numbers from 1 to the number of messages in
2354 ;; ; the mailbox
2355 ;; ; Comma delimits individual numbers, colon
2356 ;; ; delimits between two numbers inclusive.
2357 ;; ; Example: 2,4:7,9,12:* is 2,4,5,6,7,9,12,13,
2358 ;; ; 14,15 for a mailbox with 15 messages.
2359 ;;
2360 ;; sequence-num = nz-number / "*"
2361 ;; ; * is the largest number in use. For message
2362 ;; ; sequence numbers, it is the number of messages
2363 ;; ; in the mailbox. For unique identifiers, it is
2364 ;; ; the unique identifier of the last message in
2365 ;; ; the mailbox.
2366 ;;
2367 ;; flag-perm = flag / "\*"
2368 ;;
2369 ;; flag = "\Answered" / "\Flagged" / "\Deleted" /
2370 ;; "\Seen" / "\Draft" / flag-keyword / flag-extension
2371 ;; ; Does not include "\Recent"
2372 ;;
2373 ;; flag-extension = "\" atom
2374 ;; ; Future expansion. Client implementations
2375 ;; ; MUST accept flag-extension flags. Server
2376 ;; ; implementations MUST NOT generate
2377 ;; ; flag-extension flags except as defined by
2378 ;; ; future standard or standards-track
2379 ;; ; revisions of this specification.
2380 ;;
2381 ;; flag-keyword = atom
2382 ;;
2383 ;; resp-text-atom = 1*<any ATOM-CHAR except "]">
2386 ;; xxx next line for stalker communigate pro 3.3.1 bug
2413 imap-current-target-mailbox))
2418 imap-current-target-mailbox))
2423 ;; mailbox-list = "(" [mbx-list-flags] ")" SP
2424 ;; (DQUOTE QUOTED-CHAR DQUOTE / nil) SP mailbox
2425 ;;
2426 ;; mbx-list-flags = *(mbx-list-oflag SP) mbx-list-sflag
2427 ;; *(SP mbx-list-oflag) /
2428 ;; mbx-list-oflag *(SP mbx-list-oflag)
2429 ;;
2430 ;; mbx-list-oflag = "\Noinferiors" / flag-extension
2431 ;; ; Other flags; multiple possible per LIST response
2432 ;;
2433 ;; mbx-list-sflag = "\Noselect" / "\Marked" / "\Unmarked"
2434 ;; ; Selectability flags; only one per LIST response
2435 ;;
2436 ;; QUOTED-CHAR = <any TEXT-CHAR except quoted-specials> /
2437 ;; "\" quoted-specials
2438 ;;
2439 ;; quoted-specials = DQUOTE / "\"
2452 ;; msg_att ::= "(" 1#("ENVELOPE" SPACE envelope /
2453 ;; "FLAGS" SPACE "(" #(flag / "\Recent") ")" /
2454 ;; "INTERNALDATE" SPACE date_time /
2455 ;; "RFC822" [".HEADER" / ".TEXT"] SPACE nstring /
2456 ;; "RFC822.SIZE" SPACE number /
2457 ;; "BODY" ["STRUCTURE"] SPACE body /
2458 ;; "BODY" section ["<" number ">"] SPACE nstring /
2459 ;; "UID" SPACE uniqueid) ")"
2460 ;;
2461 ;; date_time ::= <"> date_day_fixed "-" date_month "-" date_year
2462 ;; SPACE time SPACE zone <">
2463 ;;
2464 ;; section ::= "[" [section_text / (nz_number *["." nz_number]
2465 ;; ["." (section_text / "MIME")])] "]"
2466 ;;
2467 ;; section_text ::= "HEADER" / "HEADER.FIELDS" [".NOT"]
2468 ;; SPACE header_list / "TEXT"
2469 ;;
2470 ;; header_fld_name ::= astring
2471 ;;
2472 ;; header_list ::= "(" 1#header_fld_name ")"
2490 section)))
2495 rfc822size body bodydetail bodystructure flags-empty)
2496 ;; Courier can insert spurious blank characters which will
2497 ;; confuse `read', so skip past them.
2533 bodydetail)
2552 ;; mailbox-data = ...
2553 ;; "STATUS" SP mailbox SP "("
2554 ;; [status-att SP number
2555 ;; *(SP status-att SP number)] ")"
2556 ;; ...
2557 ;;
2558 ;; status-att = "MESSAGES" / "RECENT" / "UIDNEXT" / "UIDVALIDITY" /
2559 ;; "UNSEEN"
2587 token mailbox)
2590 ;; acl_data ::= "ACL" SPACE mailbox *(SPACE identifier SPACE
2591 ;; rights)
2592 ;;
2593 ;; identifier ::= astring
2594 ;;
2595 ;; rights ::= astring
2599 identifier rights acl)
2608 ;; flag-list = "(" [flag *(SP flag)] ")"
2609 ;;
2610 ;; flag = "\Answered" / "\Flagged" / "\Deleted" /
2611 ;; "\Seen" / "\Draft" / flag-keyword / flag-extension
2612 ;; ; Does not include "\Recent"
2613 ;;
2614 ;; flag-keyword = atom
2615 ;;
2616 ;; flag-extension = "\" atom
2617 ;; ; Future expansion. Client implementations
2618 ;; ; MUST accept flag-extension flags. Server
2619 ;; ; implementations MUST NOT generate
2620 ;; ; flag-extension flags except as defined by
2621 ;; ; future standard or standards-track
2622 ;; ; revisions of this specification.
2630 ;; next line for Courier IMAP bug.
2639 ;; envelope = "(" env-date SP env-subject SP env-from SP env-sender SP
2640 ;; env-reply-to SP env-to SP env-cc SP env-bcc SP
2641 ;; env-in-reply-to SP env-message-id ")"
2642 ;;
2643 ;; env-bcc = "(" 1*address ")" / nil
2644 ;;
2645 ;; env-cc = "(" 1*address ")" / nil
2646 ;;
2647 ;; env-date = nstring
2648 ;;
2649 ;; env-from = "(" 1*address ")" / nil
2650 ;;
2651 ;; env-in-reply-to = nstring
2652 ;;
2653 ;; env-message-id = nstring
2654 ;;
2655 ;; env-reply-to = "(" 1*address ")" / nil
2656 ;;
2657 ;; env-sender = "(" 1*address ")" / nil
2658 ;;
2659 ;; env-subject = nstring
2660 ;;
2661 ;; env-to = "(" 1*address ")" / nil
2687 ;; body-fld-param = "(" string SP string *(SP string SP string) ")" / nil
2695 ;; buggy stalker communigate pro 3.0 doesn't print SPC
2696 ;; between body-fld-param's sometimes
2701 nil)))
2703 ;; body-extension = nstring / number /
2704 ;; "(" body-extension *(SP body-extension) ")"
2705 ;; ; Future expansion. Client implementations
2706 ;; ; MUST accept body-extension fields. Server
2707 ;; ; implementations MUST NOT generate
2708 ;; ; body-extension fields except as defined by
2709 ;; ; future standard or standards-track
2710 ;; ; revisions of this specification.
2726 ;; body-ext-1part = body-fld-md5 [SP body-fld-dsp [SP body-fld-lang
2727 ;; *(SP body-extension)]]
2728 ;; ; MUST NOT be returned on non-extensible
2729 ;; ; "BODY" fetch
2730 ;;
2731 ;; body-ext-mpart = body-fld-param [SP body-fld-dsp [SP body-fld-lang
2732 ;; *(SP body-extension)]]
2733 ;; ; MUST NOT be returned on non-extensible
2734 ;; ; "BODY" fetch
2748 ;; With assert, the code might not be eval'd.
2749 ;; (assert (imap-parse-nil) t "In imap-parse-body-ext")
2760 ext))
2762 ;; body = "(" body-type-1part / body-type-mpart ")"
2763 ;;
2764 ;; body-ext-1part = body-fld-md5 [SP body-fld-dsp [SP body-fld-lang
2765 ;; *(SP body-extension)]]
2766 ;; ; MUST NOT be returned on non-extensible
2767 ;; ; "BODY" fetch
2768 ;;
2769 ;; body-ext-mpart = body-fld-param [SP body-fld-dsp [SP body-fld-lang
2770 ;; *(SP body-extension)]]
2771 ;; ; MUST NOT be returned on non-extensible
2772 ;; ; "BODY" fetch
2773 ;;
2774 ;; body-fields = body-fld-param SP body-fld-id SP body-fld-desc SP
2775 ;; body-fld-enc SP body-fld-octets
2776 ;;
2777 ;; body-fld-desc = nstring
2778 ;;
2779 ;; body-fld-dsp = "(" string SP body-fld-param ")" / nil
2780 ;;
2781 ;; body-fld-enc = (DQUOTE ("7BIT" / "8BIT" / "BINARY" / "BASE64"/
2782 ;; "QUOTED-PRINTABLE") DQUOTE) / string
2783 ;;
2784 ;; body-fld-id = nstring
2785 ;;
2786 ;; body-fld-lang = nstring / "(" string *(SP string) ")"
2787 ;;
2788 ;; body-fld-lines = number
2789 ;;
2790 ;; body-fld-md5 = nstring
2791 ;;
2792 ;; body-fld-octets = number
2793 ;;
2794 ;; body-fld-param = "(" string SP string *(SP string SP string) ")" / nil
2795 ;;
2796 ;; body-type-1part = (body-type-basic / body-type-msg / body-type-text)
2797 ;; [SP body-ext-1part]
2798 ;;
2799 ;; body-type-basic = media-basic SP body-fields
2800 ;; ; MESSAGE subtype MUST NOT be "RFC822"
2801 ;;
2802 ;; body-type-msg = media-message SP body-fields SP envelope
2803 ;; SP body SP body-fld-lines
2804 ;;
2805 ;; body-type-text = media-text SP body-fields SP body-fld-lines
2806 ;;
2807 ;; body-type-mpart = 1*body SP media-subtype
2808 ;; [SP body-ext-mpart]
2809 ;;
2810 ;; media-basic = ((DQUOTE ("APPLICATION" / "AUDIO" / "IMAGE" /
2811 ;; "MESSAGE" / "VIDEO") DQUOTE) / string) SP media-subtype
2812 ;; ; Defined in [MIME-IMT]
2813 ;;
2814 ;; media-message = DQUOTE "MESSAGE" DQUOTE SP DQUOTE "RFC822" DQUOTE
2815 ;; ; Defined in [MIME-IMT]
2816 ;;
2817 ;; media-subtype = string
2818 ;; ; Defined in [MIME-IMT]
2819 ;;
2820 ;; media-text = DQUOTE "TEXT" DQUOTE SP media-subtype
2821 ;; ; Defined in [MIME-IMT]
2831 ;; buggy stalker communigate pro 3.0 insert a SPC between
2832 ;; parts in multiparts
2854 ;; next line for Sun SIMS bug
2864 ;; next `or' for Sun SIMS bug, it regard body-fld-enc as a
2865 ;; nstring and return nil instead of defaulting back to 7BIT
2866 ;; as the standard says.
2871 ;; ok, we're done parsing the required parts, what comes now is one
2872 ;; of three things:
2873 ;;
2874 ;; envelope (then we're parsing body-type-msg)
2875 ;; body-fld-lines (then we're parsing body-type-text)
2876 ;; body-ext-1part (then we're parsing body-type-basic)
2877 ;;
2878 ;; the problem is that the two first are in turn optionally followed
2879 ;; by the third. So we parse the first two here (if there are any)...
2888 ;; buggy stalker communigate pro 3.0 doesn't print
2889 ;; number of lines in message/rfc822 attachment
2899 ;; ...and then parse the third one here...
2914 '(
2915 imap-utf7-encode
2916 imap-utf7-decode
2917 imap-error-text
2918 imap-kerberos4s-p
2919 imap-kerberos4-open
2920 imap-ssl-p
2921 imap-ssl-open
2922 imap-network-p
2923 imap-network-open
2924 imap-interactive-login
2925 imap-kerberos4a-p
2926 imap-kerberos4-auth
2927 imap-cram-md5-p
2928 imap-cram-md5-auth
2929 imap-login-p
2930 imap-login-auth
2931 imap-anonymous-p
2932 imap-anonymous-auth
2933 imap-open-1
2934 imap-open
2935 imap-opened
2936 imap-ping-server
2937 imap-authenticate
2938 imap-close
2939 imap-capability
2940 imap-namespace
2941 imap-send-command-wait
2942 imap-mailbox-put
2943 imap-mailbox-get
2944 imap-mailbox-map-1
2945 imap-mailbox-map
2946 imap-current-mailbox
2947 imap-current-mailbox-p-1
2948 imap-current-mailbox-p
2949 imap-mailbox-select-1
2950 imap-mailbox-select
2951 imap-mailbox-examine-1
2952 imap-mailbox-examine
2953 imap-mailbox-unselect
2954 imap-mailbox-expunge
2955 imap-mailbox-close
2956 imap-mailbox-create-1
2957 imap-mailbox-create
2958 imap-mailbox-delete
2959 imap-mailbox-rename
2960 imap-mailbox-lsub
2961 imap-mailbox-list
2962 imap-mailbox-subscribe
2963 imap-mailbox-unsubscribe
2964 imap-mailbox-status
2965 imap-mailbox-acl-get
2966 imap-mailbox-acl-set
2967 imap-mailbox-acl-delete
2968 imap-current-message
2969 imap-list-to-message-set
2970 imap-fetch-asynch
2971 imap-fetch
2972 imap-message-put
2973 imap-message-get
2974 imap-message-map
2975 imap-search
2976 imap-message-flag-permanent-p
2977 imap-message-flags-set
2978 imap-message-flags-del
2979 imap-message-flags-add
2980 imap-message-copyuid-1
2981 imap-message-copyuid
2982 imap-message-copy
2983 imap-message-appenduid-1
2984 imap-message-appenduid
2985 imap-message-append
2986 imap-body-lines
2987 imap-envelope-from
2988 imap-send-command-1
2989 imap-send-command
2990 imap-wait-for-tag
2991 imap-sentinel
2992 imap-find-next-line
2993 imap-arrival-filter
2994 imap-parse-greeting
2995 imap-parse-response
2996 imap-parse-resp-text
2997 imap-parse-resp-text-code
2998 imap-parse-data-list
2999 imap-parse-fetch
3000 imap-parse-status
3001 imap-parse-acl
3002 imap-parse-flag-list
3003 imap-parse-envelope
3004 imap-parse-body-extension
3005 imap-parse-body
3006 )))
3010 ;; arch-tag: 27369ed6-33e4-482f-96f1-8bb906ba70f7
3011 ;;; imap.el ends here