| blob | 45c7ba4bbbf0655fc15b2af87b49509ea80ee117 |
1 ;;; imap.el --- imap library
2 ;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004
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 ;;
129 ;; Revision history:
130 ;;
131 ;; - 19991218 added starttls/digest-md5 patch,
132 ;; by Daiki Ueno <ueno@ueda.info.waseda.ac.jp>
133 ;; NB! you need SLIM for starttls.el and digest-md5.el
134 ;; - 19991023 commited to pgnus
135 ;;
137 ;;; Code:
155 ;; Avoid use gnus-point-at-eol so we're independent of Gnus. These
156 ;; days we have point-at-eol anyhow.
164 ;; User variables.
167 "Low-level IMAP issues."
173 "List of strings containing commands for Kerberos 4 authentication.
174 %s is replaced with server hostname, %p with port to connect to, and
175 %l with the value of `imap-default-user'. The program should accept
176 IMAP commands on stdin and return responses to stdout. Each entry in
177 the list is tried until a successful connection is made."
182 "List of strings containing commands for GSSAPI (krb5) authentication.
183 %s is replaced with server hostname, %p with port to connect to, and
184 %l with the value of `imap-default-user'. The program should accept
185 IMAP commands on stdin and return responses to stdout. Each entry in
186 the list is tried until a successful connection is made."
191 "openssl s_client -quiet -ssl2 -connect %s:%p"
192 "s_client -quiet -ssl3 -connect %s:%p"
194 "A string, or list of strings, containing commands for SSL connections.
195 Within a string, %s is replaced with the server address and %p with
196 port number on server. The program should accept IMAP commands on
197 stdin and return responses to stdout. Each entry in the list is tried
198 until a successful connection is made."
204 "rsh %s imapd"
205 "ssh %g ssh %s imapd"
207 "A list of strings, containing commands for IMAP connection.
208 Within a string, %s is replaced with the server address, %p with port
209 number on server, %g with `imap-shell-host', and %l with
210 `imap-default-user'. The program should read IMAP commands from stdin
211 and write IMAP response to stdout. Each entry in the list is tried
212 until a successful connection is made."
225 ;; Various variables.
240 "Definition of network streams.
242 \(NAME CHECK OPEN)
244 NAME names the stream, CHECK is a function returning non-nil if the
245 server supports the stream and OPEN is a function for opening the
249 kerberos4
250 digest-md5
251 cram-md5
252 login
253 anonymous)
263 "Definition of authenticators.
265 \(NAME CHECK AUTHENTICATE)
267 NAME names the authenticator. CHECK is a function returning non-nil if
268 the server support the authenticator and AUTHENTICATE is a function
272 "If non-nil, do utf7 encoding/decoding of mailbox names.
273 Since the UTF7 decoding currently only decodes into ISO-8859-1
274 characters, you may disable this decoding if you need to access UTF7
277 ;; Internal constants. Change theese and die.
285 imap-port
286 imap-client-eol
287 imap-server-eol
288 imap-auth
289 imap-stream
290 imap-username
291 imap-password
292 imap-current-mailbox
293 imap-current-target-mailbox
294 imap-message-data
295 imap-capability
296 imap-namespace
297 imap-state
298 imap-reached-tag
299 imap-failed-tags
300 imap-tag
301 imap-process
302 imap-calculate-literal-size-first
303 imap-mailbox-data))
305 ;; Internal variables.
315 "IMAP state.
316 Valid states are `closed', `initial', `nonauth', `auth', `selected'
356 "Alist of tags that failed.
357 Each element is a list with four elements; tag (a integer), response
358 state (a symbol, `OK', `NO' or `BAD'), response code (a string), and
368 "Non-nil indicates that the server emitted a continuation request.
372 "Name of buffer for imap session trace.
376 "Name of buffer for random debug spew.
379 \f
380 ;; Utility functions:
383 "Enable multibyte in the current buffer."
388 "Read a password using PROMPT.
389 If ARGS, PROMPT is used as an argument to `format'."
392 prompt)))
398 'read-passwd
401 prompt)))
409 "imap: Could not UTF7 encode `%s', using it unencoded..."
410 string)
411 string)))
412 string))
420 "imap: Could not UTF7 decode `%s', using it undecoded..."
421 string)
422 string)))
423 string))
427 t
429 nil))
435 \f
436 ;; Server functions; stream stuff:
443 cmd done)
451 name buffer shell-file-name shell-command-switch
453 cmd
455 ?s server
457 ?l imap-default-user))))
458 response)
462 imap-calculate-literal-size-first t)
465 ;; cyrus 1.6.x (13? < x <= 22) queries capabilities
468 t)
469 ;; cyrus 1.6 imtest print "S: " before server greeting
472 t)
474 ;; success in imtest < 1.6:
477 ;; success in imtest 1.6:
498 nil)))))
499 done))
506 cmd done)
513 name buffer shell-file-name shell-command-switch
515 cmd
517 ?s server
519 ?l imap-default-user))))
520 response)
526 ;; cyrus 1.6.x (13? < x <= 22) queries capabilities
529 t)
530 ;; cyrus 1.6 imtest print "S: " before server greeting
533 t)
535 ;; success in imtest 1.6:
555 nil)))))
556 done))
559 nil)
562 "Open a SSL connection to server."
565 cmd done)
572 process)
575 name buffer shell-file-name
576 shell-command-switch
579 ?s server
582 process)
604 done)
606 nil)))
609 t)
629 process))))
632 nil)
636 cmd done)
644 name buffer shell-file-name shell-command-switch
646 cmd
648 ?s server
649 ?g imap-shell-host
651 ?l imap-default-user)))))
670 done)
672 nil)))
687 done)
713 done)
715 nil)))
717 ;; Server functions; authenticator stuff:
720 "Login to server in BUFFER.
721 LOGINFUNC is passed a username and a password, it should return t if
722 it where successful authenticating itself to the server, nil otherwise.
723 Returns t if login was successful, nil otherwise."
728 ;; (condition-case ()
742 imap-username user)
749 ;; (quit (with-current-buffer buffer
750 ;; (setq user nil
751 ;; passwd nil)))
752 ;; (error (with-current-buffer buffer
753 ;; (setq user nil
754 ;; passwd nil))))
755 ret)))
777 "Login to server using the AUTH CRAM-MD5 method."
780 buffer
785 "AUTHENTICATE CRAM-MD5"
791 encoded)))))))))
803 "Login to server using the LOGIN command."
812 t)
828 "Login to server using the AUTH DIGEST-MD5 method."
831 buffer
836 "AUTHENTICATE DIGEST-MD5"
845 user passwd digest-uri)))
847 )))
849 nil
854 ;; Server functions:
860 imap-current-message nil
861 imap-state 'initial
864 imap-stream-alist))
876 imap-process))))
879 "Open a IMAP connection to host SERVER at PORT returning a buffer.
880 If PORT is unspecified, a default value is used (143 except
881 for SSL which use 993).
882 STREAM indicates the stream to use, see `imap-streams' for available
883 streams. If nil, it choices the best stream the server is capable of.
884 AUTH indicates authenticator to use, see `imap-authenticators' for
885 available authenticators. If nil, it choices the best stream the
886 server is capable of.
887 BUFFER can be a buffer or a name of a buffer, which is created if
888 necessary. If nil, the buffer name is generated."
903 ;; Choose stream.
911 imap-default-stream)
912 stream))
913 imap-stream stream
914 streams nil)))
922 imap-stream)
924 imap-stream))
927 ;; Choose authenticator
932 buffer)
934 auths nil)))
940 buffer)))
943 "Return non-nil if connection to imap server in BUFFER is open.
944 If BUFFER is nil then the current buffer is used."
952 "Authenticate to server in BUFFER, using current buffer if nil.
953 It uses the authenticator specified when opening the server. If the
954 authenticator requires username/passwords, they are queried from the
955 user and optionally stored in the buffer. If USER and/or PASSWD is
956 specified, the user will not be questioned and the username and/or
957 password is remembered in the buffer."
971 "Close connection to server in BUFFER.
972 If BUFFER is nil, the current buffer is used."
981 imap-current-message nil
982 imap-process nil)
984 t))
987 "Return a list of identifiers which server in BUFFER support.
988 If IDENTIFIER, return non-nil if it's among the servers capabilities.
989 If BUFFER is nil, the current buffer is assumed."
996 imap-capability)))
999 "Return a namespace hierarchy at server in BUFFER.
1000 If BUFFER is nil, the current buffer is assumed."
1005 imap-namespace))
1010 \f
1011 ;; Mailbox functions:
1017 propname value)
1020 t))
1024 propname))
1039 imap-mailbox-data)
1040 result)))
1043 "Map a function across each mailbox in `imap-mailbox-data', returning a list.
1044 Function should take a mailbox name (a string) as
1045 the only argument."
1064 "Select MAILBOX on server in BUFFER.
1065 If EXAMINE is non-nil, do a read-only select."
1067 imap-current-mailbox
1075 imap-current-mailbox)
1076 ;; Failed SELECT/EXAMINE unselects current mailbox
1089 "Examine MAILBOX on server in BUFFER."
1093 "Close current folder in BUFFER, without expunging articles."
1100 imap-current-mailbox
1104 imap-message-data nil
1106 t)))
1109 "Expunge articles in current folder in BUFFER.
1110 If BUFFER is nil the current buffer is assumed."
1116 "Expunge articles and close current folder in BUFFER.
1117 If BUFFER is nil the current buffer is assumed."
1122 imap-message-data nil
1124 t)))
1130 "Create MAILBOX on server in BUFFER.
1131 If BUFFER is nil the current buffer is assumed."
1136 "Delete MAILBOX on server in BUFFER.
1137 If BUFFER is nil the current buffer is assumed."
1144 "Rename mailbox OLDNAME to NEWNAME on server in BUFFER.
1145 If BUFFER is nil the current buffer is assumed."
1154 "Return a list of subscribed mailboxes on server in BUFFER.
1155 If ROOT is non-nil, only list matching mailboxes. If ADD-DELIMITER is
1156 non-nil, a hierarchy delimiter is added to root. REFERENCE is a
1157 implementation-specific string that has to be passed to lsub command."
1159 ;; Make sure we know the hierarchy separator for root's hierarchy
1163 ;; clear list data (NB not delimiter and other stuff)
1178 "Return a list of mailboxes matching ROOT on server in BUFFER.
1179 If ADD-DELIMITER is non-nil, a hierarchy delimiter is added to
1180 root. REFERENCE is a implementation-specific string that has to be
1181 passed to list command."
1183 ;; Make sure we know the hierarchy separator for root's hierarchy
1187 ;; clear list data (NB not delimiter and other stuff)
1202 "Send the SUBSCRIBE command on the mailbox to server in BUFFER.
1203 Returns non-nil if successful."
1210 "Send the SUBSCRIBE command on the mailbox to server in BUFFER.
1211 Returns non-nil if successful."
1218 "Get status items ITEM in MAILBOX from server in BUFFER.
1219 ITEMS can be a symbol or a list of symbols, valid symbols are one of
1220 the STATUS data items -- ie 'messages, 'recent, 'uidnext, 'uidvalidity
1221 or 'unseen. If ITEMS is a list of symbols, a list of values is
1222 returned, if ITEMS is a symbol only its value is returned."
1230 items
1235 items)
1239 "Get ACL on mailbox from server in BUFFER."
1249 "Change/set ACL for IDENTIFIER to RIGHTS in MAILBOX from server in BUFFER."
1256 identifier
1257 " "
1258 rights))))))
1261 "Removes any <identifier,rights> pair for IDENTIFIER in MAILBOX from server in BUFFER."
1268 identifier))))))
1270 \f
1271 ;; Message functions:
1275 imap-current-message))
1281 list
1294 range)
1302 uids)
1303 props))))
1306 "Fetch properties PROPS from message set UIDS from server in BUFFER.
1307 UIDS can be a string, number or a list of numbers. If RECEIVE
1308 is non-nil return theese properties."
1314 uids)
1315 props)))
1317 t
1323 receive)
1325 uids)
1332 propname value)
1335 t))
1340 propname)))
1343 "Map a function across each mailbox in `imap-message-data', returning a list."
1349 imap-message-data)
1350 result)))
1405 "Return t iff FLAG can be permanently (between IMAP sessions) saved on articles, in MAILBOX on server in BUFFER."
1454 "Copy ARTICLES (a string message set) to MAILBOX on server in
1455 BUFFER, creating mailbox if it doesn't exist. If dont-create is
1456 non-nil, it will not create a mailbox. On success, return a list with
1457 the UIDVALIDITY of the mailbox the article(s) was copied to as the
1458 first element, rest of list contain the saved articles' UIDs."
1465 t
1494 "Append ARTICLE (a buffer) to MAILBOX on server in BUFFER.
1495 FLAGS and DATE-TIME is currently not used. Return a cons holding
1496 uidvalidity of MAILBOX and UID the newly created article got, or nil
1497 on failure."
1507 "Return number of lines in article by looking at the mime bodystructure BODY."
1521 "Return a from string line."
1526 "@"
1530 \f
1531 ;; Internal functions.
1547 cmd cmdstr)
1555 size)
1560 ;; XXX modifies buffer!
1580 imap-log)
1596 command)))
1602 tag)))
1613 'INCOMPLETE
1620 "Return point at end of current line, taking into account literals.
1621 Return nil if no complete line has arrived."
1623 imap-server-eol)
1624 nil t)
1627 nil
1633 "IMAP process filter."
1660 imap-state)))
1663 \f
1664 ;; Imap parser.
1669 ;; number = 1*DIGIT
1670 ;; ; Unsigned 32-bit integer
1671 ;; ; (0 <= n < 4,294,967,296)
1679 ;; literal = "{" number "}" CRLF *CHAR8
1680 ;; ; Number represents the number of CHAR8s
1687 nil
1691 ;; string = quoted / literal
1692 ;;
1693 ;; quoted = DQUOTE *QUOTED-CHAR DQUOTE
1694 ;;
1695 ;; QUOTED-CHAR = <any TEXT-CHAR except quoted-specials> /
1696 ;; "\" quoted-specials
1697 ;;
1698 ;; quoted-specials = DQUOTE / "\"
1699 ;;
1700 ;; TEXT-CHAR = <any CHAR except CR and LF>
1714 name))
1718 ;; nil = "NIL"
1724 ;; nstring = string / nil
1729 nil)))
1731 ;; astring = atom / string
1732 ;;
1733 ;; atom = 1*ATOM-CHAR
1734 ;;
1735 ;; ATOM-CHAR = <any CHAR except atom-specials>
1736 ;;
1737 ;; atom-specials = "(" / ")" / "{" / SP / CTL / list-wildcards /
1738 ;; quoted-specials
1739 ;;
1740 ;; list-wildcards = "%" / "*"
1741 ;;
1742 ;; quoted-specials = DQUOTE / "\"
1752 ;; address = "(" addr-name SP addr-adl SP addr-mailbox SP
1753 ;; addr-host ")"
1754 ;;
1755 ;; addr-adl = nstring
1756 ;; ; Holds route from [RFC-822] route-addr if
1757 ;; ; non-nil
1758 ;;
1759 ;; addr-host = nstring
1760 ;; ; nil indicates [RFC-822] group syntax.
1761 ;; ; Otherwise, holds [RFC-822] domain name
1762 ;;
1763 ;; addr-mailbox = nstring
1764 ;; ; nil indicates end of [RFC-822] group; if
1765 ;; ; non-nil and addr-host is nil, holds
1766 ;; ; [RFC-822] group name.
1767 ;; ; Otherwise, holds [RFC-822] local-part
1768 ;; ; after removing [RFC-822] quoting
1769 ;;
1770 ;; addr-name = nstring
1771 ;; ; If non-nil, holds phrase from [RFC-822]
1772 ;; ; mailbox after removing [RFC-822] quoting
1773 ;;
1788 address))))
1790 ;; address-list = "(" 1*address ")" / nil
1791 ;;
1792 ;; nil = "NIL"
1799 ;; next line for MS Exchange bug
1806 ;; (assert (imap-parse-nil)) ; With assert, the code might not be eval'd.
1809 ;; mailbox = "INBOX" / astring
1810 ;; ; INBOX is case-insensitive. All case variants of
1811 ;; ; INBOX (e.g. "iNbOx") MUST be interpreted as INBOX
1812 ;; ; not as an astring. An astring which consists of
1813 ;; ; the case-insensitive sequence "I" "N" "B" "O" "X"
1814 ;; ; is considered to be INBOX and not an astring.
1815 ;; ; Refer to section 5.1 for further
1816 ;; ; semantic details of mailbox names.
1821 "INBOX"
1822 mailbox)))
1824 ;; greeting = "*" SP (resp-cond-auth / resp-cond-bye) CRLF
1825 ;;
1826 ;; resp-cond-auth = ("OK" / "PREAUTH") SP resp-text
1827 ;; ; Authentication condition
1828 ;;
1829 ;; resp-cond-bye = "BYE" SP resp-text
1832 "Parse a IMAP greeting."
1840 ;; response = *(continue-req / response-data) response-done
1841 ;;
1842 ;; continue-req = "+" SP (resp-text / base64) CRLF
1843 ;;
1844 ;; response-data = "*" SP (resp-cond-state / resp-cond-bye /
1845 ;; mailbox-data / message-data / capability-data) CRLF
1846 ;;
1847 ;; response-done = response-tagged / response-fatal
1848 ;;
1849 ;; response-fatal = "*" SP resp-cond-bye CRLF
1850 ;; ; Server closes connection immediately
1851 ;;
1852 ;; response-tagged = tag SP resp-cond-state CRLF
1853 ;;
1854 ;; resp-cond-state = ("OK" / "NO" / "BAD") SP resp-text
1855 ;; ; Status condition
1856 ;;
1857 ;; resp-cond-bye = "BYE" SP resp-text
1858 ;;
1859 ;; mailbox-data = "FLAGS" SP flag-list /
1860 ;; "LIST" SP mailbox-list /
1861 ;; "LSUB" SP mailbox-list /
1862 ;; "SEARCH" *(SP nz-number) /
1863 ;; "STATUS" SP mailbox SP "("
1864 ;; [status-att SP number *(SP status-att SP number)] ")" /
1865 ;; number SP "EXISTS" /
1866 ;; number SP "RECENT"
1867 ;;
1868 ;; message-data = nz-number SP ("EXPUNGE" / ("FETCH" SP msg-att))
1869 ;;
1870 ;; capability-data = "CAPABILITY" *(SP capability) SP "IMAP4rev1"
1871 ;; *(SP capability)
1872 ;; ; IMAP4rev1 servers which offer RFC 1730
1873 ;; ; compatibility MUST list "IMAP4" as the first
1874 ;; ; capability.
1877 "Parse a IMAP command response."
1883 t)))
1894 'search
1928 imap-failed-tags))))
1941 token status code text))))
1944 ;; resp-text = ["[" resp-text-code "]" SP] text
1945 ;;
1946 ;; text = 1*TEXT-CHAR
1947 ;;
1948 ;; TEXT-CHAR = <any CHAR except CR and LF>
1953 ;; resp-text-code = "ALERT" /
1954 ;; "BADCHARSET [SP "(" astring *(SP astring) ")" ] /
1955 ;; "NEWNAME" SP string SP string /
1956 ;; "PARSE" /
1957 ;; "PERMANENTFLAGS" SP "("
1958 ;; [flag-perm *(SP flag-perm)] ")" /
1959 ;; "READ-ONLY" /
1960 ;; "READ-WRITE" /
1961 ;; "TRYCREATE" /
1962 ;; "UIDNEXT" SP nz-number /
1963 ;; "UIDVALIDITY" SP nz-number /
1964 ;; "UNSEEN" SP nz-number /
1965 ;; resp-text-atom [SP 1*<any TEXT-CHAR except "]">]
1966 ;;
1967 ;; resp_code_apnd = "APPENDUID" SPACE nz_number SPACE uniqueid
1968 ;;
1969 ;; resp_code_copy = "COPYUID" SPACE nz_number SPACE set SPACE set
1970 ;;
1971 ;; set = sequence-num / (sequence-num ":" sequence-num) /
1972 ;; (set "," set)
1973 ;; ; Identifies a set of messages. For message
1974 ;; ; sequence numbers, these are consecutive
1975 ;; ; numbers from 1 to the number of messages in
1976 ;; ; the mailbox
1977 ;; ; Comma delimits individual numbers, colon
1978 ;; ; delimits between two numbers inclusive.
1979 ;; ; Example: 2,4:7,9,12:* is 2,4,5,6,7,9,12,13,
1980 ;; ; 14,15 for a mailbox with 15 messages.
1981 ;;
1982 ;; sequence-num = nz-number / "*"
1983 ;; ; * is the largest number in use. For message
1984 ;; ; sequence numbers, it is the number of messages
1985 ;; ; in the mailbox. For unique identifiers, it is
1986 ;; ; the unique identifier of the last message in
1987 ;; ; the mailbox.
1988 ;;
1989 ;; flag-perm = flag / "\*"
1990 ;;
1991 ;; flag = "\Answered" / "\Flagged" / "\Deleted" /
1992 ;; "\Seen" / "\Draft" / flag-keyword / flag-extension
1993 ;; ; Does not include "\Recent"
1994 ;;
1995 ;; flag-extension = "\" atom
1996 ;; ; Future expansion. Client implementations
1997 ;; ; MUST accept flag-extension flags. Server
1998 ;; ; implementations MUST NOT generate
1999 ;; ; flag-extension flags except as defined by
2000 ;; ; future standard or standards-track
2001 ;; ; revisions of this specification.
2002 ;;
2003 ;; flag-keyword = atom
2004 ;;
2005 ;; resp-text-atom = 1*<any ATOM-CHAR except "]">
2032 imap-current-target-mailbox))
2037 imap-current-target-mailbox))
2042 ;; mailbox-list = "(" [mbx-list-flags] ")" SP
2043 ;; (DQUOTE QUOTED-CHAR DQUOTE / nil) SP mailbox
2044 ;;
2045 ;; mbx-list-flags = *(mbx-list-oflag SP) mbx-list-sflag
2046 ;; *(SP mbx-list-oflag) /
2047 ;; mbx-list-oflag *(SP mbx-list-oflag)
2048 ;;
2049 ;; mbx-list-oflag = "\Noinferiors" / flag-extension
2050 ;; ; Other flags; multiple possible per LIST response
2051 ;;
2052 ;; mbx-list-sflag = "\Noselect" / "\Marked" / "\Unmarked"
2053 ;; ; Selectability flags; only one per LIST response
2054 ;;
2055 ;; QUOTED-CHAR = <any TEXT-CHAR except quoted-specials> /
2056 ;; "\" quoted-specials
2057 ;;
2058 ;; quoted-specials = DQUOTE / "\"
2071 ;; msg_att ::= "(" 1#("ENVELOPE" SPACE envelope /
2072 ;; "FLAGS" SPACE "(" #(flag / "\Recent") ")" /
2073 ;; "INTERNALDATE" SPACE date_time /
2074 ;; "RFC822" [".HEADER" / ".TEXT"] SPACE nstring /
2075 ;; "RFC822.SIZE" SPACE number /
2076 ;; "BODY" ["STRUCTURE"] SPACE body /
2077 ;; "BODY" section ["<" number ">"] SPACE nstring /
2078 ;; "UID" SPACE uniqueid) ")"
2079 ;;
2080 ;; date_time ::= <"> date_day_fixed "-" date_month "-" date_year
2081 ;; SPACE time SPACE zone <">
2082 ;;
2083 ;; section ::= "[" [section_text / (nz_number *["." nz_number]
2084 ;; ["." (section_text / "MIME")])] "]"
2085 ;;
2086 ;; section_text ::= "HEADER" / "HEADER.FIELDS" [".NOT"]
2087 ;; SPACE header_list / "TEXT"
2088 ;;
2089 ;; header_fld_name ::= astring
2090 ;;
2091 ;; header_list ::= "(" 1#header_fld_name ")"
2109 section)))
2114 rfc822size body bodydetail bodystructure)
2144 bodydetail)
2163 ;; mailbox-data = ...
2164 ;; "STATUS" SP mailbox SP "("
2165 ;; [status-att SP number
2166 ;; *(SP status-att SP number)] ")"
2167 ;; ...
2168 ;;
2169 ;; status-att = "MESSAGES" / "RECENT" / "UIDNEXT" / "UIDVALIDITY" /
2170 ;; "UNSEEN"
2191 token mailbox))))))))
2193 ;; acl_data ::= "ACL" SPACE mailbox *(SPACE identifier SPACE
2194 ;; rights)
2195 ;;
2196 ;; identifier ::= astring
2197 ;;
2198 ;; rights ::= astring
2202 identifier rights acl)
2211 ;; flag-list = "(" [flag *(SP flag)] ")"
2212 ;;
2213 ;; flag = "\Answered" / "\Flagged" / "\Deleted" /
2214 ;; "\Seen" / "\Draft" / flag-keyword / flag-extension
2215 ;; ; Does not include "\Recent"
2216 ;;
2217 ;; flag-keyword = atom
2218 ;;
2219 ;; flag-extension = "\" atom
2220 ;; ; Future expansion. Client implementations
2221 ;; ; MUST accept flag-extension flags. Server
2222 ;; ; implementations MUST NOT generate
2223 ;; ; flag-extension flags except as defined by
2224 ;; ; future standard or standards-track
2225 ;; ; revisions of this specification.
2238 ;; envelope = "(" env-date SP env-subject SP env-from SP env-sender SP
2239 ;; env-reply-to SP env-to SP env-cc SP env-bcc SP
2240 ;; env-in-reply-to SP env-message-id ")"
2241 ;;
2242 ;; env-bcc = "(" 1*address ")" / nil
2243 ;;
2244 ;; env-cc = "(" 1*address ")" / nil
2245 ;;
2246 ;; env-date = nstring
2247 ;;
2248 ;; env-from = "(" 1*address ")" / nil
2249 ;;
2250 ;; env-in-reply-to = nstring
2251 ;;
2252 ;; env-message-id = nstring
2253 ;;
2254 ;; env-reply-to = "(" 1*address ")" / nil
2255 ;;
2256 ;; env-sender = "(" 1*address ")" / nil
2257 ;;
2258 ;; env-subject = nstring
2259 ;;
2260 ;; env-to = "(" 1*address ")" / nil
2286 ;; body-fld-param = "(" string SP string *(SP string SP string) ")" / nil
2294 ;; buggy stalker communigate pro 3.0 doesn't print SPC
2295 ;; between body-fld-param's sometimes
2300 nil)))
2302 ;; body-extension = nstring / number /
2303 ;; "(" body-extension *(SP body-extension) ")"
2304 ;; ; Future expansion. Client implementations
2305 ;; ; MUST accept body-extension fields. Server
2306 ;; ; implementations MUST NOT generate
2307 ;; ; body-extension fields except as defined by
2308 ;; ; future standard or standards-track
2309 ;; ; revisions of this specification.
2325 ;; body-ext-1part = body-fld-md5 [SP body-fld-dsp [SP body-fld-lang
2326 ;; *(SP body-extension)]]
2327 ;; ; MUST NOT be returned on non-extensible
2328 ;; ; "BODY" fetch
2329 ;;
2330 ;; body-ext-mpart = body-fld-param [SP body-fld-dsp [SP body-fld-lang
2331 ;; *(SP body-extension)]]
2332 ;; ; MUST NOT be returned on non-extensible
2333 ;; ; "BODY" fetch
2347 ;; (assert (imap-parse-nil)) ; Code in assert might not be eval'd.
2358 ext))
2360 ;; body = "(" body-type-1part / body-type-mpart ")"
2361 ;;
2362 ;; body-ext-1part = body-fld-md5 [SP body-fld-dsp [SP body-fld-lang
2363 ;; *(SP body-extension)]]
2364 ;; ; MUST NOT be returned on non-extensible
2365 ;; ; "BODY" fetch
2366 ;;
2367 ;; body-ext-mpart = body-fld-param [SP body-fld-dsp [SP body-fld-lang
2368 ;; *(SP body-extension)]]
2369 ;; ; MUST NOT be returned on non-extensible
2370 ;; ; "BODY" fetch
2371 ;;
2372 ;; body-fields = body-fld-param SP body-fld-id SP body-fld-desc SP
2373 ;; body-fld-enc SP body-fld-octets
2374 ;;
2375 ;; body-fld-desc = nstring
2376 ;;
2377 ;; body-fld-dsp = "(" string SP body-fld-param ")" / nil
2378 ;;
2379 ;; body-fld-enc = (DQUOTE ("7BIT" / "8BIT" / "BINARY" / "BASE64"/
2380 ;; "QUOTED-PRINTABLE") DQUOTE) / string
2381 ;;
2382 ;; body-fld-id = nstring
2383 ;;
2384 ;; body-fld-lang = nstring / "(" string *(SP string) ")"
2385 ;;
2386 ;; body-fld-lines = number
2387 ;;
2388 ;; body-fld-md5 = nstring
2389 ;;
2390 ;; body-fld-octets = number
2391 ;;
2392 ;; body-fld-param = "(" string SP string *(SP string SP string) ")" / nil
2393 ;;
2394 ;; body-type-1part = (body-type-basic / body-type-msg / body-type-text)
2395 ;; [SP body-ext-1part]
2396 ;;
2397 ;; body-type-basic = media-basic SP body-fields
2398 ;; ; MESSAGE subtype MUST NOT be "RFC822"
2399 ;;
2400 ;; body-type-msg = media-message SP body-fields SP envelope
2401 ;; SP body SP body-fld-lines
2402 ;;
2403 ;; body-type-text = media-text SP body-fields SP body-fld-lines
2404 ;;
2405 ;; body-type-mpart = 1*body SP media-subtype
2406 ;; [SP body-ext-mpart]
2407 ;;
2408 ;; media-basic = ((DQUOTE ("APPLICATION" / "AUDIO" / "IMAGE" /
2409 ;; "MESSAGE" / "VIDEO") DQUOTE) / string) SP media-subtype
2410 ;; ; Defined in [MIME-IMT]
2411 ;;
2412 ;; media-message = DQUOTE "MESSAGE" DQUOTE SP DQUOTE "RFC822" DQUOTE
2413 ;; ; Defined in [MIME-IMT]
2414 ;;
2415 ;; media-subtype = string
2416 ;; ; Defined in [MIME-IMT]
2417 ;;
2418 ;; media-text = DQUOTE "TEXT" DQUOTE SP media-subtype
2419 ;; ; Defined in [MIME-IMT]
2429 ;; buggy stalker communigate pro 3.0 insert a SPC between
2430 ;; parts in multiparts
2452 ;; next line for Sun SIMS bug
2462 ;; next `or' for Sun SIMS bug, it regard body-fld-enc as a
2463 ;; nstring and return nil instead of defaulting back to 7BIT
2464 ;; as the standard says.
2469 ;; ok, we're done parsing the required parts, what comes now is one
2470 ;; of three things:
2471 ;;
2472 ;; envelope (then we're parsing body-type-msg)
2473 ;; body-fld-lines (then we're parsing body-type-text)
2474 ;; body-ext-1part (then we're parsing body-type-basic)
2475 ;;
2476 ;; the problem is that the two first are in turn optionally followed
2477 ;; by the third. So we parse the first two here (if there are any)...
2486 ;; buggy stalker communigate pro 3.0 doesn't print
2487 ;; number of lines in message/rfc822 attachment
2497 ;; ...and then parse the third one here...
2512 '(
2513 imap-read-passwd
2514 imap-utf7-encode
2515 imap-utf7-decode
2516 imap-error-text
2517 imap-kerberos4s-p
2518 imap-kerberos4-open
2519 imap-ssl-p
2520 imap-ssl-open
2521 imap-network-p
2522 imap-network-open
2523 imap-interactive-login
2524 imap-kerberos4a-p
2525 imap-kerberos4-auth
2526 imap-cram-md5-p
2527 imap-cram-md5-auth
2528 imap-login-p
2529 imap-login-auth
2530 imap-anonymous-p
2531 imap-anonymous-auth
2532 imap-open-1
2533 imap-open
2534 imap-opened
2535 imap-authenticate
2536 imap-close
2537 imap-capability
2538 imap-namespace
2539 imap-send-command-wait
2540 imap-mailbox-put
2541 imap-mailbox-get
2542 imap-mailbox-map-1
2543 imap-mailbox-map
2544 imap-current-mailbox
2545 imap-current-mailbox-p-1
2546 imap-current-mailbox-p
2547 imap-mailbox-select-1
2548 imap-mailbox-select
2549 imap-mailbox-examine-1
2550 imap-mailbox-examine
2551 imap-mailbox-unselect
2552 imap-mailbox-expunge
2553 imap-mailbox-close
2554 imap-mailbox-create-1
2555 imap-mailbox-create
2556 imap-mailbox-delete
2557 imap-mailbox-rename
2558 imap-mailbox-lsub
2559 imap-mailbox-list
2560 imap-mailbox-subscribe
2561 imap-mailbox-unsubscribe
2562 imap-mailbox-status
2563 imap-mailbox-acl-get
2564 imap-mailbox-acl-set
2565 imap-mailbox-acl-delete
2566 imap-current-message
2567 imap-list-to-message-set
2568 imap-fetch-asynch
2569 imap-fetch
2570 imap-message-put
2571 imap-message-get
2572 imap-message-map
2573 imap-search
2574 imap-message-flag-permanent-p
2575 imap-message-flags-set
2576 imap-message-flags-del
2577 imap-message-flags-add
2578 imap-message-copyuid-1
2579 imap-message-copyuid
2580 imap-message-copy
2581 imap-message-appenduid-1
2582 imap-message-appenduid
2583 imap-message-append
2584 imap-body-lines
2585 imap-envelope-from
2586 imap-send-command-1
2587 imap-send-command
2588 imap-wait-for-tag
2589 imap-sentinel
2590 imap-find-next-line
2591 imap-arrival-filter
2592 imap-parse-greeting
2593 imap-parse-response
2594 imap-parse-resp-text
2595 imap-parse-resp-text-code
2596 imap-parse-data-list
2597 imap-parse-fetch
2598 imap-parse-status
2599 imap-parse-acl
2600 imap-parse-flag-list
2601 imap-parse-envelope
2602 imap-parse-body-extension
2603 imap-parse-body
2604 )))
2608 ;;; arch-tag: 27369ed6-33e4-482f-96f1-8bb906ba70f7
2609 ;;; imap.el ends here