| blob | 40e41d79de7fcba1f7e43f8399a219b2e535676a |
1 ;;; imap.el --- imap library
3 ;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007 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/RFC3501 (IMAP4/IMAP4rev1), implemented
78 ;; IMAP 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'), RFC2971 (ID). It also
83 ;; takes advantage of 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 ;; User variables.
161 "Low-level IMAP issues."
167 "List of strings containing commands for Kerberos 4 authentication.
168 %s is replaced with server hostname, %p with port to connect to, and
169 %l with the value of `imap-default-user'. The program should accept
170 IMAP commands on stdin and return responses to stdout. Each entry in
171 the list is tried until a successful connection is made."
177 "--mechanism GSSAPI "
180 "List of strings containing commands for GSSAPI (krb5) authentication.
181 %s is replaced with server hostname, %p with port to connect to, and
182 %l with the value of `imap-default-user'. The program should accept
183 IMAP commands on stdin and return responses to stdout. Each entry in
184 the list is tried until a successful connection is made."
189 "openssl s_client -quiet -ssl2 -connect %s:%p"
190 "s_client -quiet -ssl3 -connect %s:%p"
192 "A string, or list of strings, containing commands for SSL connections.
193 Within a string, %s is replaced with the server address and %p with
194 port number on server. The program should accept IMAP commands on
195 stdin and return responses to stdout. Each entry in the list is tried
196 until a successful connection is made."
202 "rsh %s imapd"
203 "ssh %g ssh %s imapd"
205 "A list of strings, containing commands for IMAP connection.
206 Within a string, %s is replaced with the server address, %p with port
207 number on server, %g with `imap-shell-host', and %l with
208 `imap-default-user'. The program should read IMAP commands from stdin
209 and write IMAP response to stdout. Each entry in the list is tried
210 until a successful connection is made."
215 "*Value for `process-connection-type' to use for Kerberos4, GSSAPI and SSL.
216 The `process-connection-type' variable control type of device
217 used to communicate with subprocesses. Values are nil to use a
218 pipe, or t or `pty' to use a pty. The value has no effect if the
219 system has no ptys or if all ptys are busy: then a pipe is used
220 in any case. The value takes effect when a IMAP server is
221 opened, changing it after that has no effect."
227 "If non-nil, do utf7 encoding/decoding of mailbox names.
228 Since the UTF7 decoding currently only decodes into ISO-8859-1
229 characters, you may disable this decoding if you need to access UTF7
230 encoded mailboxes which doesn't translate into ISO-8859-1."
235 "If non-nil, a imap session trace is placed in *imap-log* buffer.
236 Note that username, passwords and other privacy sensitive
237 information (such as e-mail) may be stored in the *imap-log*
238 buffer. It is not written to disk, however. Do not enable this
239 variable unless you are comfortable with that."
244 "If non-nil, random debug spews are placed in *imap-debug* buffer.
245 Note that username, passwords and other privacy sensitive
246 information (such as e-mail) may be stored in the *imap-debug*
247 buffer. It is not written to disk, however. Do not enable this
248 variable unless you are comfortable with that."
253 "Hostname of rlogin proxy."
258 "Default username to use."
265 1.0
267 "*How long to wait between checking for the end of output.
268 Shorter values mean quicker response, but is more CPU intensive."
273 "If non-nil, store session password without promting."
277 ;; Various variables.
293 "Definition of network streams.
295 \(NAME CHECK OPEN)
297 NAME names the stream, CHECK is a function returning non-nil if the
298 server support the stream and OPEN is a function for opening the
302 kerberos4
303 digest-md5
304 cram-md5
305 ;;sasl
306 login
307 anonymous)
318 "Definition of authenticators.
320 \(NAME CHECK AUTHENTICATE)
322 NAME names the authenticator. CHECK is a function returning non-nil if
323 the server support the authenticator and AUTHENTICATE is a function
330 "Close server immediately if it can't logout in this number of seconds.
331 If it is nil, never close server until logout completes. Normally,
332 the value of this variable will be bound to a certain value to which
333 an application program that uses this module specifies on a per-server
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-id
357 imap-namespace
358 imap-state
359 imap-reached-tag
360 imap-failed-tags
361 imap-tag
362 imap-process
363 imap-calculate-literal-size-first
364 imap-mailbox-data))
368 ;; Internal variables.
378 "IMAP state.
379 Valid states are `closed', `initial', `nonauth', `auth', `selected'
413 "Identity of server.
423 "Alist of tags that failed.
424 Each element is a list with four elements; tag (a integer), response
425 state (a symbol, `OK', `NO' or `BAD'), response code (a string), and
435 "Non-nil indicates that the server emitted a continuation request.
439 "List of response tags and callbacks, on the form `(number . function)'.
440 The function should take two arguments, the first the IMAP tag and the
443 \f
444 ;; Utility functions:
447 "Delete by side effect any elements of LIST whose car is `equal' to KEY.
448 The modified LIST is returned. If the first member
449 of LIST has a car that is `equal' to KEY, there is no way to remove it
450 by side effect; therefore, write `(setq foo (remassoc key foo))' to be
451 sure of changing the value of `foo'."
456 alist)))
459 "Enable multibyte in the current buffer."
469 "imap: Could not UTF7 encode `%s', using it unencoded..."
470 string)
471 string)))
472 string))
480 "imap: Could not UTF7 decode `%s', using it undecoded..."
481 string)
482 string)))
483 string))
487 t
489 nil))
495 \f
496 ;; Server functions; stream stuff:
503 cmd done)
512 name buffer shell-file-name shell-command-switch
514 cmd
516 ?s server
518 ?l imap-default-user))))
519 response)
523 imap-calculate-literal-size-first t)
527 ;; Athena IMTEST can output SSL verify errors
530 t)
533 t)
534 ;; cyrus 1.6.x (13? < x <= 22) queries capabilities
537 t)
538 ;; cyrus 1.6 imtest print "S: " before server greeting
541 t)
543 ;; success in imtest < 1.6:
546 ;; success in imtest 1.6:
567 nil)))))
568 done))
575 cmd done)
584 name buffer shell-file-name shell-command-switch
586 cmd
588 ?s server
590 ?l imap-default-user))))
591 response)
595 imap-calculate-literal-size-first t)
599 ;; Athena IMTEST can output SSL verify errors
602 t)
605 t)
606 ;; cyrus 1.6.x (13? < x <= 22) queries capabilities
609 t)
610 ;; cyrus 1.6 imtest print "S: " before server greeting
613 t)
614 ;; GNU SASL may print 'Trying ...' first.
617 t)
619 ;; success in imtest 1.6:
622 "Client authentication "
624 nil t)
642 nil)))))
643 done))
646 nil)
649 "Open a SSL connection to server."
652 cmd done)
662 'set-process-query-on-exit-flag
664 process)
667 name buffer shell-file-name
668 shell-command-switch
671 ?s server
674 process)
696 done)
698 nil)))
701 nil)
723 process))))
726 t)
747 process))))
750 nil)
755 cmd done)
763 name buffer shell-file-name shell-command-switch
765 cmd
767 ?s server
768 ?g imap-shell-host
770 ?l imap-default-user)))))
791 done)
793 nil)))
803 done tls-info)
832 done))
834 ;; Server functions; authenticator stuff:
837 "Login to server in BUFFER.
838 LOGINFUNC is passed a username and a password, it should return t if
839 it where successful authenticating itself to the server, nil otherwise.
840 Returns t if login was successful, nil otherwise."
845 ;; (condition-case ()
856 imap-server " (using authenticator `"
862 imap-username user)
871 ;; (quit (with-current-buffer buffer
872 ;; (setq user nil
873 ;; passwd nil)))
874 ;; (error (with-current-buffer buffer
875 ;; (setq user nil
876 ;; passwd nil))))
877 ret)))
900 "Login to server using the AUTH CRAM-MD5 method."
903 buffer
908 "AUTHENTICATE CRAM-MD5"
914 encoded)))))))))
934 "Login to server using the LOGIN command."
946 t)
955 ;;; Compiler directives.
968 mecs))
984 "Login to server using the SASL method."
991 logged user)
1007 buffer)))
1017 logged t)
1020 logged)))
1029 "Login to server using the AUTH DIGEST-MD5 method."
1032 buffer
1037 "AUTHENTICATE DIGEST-MD5"
1046 user passwd digest-uri)))
1048 )))
1050 nil
1055 ;; Server functions:
1061 imap-current-message nil
1062 imap-state 'initial
1065 imap-stream-alist))
1077 imap-process))))
1080 "Open a IMAP connection to host SERVER at PORT returning a buffer.
1081 If PORT is unspecified, a default value is used (143 except
1082 for SSL which use 993).
1083 STREAM indicates the stream to use, see `imap-streams' for available
1084 streams. If nil, it choices the best stream the server is capable of.
1085 AUTH indicates authenticator to use, see `imap-authenticators' for
1086 available authenticators. If nil, it choices the best stream the
1087 server is capable of.
1088 BUFFER can be a buffer or a name of a buffer, which is created if
1089 necessary. If nil, the buffer name is generated."
1106 nil)
1108 ;; Need to choose stream.
1111 ;; OK to use this stream?
1113 ;; Stream changed?
1129 "imap: Reconnecting with stream `%s'...failed"
1130 stream))
1131 ;; We're done, kill the first connection
1134 buffer
1139 stream)
1143 ;; We're done
1151 buffer))))
1154 "Return non-nil if connection to imap server in BUFFER is open.
1155 If BUFFER is nil then the current buffer is used."
1163 "Authenticate to server in BUFFER, using current buffer if nil.
1164 It uses the authenticator specified when opening the server. If the
1165 authenticator requires username/passwords, they are queried from the
1166 user and optionally stored in the buffer. If USER and/or PASSWD is
1167 specified, the user will not be questioned and the username and/or
1168 password is remembered in the buffer."
1182 ;; Choose authenticator.
1184 auth)
1186 ;; OK to use authenticator?
1189 imap-server auth)
1194 imap-server auth)
1197 imap-server auth)))))
1198 imap-state))))
1201 "Close connection to server in BUFFER.
1202 If BUFFER is nil, the current buffer is used."
1212 imap-current-message nil
1213 imap-process nil)
1215 t))
1218 "Return a list of identifiers which server in BUFFER support.
1219 If IDENTIFIER, return non-nil if it's among the servers capabilities.
1220 If BUFFER is nil, the current buffer is assumed."
1227 imap-capability)))
1230 "Identify client to server in BUFFER, and return server identity.
1231 LIST-OF-VALUES is nil, or a plist with identifier and value
1232 strings to send to the server to identify the client.
1234 Return a list of identifiers which server in BUFFER support, or
1235 nil if it doesn't support ID or returns no information.
1237 If BUFFER is nil, the current buffer is assumed."
1242 "ID NIL"
1245 list-of-values
1247 imap-id)))
1250 "Return a namespace hierarchy at server in BUFFER.
1251 If BUFFER is nil, the current buffer is assumed."
1256 imap-namespace))
1283 \f
1284 ;; Mailbox functions:
1290 propname value)
1293 t))
1297 propname))
1312 imap-mailbox-data)
1313 result)))
1316 "Map a function across each mailbox in `imap-mailbox-data', returning a list.
1317 Function should take a mailbox name (a string) as
1318 the only argument."
1337 "Select MAILBOX on server in BUFFER.
1338 If EXAMINE is non-nil, do a read-only select."
1340 imap-current-mailbox
1348 imap-current-mailbox)
1349 ;; Failed SELECT/EXAMINE unselects current mailbox
1362 "Examine MAILBOX on server in BUFFER."
1366 "Close current folder in BUFFER, without expunging articles."
1373 imap-current-mailbox
1377 imap-message-data nil
1379 t)))
1382 "Expunge articles in current folder in BUFFER.
1383 If ASYNCH, do not wait for succesful completion of the command.
1384 If BUFFER is nil the current buffer is assumed."
1392 "Expunge articles and close current folder in BUFFER.
1393 If ASYNCH, do not wait for succesful completion of the command.
1394 If BUFFER is nil the current buffer is assumed."
1401 imap-current-mailbox status)
1403 imap-current-mailbox)
1404 ;; Don't wipe out data if another mailbox
1405 ;; was selected...
1407 imap-message-data nil
1411 imap-message-data nil
1413 t)))
1419 "Create MAILBOX on server in BUFFER.
1420 If BUFFER is nil the current buffer is assumed."
1425 "Delete MAILBOX on server in BUFFER.
1426 If BUFFER is nil the current buffer is assumed."
1433 "Rename mailbox OLDNAME to NEWNAME on server in BUFFER.
1434 If BUFFER is nil the current buffer is assumed."
1443 "Return a list of subscribed mailboxes on server in BUFFER.
1444 If ROOT is non-nil, only list matching mailboxes. If ADD-DELIMITER is
1445 non-nil, a hierarchy delimiter is added to root. REFERENCE is a
1446 implementation-specific string that has to be passed to lsub command."
1448 ;; Make sure we know the hierarchy separator for root's hierarchy
1452 ;; clear list data (NB not delimiter and other stuff)
1467 "Return a list of mailboxes matching ROOT on server in BUFFER.
1468 If ADD-DELIMITER is non-nil, a hierarchy delimiter is added to
1469 root. REFERENCE is a implementation-specific string that has to be
1470 passed to list command."
1472 ;; Make sure we know the hierarchy separator for root's hierarchy
1476 ;; clear list data (NB not delimiter and other stuff)
1491 "Send the SUBSCRIBE command on the mailbox to server in BUFFER.
1492 Returns non-nil if successful."
1499 "Send the SUBSCRIBE command on the mailbox to server in BUFFER.
1500 Returns non-nil if successful."
1507 "Get status items ITEM in MAILBOX from server in BUFFER.
1508 ITEMS can be a symbol or a list of symbols, valid symbols are one of
1509 the STATUS data items -- ie 'messages, 'recent, 'uidnext, 'uidvalidity
1510 or 'unseen. If ITEMS is a list of symbols, a list of values is
1511 returned, if ITEMS is a symbol only its value is returned."
1520 items
1525 items)
1529 "Send status item request ITEM on MAILBOX to 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. The IMAP command tag is returned."
1540 items
1544 "Get ACL on mailbox from server in BUFFER."
1554 "Change/set ACL for IDENTIFIER to RIGHTS in MAILBOX from server in BUFFER."
1561 identifier
1562 " "
1563 rights))))))
1566 "Removes any <identifier,rights> pair for IDENTIFIER in MAILBOX from server in BUFFER."
1573 identifier))))))
1575 \f
1576 ;; Message functions:
1580 imap-current-message))
1586 list
1599 range)
1607 uids)
1608 props))))
1611 "Fetch properties PROPS from message set UIDS from server in BUFFER.
1612 UIDS can be a string, number or a list of numbers. If RECEIVE
1613 is non-nil return these properties."
1619 uids)
1620 props)))
1622 t
1628 receive)
1630 uids)
1637 propname value)
1640 t))
1645 propname)))
1648 "Map a function across each mailbox in `imap-message-data', returning a list."
1654 imap-message-data)
1655 result)))
1708 nil)
1712 "Return t if FLAG can be permanently (between IMAP sessions) saved on articles, in MAILBOX on server in BUFFER."
1738 ;; Cf. http://thread.gmane.org/gmane.emacs.gnus.general/65317/focus=65343
1739 ;; Signal an error if we'd get an integer overflow.
1740 ;;
1741 ;; FIXME: Identify relevant calls to `string-to-number' and replace them with
1742 ;; `imap-string-to-integer'.
1748 number)))
1773 "Copy ARTICLES (a string message set) to MAILBOX on server in
1774 BUFFER, creating mailbox if it doesn't exist. If dont-create is
1775 non-nil, it will not create a mailbox. On success, return a list with
1776 the UIDVALIDITY of the mailbox the article(s) was copied to as the
1777 first element, rest of list contain the saved articles' UIDs."
1784 t
1786 ;; removed because of buggy Oracle server
1787 ;; that doesn't send TRYCREATE tags (which
1788 ;; is a MUST according to specifications):
1789 ;;(imap-mailbox-get-1 'trycreate mailbox)
1816 "Append ARTICLE (a buffer) to MAILBOX on server in BUFFER.
1817 FLAGS and DATE-TIME is currently not used. Return a cons holding
1818 uidvalidity of MAILBOX and UID the newly created article got, or nil
1819 on failure."
1829 "Return number of lines in article by looking at the mime bodystructure BODY."
1843 "Return a from string line."
1848 "@"
1852 \f
1853 ;; Internal functions.
1872 cmd cmdstr)
1880 size)
1885 ;; XXX modifies buffer!
1905 imap-log-buffer)
1921 command)))
1927 tag)))
1936 message-log-max)
1945 ;; A process can die _before_ we have processed everything it
1946 ;; has to say. Moreover, this can happen in between the call to
1947 ;; accept-process-output and the call to process-status in an
1948 ;; iteration of the loop above.
1957 'INCOMPLETE
1964 "Return point at end of current line, taking into account literals.
1965 Return nil if no complete line has arrived."
1967 imap-server-eol)
1968 nil t)
1971 nil
1977 "IMAP process filter."
1978 ;; Sometimes, we are called even though the process has died.
1979 ;; Better abstain from doing stuff in that case.
2007 imap-state)))
2010 \f
2011 ;; Imap parser.
2016 ;; number = 1*DIGIT
2017 ;; ; Unsigned 32-bit integer
2018 ;; ; (0 <= n < 4,294,967,296)
2026 ;; literal = "{" number "}" CRLF *CHAR8
2027 ;; ; Number represents the number of CHAR8s
2034 nil
2038 ;; string = quoted / literal
2039 ;;
2040 ;; quoted = DQUOTE *QUOTED-CHAR DQUOTE
2041 ;;
2042 ;; QUOTED-CHAR = <any TEXT-CHAR except quoted-specials> /
2043 ;; "\" quoted-specials
2044 ;;
2045 ;; quoted-specials = DQUOTE / "\"
2046 ;;
2047 ;; TEXT-CHAR = <any CHAR except CR and LF>
2061 name))
2065 ;; nil = "NIL"
2071 ;; nstring = string / nil
2076 nil)))
2078 ;; astring = atom / string
2079 ;;
2080 ;; atom = 1*ATOM-CHAR
2081 ;;
2082 ;; ATOM-CHAR = <any CHAR except atom-specials>
2083 ;;
2084 ;; atom-specials = "(" / ")" / "{" / SP / CTL / list-wildcards /
2085 ;; quoted-specials
2086 ;;
2087 ;; list-wildcards = "%" / "*"
2088 ;;
2089 ;; quoted-specials = DQUOTE / "\"
2099 ;; address = "(" addr-name SP addr-adl SP addr-mailbox SP
2100 ;; addr-host ")"
2101 ;;
2102 ;; addr-adl = nstring
2103 ;; ; Holds route from [RFC-822] route-addr if
2104 ;; ; non-nil
2105 ;;
2106 ;; addr-host = nstring
2107 ;; ; nil indicates [RFC-822] group syntax.
2108 ;; ; Otherwise, holds [RFC-822] domain name
2109 ;;
2110 ;; addr-mailbox = nstring
2111 ;; ; nil indicates end of [RFC-822] group; if
2112 ;; ; non-nil and addr-host is nil, holds
2113 ;; ; [RFC-822] group name.
2114 ;; ; Otherwise, holds [RFC-822] local-part
2115 ;; ; after removing [RFC-822] quoting
2116 ;;
2117 ;; addr-name = nstring
2118 ;; ; If non-nil, holds phrase from [RFC-822]
2119 ;; ; mailbox after removing [RFC-822] quoting
2120 ;;
2135 address))))
2137 ;; address-list = "(" 1*address ")" / nil
2138 ;;
2139 ;; nil = "NIL"
2146 ;; next line for MS Exchange bug
2153 ;; With assert, the code might not be eval'd.
2154 ;; (assert (imap-parse-nil) t "In imap-parse-address-list")
2157 ;; mailbox = "INBOX" / astring
2158 ;; ; INBOX is case-insensitive. All case variants of
2159 ;; ; INBOX (e.g. "iNbOx") MUST be interpreted as INBOX
2160 ;; ; not as an astring. An astring which consists of
2161 ;; ; the case-insensitive sequence "I" "N" "B" "O" "X"
2162 ;; ; is considered to be INBOX and not an astring.
2163 ;; ; Refer to section 5.1 for further
2164 ;; ; semantic details of mailbox names.
2169 "INBOX"
2170 mailbox)))
2172 ;; greeting = "*" SP (resp-cond-auth / resp-cond-bye) CRLF
2173 ;;
2174 ;; resp-cond-auth = ("OK" / "PREAUTH") SP resp-text
2175 ;; ; Authentication condition
2176 ;;
2177 ;; resp-cond-bye = "BYE" SP resp-text
2180 "Parse a IMAP greeting."
2188 ;; response = *(continue-req / response-data) response-done
2189 ;;
2190 ;; continue-req = "+" SP (resp-text / base64) CRLF
2191 ;;
2192 ;; response-data = "*" SP (resp-cond-state / resp-cond-bye /
2193 ;; mailbox-data / message-data / capability-data) CRLF
2194 ;;
2195 ;; response-done = response-tagged / response-fatal
2196 ;;
2197 ;; response-fatal = "*" SP resp-cond-bye CRLF
2198 ;; ; Server closes connection immediately
2199 ;;
2200 ;; response-tagged = tag SP resp-cond-state CRLF
2201 ;;
2202 ;; resp-cond-state = ("OK" / "NO" / "BAD") SP resp-text
2203 ;; ; Status condition
2204 ;;
2205 ;; resp-cond-bye = "BYE" SP resp-text
2206 ;;
2207 ;; mailbox-data = "FLAGS" SP flag-list /
2208 ;; "LIST" SP mailbox-list /
2209 ;; "LSUB" SP mailbox-list /
2210 ;; "SEARCH" *(SP nz-number) /
2211 ;; "STATUS" SP mailbox SP "("
2212 ;; [status-att SP number *(SP status-att SP number)] ")" /
2213 ;; number SP "EXISTS" /
2214 ;; number SP "RECENT"
2215 ;;
2216 ;; message-data = nz-number SP ("EXPUNGE" / ("FETCH" SP msg-att))
2217 ;;
2218 ;; capability-data = "CAPABILITY" *(SP capability) SP "IMAP4rev1"
2219 ;; *(SP capability)
2220 ;; ; IMAP4rev1 servers which offer RFC 1730
2221 ;; ; compatibility MUST list "IMAP4" as the first
2222 ;; ; capability.
2225 "Parse a IMAP command response."
2231 t)))
2242 'search
2278 imap-failed-tags))))
2291 token status code text))))
2298 ;; resp-text = ["[" resp-text-code "]" SP] text
2299 ;;
2300 ;; text = 1*TEXT-CHAR
2301 ;;
2302 ;; TEXT-CHAR = <any CHAR except CR and LF>
2307 ;; resp-text-code = "ALERT" /
2308 ;; "BADCHARSET [SP "(" astring *(SP astring) ")" ] /
2309 ;; "NEWNAME" SP string SP string /
2310 ;; "PARSE" /
2311 ;; "PERMANENTFLAGS" SP "("
2312 ;; [flag-perm *(SP flag-perm)] ")" /
2313 ;; "READ-ONLY" /
2314 ;; "READ-WRITE" /
2315 ;; "TRYCREATE" /
2316 ;; "UIDNEXT" SP nz-number /
2317 ;; "UIDVALIDITY" SP nz-number /
2318 ;; "UNSEEN" SP nz-number /
2319 ;; resp-text-atom [SP 1*<any TEXT-CHAR except "]">]
2320 ;;
2321 ;; resp_code_apnd = "APPENDUID" SPACE nz_number SPACE uniqueid
2322 ;;
2323 ;; resp_code_copy = "COPYUID" SPACE nz_number SPACE set SPACE set
2324 ;;
2325 ;; set = sequence-num / (sequence-num ":" sequence-num) /
2326 ;; (set "," set)
2327 ;; ; Identifies a set of messages. For message
2328 ;; ; sequence numbers, these are consecutive
2329 ;; ; numbers from 1 to the number of messages in
2330 ;; ; the mailbox
2331 ;; ; Comma delimits individual numbers, colon
2332 ;; ; delimits between two numbers inclusive.
2333 ;; ; Example: 2,4:7,9,12:* is 2,4,5,6,7,9,12,13,
2334 ;; ; 14,15 for a mailbox with 15 messages.
2335 ;;
2336 ;; sequence-num = nz-number / "*"
2337 ;; ; * is the largest number in use. For message
2338 ;; ; sequence numbers, it is the number of messages
2339 ;; ; in the mailbox. For unique identifiers, it is
2340 ;; ; the unique identifier of the last message in
2341 ;; ; the mailbox.
2342 ;;
2343 ;; flag-perm = flag / "\*"
2344 ;;
2345 ;; flag = "\Answered" / "\Flagged" / "\Deleted" /
2346 ;; "\Seen" / "\Draft" / flag-keyword / flag-extension
2347 ;; ; Does not include "\Recent"
2348 ;;
2349 ;; flag-extension = "\" atom
2350 ;; ; Future expansion. Client implementations
2351 ;; ; MUST accept flag-extension flags. Server
2352 ;; ; implementations MUST NOT generate
2353 ;; ; flag-extension flags except as defined by
2354 ;; ; future standard or standards-track
2355 ;; ; revisions of this specification.
2356 ;;
2357 ;; flag-keyword = atom
2358 ;;
2359 ;; resp-text-atom = 1*<any ATOM-CHAR except "]">
2362 ;; xxx next line for stalker communigate pro 3.3.1 bug
2389 imap-current-target-mailbox))
2394 imap-current-target-mailbox))
2399 ;; mailbox-list = "(" [mbx-list-flags] ")" SP
2400 ;; (DQUOTE QUOTED-CHAR DQUOTE / nil) SP mailbox
2401 ;;
2402 ;; mbx-list-flags = *(mbx-list-oflag SP) mbx-list-sflag
2403 ;; *(SP mbx-list-oflag) /
2404 ;; mbx-list-oflag *(SP mbx-list-oflag)
2405 ;;
2406 ;; mbx-list-oflag = "\Noinferiors" / flag-extension
2407 ;; ; Other flags; multiple possible per LIST response
2408 ;;
2409 ;; mbx-list-sflag = "\Noselect" / "\Marked" / "\Unmarked"
2410 ;; ; Selectability flags; only one per LIST response
2411 ;;
2412 ;; QUOTED-CHAR = <any TEXT-CHAR except quoted-specials> /
2413 ;; "\" quoted-specials
2414 ;;
2415 ;; quoted-specials = DQUOTE / "\"
2428 ;; msg_att ::= "(" 1#("ENVELOPE" SPACE envelope /
2429 ;; "FLAGS" SPACE "(" #(flag / "\Recent") ")" /
2430 ;; "INTERNALDATE" SPACE date_time /
2431 ;; "RFC822" [".HEADER" / ".TEXT"] SPACE nstring /
2432 ;; "RFC822.SIZE" SPACE number /
2433 ;; "BODY" ["STRUCTURE"] SPACE body /
2434 ;; "BODY" section ["<" number ">"] SPACE nstring /
2435 ;; "UID" SPACE uniqueid) ")"
2436 ;;
2437 ;; date_time ::= <"> date_day_fixed "-" date_month "-" date_year
2438 ;; SPACE time SPACE zone <">
2439 ;;
2440 ;; section ::= "[" [section_text / (nz_number *["." nz_number]
2441 ;; ["." (section_text / "MIME")])] "]"
2442 ;;
2443 ;; section_text ::= "HEADER" / "HEADER.FIELDS" [".NOT"]
2444 ;; SPACE header_list / "TEXT"
2445 ;;
2446 ;; header_fld_name ::= astring
2447 ;;
2448 ;; header_list ::= "(" 1#header_fld_name ")"
2466 section)))
2471 rfc822size body bodydetail bodystructure flags-empty)
2505 bodydetail)
2524 ;; mailbox-data = ...
2525 ;; "STATUS" SP mailbox SP "("
2526 ;; [status-att SP number
2527 ;; *(SP status-att SP number)] ")"
2528 ;; ...
2529 ;;
2530 ;; status-att = "MESSAGES" / "RECENT" / "UIDNEXT" / "UIDVALIDITY" /
2531 ;; "UNSEEN"
2559 token mailbox)
2562 ;; acl_data ::= "ACL" SPACE mailbox *(SPACE identifier SPACE
2563 ;; rights)
2564 ;;
2565 ;; identifier ::= astring
2566 ;;
2567 ;; rights ::= astring
2571 identifier rights acl)
2580 ;; flag-list = "(" [flag *(SP flag)] ")"
2581 ;;
2582 ;; flag = "\Answered" / "\Flagged" / "\Deleted" /
2583 ;; "\Seen" / "\Draft" / flag-keyword / flag-extension
2584 ;; ; Does not include "\Recent"
2585 ;;
2586 ;; flag-keyword = atom
2587 ;;
2588 ;; flag-extension = "\" atom
2589 ;; ; Future expansion. Client implementations
2590 ;; ; MUST accept flag-extension flags. Server
2591 ;; ; implementations MUST NOT generate
2592 ;; ; flag-extension flags except as defined by
2593 ;; ; future standard or standards-track
2594 ;; ; revisions of this specification.
2602 ;; next line for Courier IMAP bug.
2611 ;; envelope = "(" env-date SP env-subject SP env-from SP env-sender SP
2612 ;; env-reply-to SP env-to SP env-cc SP env-bcc SP
2613 ;; env-in-reply-to SP env-message-id ")"
2614 ;;
2615 ;; env-bcc = "(" 1*address ")" / nil
2616 ;;
2617 ;; env-cc = "(" 1*address ")" / nil
2618 ;;
2619 ;; env-date = nstring
2620 ;;
2621 ;; env-from = "(" 1*address ")" / nil
2622 ;;
2623 ;; env-in-reply-to = nstring
2624 ;;
2625 ;; env-message-id = nstring
2626 ;;
2627 ;; env-reply-to = "(" 1*address ")" / nil
2628 ;;
2629 ;; env-sender = "(" 1*address ")" / nil
2630 ;;
2631 ;; env-subject = nstring
2632 ;;
2633 ;; env-to = "(" 1*address ")" / nil
2659 ;; body-fld-param = "(" string SP string *(SP string SP string) ")" / nil
2667 ;; buggy stalker communigate pro 3.0 doesn't print SPC
2668 ;; between body-fld-param's sometimes
2673 nil)))
2675 ;; body-extension = nstring / number /
2676 ;; "(" body-extension *(SP body-extension) ")"
2677 ;; ; Future expansion. Client implementations
2678 ;; ; MUST accept body-extension fields. Server
2679 ;; ; implementations MUST NOT generate
2680 ;; ; body-extension fields except as defined by
2681 ;; ; future standard or standards-track
2682 ;; ; revisions of this specification.
2698 ;; body-ext-1part = body-fld-md5 [SP body-fld-dsp [SP body-fld-lang
2699 ;; *(SP body-extension)]]
2700 ;; ; MUST NOT be returned on non-extensible
2701 ;; ; "BODY" fetch
2702 ;;
2703 ;; body-ext-mpart = body-fld-param [SP body-fld-dsp [SP body-fld-lang
2704 ;; *(SP body-extension)]]
2705 ;; ; MUST NOT be returned on non-extensible
2706 ;; ; "BODY" fetch
2720 ;; With assert, the code might not be eval'd.
2721 ;; (assert (imap-parse-nil) t "In imap-parse-body-ext")
2732 ext))
2734 ;; body = "(" body-type-1part / body-type-mpart ")"
2735 ;;
2736 ;; body-ext-1part = body-fld-md5 [SP body-fld-dsp [SP body-fld-lang
2737 ;; *(SP body-extension)]]
2738 ;; ; MUST NOT be returned on non-extensible
2739 ;; ; "BODY" fetch
2740 ;;
2741 ;; body-ext-mpart = body-fld-param [SP body-fld-dsp [SP body-fld-lang
2742 ;; *(SP body-extension)]]
2743 ;; ; MUST NOT be returned on non-extensible
2744 ;; ; "BODY" fetch
2745 ;;
2746 ;; body-fields = body-fld-param SP body-fld-id SP body-fld-desc SP
2747 ;; body-fld-enc SP body-fld-octets
2748 ;;
2749 ;; body-fld-desc = nstring
2750 ;;
2751 ;; body-fld-dsp = "(" string SP body-fld-param ")" / nil
2752 ;;
2753 ;; body-fld-enc = (DQUOTE ("7BIT" / "8BIT" / "BINARY" / "BASE64"/
2754 ;; "QUOTED-PRINTABLE") DQUOTE) / string
2755 ;;
2756 ;; body-fld-id = nstring
2757 ;;
2758 ;; body-fld-lang = nstring / "(" string *(SP string) ")"
2759 ;;
2760 ;; body-fld-lines = number
2761 ;;
2762 ;; body-fld-md5 = nstring
2763 ;;
2764 ;; body-fld-octets = number
2765 ;;
2766 ;; body-fld-param = "(" string SP string *(SP string SP string) ")" / nil
2767 ;;
2768 ;; body-type-1part = (body-type-basic / body-type-msg / body-type-text)
2769 ;; [SP body-ext-1part]
2770 ;;
2771 ;; body-type-basic = media-basic SP body-fields
2772 ;; ; MESSAGE subtype MUST NOT be "RFC822"
2773 ;;
2774 ;; body-type-msg = media-message SP body-fields SP envelope
2775 ;; SP body SP body-fld-lines
2776 ;;
2777 ;; body-type-text = media-text SP body-fields SP body-fld-lines
2778 ;;
2779 ;; body-type-mpart = 1*body SP media-subtype
2780 ;; [SP body-ext-mpart]
2781 ;;
2782 ;; media-basic = ((DQUOTE ("APPLICATION" / "AUDIO" / "IMAGE" /
2783 ;; "MESSAGE" / "VIDEO") DQUOTE) / string) SP media-subtype
2784 ;; ; Defined in [MIME-IMT]
2785 ;;
2786 ;; media-message = DQUOTE "MESSAGE" DQUOTE SP DQUOTE "RFC822" DQUOTE
2787 ;; ; Defined in [MIME-IMT]
2788 ;;
2789 ;; media-subtype = string
2790 ;; ; Defined in [MIME-IMT]
2791 ;;
2792 ;; media-text = DQUOTE "TEXT" DQUOTE SP media-subtype
2793 ;; ; Defined in [MIME-IMT]
2803 ;; buggy stalker communigate pro 3.0 insert a SPC between
2804 ;; parts in multiparts
2826 ;; next line for Sun SIMS bug
2836 ;; next `or' for Sun SIMS bug, it regard body-fld-enc as a
2837 ;; nstring and return nil instead of defaulting back to 7BIT
2838 ;; as the standard says.
2843 ;; ok, we're done parsing the required parts, what comes now is one
2844 ;; of three things:
2845 ;;
2846 ;; envelope (then we're parsing body-type-msg)
2847 ;; body-fld-lines (then we're parsing body-type-text)
2848 ;; body-ext-1part (then we're parsing body-type-basic)
2849 ;;
2850 ;; the problem is that the two first are in turn optionally followed
2851 ;; by the third. So we parse the first two here (if there are any)...
2860 ;; buggy stalker communigate pro 3.0 doesn't print
2861 ;; number of lines in message/rfc822 attachment
2871 ;; ...and then parse the third one here...
2886 '(
2887 imap-utf7-encode
2888 imap-utf7-decode
2889 imap-error-text
2890 imap-kerberos4s-p
2891 imap-kerberos4-open
2892 imap-ssl-p
2893 imap-ssl-open
2894 imap-network-p
2895 imap-network-open
2896 imap-interactive-login
2897 imap-kerberos4a-p
2898 imap-kerberos4-auth
2899 imap-cram-md5-p
2900 imap-cram-md5-auth
2901 imap-login-p
2902 imap-login-auth
2903 imap-anonymous-p
2904 imap-anonymous-auth
2905 imap-open-1
2906 imap-open
2907 imap-opened
2908 imap-authenticate
2909 imap-close
2910 imap-capability
2911 imap-namespace
2912 imap-send-command-wait
2913 imap-mailbox-put
2914 imap-mailbox-get
2915 imap-mailbox-map-1
2916 imap-mailbox-map
2917 imap-current-mailbox
2918 imap-current-mailbox-p-1
2919 imap-current-mailbox-p
2920 imap-mailbox-select-1
2921 imap-mailbox-select
2922 imap-mailbox-examine-1
2923 imap-mailbox-examine
2924 imap-mailbox-unselect
2925 imap-mailbox-expunge
2926 imap-mailbox-close
2927 imap-mailbox-create-1
2928 imap-mailbox-create
2929 imap-mailbox-delete
2930 imap-mailbox-rename
2931 imap-mailbox-lsub
2932 imap-mailbox-list
2933 imap-mailbox-subscribe
2934 imap-mailbox-unsubscribe
2935 imap-mailbox-status
2936 imap-mailbox-acl-get
2937 imap-mailbox-acl-set
2938 imap-mailbox-acl-delete
2939 imap-current-message
2940 imap-list-to-message-set
2941 imap-fetch-asynch
2942 imap-fetch
2943 imap-message-put
2944 imap-message-get
2945 imap-message-map
2946 imap-search
2947 imap-message-flag-permanent-p
2948 imap-message-flags-set
2949 imap-message-flags-del
2950 imap-message-flags-add
2951 imap-message-copyuid-1
2952 imap-message-copyuid
2953 imap-message-copy
2954 imap-message-appenduid-1
2955 imap-message-appenduid
2956 imap-message-append
2957 imap-body-lines
2958 imap-envelope-from
2959 imap-send-command-1
2960 imap-send-command
2961 imap-wait-for-tag
2962 imap-sentinel
2963 imap-find-next-line
2964 imap-arrival-filter
2965 imap-parse-greeting
2966 imap-parse-response
2967 imap-parse-resp-text
2968 imap-parse-resp-text-code
2969 imap-parse-data-list
2970 imap-parse-fetch
2971 imap-parse-status
2972 imap-parse-acl
2973 imap-parse-flag-list
2974 imap-parse-envelope
2975 imap-parse-body-extension
2976 imap-parse-body
2977 )))
2981 ;;; arch-tag: 27369ed6-33e4-482f-96f1-8bb906ba70f7
2982 ;;; imap.el ends here