| blob | 82cb67847813cf7fd965e6fd890b54cc1dd2a17a |
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, or (at your option)
14 ;; 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; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, USA.
26 ;;; Commentary:
28 ;; imap.el is a elisp library providing an interface for talking to
29 ;; IMAP servers.
30 ;;
31 ;; imap.el is roughly divided in two parts, one that parses IMAP
32 ;; responses from the server and storing data into buffer-local
33 ;; variables, and one for utility functions which send commands to
34 ;; server, waits for an answer, and return information. The latter
35 ;; part is layered on top of the previous.
36 ;;
37 ;; The imap.el API consist of the following functions, other functions
38 ;; in this file should not be called directly and the result of doing
39 ;; so are at best undefined.
40 ;;
41 ;; Global commands:
42 ;;
43 ;; imap-open, imap-opened, imap-authenticate, imap-close,
44 ;; imap-capability, imap-namespace, imap-error-text
45 ;;
46 ;; Mailbox commands:
47 ;;
48 ;; imap-mailbox-get, imap-mailbox-map, imap-current-mailbox,
49 ;; imap-current-mailbox-p, imap-search, imap-mailbox-select,
50 ;; imap-mailbox-examine, imap-mailbox-unselect, imap-mailbox-expunge
51 ;; imap-mailbox-close, imap-mailbox-create, imap-mailbox-delete
52 ;; imap-mailbox-rename, imap-mailbox-lsub, imap-mailbox-list
53 ;; imap-mailbox-subscribe, imap-mailbox-unsubscribe, imap-mailbox-status
54 ;; imap-mailbox-acl-get, imap-mailbox-acl-set, imap-mailbox-acl-delete
55 ;;
56 ;; Message commands:
57 ;;
58 ;; imap-fetch-asynch, imap-fetch,
59 ;; imap-current-message, imap-list-to-message-set,
60 ;; imap-message-get, imap-message-map
61 ;; imap-message-envelope-date, imap-message-envelope-subject,
62 ;; imap-message-envelope-from, imap-message-envelope-sender,
63 ;; imap-message-envelope-reply-to, imap-message-envelope-to,
64 ;; imap-message-envelope-cc, imap-message-envelope-bcc
65 ;; imap-message-envelope-in-reply-to, imap-message-envelope-message-id
66 ;; imap-message-body, imap-message-flag-permanent-p
67 ;; imap-message-flags-set, imap-message-flags-del
68 ;; imap-message-flags-add, imap-message-copyuid
69 ;; imap-message-copy, imap-message-appenduid
70 ;; imap-message-append, imap-envelope-from
71 ;; imap-body-lines
72 ;;
73 ;; It is my hope that these commands should be pretty self
74 ;; explanatory for someone that know IMAP. All functions have
75 ;; additional documentation on how to invoke them.
76 ;;
77 ;; imap.el support RFC1730/2060 (IMAP4/IMAP4rev1), implemented IMAP
78 ;; extensions are RFC2195 (CRAM-MD5), RFC2086 (ACL), RFC2342
79 ;; (NAMESPACE), RFC2359 (UIDPLUS), the IMAP-part of RFC2595 (STARTTLS,
80 ;; LOGINDISABLED) (with use of external library starttls.el and
81 ;; program starttls) and the GSSAPI / kerberos V4 sections of RFC1731
82 ;; (with use of external program `imtest'). It also takes advantage of
83 ;; the UNSELECT extension in Cyrus IMAPD.
84 ;;
85 ;; Without the work of John McClary Prevost and Jim Radford this library
86 ;; would not have seen the light of day. Many thanks.
87 ;;
88 ;; This is a transcript of short interactive session for demonstration
89 ;; purposes.
90 ;;
91 ;; (imap-open "my.mail.server")
92 ;; => " *imap* my.mail.server:0"
93 ;;
94 ;; The rest are invoked with current buffer as the buffer returned by
95 ;; `imap-open'. It is possible to do all without this, but it would
96 ;; look ugly here since `buffer' is always the last argument for all
97 ;; imap.el API functions.
98 ;;
99 ;; (imap-authenticate "myusername" "mypassword")
100 ;; => auth
101 ;;
102 ;; (imap-mailbox-lsub "*")
103 ;; => ("INBOX.sentmail" "INBOX.private" "INBOX.draft" "INBOX.spam")
104 ;;
105 ;; (imap-mailbox-list "INBOX.n%")
106 ;; => ("INBOX.namedroppers" "INBOX.nnimap" "INBOX.ntbugtraq")
107 ;;
108 ;; (imap-mailbox-select "INBOX.nnimap")
109 ;; => "INBOX.nnimap"
110 ;;
111 ;; (imap-mailbox-get 'exists)
112 ;; => 166
113 ;;
114 ;; (imap-mailbox-get 'uidvalidity)
115 ;; => "908992622"
116 ;;
117 ;; (imap-search "FLAGGED SINCE 18-DEC-98")
118 ;; => (235 236)
119 ;;
120 ;; (imap-fetch 235 "RFC822.PEEK" 'RFC822)
121 ;; => "X-Sieve: cmu-sieve 1.3^M\nX-Username: <jas@pdc.kth.se>^M\r...."
122 ;;
123 ;; Todo:
124 ;;
125 ;; o Parse UIDs as strings? We need to overcome the 28 bit limit somehow.
126 ;; o Don't use `read' at all (important places already fixed)
127 ;; o Accept list of articles instead of message set string in most
128 ;; imap-message-* functions.
129 ;; o Send strings as literal if they contain, e.g., ".
130 ;;
131 ;; Revision history:
132 ;;
133 ;; - 19991218 added starttls/digest-md5 patch,
134 ;; by Daiki Ueno <ueno@ueda.info.waseda.ac.jp>
135 ;; NB! you need SLIM for starttls.el and digest-md5.el
136 ;; - 19991023 commited to pgnus
137 ;;
139 ;;; Code:
158 ;; Avoid use gnus-point-at-eol so we're independent of Gnus. These
159 ;; days we have point-at-eol anyhow.
167 ;; User variables.
170 "Low-level IMAP issues."
176 "List of strings containing commands for Kerberos 4 authentication.
177 %s is replaced with server hostname, %p with port to connect to, and
178 %l with the value of `imap-default-user'. The program should accept
179 IMAP commands on stdin and return responses to stdout. Each entry in
180 the list is tried until a successful connection is made."
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.
245 Note that username, passwords and other privacy sensitive
246 information (such as e-mail) may be stored in the *imap-log*
247 buffer. It is not written to disk, however. Do not enable this
248 variable unless you are comfortable with that."
253 "If non-nil, random debug spews are placed in *imap-debug* buffer.
254 Note that username, passwords and other privacy sensitive
255 information (such as e-mail) may be stored in the *imap-debug*
256 buffer. It is not written to disk, however. Do not enable this
257 variable unless you are comfortable with that."
262 "Hostname of rlogin proxy."
267 "Default username to use."
274 1.0
276 "*How long to wait between checking for the end of output.
277 Shorter values mean quicker response, but is more CPU intensive."
282 "If non-nil, store session password without promting."
286 ;; Various variables.
302 "Definition of network streams.
304 \(NAME CHECK OPEN)
306 NAME names the stream, CHECK is a function returning non-nil if the
307 server support the stream and OPEN is a function for opening the
311 kerberos4
312 digest-md5
313 cram-md5
314 login
315 anonymous)
325 "Definition of authenticators.
327 \(NAME CHECK AUTHENTICATE)
329 NAME names the authenticator. CHECK is a function returning non-nil if
330 the server support the authenticator and AUTHENTICATE is a function
336 ;; Internal constants. Change these and die.
345 imap-port
346 imap-client-eol
347 imap-server-eol
348 imap-auth
349 imap-stream
350 imap-username
351 imap-password
352 imap-current-mailbox
353 imap-current-target-mailbox
354 imap-message-data
355 imap-capability
356 imap-namespace
357 imap-state
358 imap-reached-tag
359 imap-failed-tags
360 imap-tag
361 imap-process
362 imap-calculate-literal-size-first
363 imap-mailbox-data))
367 ;; Internal variables.
377 "IMAP state.
378 Valid states are `closed', `initial', `nonauth', `auth', `selected'
418 "Alist of tags that failed.
419 Each element is a list with four elements; tag (a integer), response
420 state (a symbol, `OK', `NO' or `BAD'), response code (a string), and
430 "Non-nil indicates that the server emitted a continuation request.
434 "List of response tags and callbacks, on the form `(number . function)'.
435 The function should take two arguments, the first the IMAP tag and the
438 \f
439 ;; Utility functions:
442 "Delete by side effect any elements of LIST whose car is `equal' to KEY.
443 The modified LIST is returned. If the first member
444 of LIST has a car that is `equal' to KEY, there is no way to remove it
445 by side effect; therefore, write `(setq foo (remassoc key foo))' to be
446 sure of changing the value of `foo'."
451 alist)))
454 "Enable multibyte in the current buffer."
464 "imap: Could not UTF7 encode `%s', using it unencoded..."
465 string)
466 string)))
467 string))
475 "imap: Could not UTF7 decode `%s', using it undecoded..."
476 string)
477 string)))
478 string))
482 t
484 nil))
490 \f
491 ;; Server functions; stream stuff:
498 cmd done)
507 name buffer shell-file-name shell-command-switch
509 cmd
511 ?s server
513 ?l imap-default-user))))
514 response)
518 imap-calculate-literal-size-first t)
522 ;; Athena IMTEST can output SSL verify errors
525 t)
528 t)
529 ;; cyrus 1.6.x (13? < x <= 22) queries capabilities
532 t)
533 ;; cyrus 1.6 imtest print "S: " before server greeting
536 t)
538 ;; success in imtest < 1.6:
541 ;; success in imtest 1.6:
562 nil)))))
563 done))
570 cmd done)
579 name buffer shell-file-name shell-command-switch
581 cmd
583 ?s server
585 ?l imap-default-user))))
586 response)
590 imap-calculate-literal-size-first t)
594 ;; Athena IMTEST can output SSL verify errors
597 t)
600 t)
601 ;; cyrus 1.6.x (13? < x <= 22) queries capabilities
604 t)
605 ;; cyrus 1.6 imtest print "S: " before server greeting
608 t)
609 ;; GNU SASL may print 'Trying ...' first.
612 t)
614 ;; success in imtest 1.6:
617 "Client authentication "
619 nil t)
637 nil)))))
638 done))
641 nil)
644 "Open a SSL connection to server."
647 cmd done)
657 'set-process-query-on-exit-flag
659 process)
662 name buffer shell-file-name
663 shell-command-switch
666 ?s server
669 process)
691 done)
693 nil)))
696 nil)
718 process))))
721 t)
742 process))))
745 nil)
750 cmd done)
758 name buffer shell-file-name shell-command-switch
760 cmd
762 ?s server
763 ?g imap-shell-host
765 ?l imap-default-user)))))
786 done)
788 nil)))
798 done tls-info)
827 done))
829 ;; Server functions; authenticator stuff:
832 "Login to server in BUFFER.
833 LOGINFUNC is passed a username and a password, it should return t if
834 it where successful authenticating itself to the server, nil otherwise.
835 Returns t if login was successful, nil otherwise."
840 ;; (condition-case ()
851 imap-server " (using authenticator `"
857 imap-username user)
866 ;; (quit (with-current-buffer buffer
867 ;; (setq user nil
868 ;; passwd nil)))
869 ;; (error (with-current-buffer buffer
870 ;; (setq user nil
871 ;; passwd nil))))
872 ret)))
895 "Login to server using the AUTH CRAM-MD5 method."
898 buffer
903 "AUTHENTICATE CRAM-MD5"
909 encoded)))))))))
919 "Login to server using the LOGIN command."
928 t)
944 "Login to server using the AUTH DIGEST-MD5 method."
947 buffer
952 "AUTHENTICATE DIGEST-MD5"
961 user passwd digest-uri)))
963 )))
965 nil
970 ;; Server functions:
976 imap-current-message nil
977 imap-state 'initial
980 imap-stream-alist))
992 imap-process))))
995 "Open a IMAP connection to host SERVER at PORT returning a buffer.
996 If PORT is unspecified, a default value is used (143 except
997 for SSL which use 993).
998 STREAM indicates the stream to use, see `imap-streams' for available
999 streams. If nil, it choices the best stream the server is capable of.
1000 AUTH indicates authenticator to use, see `imap-authenticators' for
1001 available authenticators. If nil, it choices the best stream the
1002 server is capable of.
1003 BUFFER can be a buffer or a name of a buffer, which is created if
1004 necessary. If nil, the buffer name is generated."
1021 nil)
1023 ;; Need to choose stream.
1026 ;; OK to use this stream?
1028 ;; Stream changed?
1044 "imap: Reconnecting with stream `%s'...failed"
1045 stream))
1046 ;; We're done, kill the first connection
1049 buffer
1054 stream)
1058 ;; We're done
1066 buffer))))
1069 "Return non-nil if connection to imap server in BUFFER is open.
1070 If BUFFER is nil then the current buffer is used."
1078 "Authenticate to server in BUFFER, using current buffer if nil.
1079 It uses the authenticator specified when opening the server. If the
1080 authenticator requires username/passwords, they are queried from the
1081 user and optionally stored in the buffer. If USER and/or PASSWD is
1082 specified, the user will not be questioned and the username and/or
1083 password is remembered in the buffer."
1097 ;; Choose authenticator.
1099 auth)
1101 ;; OK to use authenticator?
1104 imap-server auth)
1109 imap-server auth)
1112 imap-server auth)))))
1113 imap-state))))
1116 "Close connection to server in BUFFER.
1117 If BUFFER is nil, the current buffer is used."
1127 imap-current-message nil
1128 imap-process nil)
1130 t))
1133 "Return a list of identifiers which server in BUFFER support.
1134 If IDENTIFIER, return non-nil if it's among the servers capabilities.
1135 If BUFFER is nil, the current buffer is assumed."
1142 imap-capability)))
1145 "Return a namespace hierarchy at server in BUFFER.
1146 If BUFFER is nil, the current buffer is assumed."
1151 imap-namespace))
1156 \f
1157 ;; Mailbox functions:
1163 propname value)
1166 t))
1170 propname))
1185 imap-mailbox-data)
1186 result)))
1189 "Map a function across each mailbox in `imap-mailbox-data', returning a list.
1190 Function should take a mailbox name (a string) as
1191 the only argument."
1210 "Select MAILBOX on server in BUFFER.
1211 If EXAMINE is non-nil, do a read-only select."
1213 imap-current-mailbox
1221 imap-current-mailbox)
1222 ;; Failed SELECT/EXAMINE unselects current mailbox
1235 "Examine MAILBOX on server in BUFFER."
1239 "Close current folder in BUFFER, without expunging articles."
1246 imap-current-mailbox
1250 imap-message-data nil
1252 t)))
1255 "Expunge articles in current folder in BUFFER.
1256 If ASYNCH, do not wait for succesful completion of the command.
1257 If BUFFER is nil the current buffer is assumed."
1265 "Expunge articles and close current folder in BUFFER.
1266 If ASYNCH, do not wait for succesful completion of the command.
1267 If BUFFER is nil the current buffer is assumed."
1274 imap-current-mailbox status)
1276 imap-current-mailbox)
1277 ;; Don't wipe out data if another mailbox
1278 ;; was selected...
1280 imap-message-data nil
1284 imap-message-data nil
1286 t)))
1292 "Create MAILBOX on server in BUFFER.
1293 If BUFFER is nil the current buffer is assumed."
1298 "Delete MAILBOX on server in BUFFER.
1299 If BUFFER is nil the current buffer is assumed."
1306 "Rename mailbox OLDNAME to NEWNAME on server in BUFFER.
1307 If BUFFER is nil the current buffer is assumed."
1316 "Return a list of subscribed mailboxes on server in BUFFER.
1317 If ROOT is non-nil, only list matching mailboxes. If ADD-DELIMITER is
1318 non-nil, a hierarchy delimiter is added to root. REFERENCE is a
1319 implementation-specific string that has to be passed to lsub command."
1321 ;; Make sure we know the hierarchy separator for root's hierarchy
1325 ;; clear list data (NB not delimiter and other stuff)
1340 "Return a list of mailboxes matching ROOT on server in BUFFER.
1341 If ADD-DELIMITER is non-nil, a hierarchy delimiter is added to
1342 root. REFERENCE is a implementation-specific string that has to be
1343 passed to list command."
1345 ;; Make sure we know the hierarchy separator for root's hierarchy
1349 ;; clear list data (NB not delimiter and other stuff)
1364 "Send the SUBSCRIBE command on the mailbox to server in BUFFER.
1365 Returns non-nil if successful."
1372 "Send the SUBSCRIBE command on the mailbox to server in BUFFER.
1373 Returns non-nil if successful."
1380 "Get status items ITEM in MAILBOX from server in BUFFER.
1381 ITEMS can be a symbol or a list of symbols, valid symbols are one of
1382 the STATUS data items -- ie 'messages, 'recent, 'uidnext, 'uidvalidity
1383 or 'unseen. If ITEMS is a list of symbols, a list of values is
1384 returned, if ITEMS is a symbol only its value is returned."
1393 items
1398 items)
1402 "Send status item request ITEM on MAILBOX to server in BUFFER.
1403 ITEMS can be a symbol or a list of symbols, valid symbols are one of
1404 the STATUS data items -- ie 'messages, 'recent, 'uidnext, 'uidvalidity
1405 or 'unseen. The IMAP command tag is returned."
1412 items
1416 "Get ACL on mailbox from server in BUFFER."
1426 "Change/set ACL for IDENTIFIER to RIGHTS in MAILBOX from server in BUFFER."
1433 identifier
1434 " "
1435 rights))))))
1438 "Removes any <identifier,rights> pair for IDENTIFIER in MAILBOX from server in BUFFER."
1445 identifier))))))
1447 \f
1448 ;; Message functions:
1452 imap-current-message))
1458 list
1471 range)
1479 uids)
1480 props))))
1483 "Fetch properties PROPS from message set UIDS from server in BUFFER.
1484 UIDS can be a string, number or a list of numbers. If RECEIVE
1485 is non-nil return these properties."
1491 uids)
1492 props)))
1494 t
1500 receive)
1502 uids)
1509 propname value)
1512 t))
1517 propname)))
1520 "Map a function across each mailbox in `imap-message-data', returning a list."
1526 imap-message-data)
1527 result)))
1580 nil)
1584 "Return t if FLAG can be permanently (between IMAP sessions) saved on articles, in MAILBOX on server in BUFFER."
1633 "Copy ARTICLES (a string message set) to MAILBOX on server in
1634 BUFFER, creating mailbox if it doesn't exist. If dont-create is
1635 non-nil, it will not create a mailbox. On success, return a list with
1636 the UIDVALIDITY of the mailbox the article(s) was copied to as the
1637 first element, rest of list contain the saved articles' UIDs."
1644 t
1646 ;; removed because of buggy Oracle server
1647 ;; that doesn't send TRYCREATE tags (which
1648 ;; is a MUST according to specifications):
1649 ;;(imap-mailbox-get-1 'trycreate mailbox)
1676 "Append ARTICLE (a buffer) to MAILBOX on server in BUFFER.
1677 FLAGS and DATE-TIME is currently not used. Return a cons holding
1678 uidvalidity of MAILBOX and UID the newly created article got, or nil
1679 on failure."
1689 "Return number of lines in article by looking at the mime bodystructure BODY."
1703 "Return a from string line."
1708 "@"
1712 \f
1713 ;; Internal functions.
1732 cmd cmdstr)
1740 size)
1745 ;; XXX modifies buffer!
1765 imap-log-buffer)
1781 command)))
1787 tag)))
1796 message-log-max)
1805 ;; A process can die _before_ we have processed everything it
1806 ;; has to say. Moreover, this can happen in between the call to
1807 ;; accept-process-output and the call to process-status in an
1808 ;; iteration of the loop above.
1817 'INCOMPLETE
1824 "Return point at end of current line, taking into account literals.
1825 Return nil if no complete line has arrived."
1827 imap-server-eol)
1828 nil t)
1831 nil
1837 "IMAP process filter."
1838 ;; Sometimes, we are called even though the process has died.
1839 ;; Better abstain from doing stuff in that case.
1867 imap-state)))
1870 \f
1871 ;; Imap parser.
1876 ;; number = 1*DIGIT
1877 ;; ; Unsigned 32-bit integer
1878 ;; ; (0 <= n < 4,294,967,296)
1886 ;; literal = "{" number "}" CRLF *CHAR8
1887 ;; ; Number represents the number of CHAR8s
1894 nil
1898 ;; string = quoted / literal
1899 ;;
1900 ;; quoted = DQUOTE *QUOTED-CHAR DQUOTE
1901 ;;
1902 ;; QUOTED-CHAR = <any TEXT-CHAR except quoted-specials> /
1903 ;; "\" quoted-specials
1904 ;;
1905 ;; quoted-specials = DQUOTE / "\"
1906 ;;
1907 ;; TEXT-CHAR = <any CHAR except CR and LF>
1921 name))
1925 ;; nil = "NIL"
1931 ;; nstring = string / nil
1936 nil)))
1938 ;; astring = atom / string
1939 ;;
1940 ;; atom = 1*ATOM-CHAR
1941 ;;
1942 ;; ATOM-CHAR = <any CHAR except atom-specials>
1943 ;;
1944 ;; atom-specials = "(" / ")" / "{" / SP / CTL / list-wildcards /
1945 ;; quoted-specials
1946 ;;
1947 ;; list-wildcards = "%" / "*"
1948 ;;
1949 ;; quoted-specials = DQUOTE / "\"
1959 ;; address = "(" addr-name SP addr-adl SP addr-mailbox SP
1960 ;; addr-host ")"
1961 ;;
1962 ;; addr-adl = nstring
1963 ;; ; Holds route from [RFC-822] route-addr if
1964 ;; ; non-nil
1965 ;;
1966 ;; addr-host = nstring
1967 ;; ; nil indicates [RFC-822] group syntax.
1968 ;; ; Otherwise, holds [RFC-822] domain name
1969 ;;
1970 ;; addr-mailbox = nstring
1971 ;; ; nil indicates end of [RFC-822] group; if
1972 ;; ; non-nil and addr-host is nil, holds
1973 ;; ; [RFC-822] group name.
1974 ;; ; Otherwise, holds [RFC-822] local-part
1975 ;; ; after removing [RFC-822] quoting
1976 ;;
1977 ;; addr-name = nstring
1978 ;; ; If non-nil, holds phrase from [RFC-822]
1979 ;; ; mailbox after removing [RFC-822] quoting
1980 ;;
1995 address))))
1997 ;; address-list = "(" 1*address ")" / nil
1998 ;;
1999 ;; nil = "NIL"
2006 ;; next line for MS Exchange bug
2013 ;; With assert, the code might not be eval'd.
2014 ;; (assert (imap-parse-nil) t "In imap-parse-address-list")
2017 ;; mailbox = "INBOX" / astring
2018 ;; ; INBOX is case-insensitive. All case variants of
2019 ;; ; INBOX (e.g. "iNbOx") MUST be interpreted as INBOX
2020 ;; ; not as an astring. An astring which consists of
2021 ;; ; the case-insensitive sequence "I" "N" "B" "O" "X"
2022 ;; ; is considered to be INBOX and not an astring.
2023 ;; ; Refer to section 5.1 for further
2024 ;; ; semantic details of mailbox names.
2029 "INBOX"
2030 mailbox)))
2032 ;; greeting = "*" SP (resp-cond-auth / resp-cond-bye) CRLF
2033 ;;
2034 ;; resp-cond-auth = ("OK" / "PREAUTH") SP resp-text
2035 ;; ; Authentication condition
2036 ;;
2037 ;; resp-cond-bye = "BYE" SP resp-text
2040 "Parse a IMAP greeting."
2048 ;; response = *(continue-req / response-data) response-done
2049 ;;
2050 ;; continue-req = "+" SP (resp-text / base64) CRLF
2051 ;;
2052 ;; response-data = "*" SP (resp-cond-state / resp-cond-bye /
2053 ;; mailbox-data / message-data / capability-data) CRLF
2054 ;;
2055 ;; response-done = response-tagged / response-fatal
2056 ;;
2057 ;; response-fatal = "*" SP resp-cond-bye CRLF
2058 ;; ; Server closes connection immediately
2059 ;;
2060 ;; response-tagged = tag SP resp-cond-state CRLF
2061 ;;
2062 ;; resp-cond-state = ("OK" / "NO" / "BAD") SP resp-text
2063 ;; ; Status condition
2064 ;;
2065 ;; resp-cond-bye = "BYE" SP resp-text
2066 ;;
2067 ;; mailbox-data = "FLAGS" SP flag-list /
2068 ;; "LIST" SP mailbox-list /
2069 ;; "LSUB" SP mailbox-list /
2070 ;; "SEARCH" *(SP nz-number) /
2071 ;; "STATUS" SP mailbox SP "("
2072 ;; [status-att SP number *(SP status-att SP number)] ")" /
2073 ;; number SP "EXISTS" /
2074 ;; number SP "RECENT"
2075 ;;
2076 ;; message-data = nz-number SP ("EXPUNGE" / ("FETCH" SP msg-att))
2077 ;;
2078 ;; capability-data = "CAPABILITY" *(SP capability) SP "IMAP4rev1"
2079 ;; *(SP capability)
2080 ;; ; IMAP4rev1 servers which offer RFC 1730
2081 ;; ; compatibility MUST list "IMAP4" as the first
2082 ;; ; capability.
2085 "Parse a IMAP command response."
2091 t)))
2102 'search
2136 imap-failed-tags))))
2149 token status code text))))
2156 ;; resp-text = ["[" resp-text-code "]" SP] text
2157 ;;
2158 ;; text = 1*TEXT-CHAR
2159 ;;
2160 ;; TEXT-CHAR = <any CHAR except CR and LF>
2165 ;; resp-text-code = "ALERT" /
2166 ;; "BADCHARSET [SP "(" astring *(SP astring) ")" ] /
2167 ;; "NEWNAME" SP string SP string /
2168 ;; "PARSE" /
2169 ;; "PERMANENTFLAGS" SP "("
2170 ;; [flag-perm *(SP flag-perm)] ")" /
2171 ;; "READ-ONLY" /
2172 ;; "READ-WRITE" /
2173 ;; "TRYCREATE" /
2174 ;; "UIDNEXT" SP nz-number /
2175 ;; "UIDVALIDITY" SP nz-number /
2176 ;; "UNSEEN" SP nz-number /
2177 ;; resp-text-atom [SP 1*<any TEXT-CHAR except "]">]
2178 ;;
2179 ;; resp_code_apnd = "APPENDUID" SPACE nz_number SPACE uniqueid
2180 ;;
2181 ;; resp_code_copy = "COPYUID" SPACE nz_number SPACE set SPACE set
2182 ;;
2183 ;; set = sequence-num / (sequence-num ":" sequence-num) /
2184 ;; (set "," set)
2185 ;; ; Identifies a set of messages. For message
2186 ;; ; sequence numbers, these are consecutive
2187 ;; ; numbers from 1 to the number of messages in
2188 ;; ; the mailbox
2189 ;; ; Comma delimits individual numbers, colon
2190 ;; ; delimits between two numbers inclusive.
2191 ;; ; Example: 2,4:7,9,12:* is 2,4,5,6,7,9,12,13,
2192 ;; ; 14,15 for a mailbox with 15 messages.
2193 ;;
2194 ;; sequence-num = nz-number / "*"
2195 ;; ; * is the largest number in use. For message
2196 ;; ; sequence numbers, it is the number of messages
2197 ;; ; in the mailbox. For unique identifiers, it is
2198 ;; ; the unique identifier of the last message in
2199 ;; ; the mailbox.
2200 ;;
2201 ;; flag-perm = flag / "\*"
2202 ;;
2203 ;; flag = "\Answered" / "\Flagged" / "\Deleted" /
2204 ;; "\Seen" / "\Draft" / flag-keyword / flag-extension
2205 ;; ; Does not include "\Recent"
2206 ;;
2207 ;; flag-extension = "\" atom
2208 ;; ; Future expansion. Client implementations
2209 ;; ; MUST accept flag-extension flags. Server
2210 ;; ; implementations MUST NOT generate
2211 ;; ; flag-extension flags except as defined by
2212 ;; ; future standard or standards-track
2213 ;; ; revisions of this specification.
2214 ;;
2215 ;; flag-keyword = atom
2216 ;;
2217 ;; resp-text-atom = 1*<any ATOM-CHAR except "]">
2220 ;; xxx next line for stalker communigate pro 3.3.1 bug
2247 imap-current-target-mailbox))
2252 imap-current-target-mailbox))
2257 ;; mailbox-list = "(" [mbx-list-flags] ")" SP
2258 ;; (DQUOTE QUOTED-CHAR DQUOTE / nil) SP mailbox
2259 ;;
2260 ;; mbx-list-flags = *(mbx-list-oflag SP) mbx-list-sflag
2261 ;; *(SP mbx-list-oflag) /
2262 ;; mbx-list-oflag *(SP mbx-list-oflag)
2263 ;;
2264 ;; mbx-list-oflag = "\Noinferiors" / flag-extension
2265 ;; ; Other flags; multiple possible per LIST response
2266 ;;
2267 ;; mbx-list-sflag = "\Noselect" / "\Marked" / "\Unmarked"
2268 ;; ; Selectability flags; only one per LIST response
2269 ;;
2270 ;; QUOTED-CHAR = <any TEXT-CHAR except quoted-specials> /
2271 ;; "\" quoted-specials
2272 ;;
2273 ;; quoted-specials = DQUOTE / "\"
2286 ;; msg_att ::= "(" 1#("ENVELOPE" SPACE envelope /
2287 ;; "FLAGS" SPACE "(" #(flag / "\Recent") ")" /
2288 ;; "INTERNALDATE" SPACE date_time /
2289 ;; "RFC822" [".HEADER" / ".TEXT"] SPACE nstring /
2290 ;; "RFC822.SIZE" SPACE number /
2291 ;; "BODY" ["STRUCTURE"] SPACE body /
2292 ;; "BODY" section ["<" number ">"] SPACE nstring /
2293 ;; "UID" SPACE uniqueid) ")"
2294 ;;
2295 ;; date_time ::= <"> date_day_fixed "-" date_month "-" date_year
2296 ;; SPACE time SPACE zone <">
2297 ;;
2298 ;; section ::= "[" [section_text / (nz_number *["." nz_number]
2299 ;; ["." (section_text / "MIME")])] "]"
2300 ;;
2301 ;; section_text ::= "HEADER" / "HEADER.FIELDS" [".NOT"]
2302 ;; SPACE header_list / "TEXT"
2303 ;;
2304 ;; header_fld_name ::= astring
2305 ;;
2306 ;; header_list ::= "(" 1#header_fld_name ")"
2324 section)))
2329 rfc822size body bodydetail bodystructure flags-empty)
2363 bodydetail)
2382 ;; mailbox-data = ...
2383 ;; "STATUS" SP mailbox SP "("
2384 ;; [status-att SP number
2385 ;; *(SP status-att SP number)] ")"
2386 ;; ...
2387 ;;
2388 ;; status-att = "MESSAGES" / "RECENT" / "UIDNEXT" / "UIDVALIDITY" /
2389 ;; "UNSEEN"
2417 token mailbox)
2420 ;; acl_data ::= "ACL" SPACE mailbox *(SPACE identifier SPACE
2421 ;; rights)
2422 ;;
2423 ;; identifier ::= astring
2424 ;;
2425 ;; rights ::= astring
2429 identifier rights acl)
2438 ;; flag-list = "(" [flag *(SP flag)] ")"
2439 ;;
2440 ;; flag = "\Answered" / "\Flagged" / "\Deleted" /
2441 ;; "\Seen" / "\Draft" / flag-keyword / flag-extension
2442 ;; ; Does not include "\Recent"
2443 ;;
2444 ;; flag-keyword = atom
2445 ;;
2446 ;; flag-extension = "\" atom
2447 ;; ; Future expansion. Client implementations
2448 ;; ; MUST accept flag-extension flags. Server
2449 ;; ; implementations MUST NOT generate
2450 ;; ; flag-extension flags except as defined by
2451 ;; ; future standard or standards-track
2452 ;; ; revisions of this specification.
2460 ;; next line for Courier IMAP bug.
2469 ;; envelope = "(" env-date SP env-subject SP env-from SP env-sender SP
2470 ;; env-reply-to SP env-to SP env-cc SP env-bcc SP
2471 ;; env-in-reply-to SP env-message-id ")"
2472 ;;
2473 ;; env-bcc = "(" 1*address ")" / nil
2474 ;;
2475 ;; env-cc = "(" 1*address ")" / nil
2476 ;;
2477 ;; env-date = nstring
2478 ;;
2479 ;; env-from = "(" 1*address ")" / nil
2480 ;;
2481 ;; env-in-reply-to = nstring
2482 ;;
2483 ;; env-message-id = nstring
2484 ;;
2485 ;; env-reply-to = "(" 1*address ")" / nil
2486 ;;
2487 ;; env-sender = "(" 1*address ")" / nil
2488 ;;
2489 ;; env-subject = nstring
2490 ;;
2491 ;; env-to = "(" 1*address ")" / nil
2517 ;; body-fld-param = "(" string SP string *(SP string SP string) ")" / nil
2525 ;; buggy stalker communigate pro 3.0 doesn't print SPC
2526 ;; between body-fld-param's sometimes
2531 nil)))
2533 ;; body-extension = nstring / number /
2534 ;; "(" body-extension *(SP body-extension) ")"
2535 ;; ; Future expansion. Client implementations
2536 ;; ; MUST accept body-extension fields. Server
2537 ;; ; implementations MUST NOT generate
2538 ;; ; body-extension fields except as defined by
2539 ;; ; future standard or standards-track
2540 ;; ; revisions of this specification.
2556 ;; body-ext-1part = body-fld-md5 [SP body-fld-dsp [SP body-fld-lang
2557 ;; *(SP body-extension)]]
2558 ;; ; MUST NOT be returned on non-extensible
2559 ;; ; "BODY" fetch
2560 ;;
2561 ;; body-ext-mpart = body-fld-param [SP body-fld-dsp [SP body-fld-lang
2562 ;; *(SP body-extension)]]
2563 ;; ; MUST NOT be returned on non-extensible
2564 ;; ; "BODY" fetch
2578 ;; With assert, the code might not be eval'd.
2579 ;; (assert (imap-parse-nil) t "In imap-parse-body-ext")
2590 ext))
2592 ;; body = "(" body-type-1part / body-type-mpart ")"
2593 ;;
2594 ;; body-ext-1part = body-fld-md5 [SP body-fld-dsp [SP body-fld-lang
2595 ;; *(SP body-extension)]]
2596 ;; ; MUST NOT be returned on non-extensible
2597 ;; ; "BODY" fetch
2598 ;;
2599 ;; body-ext-mpart = body-fld-param [SP body-fld-dsp [SP body-fld-lang
2600 ;; *(SP body-extension)]]
2601 ;; ; MUST NOT be returned on non-extensible
2602 ;; ; "BODY" fetch
2603 ;;
2604 ;; body-fields = body-fld-param SP body-fld-id SP body-fld-desc SP
2605 ;; body-fld-enc SP body-fld-octets
2606 ;;
2607 ;; body-fld-desc = nstring
2608 ;;
2609 ;; body-fld-dsp = "(" string SP body-fld-param ")" / nil
2610 ;;
2611 ;; body-fld-enc = (DQUOTE ("7BIT" / "8BIT" / "BINARY" / "BASE64"/
2612 ;; "QUOTED-PRINTABLE") DQUOTE) / string
2613 ;;
2614 ;; body-fld-id = nstring
2615 ;;
2616 ;; body-fld-lang = nstring / "(" string *(SP string) ")"
2617 ;;
2618 ;; body-fld-lines = number
2619 ;;
2620 ;; body-fld-md5 = nstring
2621 ;;
2622 ;; body-fld-octets = number
2623 ;;
2624 ;; body-fld-param = "(" string SP string *(SP string SP string) ")" / nil
2625 ;;
2626 ;; body-type-1part = (body-type-basic / body-type-msg / body-type-text)
2627 ;; [SP body-ext-1part]
2628 ;;
2629 ;; body-type-basic = media-basic SP body-fields
2630 ;; ; MESSAGE subtype MUST NOT be "RFC822"
2631 ;;
2632 ;; body-type-msg = media-message SP body-fields SP envelope
2633 ;; SP body SP body-fld-lines
2634 ;;
2635 ;; body-type-text = media-text SP body-fields SP body-fld-lines
2636 ;;
2637 ;; body-type-mpart = 1*body SP media-subtype
2638 ;; [SP body-ext-mpart]
2639 ;;
2640 ;; media-basic = ((DQUOTE ("APPLICATION" / "AUDIO" / "IMAGE" /
2641 ;; "MESSAGE" / "VIDEO") DQUOTE) / string) SP media-subtype
2642 ;; ; Defined in [MIME-IMT]
2643 ;;
2644 ;; media-message = DQUOTE "MESSAGE" DQUOTE SP DQUOTE "RFC822" DQUOTE
2645 ;; ; Defined in [MIME-IMT]
2646 ;;
2647 ;; media-subtype = string
2648 ;; ; Defined in [MIME-IMT]
2649 ;;
2650 ;; media-text = DQUOTE "TEXT" DQUOTE SP media-subtype
2651 ;; ; Defined in [MIME-IMT]
2661 ;; buggy stalker communigate pro 3.0 insert a SPC between
2662 ;; parts in multiparts
2684 ;; next line for Sun SIMS bug
2694 ;; next `or' for Sun SIMS bug, it regard body-fld-enc as a
2695 ;; nstring and return nil instead of defaulting back to 7BIT
2696 ;; as the standard says.
2701 ;; ok, we're done parsing the required parts, what comes now is one
2702 ;; of three things:
2703 ;;
2704 ;; envelope (then we're parsing body-type-msg)
2705 ;; body-fld-lines (then we're parsing body-type-text)
2706 ;; body-ext-1part (then we're parsing body-type-basic)
2707 ;;
2708 ;; the problem is that the two first are in turn optionally followed
2709 ;; by the third. So we parse the first two here (if there are any)...
2718 ;; buggy stalker communigate pro 3.0 doesn't print
2719 ;; number of lines in message/rfc822 attachment
2729 ;; ...and then parse the third one here...
2744 '(
2745 imap-utf7-encode
2746 imap-utf7-decode
2747 imap-error-text
2748 imap-kerberos4s-p
2749 imap-kerberos4-open
2750 imap-ssl-p
2751 imap-ssl-open
2752 imap-network-p
2753 imap-network-open
2754 imap-interactive-login
2755 imap-kerberos4a-p
2756 imap-kerberos4-auth
2757 imap-cram-md5-p
2758 imap-cram-md5-auth
2759 imap-login-p
2760 imap-login-auth
2761 imap-anonymous-p
2762 imap-anonymous-auth
2763 imap-open-1
2764 imap-open
2765 imap-opened
2766 imap-authenticate
2767 imap-close
2768 imap-capability
2769 imap-namespace
2770 imap-send-command-wait
2771 imap-mailbox-put
2772 imap-mailbox-get
2773 imap-mailbox-map-1
2774 imap-mailbox-map
2775 imap-current-mailbox
2776 imap-current-mailbox-p-1
2777 imap-current-mailbox-p
2778 imap-mailbox-select-1
2779 imap-mailbox-select
2780 imap-mailbox-examine-1
2781 imap-mailbox-examine
2782 imap-mailbox-unselect
2783 imap-mailbox-expunge
2784 imap-mailbox-close
2785 imap-mailbox-create-1
2786 imap-mailbox-create
2787 imap-mailbox-delete
2788 imap-mailbox-rename
2789 imap-mailbox-lsub
2790 imap-mailbox-list
2791 imap-mailbox-subscribe
2792 imap-mailbox-unsubscribe
2793 imap-mailbox-status
2794 imap-mailbox-acl-get
2795 imap-mailbox-acl-set
2796 imap-mailbox-acl-delete
2797 imap-current-message
2798 imap-list-to-message-set
2799 imap-fetch-asynch
2800 imap-fetch
2801 imap-message-put
2802 imap-message-get
2803 imap-message-map
2804 imap-search
2805 imap-message-flag-permanent-p
2806 imap-message-flags-set
2807 imap-message-flags-del
2808 imap-message-flags-add
2809 imap-message-copyuid-1
2810 imap-message-copyuid
2811 imap-message-copy
2812 imap-message-appenduid-1
2813 imap-message-appenduid
2814 imap-message-append
2815 imap-body-lines
2816 imap-envelope-from
2817 imap-send-command-1
2818 imap-send-command
2819 imap-wait-for-tag
2820 imap-sentinel
2821 imap-find-next-line
2822 imap-arrival-filter
2823 imap-parse-greeting
2824 imap-parse-response
2825 imap-parse-resp-text
2826 imap-parse-resp-text-code
2827 imap-parse-data-list
2828 imap-parse-fetch
2829 imap-parse-status
2830 imap-parse-acl
2831 imap-parse-flag-list
2832 imap-parse-envelope
2833 imap-parse-body-extension
2834 imap-parse-body
2835 )))
2839 ;;; arch-tag: 27369ed6-33e4-482f-96f1-8bb906ba70f7
2840 ;;; imap.el ends here