| blob | 6ef8dfa5fe28a3f5ad49a54c62657cc88b7ae29e |
1 ;;; imap.el --- imap library
2 ;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003
3 ;; Free Software Foundation, Inc.
5 ;; Author: Simon Josefsson <jas@pdc.kth.se>
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 2, or (at your option)
13 ;; 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; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
25 ;;; Commentary:
27 ;; imap.el is a elisp library providing an interface for talking to
28 ;; IMAP servers.
29 ;;
30 ;; imap.el is roughly divided in two parts, one that parses IMAP
31 ;; responses from the server and storing data into buffer-local
32 ;; variables, and one for utility functions which send commands to
33 ;; server, waits for an answer, and return information. The latter
34 ;; part is layered on top of the previous.
35 ;;
36 ;; The imap.el API consist of the following functions, other functions
37 ;; in this file should not be called directly and the result of doing
38 ;; so are at best undefined.
39 ;;
40 ;; Global commands:
41 ;;
42 ;; imap-open, imap-opened, imap-authenticate, imap-close,
43 ;; imap-capability, imap-namespace, imap-error-text
44 ;;
45 ;; Mailbox commands:
46 ;;
47 ;; imap-mailbox-get, imap-mailbox-map, imap-current-mailbox,
48 ;; imap-current-mailbox-p, imap-search, imap-mailbox-select,
49 ;; imap-mailbox-examine, imap-mailbox-unselect, imap-mailbox-expunge
50 ;; imap-mailbox-close, imap-mailbox-create, imap-mailbox-delete
51 ;; imap-mailbox-rename, imap-mailbox-lsub, imap-mailbox-list
52 ;; imap-mailbox-subscribe, imap-mailbox-unsubscribe, imap-mailbox-status
53 ;; imap-mailbox-acl-get, imap-mailbox-acl-set, imap-mailbox-acl-delete
54 ;;
55 ;; Message commands:
56 ;;
57 ;; imap-fetch-asynch, imap-fetch,
58 ;; imap-current-message, imap-list-to-message-set,
59 ;; imap-message-get, imap-message-map
60 ;; imap-message-envelope-date, imap-message-envelope-subject,
61 ;; imap-message-envelope-from, imap-message-envelope-sender,
62 ;; imap-message-envelope-reply-to, imap-message-envelope-to,
63 ;; imap-message-envelope-cc, imap-message-envelope-bcc
64 ;; imap-message-envelope-in-reply-to, imap-message-envelope-message-id
65 ;; imap-message-body, imap-message-flag-permanent-p
66 ;; imap-message-flags-set, imap-message-flags-del
67 ;; imap-message-flags-add, imap-message-copyuid
68 ;; imap-message-copy, imap-message-appenduid
69 ;; imap-message-append, imap-envelope-from
70 ;; imap-body-lines
71 ;;
72 ;; It is my hope that theese commands should be pretty self
73 ;; explanatory for someone that know IMAP. All functions have
74 ;; additional documentation on how to invoke them.
75 ;;
76 ;; imap.el support RFC1730/2060 (IMAP4/IMAP4rev1), implemented IMAP
77 ;; extensions are RFC2195 (CRAM-MD5), RFC2086 (ACL), RFC2342
78 ;; (NAMESPACE), RFC2359 (UIDPLUS), the IMAP-part of RFC2595 (STARTTLS,
79 ;; LOGINDISABLED) (with use of external library starttls.el and
80 ;; program starttls) and the GSSAPI / kerberos V4 sections of RFC1731
81 ;; (with use of external program `imtest'). It also take advantage
82 ;; the UNSELECT extension in Cyrus IMAPD.
83 ;;
84 ;; Without the work of John McClary Prevost and Jim Radford this library
85 ;; would not have seen the light of day. Many thanks.
86 ;;
87 ;; This is a transcript of short interactive session for demonstration
88 ;; purposes.
89 ;;
90 ;; (imap-open "my.mail.server")
91 ;; => " *imap* my.mail.server:0"
92 ;;
93 ;; The rest are invoked with current buffer as the buffer returned by
94 ;; `imap-open'. It is possible to do all without this, but it would
95 ;; look ugly here since `buffer' is always the last argument for all
96 ;; imap.el API functions.
97 ;;
98 ;; (imap-authenticate "myusername" "mypassword")
99 ;; => auth
100 ;;
101 ;; (imap-mailbox-lsub "*")
102 ;; => ("INBOX.sentmail" "INBOX.private" "INBOX.draft" "INBOX.spam")
103 ;;
104 ;; (imap-mailbox-list "INBOX.n%")
105 ;; => ("INBOX.namedroppers" "INBOX.nnimap" "INBOX.ntbugtraq")
106 ;;
107 ;; (imap-mailbox-select "INBOX.nnimap")
108 ;; => "INBOX.nnimap"
109 ;;
110 ;; (imap-mailbox-get 'exists)
111 ;; => 166
112 ;;
113 ;; (imap-mailbox-get 'uidvalidity)
114 ;; => "908992622"
115 ;;
116 ;; (imap-search "FLAGGED SINCE 18-DEC-98")
117 ;; => (235 236)
118 ;;
119 ;; (imap-fetch 235 "RFC822.PEEK" 'RFC822)
120 ;; => "X-Sieve: cmu-sieve 1.3^M\nX-Username: <jas@pdc.kth.se>^M\r...."
121 ;;
122 ;; Todo:
123 ;;
124 ;; o Parse UIDs as strings? We need to overcome the 28 bit limit somehow.
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 commited to pgnus
136 ;;
138 ;;; Code:
157 ;; Avoid use gnus-point-at-eol so we're independent of Gnus. These
158 ;; days we have point-at-eol anyhow.
166 ;; User variables.
169 "Low-level IMAP issues."
175 "List of strings containing commands for Kerberos 4 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."
185 "--imap --application-data "
186 "--mechanism GSSAPI "
189 "List of strings containing commands for GSSAPI (krb5) authentication.
190 %s is replaced with server hostname, %p with port to connect to, and
191 %l with the value of `imap-default-user'. The program should accept
192 IMAP commands on stdin and return responses to stdout. Each entry in
193 the list is tried until a successful connection is made."
198 "openssl s_client -quiet -ssl2 -connect %s:%p"
199 "s_client -quiet -ssl3 -connect %s:%p"
201 "A string, or list of strings, containing commands for SSL connections.
202 Within a string, %s is replaced with the server address and %p with
203 port number on server. The program should accept IMAP commands on
204 stdin and return responses to stdout. Each entry in the list is tried
205 until a successful connection is made."
211 "rsh %s imapd"
212 "ssh %g ssh %s imapd"
214 "A list of strings, containing commands for IMAP connection.
215 Within a string, %s is replaced with the server address, %p with port
216 number on server, %g with `imap-shell-host', and %l with
217 `imap-default-user'. The program should read IMAP commands from stdin
218 and write IMAP response to stdout. Each entry in the list is tried
219 until a successful connection is made."
224 "*Value for `process-connection-type' to use for Kerberos4, GSSAPI and SSL.
225 The `process-connection-type' variable control type of device
226 used to communicate with subprocesses. Values are nil to use a
227 pipe, or t or `pty' to use a pty. The value has no effect if the
228 system has no ptys or if all ptys are busy: then a pipe is used
229 in any case. The value takes effect when a IMAP server is
230 opened, changing it after that has no effect."
236 "If non-nil, do utf7 encoding/decoding of mailbox names.
237 Since the UTF7 decoding currently only decodes into ISO-8859-1
238 characters, you may disable this decoding if you need to access UTF7
239 encoded mailboxes which doesn't translate into ISO-8859-1."
244 "If non-nil, a imap session trace is placed in *imap-log* buffer."
249 "If non-nil, random debug spews are placed in *imap-debug* buffer."
254 "Hostname of rlogin proxy."
259 "Default username to use."
266 1.0
268 "*How long to wait between checking for the end of output.
269 Shorter values mean quicker response, but is more CPU intensive."
274 "If non-nil, store session password without promting."
278 ;; Various variables.
294 "Definition of network streams.
296 \(NAME CHECK OPEN)
298 NAME names the stream, CHECK is a function returning non-nil if the
299 server support the stream and OPEN is a function for opening the
303 kerberos4
304 digest-md5
305 cram-md5
306 login
307 anonymous)
317 "Definition of authenticators.
319 \(NAME CHECK AUTHENTICATE)
321 NAME names the authenticator. CHECK is a function returning non-nil if
322 the server support the authenticator and AUTHENTICATE is a function
328 ;; Internal constants. Change theese and die.
337 imap-port
338 imap-client-eol
339 imap-server-eol
340 imap-auth
341 imap-stream
342 imap-username
343 imap-password
344 imap-current-mailbox
345 imap-current-target-mailbox
346 imap-message-data
347 imap-capability
348 imap-namespace
349 imap-state
350 imap-reached-tag
351 imap-failed-tags
352 imap-tag
353 imap-process
354 imap-calculate-literal-size-first
355 imap-mailbox-data))
359 ;; Internal variables.
369 "IMAP state.
370 Valid states are `closed', `initial', `nonauth', `auth', `selected'
410 "Alist of tags that failed.
411 Each element is a list with four elements; tag (a integer), response
412 state (a symbol, `OK', `NO' or `BAD'), response code (a string), and
422 "Non-nil indicates that the server emitted a continuation request.
426 "List of response tags and callbacks, on the form `(number . function)'.
427 The function should take two arguments, the first the IMAP tag and the
430 \f
431 ;; Utility functions:
434 "Delete by side effect any elements of LIST whose car is `equal' to KEY.
435 The modified LIST is returned. If the first member
436 of LIST has a car that is `equal' to KEY, there is no way to remove it
437 by side effect; therefore, write `(setq foo (remassoc key foo))' to be
438 sure of changing the value of `foo'."
443 alist)))
446 "Enable multibyte in the current buffer."
456 "imap: Could not UTF7 encode `%s', using it unencoded..."
457 string)
458 string)))
459 string))
467 "imap: Could not UTF7 decode `%s', using it undecoded..."
468 string)
469 string)))
470 string))
474 t
476 nil))
482 \f
483 ;; Server functions; stream stuff:
490 cmd done)
499 name buffer shell-file-name shell-command-switch
501 cmd
503 ?s server
505 ?l imap-default-user))))
506 response)
510 imap-calculate-literal-size-first t)
514 ;; Athena IMTEST can output SSL verify errors
517 t)
520 t)
521 ;; cyrus 1.6.x (13? < x <= 22) queries capabilities
524 t)
525 ;; cyrus 1.6 imtest print "S: " before server greeting
528 t)
530 ;; success in imtest < 1.6:
533 ;; success in imtest 1.6:
554 nil)))))
555 done))
562 cmd done)
571 name buffer shell-file-name shell-command-switch
573 cmd
575 ?s server
577 ?l imap-default-user))))
578 response)
582 imap-calculate-literal-size-first t)
586 ;; cyrus 1.6.x (13? < x <= 22) queries capabilities
589 t)
590 ;; cyrus 1.6 imtest print "S: " before server greeting
593 t)
595 ;; success in imtest 1.6:
598 "Client authentication "
600 nil t)
618 nil)))))
619 done))
622 nil)
625 "Open a SSL connection to server."
628 cmd done)
636 process)
639 name buffer shell-file-name
640 shell-command-switch
643 ?s server
646 process)
668 done)
670 nil)))
673 nil)
695 process))))
698 t)
719 process))))
722 nil)
727 cmd done)
735 name buffer shell-file-name shell-command-switch
737 cmd
739 ?s server
740 ?g imap-shell-host
742 ?l imap-default-user)))))
763 done)
765 nil)))
775 done tls-info)
804 done))
806 ;; Server functions; authenticator stuff:
809 "Login to server in BUFFER.
810 LOGINFUNC is passed a username and a password, it should return t if
811 it where successful authenticating itself to the server, nil otherwise.
812 Returns t if login was successful, nil otherwise."
817 ;; (condition-case ()
828 imap-server " (using authenticator `"
834 imap-username user)
843 ;; (quit (with-current-buffer buffer
844 ;; (setq user nil
845 ;; passwd nil)))
846 ;; (error (with-current-buffer buffer
847 ;; (setq user nil
848 ;; passwd nil))))
849 ret)))
872 "Login to server using the AUTH CRAM-MD5 method."
875 buffer
880 "AUTHENTICATE CRAM-MD5"
886 encoded)))))))))
896 "Login to server using the LOGIN command."
905 t)
921 "Login to server using the AUTH DIGEST-MD5 method."
924 buffer
929 "AUTHENTICATE DIGEST-MD5"
938 user passwd digest-uri)))
940 )))
942 nil
947 ;; Server functions:
953 imap-current-message nil
954 imap-state 'initial
957 imap-stream-alist))
969 imap-process))))
972 "Open a IMAP connection to host SERVER at PORT returning a buffer.
973 If PORT is unspecified, a default value is used (143 except
974 for SSL which use 993).
975 STREAM indicates the stream to use, see `imap-streams' for available
976 streams. If nil, it choices the best stream the server is capable of.
977 AUTH indicates authenticator to use, see `imap-authenticators' for
978 available authenticators. If nil, it choices the best stream the
979 server is capable of.
980 BUFFER can be a buffer or a name of a buffer, which is created if
981 necessary. If nil, the buffer name is generated."
998 nil)
1000 ;; Need to choose stream.
1003 ;; OK to use this stream?
1005 ;; Stream changed?
1021 "imap: Reconnecting with stream `%s'...failed"
1022 stream))
1023 ;; We're done, kill the first connection
1028 stream)
1032 ;; We're done
1040 buffer))))
1043 "Return non-nil if connection to imap server in BUFFER is open.
1044 If BUFFER is nil then the current buffer is used."
1052 "Authenticate to server in BUFFER, using current buffer if nil.
1053 It uses the authenticator specified when opening the server. If the
1054 authenticator requires username/passwords, they are queried from the
1055 user and optionally stored in the buffer. If USER and/or PASSWD is
1056 specified, the user will not be questioned and the username and/or
1057 password is remembered in the buffer."
1071 ;; Choose authenticator.
1073 auth)
1075 ;; OK to use authenticator?
1078 imap-server auth)
1083 imap-server auth)
1086 imap-server auth)))))
1087 imap-state))))
1090 "Close connection to server in BUFFER.
1091 If BUFFER is nil, the current buffer is used."
1101 imap-current-message nil
1102 imap-process nil)
1104 t))
1107 "Return a list of identifiers which server in BUFFER support.
1108 If IDENTIFIER, return non-nil if it's among the servers capabilities.
1109 If BUFFER is nil, the current buffer is assumed."
1116 imap-capability)))
1119 "Return a namespace hierarchy at server in BUFFER.
1120 If BUFFER is nil, the current buffer is assumed."
1125 imap-namespace))
1130 \f
1131 ;; Mailbox functions:
1137 propname value)
1140 t))
1144 propname))
1159 imap-mailbox-data)
1160 result)))
1163 "Map a function across each mailbox in `imap-mailbox-data', returning a list.
1164 Function should take a mailbox name (a string) as
1165 the only argument."
1184 "Select MAILBOX on server in BUFFER.
1185 If EXAMINE is non-nil, do a read-only select."
1187 imap-current-mailbox
1195 imap-current-mailbox)
1196 ;; Failed SELECT/EXAMINE unselects current mailbox
1209 "Examine MAILBOX on server in BUFFER."
1213 "Close current folder in BUFFER, without expunging articles."
1220 imap-current-mailbox
1224 imap-message-data nil
1226 t)))
1229 "Expunge articles in current folder in BUFFER.
1230 If ASYNCH, do not wait for succesful completion of the command.
1231 If BUFFER is nil the current buffer is assumed."
1239 "Expunge articles and close current folder in BUFFER.
1240 If ASYNCH, do not wait for succesful completion of the command.
1241 If BUFFER is nil the current buffer is assumed."
1248 imap-current-mailbox status)
1250 imap-current-mailbox)
1251 ;; Don't wipe out data if another mailbox
1252 ;; was selected...
1254 imap-message-data nil
1258 imap-message-data nil
1260 t)))
1266 "Create MAILBOX on server in BUFFER.
1267 If BUFFER is nil the current buffer is assumed."
1272 "Delete MAILBOX on server in BUFFER.
1273 If BUFFER is nil the current buffer is assumed."
1280 "Rename mailbox OLDNAME to NEWNAME on server in BUFFER.
1281 If BUFFER is nil the current buffer is assumed."
1290 "Return a list of subscribed mailboxes on server in BUFFER.
1291 If ROOT is non-nil, only list matching mailboxes. If ADD-DELIMITER is
1292 non-nil, a hierarchy delimiter is added to root. REFERENCE is a
1293 implementation-specific string that has to be passed to lsub command."
1295 ;; Make sure we know the hierarchy separator for root's hierarchy
1299 ;; clear list data (NB not delimiter and other stuff)
1314 "Return a list of mailboxes matching ROOT on server in BUFFER.
1315 If ADD-DELIMITER is non-nil, a hierarchy delimiter is added to
1316 root. REFERENCE is a implementation-specific string that has to be
1317 passed to list command."
1319 ;; Make sure we know the hierarchy separator for root's hierarchy
1323 ;; clear list data (NB not delimiter and other stuff)
1338 "Send the SUBSCRIBE command on the mailbox to server in BUFFER.
1339 Returns non-nil if successful."
1346 "Send the SUBSCRIBE command on the mailbox to server in BUFFER.
1347 Returns non-nil if successful."
1354 "Get status items ITEM in MAILBOX from server in BUFFER.
1355 ITEMS can be a symbol or a list of symbols, valid symbols are one of
1356 the STATUS data items -- ie 'messages, 'recent, 'uidnext, 'uidvalidity
1357 or 'unseen. If ITEMS is a list of symbols, a list of values is
1358 returned, if ITEMS is a symbol only its value is returned."
1367 items
1372 items)
1376 "Send status item request ITEM on MAILBOX to server in BUFFER.
1377 ITEMS can be a symbol or a list of symbols, valid symbols are one of
1378 the STATUS data items -- ie 'messages, 'recent, 'uidnext, 'uidvalidity
1379 or 'unseen. The IMAP command tag is returned."
1386 items
1390 "Get ACL on mailbox from server in BUFFER."
1400 "Change/set ACL for IDENTIFIER to RIGHTS in MAILBOX from server in BUFFER."
1407 identifier
1408 " "
1409 rights))))))
1412 "Removes any <identifier,rights> pair for IDENTIFIER in MAILBOX from server in BUFFER."
1419 identifier))))))
1421 \f
1422 ;; Message functions:
1426 imap-current-message))
1432 list
1445 range)
1453 uids)
1454 props))))
1457 "Fetch properties PROPS from message set UIDS from server in BUFFER.
1458 UIDS can be a string, number or a list of numbers. If RECEIVE
1459 is non-nil return theese properties."
1465 uids)
1466 props)))
1468 t
1474 receive)
1476 uids)
1483 propname value)
1486 t))
1491 propname)))
1494 "Map a function across each mailbox in `imap-message-data', returning a list."
1500 imap-message-data)
1501 result)))
1554 nil)
1558 "Return t iff FLAG can be permanently (between IMAP sessions) saved on articles, in MAILBOX on server in BUFFER."
1607 "Copy ARTICLES (a string message set) to MAILBOX on server in
1608 BUFFER, creating mailbox if it doesn't exist. If dont-create is
1609 non-nil, it will not create a mailbox. On success, return a list with
1610 the UIDVALIDITY of the mailbox the article(s) was copied to as the
1611 first element, rest of list contain the saved articles' UIDs."
1618 t
1620 ;; removed because of buggy Oracle server
1621 ;; that doesn't send TRYCREATE tags (which
1622 ;; is a MUST according to specifications):
1623 ;;(imap-mailbox-get-1 'trycreate mailbox)
1650 "Append ARTICLE (a buffer) to MAILBOX on server in BUFFER.
1651 FLAGS and DATE-TIME is currently not used. Return a cons holding
1652 uidvalidity of MAILBOX and UID the newly created article got, or nil
1653 on failure."
1663 "Return number of lines in article by looking at the mime bodystructure BODY."
1677 "Return a from string line."
1682 "@"
1686 \f
1687 ;; Internal functions.
1706 cmd cmdstr)
1714 size)
1719 ;; XXX modifies buffer!
1739 imap-log-buffer)
1755 command)))
1761 tag)))
1770 message-log-max)
1779 ;; A process can die _before_ we have processed everything it
1780 ;; has to say. Moreover, this can happen in between the call to
1781 ;; accept-process-output and the call to process-status in an
1782 ;; iteration of the loop above.
1791 'INCOMPLETE
1798 "Return point at end of current line, taking into account literals.
1799 Return nil if no complete line has arrived."
1801 imap-server-eol)
1802 nil t)
1805 nil
1811 "IMAP process filter."
1812 ;; Sometimes, we are called even though the process has died.
1813 ;; Better abstain from doing stuff in that case.
1841 imap-state)))
1844 \f
1845 ;; Imap parser.
1850 ;; number = 1*DIGIT
1851 ;; ; Unsigned 32-bit integer
1852 ;; ; (0 <= n < 4,294,967,296)
1860 ;; literal = "{" number "}" CRLF *CHAR8
1861 ;; ; Number represents the number of CHAR8s
1868 nil
1872 ;; string = quoted / literal
1873 ;;
1874 ;; quoted = DQUOTE *QUOTED-CHAR DQUOTE
1875 ;;
1876 ;; QUOTED-CHAR = <any TEXT-CHAR except quoted-specials> /
1877 ;; "\" quoted-specials
1878 ;;
1879 ;; quoted-specials = DQUOTE / "\"
1880 ;;
1881 ;; TEXT-CHAR = <any CHAR except CR and LF>
1895 name))
1899 ;; nil = "NIL"
1905 ;; nstring = string / nil
1910 nil)))
1912 ;; astring = atom / string
1913 ;;
1914 ;; atom = 1*ATOM-CHAR
1915 ;;
1916 ;; ATOM-CHAR = <any CHAR except atom-specials>
1917 ;;
1918 ;; atom-specials = "(" / ")" / "{" / SP / CTL / list-wildcards /
1919 ;; quoted-specials
1920 ;;
1921 ;; list-wildcards = "%" / "*"
1922 ;;
1923 ;; quoted-specials = DQUOTE / "\"
1933 ;; address = "(" addr-name SP addr-adl SP addr-mailbox SP
1934 ;; addr-host ")"
1935 ;;
1936 ;; addr-adl = nstring
1937 ;; ; Holds route from [RFC-822] route-addr if
1938 ;; ; non-nil
1939 ;;
1940 ;; addr-host = nstring
1941 ;; ; nil indicates [RFC-822] group syntax.
1942 ;; ; Otherwise, holds [RFC-822] domain name
1943 ;;
1944 ;; addr-mailbox = nstring
1945 ;; ; nil indicates end of [RFC-822] group; if
1946 ;; ; non-nil and addr-host is nil, holds
1947 ;; ; [RFC-822] group name.
1948 ;; ; Otherwise, holds [RFC-822] local-part
1949 ;; ; after removing [RFC-822] quoting
1950 ;;
1951 ;; addr-name = nstring
1952 ;; ; If non-nil, holds phrase from [RFC-822]
1953 ;; ; mailbox after removing [RFC-822] quoting
1954 ;;
1969 address))))
1971 ;; address-list = "(" 1*address ")" / nil
1972 ;;
1973 ;; nil = "NIL"
1980 ;; next line for MS Exchange bug
1987 ;; With assert, the code might not be eval'd.
1988 ;; (assert (imap-parse-nil) t "In imap-parse-address-list")
1991 ;; mailbox = "INBOX" / astring
1992 ;; ; INBOX is case-insensitive. All case variants of
1993 ;; ; INBOX (e.g. "iNbOx") MUST be interpreted as INBOX
1994 ;; ; not as an astring. An astring which consists of
1995 ;; ; the case-insensitive sequence "I" "N" "B" "O" "X"
1996 ;; ; is considered to be INBOX and not an astring.
1997 ;; ; Refer to section 5.1 for further
1998 ;; ; semantic details of mailbox names.
2003 "INBOX"
2004 mailbox)))
2006 ;; greeting = "*" SP (resp-cond-auth / resp-cond-bye) CRLF
2007 ;;
2008 ;; resp-cond-auth = ("OK" / "PREAUTH") SP resp-text
2009 ;; ; Authentication condition
2010 ;;
2011 ;; resp-cond-bye = "BYE" SP resp-text
2014 "Parse a IMAP greeting."
2022 ;; response = *(continue-req / response-data) response-done
2023 ;;
2024 ;; continue-req = "+" SP (resp-text / base64) CRLF
2025 ;;
2026 ;; response-data = "*" SP (resp-cond-state / resp-cond-bye /
2027 ;; mailbox-data / message-data / capability-data) CRLF
2028 ;;
2029 ;; response-done = response-tagged / response-fatal
2030 ;;
2031 ;; response-fatal = "*" SP resp-cond-bye CRLF
2032 ;; ; Server closes connection immediately
2033 ;;
2034 ;; response-tagged = tag SP resp-cond-state CRLF
2035 ;;
2036 ;; resp-cond-state = ("OK" / "NO" / "BAD") SP resp-text
2037 ;; ; Status condition
2038 ;;
2039 ;; resp-cond-bye = "BYE" SP resp-text
2040 ;;
2041 ;; mailbox-data = "FLAGS" SP flag-list /
2042 ;; "LIST" SP mailbox-list /
2043 ;; "LSUB" SP mailbox-list /
2044 ;; "SEARCH" *(SP nz-number) /
2045 ;; "STATUS" SP mailbox SP "("
2046 ;; [status-att SP number *(SP status-att SP number)] ")" /
2047 ;; number SP "EXISTS" /
2048 ;; number SP "RECENT"
2049 ;;
2050 ;; message-data = nz-number SP ("EXPUNGE" / ("FETCH" SP msg-att))
2051 ;;
2052 ;; capability-data = "CAPABILITY" *(SP capability) SP "IMAP4rev1"
2053 ;; *(SP capability)
2054 ;; ; IMAP4rev1 servers which offer RFC 1730
2055 ;; ; compatibility MUST list "IMAP4" as the first
2056 ;; ; capability.
2059 "Parse a IMAP command response."
2065 t)))
2076 'search
2110 imap-failed-tags))))
2123 token status code text))))
2130 ;; resp-text = ["[" resp-text-code "]" SP] text
2131 ;;
2132 ;; text = 1*TEXT-CHAR
2133 ;;
2134 ;; TEXT-CHAR = <any CHAR except CR and LF>
2139 ;; resp-text-code = "ALERT" /
2140 ;; "BADCHARSET [SP "(" astring *(SP astring) ")" ] /
2141 ;; "NEWNAME" SP string SP string /
2142 ;; "PARSE" /
2143 ;; "PERMANENTFLAGS" SP "("
2144 ;; [flag-perm *(SP flag-perm)] ")" /
2145 ;; "READ-ONLY" /
2146 ;; "READ-WRITE" /
2147 ;; "TRYCREATE" /
2148 ;; "UIDNEXT" SP nz-number /
2149 ;; "UIDVALIDITY" SP nz-number /
2150 ;; "UNSEEN" SP nz-number /
2151 ;; resp-text-atom [SP 1*<any TEXT-CHAR except "]">]
2152 ;;
2153 ;; resp_code_apnd = "APPENDUID" SPACE nz_number SPACE uniqueid
2154 ;;
2155 ;; resp_code_copy = "COPYUID" SPACE nz_number SPACE set SPACE set
2156 ;;
2157 ;; set = sequence-num / (sequence-num ":" sequence-num) /
2158 ;; (set "," set)
2159 ;; ; Identifies a set of messages. For message
2160 ;; ; sequence numbers, these are consecutive
2161 ;; ; numbers from 1 to the number of messages in
2162 ;; ; the mailbox
2163 ;; ; Comma delimits individual numbers, colon
2164 ;; ; delimits between two numbers inclusive.
2165 ;; ; Example: 2,4:7,9,12:* is 2,4,5,6,7,9,12,13,
2166 ;; ; 14,15 for a mailbox with 15 messages.
2167 ;;
2168 ;; sequence-num = nz-number / "*"
2169 ;; ; * is the largest number in use. For message
2170 ;; ; sequence numbers, it is the number of messages
2171 ;; ; in the mailbox. For unique identifiers, it is
2172 ;; ; the unique identifier of the last message in
2173 ;; ; the mailbox.
2174 ;;
2175 ;; flag-perm = flag / "\*"
2176 ;;
2177 ;; flag = "\Answered" / "\Flagged" / "\Deleted" /
2178 ;; "\Seen" / "\Draft" / flag-keyword / flag-extension
2179 ;; ; Does not include "\Recent"
2180 ;;
2181 ;; flag-extension = "\" atom
2182 ;; ; Future expansion. Client implementations
2183 ;; ; MUST accept flag-extension flags. Server
2184 ;; ; implementations MUST NOT generate
2185 ;; ; flag-extension flags except as defined by
2186 ;; ; future standard or standards-track
2187 ;; ; revisions of this specification.
2188 ;;
2189 ;; flag-keyword = atom
2190 ;;
2191 ;; resp-text-atom = 1*<any ATOM-CHAR except "]">
2194 ;; xxx next line for stalker communigate pro 3.3.1 bug
2221 imap-current-target-mailbox))
2226 imap-current-target-mailbox))
2231 ;; mailbox-list = "(" [mbx-list-flags] ")" SP
2232 ;; (DQUOTE QUOTED-CHAR DQUOTE / nil) SP mailbox
2233 ;;
2234 ;; mbx-list-flags = *(mbx-list-oflag SP) mbx-list-sflag
2235 ;; *(SP mbx-list-oflag) /
2236 ;; mbx-list-oflag *(SP mbx-list-oflag)
2237 ;;
2238 ;; mbx-list-oflag = "\Noinferiors" / flag-extension
2239 ;; ; Other flags; multiple possible per LIST response
2240 ;;
2241 ;; mbx-list-sflag = "\Noselect" / "\Marked" / "\Unmarked"
2242 ;; ; Selectability flags; only one per LIST response
2243 ;;
2244 ;; QUOTED-CHAR = <any TEXT-CHAR except quoted-specials> /
2245 ;; "\" quoted-specials
2246 ;;
2247 ;; quoted-specials = DQUOTE / "\"
2260 ;; msg_att ::= "(" 1#("ENVELOPE" SPACE envelope /
2261 ;; "FLAGS" SPACE "(" #(flag / "\Recent") ")" /
2262 ;; "INTERNALDATE" SPACE date_time /
2263 ;; "RFC822" [".HEADER" / ".TEXT"] SPACE nstring /
2264 ;; "RFC822.SIZE" SPACE number /
2265 ;; "BODY" ["STRUCTURE"] SPACE body /
2266 ;; "BODY" section ["<" number ">"] SPACE nstring /
2267 ;; "UID" SPACE uniqueid) ")"
2268 ;;
2269 ;; date_time ::= <"> date_day_fixed "-" date_month "-" date_year
2270 ;; SPACE time SPACE zone <">
2271 ;;
2272 ;; section ::= "[" [section_text / (nz_number *["." nz_number]
2273 ;; ["." (section_text / "MIME")])] "]"
2274 ;;
2275 ;; section_text ::= "HEADER" / "HEADER.FIELDS" [".NOT"]
2276 ;; SPACE header_list / "TEXT"
2277 ;;
2278 ;; header_fld_name ::= astring
2279 ;;
2280 ;; header_list ::= "(" 1#header_fld_name ")"
2298 section)))
2303 rfc822size body bodydetail bodystructure flags-empty)
2337 bodydetail)
2356 ;; mailbox-data = ...
2357 ;; "STATUS" SP mailbox SP "("
2358 ;; [status-att SP number
2359 ;; *(SP status-att SP number)] ")"
2360 ;; ...
2361 ;;
2362 ;; status-att = "MESSAGES" / "RECENT" / "UIDNEXT" / "UIDVALIDITY" /
2363 ;; "UNSEEN"
2391 token mailbox)
2394 ;; acl_data ::= "ACL" SPACE mailbox *(SPACE identifier SPACE
2395 ;; rights)
2396 ;;
2397 ;; identifier ::= astring
2398 ;;
2399 ;; rights ::= astring
2403 identifier rights acl)
2412 ;; flag-list = "(" [flag *(SP flag)] ")"
2413 ;;
2414 ;; flag = "\Answered" / "\Flagged" / "\Deleted" /
2415 ;; "\Seen" / "\Draft" / flag-keyword / flag-extension
2416 ;; ; Does not include "\Recent"
2417 ;;
2418 ;; flag-keyword = atom
2419 ;;
2420 ;; flag-extension = "\" atom
2421 ;; ; Future expansion. Client implementations
2422 ;; ; MUST accept flag-extension flags. Server
2423 ;; ; implementations MUST NOT generate
2424 ;; ; flag-extension flags except as defined by
2425 ;; ; future standard or standards-track
2426 ;; ; revisions of this specification.
2434 ;; next line for Courier IMAP bug.
2443 ;; envelope = "(" env-date SP env-subject SP env-from SP env-sender SP
2444 ;; env-reply-to SP env-to SP env-cc SP env-bcc SP
2445 ;; env-in-reply-to SP env-message-id ")"
2446 ;;
2447 ;; env-bcc = "(" 1*address ")" / nil
2448 ;;
2449 ;; env-cc = "(" 1*address ")" / nil
2450 ;;
2451 ;; env-date = nstring
2452 ;;
2453 ;; env-from = "(" 1*address ")" / nil
2454 ;;
2455 ;; env-in-reply-to = nstring
2456 ;;
2457 ;; env-message-id = nstring
2458 ;;
2459 ;; env-reply-to = "(" 1*address ")" / nil
2460 ;;
2461 ;; env-sender = "(" 1*address ")" / nil
2462 ;;
2463 ;; env-subject = nstring
2464 ;;
2465 ;; env-to = "(" 1*address ")" / nil
2491 ;; body-fld-param = "(" string SP string *(SP string SP string) ")" / nil
2499 ;; buggy stalker communigate pro 3.0 doesn't print SPC
2500 ;; between body-fld-param's sometimes
2505 nil)))
2507 ;; body-extension = nstring / number /
2508 ;; "(" body-extension *(SP body-extension) ")"
2509 ;; ; Future expansion. Client implementations
2510 ;; ; MUST accept body-extension fields. Server
2511 ;; ; implementations MUST NOT generate
2512 ;; ; body-extension fields except as defined by
2513 ;; ; future standard or standards-track
2514 ;; ; revisions of this specification.
2530 ;; body-ext-1part = body-fld-md5 [SP body-fld-dsp [SP body-fld-lang
2531 ;; *(SP body-extension)]]
2532 ;; ; MUST NOT be returned on non-extensible
2533 ;; ; "BODY" fetch
2534 ;;
2535 ;; body-ext-mpart = body-fld-param [SP body-fld-dsp [SP body-fld-lang
2536 ;; *(SP body-extension)]]
2537 ;; ; MUST NOT be returned on non-extensible
2538 ;; ; "BODY" fetch
2552 ;; With assert, the code might not be eval'd.
2553 ;; (assert (imap-parse-nil) t "In imap-parse-body-ext")
2564 ext))
2566 ;; body = "(" body-type-1part / body-type-mpart ")"
2567 ;;
2568 ;; body-ext-1part = body-fld-md5 [SP body-fld-dsp [SP body-fld-lang
2569 ;; *(SP body-extension)]]
2570 ;; ; MUST NOT be returned on non-extensible
2571 ;; ; "BODY" fetch
2572 ;;
2573 ;; body-ext-mpart = body-fld-param [SP body-fld-dsp [SP body-fld-lang
2574 ;; *(SP body-extension)]]
2575 ;; ; MUST NOT be returned on non-extensible
2576 ;; ; "BODY" fetch
2577 ;;
2578 ;; body-fields = body-fld-param SP body-fld-id SP body-fld-desc SP
2579 ;; body-fld-enc SP body-fld-octets
2580 ;;
2581 ;; body-fld-desc = nstring
2582 ;;
2583 ;; body-fld-dsp = "(" string SP body-fld-param ")" / nil
2584 ;;
2585 ;; body-fld-enc = (DQUOTE ("7BIT" / "8BIT" / "BINARY" / "BASE64"/
2586 ;; "QUOTED-PRINTABLE") DQUOTE) / string
2587 ;;
2588 ;; body-fld-id = nstring
2589 ;;
2590 ;; body-fld-lang = nstring / "(" string *(SP string) ")"
2591 ;;
2592 ;; body-fld-lines = number
2593 ;;
2594 ;; body-fld-md5 = nstring
2595 ;;
2596 ;; body-fld-octets = number
2597 ;;
2598 ;; body-fld-param = "(" string SP string *(SP string SP string) ")" / nil
2599 ;;
2600 ;; body-type-1part = (body-type-basic / body-type-msg / body-type-text)
2601 ;; [SP body-ext-1part]
2602 ;;
2603 ;; body-type-basic = media-basic SP body-fields
2604 ;; ; MESSAGE subtype MUST NOT be "RFC822"
2605 ;;
2606 ;; body-type-msg = media-message SP body-fields SP envelope
2607 ;; SP body SP body-fld-lines
2608 ;;
2609 ;; body-type-text = media-text SP body-fields SP body-fld-lines
2610 ;;
2611 ;; body-type-mpart = 1*body SP media-subtype
2612 ;; [SP body-ext-mpart]
2613 ;;
2614 ;; media-basic = ((DQUOTE ("APPLICATION" / "AUDIO" / "IMAGE" /
2615 ;; "MESSAGE" / "VIDEO") DQUOTE) / string) SP media-subtype
2616 ;; ; Defined in [MIME-IMT]
2617 ;;
2618 ;; media-message = DQUOTE "MESSAGE" DQUOTE SP DQUOTE "RFC822" DQUOTE
2619 ;; ; Defined in [MIME-IMT]
2620 ;;
2621 ;; media-subtype = string
2622 ;; ; Defined in [MIME-IMT]
2623 ;;
2624 ;; media-text = DQUOTE "TEXT" DQUOTE SP media-subtype
2625 ;; ; Defined in [MIME-IMT]
2635 ;; buggy stalker communigate pro 3.0 insert a SPC between
2636 ;; parts in multiparts
2658 ;; next line for Sun SIMS bug
2668 ;; next `or' for Sun SIMS bug, it regard body-fld-enc as a
2669 ;; nstring and return nil instead of defaulting back to 7BIT
2670 ;; as the standard says.
2675 ;; ok, we're done parsing the required parts, what comes now is one
2676 ;; of three things:
2677 ;;
2678 ;; envelope (then we're parsing body-type-msg)
2679 ;; body-fld-lines (then we're parsing body-type-text)
2680 ;; body-ext-1part (then we're parsing body-type-basic)
2681 ;;
2682 ;; the problem is that the two first are in turn optionally followed
2683 ;; by the third. So we parse the first two here (if there are any)...
2692 ;; buggy stalker communigate pro 3.0 doesn't print
2693 ;; number of lines in message/rfc822 attachment
2703 ;; ...and then parse the third one here...
2718 '(
2719 imap-utf7-encode
2720 imap-utf7-decode
2721 imap-error-text
2722 imap-kerberos4s-p
2723 imap-kerberos4-open
2724 imap-ssl-p
2725 imap-ssl-open
2726 imap-network-p
2727 imap-network-open
2728 imap-interactive-login
2729 imap-kerberos4a-p
2730 imap-kerberos4-auth
2731 imap-cram-md5-p
2732 imap-cram-md5-auth
2733 imap-login-p
2734 imap-login-auth
2735 imap-anonymous-p
2736 imap-anonymous-auth
2737 imap-open-1
2738 imap-open
2739 imap-opened
2740 imap-authenticate
2741 imap-close
2742 imap-capability
2743 imap-namespace
2744 imap-send-command-wait
2745 imap-mailbox-put
2746 imap-mailbox-get
2747 imap-mailbox-map-1
2748 imap-mailbox-map
2749 imap-current-mailbox
2750 imap-current-mailbox-p-1
2751 imap-current-mailbox-p
2752 imap-mailbox-select-1
2753 imap-mailbox-select
2754 imap-mailbox-examine-1
2755 imap-mailbox-examine
2756 imap-mailbox-unselect
2757 imap-mailbox-expunge
2758 imap-mailbox-close
2759 imap-mailbox-create-1
2760 imap-mailbox-create
2761 imap-mailbox-delete
2762 imap-mailbox-rename
2763 imap-mailbox-lsub
2764 imap-mailbox-list
2765 imap-mailbox-subscribe
2766 imap-mailbox-unsubscribe
2767 imap-mailbox-status
2768 imap-mailbox-acl-get
2769 imap-mailbox-acl-set
2770 imap-mailbox-acl-delete
2771 imap-current-message
2772 imap-list-to-message-set
2773 imap-fetch-asynch
2774 imap-fetch
2775 imap-message-put
2776 imap-message-get
2777 imap-message-map
2778 imap-search
2779 imap-message-flag-permanent-p
2780 imap-message-flags-set
2781 imap-message-flags-del
2782 imap-message-flags-add
2783 imap-message-copyuid-1
2784 imap-message-copyuid
2785 imap-message-copy
2786 imap-message-appenduid-1
2787 imap-message-appenduid
2788 imap-message-append
2789 imap-body-lines
2790 imap-envelope-from
2791 imap-send-command-1
2792 imap-send-command
2793 imap-wait-for-tag
2794 imap-sentinel
2795 imap-find-next-line
2796 imap-arrival-filter
2797 imap-parse-greeting
2798 imap-parse-response
2799 imap-parse-resp-text
2800 imap-parse-resp-text-code
2801 imap-parse-data-list
2802 imap-parse-fetch
2803 imap-parse-status
2804 imap-parse-acl
2805 imap-parse-flag-list
2806 imap-parse-envelope
2807 imap-parse-body-extension
2808 imap-parse-body
2809 )))
2813 ;;; arch-tag: 27369ed6-33e4-482f-96f1-8bb906ba70f7
2814 ;;; imap.el ends here