| blob | d46a92a0b2842fe3459f6a08a1f0d05d31054bf7 |
1 ;;; imap.el --- imap library
2 ;; Copyright (C) 1998, 1999, 2000
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:
156 ;; Avoid use gnus-point-at-eol so we're independent of Gnus. These
157 ;; days we have point-at-eol anyhow.
165 ;; User variables.
168 "Low-level IMAP issues."
174 "List of strings containing commands for Kerberos 4 authentication.
175 %s is replaced with server hostname, %p with port to connect to, and
176 %l with the value of `imap-default-user'. The program should accept
177 IMAP commands on stdin and return responses to stdout. Each entry in
178 the list is tried until a successful connection is made."
183 "List of strings containing commands for GSSAPI (krb5) authentication.
184 %s is replaced with server hostname, %p with port to connect to, and
185 %l with the value of `imap-default-user'. The program should accept
186 IMAP commands on stdin and return responses to stdout. Each entry in
187 the list is tried until a successful connection is made."
192 "openssl s_client -ssl2 -connect %s:%p"
193 "s_client -ssl3 -connect %s:%p"
195 "A string, or list of strings, containing commands for SSL connections.
196 Within a string, %s is replaced with the server address and %p with
197 port number on server. The program should accept IMAP commands on
198 stdin and return responses to stdout. Each entry in the list is tried
199 until a successful connection is made."
205 "rsh %s imapd"
206 "ssh %g ssh %s imapd"
208 "A list of strings, containing commands for IMAP connection.
209 Within a string, %s is replaced with the server address, %p with port
210 number on server, %g with `imap-shell-host', and %l with
211 `imap-default-user'. The program should read IMAP commands from stdin
212 and write IMAP response to stdout. Each entry in the list is tried
213 until a successful connection is made."
226 ;; Various variables.
241 "Definition of network streams.
243 (NAME CHECK OPEN)
245 NAME names the stream, CHECK is a function returning non-nil if the
246 server support the stream and OPEN is a function for opening the
250 kerberos4
251 digest-md5
252 cram-md5
253 login
254 anonymous)
264 "Definition of authenticators.
266 (NAME CHECK AUTHENTICATE)
268 NAME names the authenticator. CHECK is a function returning non-nil if
269 the server support the authenticator and AUTHENTICATE is a function
273 "If non-nil, do utf7 encoding/decoding of mailbox names.
274 Since the UTF7 decoding currently only decodes into ISO-8859-1
275 characters, you may disable this decoding if you need to access UTF7
278 ;; Internal constants. Change theese and die.
286 imap-port
287 imap-client-eol
288 imap-server-eol
289 imap-auth
290 imap-stream
291 imap-username
292 imap-password
293 imap-current-mailbox
294 imap-current-target-mailbox
295 imap-message-data
296 imap-capability
297 imap-namespace
298 imap-state
299 imap-reached-tag
300 imap-failed-tags
301 imap-tag
302 imap-process
303 imap-calculate-literal-size-first
304 imap-mailbox-data))
306 ;; Internal variables.
316 "IMAP state.
317 Valid states are `closed', `initial', `nonauth', `auth', `selected'
357 "Alist of tags that failed.
358 Each element is a list with four elements; tag (a integer), response
359 state (a symbol, `OK', `NO' or `BAD'), response code (a string), and
369 "Non-nil indicates that the server emitted a continuation request.
373 "Name of buffer for imap session trace.
377 "Name of buffer for random debug spew.
380 \f
381 ;; Utility functions:
384 "Enable multibyte in the current buffer."
389 "Read a password using PROMPT.
390 If ARGS, PROMPT is used as an argument to `format'."
393 prompt)))
399 'read-passwd
402 prompt)))
410 "imap: Could not UTF7 encode `%s', using it unencoded..."
411 string)
412 string)))
413 string))
421 "imap: Could not UTF7 decode `%s', using it undecoded..."
422 string)
423 string)))
424 string))
428 t
430 nil))
436 \f
437 ;; Server functions; stream stuff:
444 cmd done)
452 name buffer shell-file-name shell-command-switch
454 cmd
456 ?s server
458 ?l imap-default-user))))
459 response)
463 imap-calculate-literal-size-first t)
466 ;; cyrus 1.6.x (13? < x <= 22) queries capabilities
469 t)
470 ;; cyrus 1.6 imtest print "S: " before server greeting
473 t)
475 ;; success in imtest < 1.6:
478 ;; success in imtest 1.6:
499 nil)))))
500 done))
507 cmd done)
514 name buffer shell-file-name shell-command-switch
516 cmd
518 ?s server
520 ?l imap-default-user))))
521 response)
527 ;; cyrus 1.6.x (13? < x <= 22) queries capabilities
530 t)
531 ;; cyrus 1.6 imtest print "S: " before server greeting
534 t)
536 ;; success in imtest 1.6:
556 nil)))))
557 done))
560 nil)
563 "Open a SSL connection to server."
566 cmd done)
576 ?s server
578 process)
580 name buffer server port)))
601 done)
603 nil)))
606 t)
626 process))))
629 nil)
633 cmd done)
641 name buffer shell-file-name shell-command-switch
643 cmd
645 ?s server
646 ?g imap-shell-host
648 ?l imap-default-user)))))
667 done)
669 nil)))
684 done)
710 done)
712 nil)))
714 ;; Server functions; authenticator stuff:
717 "Login to server in BUFFER.
718 LOGINFUNC is passed a username and a password, it should return t if
719 it where sucessful authenticating itself to the server, nil otherwise.
720 Returns t if login was successful, nil otherwise."
725 ;; (condition-case ()
739 imap-username user)
746 ;; (quit (with-current-buffer buffer
747 ;; (setq user nil
748 ;; passwd nil)))
749 ;; (error (with-current-buffer buffer
750 ;; (setq user nil
751 ;; passwd nil))))
752 ret)))
774 "Login to server using the AUTH CRAM-MD5 method."
777 buffer
782 "AUTHENTICATE CRAM-MD5"
788 encoded)))))))))
800 "Login to server using the LOGIN command."
809 t)
825 "Login to server using the AUTH DIGEST-MD5 method."
828 buffer
833 "AUTHENTICATE DIGEST-MD5"
842 user passwd digest-uri)))
844 )))
846 nil
851 ;; Server functions:
857 imap-current-message nil
858 imap-state 'initial
861 imap-stream-alist))
873 imap-process))))
876 "Open a IMAP connection to host SERVER at PORT returning a buffer.
877 If PORT is unspecified, a default value is used (143 except
878 for SSL which use 993).
879 STREAM indicates the stream to use, see `imap-streams' for available
880 streams. If nil, it choices the best stream the server is capable of.
881 AUTH indicates authenticator to use, see `imap-authenticators' for
882 available authenticators. If nil, it choices the best stream the
883 server is capable of.
884 BUFFER can be a buffer or a name of a buffer, which is created if
885 necessery. If nil, the buffer name is generated."
900 ;; Choose stream.
908 imap-default-stream)
909 stream))
910 imap-stream stream
911 streams nil)))
919 imap-stream)
921 imap-stream))
924 ;; Choose authenticator
929 buffer)
931 auths nil)))
937 buffer)))
940 "Return non-nil if connection to imap server in BUFFER is open.
941 If BUFFER is nil then the current buffer is used."
949 "Authenticate to server in BUFFER, using current buffer if nil.
950 It uses the authenticator specified when opening the server. If the
951 authenticator requires username/passwords, they are queried from the
952 user and optionally stored in the buffer. If USER and/or PASSWD is
953 specified, the user will not be questioned and the username and/or
954 password is remembered in the buffer."
968 "Close connection to server in BUFFER.
969 If BUFFER is nil, the current buffer is used."
978 imap-current-message nil
979 imap-process nil)
981 t))
984 "Return a list of identifiers which server in BUFFER support.
985 If IDENTIFIER, return non-nil if it's among the servers capabilities.
986 If BUFFER is nil, the current buffer is assumed."
993 imap-capability)))
996 "Return a namespace hierarchy at server in BUFFER.
997 If BUFFER is nil, the current buffer is assumed."
1002 imap-namespace))
1007 \f
1008 ;; Mailbox functions:
1014 propname value)
1017 t))
1021 propname))
1036 imap-mailbox-data)
1037 result)))
1040 "Map a function across each mailbox in `imap-mailbox-data', returning a list.
1041 Function should take a mailbox name (a string) as
1042 the only argument."
1061 "Select MAILBOX on server in BUFFER.
1062 If EXAMINE is non-nil, do a read-only select."
1064 imap-current-mailbox
1072 imap-current-mailbox)
1073 ;; Failed SELECT/EXAMINE unselects current mailbox
1086 "Examine MAILBOX on server in BUFFER."
1090 "Close current folder in BUFFER, without expunging articles."
1097 imap-current-mailbox
1101 imap-message-data nil
1103 t)))
1106 "Expunge articles in current folder in BUFFER.
1107 If BUFFER is nil the current buffer is assumed."
1113 "Expunge articles and close current folder in BUFFER.
1114 If BUFFER is nil the current buffer is assumed."
1119 imap-message-data nil
1121 t)))
1127 "Create MAILBOX on server in BUFFER.
1128 If BUFFER is nil the current buffer is assumed."
1133 "Delete MAILBOX on server in BUFFER.
1134 If BUFFER is nil the current buffer is assumed."
1141 "Rename mailbox OLDNAME to NEWNAME on server in BUFFER.
1142 If BUFFER is nil the current buffer is assumed."
1151 "Return a list of subscribed mailboxes on server in BUFFER.
1152 If ROOT is non-nil, only list matching mailboxes. If ADD-DELIMITER is
1153 non-nil, a hierarchy delimiter is added to root. REFERENCE is a
1154 implementation-specific string that has to be passed to lsub command."
1156 ;; Make sure we know the hierarchy separator for root's hierarchy
1160 ;; clear list data (NB not delimiter and other stuff)
1175 "Return a list of mailboxes matching ROOT on server in BUFFER.
1176 If ADD-DELIMITER is non-nil, a hierarchy delimiter is added to
1177 root. REFERENCE is a implementation-specific string that has to be
1178 passed to list command."
1180 ;; Make sure we know the hierarchy separator for root's hierarchy
1184 ;; clear list data (NB not delimiter and other stuff)
1199 "Send the SUBSCRIBE command on the mailbox to server in BUFFER.
1200 Returns non-nil if successful."
1207 "Send the SUBSCRIBE command on the mailbox to server in BUFFER.
1208 Returns non-nil if successful."
1215 "Get status items ITEM in MAILBOX from server in BUFFER.
1216 ITEMS can be a symbol or a list of symbols, valid symbols are one of
1217 the STATUS data items -- ie 'messages, 'recent, 'uidnext, 'uidvalidity
1218 or 'unseen. If ITEMS is a list of symbols, a list of values is
1219 returned, if ITEMS is a symbol only it's value is returned."
1227 items
1232 items)
1236 "Get ACL on mailbox from server in BUFFER."
1246 "Change/set ACL for IDENTIFIER to RIGHTS in MAILBOX from server in BUFFER."
1253 identifier
1254 " "
1255 rights))))))
1258 "Removes any <identifier,rights> pair for IDENTIFIER in MAILBOX from server in BUFFER."
1265 identifier))))))
1267 \f
1268 ;; Message functions:
1272 imap-current-message))
1278 list
1291 range)
1299 uids)
1300 props))))
1303 "Fetch properties PROPS from message set UIDS from server in BUFFER.
1304 UIDS can be a string, number or a list of numbers. If RECEIVE
1305 is non-nil return theese properties."
1311 uids)
1312 props)))
1314 t
1320 receive)
1322 uids)
1329 propname value)
1332 t))
1337 propname)))
1340 "Map a function across each mailbox in `imap-message-data', returning a list."
1346 imap-message-data)
1347 result)))
1402 "Return t iff FLAG can be permanently (between IMAP sessions) saved on articles, in MAILBOX on server in BUFFER."
1451 "Copy ARTICLES (a string message set) to MAILBOX on server in
1452 BUFFER, creating mailbox if it doesn't exist. If dont-create is
1453 non-nil, it will not create a mailbox. On success, return a list with
1454 the UIDVALIDITY of the mailbox the article(s) was copied to as the
1455 first element, rest of list contain the saved articles' UIDs."
1462 t
1491 "Append ARTICLE (a buffer) to MAILBOX on server in BUFFER.
1492 FLAGS and DATE-TIME is currently not used. Return a cons holding
1493 uidvalidity of MAILBOX and UID the newly created article got, or nil
1494 on failure."
1504 "Return number of lines in article by looking at the mime bodystructure BODY."
1518 "Return a from string line."
1523 "@"
1527 \f
1528 ;; Internal functions.
1544 cmd cmdstr)
1552 size)
1557 ;; XXX modifies buffer!
1577 imap-log)
1593 command)))
1599 tag)))
1610 'INCOMPLETE
1617 "Return point at end of current line, taking into account literals.
1618 Return nil if no complete line has arrived."
1620 imap-server-eol)
1621 nil t)
1624 nil
1630 "IMAP process filter."
1657 imap-state)))
1660 \f
1661 ;; Imap parser.
1666 ;; number = 1*DIGIT
1667 ;; ; Unsigned 32-bit integer
1668 ;; ; (0 <= n < 4,294,967,296)
1676 ;; literal = "{" number "}" CRLF *CHAR8
1677 ;; ; Number represents the number of CHAR8s
1684 nil
1688 ;; string = quoted / literal
1689 ;;
1690 ;; quoted = DQUOTE *QUOTED-CHAR DQUOTE
1691 ;;
1692 ;; QUOTED-CHAR = <any TEXT-CHAR except quoted-specials> /
1693 ;; "\" quoted-specials
1694 ;;
1695 ;; quoted-specials = DQUOTE / "\"
1696 ;;
1697 ;; TEXT-CHAR = <any CHAR except CR and LF>
1711 name))
1715 ;; nil = "NIL"
1721 ;; nstring = string / nil
1726 nil)))
1728 ;; astring = atom / string
1729 ;;
1730 ;; atom = 1*ATOM-CHAR
1731 ;;
1732 ;; ATOM-CHAR = <any CHAR except atom-specials>
1733 ;;
1734 ;; atom-specials = "(" / ")" / "{" / SP / CTL / list-wildcards /
1735 ;; quoted-specials
1736 ;;
1737 ;; list-wildcards = "%" / "*"
1738 ;;
1739 ;; quoted-specials = DQUOTE / "\"
1749 ;; address = "(" addr-name SP addr-adl SP addr-mailbox SP
1750 ;; addr-host ")"
1751 ;;
1752 ;; addr-adl = nstring
1753 ;; ; Holds route from [RFC-822] route-addr if
1754 ;; ; non-nil
1755 ;;
1756 ;; addr-host = nstring
1757 ;; ; nil indicates [RFC-822] group syntax.
1758 ;; ; Otherwise, holds [RFC-822] domain name
1759 ;;
1760 ;; addr-mailbox = nstring
1761 ;; ; nil indicates end of [RFC-822] group; if
1762 ;; ; non-nil and addr-host is nil, holds
1763 ;; ; [RFC-822] group name.
1764 ;; ; Otherwise, holds [RFC-822] local-part
1765 ;; ; after removing [RFC-822] quoting
1766 ;;
1767 ;; addr-name = nstring
1768 ;; ; If non-nil, holds phrase from [RFC-822]
1769 ;; ; mailbox after removing [RFC-822] quoting
1770 ;;
1785 address))))
1787 ;; address-list = "(" 1*address ")" / nil
1788 ;;
1789 ;; nil = "NIL"
1796 ;; next line for MS Exchange bug
1805 ;; mailbox = "INBOX" / astring
1806 ;; ; INBOX is case-insensitive. All case variants of
1807 ;; ; INBOX (e.g. "iNbOx") MUST be interpreted as INBOX
1808 ;; ; not as an astring. An astring which consists of
1809 ;; ; the case-insensitive sequence "I" "N" "B" "O" "X"
1810 ;; ; is considered to be INBOX and not an astring.
1811 ;; ; Refer to section 5.1 for further
1812 ;; ; semantic details of mailbox names.
1817 "INBOX"
1818 mailbox)))
1820 ;; greeting = "*" SP (resp-cond-auth / resp-cond-bye) CRLF
1821 ;;
1822 ;; resp-cond-auth = ("OK" / "PREAUTH") SP resp-text
1823 ;; ; Authentication condition
1824 ;;
1825 ;; resp-cond-bye = "BYE" SP resp-text
1828 "Parse a IMAP greeting."
1836 ;; response = *(continue-req / response-data) response-done
1837 ;;
1838 ;; continue-req = "+" SP (resp-text / base64) CRLF
1839 ;;
1840 ;; response-data = "*" SP (resp-cond-state / resp-cond-bye /
1841 ;; mailbox-data / message-data / capability-data) CRLF
1842 ;;
1843 ;; response-done = response-tagged / response-fatal
1844 ;;
1845 ;; response-fatal = "*" SP resp-cond-bye CRLF
1846 ;; ; Server closes connection immediately
1847 ;;
1848 ;; response-tagged = tag SP resp-cond-state CRLF
1849 ;;
1850 ;; resp-cond-state = ("OK" / "NO" / "BAD") SP resp-text
1851 ;; ; Status condition
1852 ;;
1853 ;; resp-cond-bye = "BYE" SP resp-text
1854 ;;
1855 ;; mailbox-data = "FLAGS" SP flag-list /
1856 ;; "LIST" SP mailbox-list /
1857 ;; "LSUB" SP mailbox-list /
1858 ;; "SEARCH" *(SP nz-number) /
1859 ;; "STATUS" SP mailbox SP "("
1860 ;; [status-att SP number *(SP status-att SP number)] ")" /
1861 ;; number SP "EXISTS" /
1862 ;; number SP "RECENT"
1863 ;;
1864 ;; message-data = nz-number SP ("EXPUNGE" / ("FETCH" SP msg-att))
1865 ;;
1866 ;; capability-data = "CAPABILITY" *(SP capability) SP "IMAP4rev1"
1867 ;; *(SP capability)
1868 ;; ; IMAP4rev1 servers which offer RFC 1730
1869 ;; ; compatibility MUST list "IMAP4" as the first
1870 ;; ; capability.
1873 "Parse a IMAP command response."
1879 t)))
1890 'search
1924 imap-failed-tags))))
1937 token status code text))))
1940 ;; resp-text = ["[" resp-text-code "]" SP] text
1941 ;;
1942 ;; text = 1*TEXT-CHAR
1943 ;;
1944 ;; TEXT-CHAR = <any CHAR except CR and LF>
1949 ;; resp-text-code = "ALERT" /
1950 ;; "BADCHARSET [SP "(" astring *(SP astring) ")" ] /
1951 ;; "NEWNAME" SP string SP string /
1952 ;; "PARSE" /
1953 ;; "PERMANENTFLAGS" SP "("
1954 ;; [flag-perm *(SP flag-perm)] ")" /
1955 ;; "READ-ONLY" /
1956 ;; "READ-WRITE" /
1957 ;; "TRYCREATE" /
1958 ;; "UIDNEXT" SP nz-number /
1959 ;; "UIDVALIDITY" SP nz-number /
1960 ;; "UNSEEN" SP nz-number /
1961 ;; resp-text-atom [SP 1*<any TEXT-CHAR except "]">]
1962 ;;
1963 ;; resp_code_apnd = "APPENDUID" SPACE nz_number SPACE uniqueid
1964 ;;
1965 ;; resp_code_copy = "COPYUID" SPACE nz_number SPACE set SPACE set
1966 ;;
1967 ;; set = sequence-num / (sequence-num ":" sequence-num) /
1968 ;; (set "," set)
1969 ;; ; Identifies a set of messages. For message
1970 ;; ; sequence numbers, these are consecutive
1971 ;; ; numbers from 1 to the number of messages in
1972 ;; ; the mailbox
1973 ;; ; Comma delimits individual numbers, colon
1974 ;; ; delimits between two numbers inclusive.
1975 ;; ; Example: 2,4:7,9,12:* is 2,4,5,6,7,9,12,13,
1976 ;; ; 14,15 for a mailbox with 15 messages.
1977 ;;
1978 ;; sequence-num = nz-number / "*"
1979 ;; ; * is the largest number in use. For message
1980 ;; ; sequence numbers, it is the number of messages
1981 ;; ; in the mailbox. For unique identifiers, it is
1982 ;; ; the unique identifier of the last message in
1983 ;; ; the mailbox.
1984 ;;
1985 ;; flag-perm = flag / "\*"
1986 ;;
1987 ;; flag = "\Answered" / "\Flagged" / "\Deleted" /
1988 ;; "\Seen" / "\Draft" / flag-keyword / flag-extension
1989 ;; ; Does not include "\Recent"
1990 ;;
1991 ;; flag-extension = "\" atom
1992 ;; ; Future expansion. Client implementations
1993 ;; ; MUST accept flag-extension flags. Server
1994 ;; ; implementations MUST NOT generate
1995 ;; ; flag-extension flags except as defined by
1996 ;; ; future standard or standards-track
1997 ;; ; revisions of this specification.
1998 ;;
1999 ;; flag-keyword = atom
2000 ;;
2001 ;; resp-text-atom = 1*<any ATOM-CHAR except "]">
2028 imap-current-target-mailbox))
2033 imap-current-target-mailbox))
2038 ;; mailbox-list = "(" [mbx-list-flags] ")" SP
2039 ;; (DQUOTE QUOTED-CHAR DQUOTE / nil) SP mailbox
2040 ;;
2041 ;; mbx-list-flags = *(mbx-list-oflag SP) mbx-list-sflag
2042 ;; *(SP mbx-list-oflag) /
2043 ;; mbx-list-oflag *(SP mbx-list-oflag)
2044 ;;
2045 ;; mbx-list-oflag = "\Noinferiors" / flag-extension
2046 ;; ; Other flags; multiple possible per LIST response
2047 ;;
2048 ;; mbx-list-sflag = "\Noselect" / "\Marked" / "\Unmarked"
2049 ;; ; Selectability flags; only one per LIST response
2050 ;;
2051 ;; QUOTED-CHAR = <any TEXT-CHAR except quoted-specials> /
2052 ;; "\" quoted-specials
2053 ;;
2054 ;; quoted-specials = DQUOTE / "\"
2067 ;; msg_att ::= "(" 1#("ENVELOPE" SPACE envelope /
2068 ;; "FLAGS" SPACE "(" #(flag / "\Recent") ")" /
2069 ;; "INTERNALDATE" SPACE date_time /
2070 ;; "RFC822" [".HEADER" / ".TEXT"] SPACE nstring /
2071 ;; "RFC822.SIZE" SPACE number /
2072 ;; "BODY" ["STRUCTURE"] SPACE body /
2073 ;; "BODY" section ["<" number ">"] SPACE nstring /
2074 ;; "UID" SPACE uniqueid) ")"
2075 ;;
2076 ;; date_time ::= <"> date_day_fixed "-" date_month "-" date_year
2077 ;; SPACE time SPACE zone <">
2078 ;;
2079 ;; section ::= "[" [section_text / (nz_number *["." nz_number]
2080 ;; ["." (section_text / "MIME")])] "]"
2081 ;;
2082 ;; section_text ::= "HEADER" / "HEADER.FIELDS" [".NOT"]
2083 ;; SPACE header_list / "TEXT"
2084 ;;
2085 ;; header_fld_name ::= astring
2086 ;;
2087 ;; header_list ::= "(" 1#header_fld_name ")"
2105 section)))
2110 rfc822size body bodydetail bodystructure)
2140 bodydetail)
2159 ;; mailbox-data = ...
2160 ;; "STATUS" SP mailbox SP "("
2161 ;; [status-att SP number
2162 ;; *(SP status-att SP number)] ")"
2163 ;; ...
2164 ;;
2165 ;; status-att = "MESSAGES" / "RECENT" / "UIDNEXT" / "UIDVALIDITY" /
2166 ;; "UNSEEN"
2187 token mailbox))))))))
2189 ;; acl_data ::= "ACL" SPACE mailbox *(SPACE identifier SPACE
2190 ;; rights)
2191 ;;
2192 ;; identifier ::= astring
2193 ;;
2194 ;; rights ::= astring
2198 identifier rights acl)
2207 ;; flag-list = "(" [flag *(SP flag)] ")"
2208 ;;
2209 ;; flag = "\Answered" / "\Flagged" / "\Deleted" /
2210 ;; "\Seen" / "\Draft" / flag-keyword / flag-extension
2211 ;; ; Does not include "\Recent"
2212 ;;
2213 ;; flag-keyword = atom
2214 ;;
2215 ;; flag-extension = "\" atom
2216 ;; ; Future expansion. Client implementations
2217 ;; ; MUST accept flag-extension flags. Server
2218 ;; ; implementations MUST NOT generate
2219 ;; ; flag-extension flags except as defined by
2220 ;; ; future standard or standards-track
2221 ;; ; revisions of this specification.
2234 ;; envelope = "(" env-date SP env-subject SP env-from SP env-sender SP
2235 ;; env-reply-to SP env-to SP env-cc SP env-bcc SP
2236 ;; env-in-reply-to SP env-message-id ")"
2237 ;;
2238 ;; env-bcc = "(" 1*address ")" / nil
2239 ;;
2240 ;; env-cc = "(" 1*address ")" / nil
2241 ;;
2242 ;; env-date = nstring
2243 ;;
2244 ;; env-from = "(" 1*address ")" / nil
2245 ;;
2246 ;; env-in-reply-to = nstring
2247 ;;
2248 ;; env-message-id = nstring
2249 ;;
2250 ;; env-reply-to = "(" 1*address ")" / nil
2251 ;;
2252 ;; env-sender = "(" 1*address ")" / nil
2253 ;;
2254 ;; env-subject = nstring
2255 ;;
2256 ;; env-to = "(" 1*address ")" / nil
2282 ;; body-fld-param = "(" string SP string *(SP string SP string) ")" / nil
2290 ;; buggy stalker communigate pro 3.0 doesn't print SPC
2291 ;; between body-fld-param's sometimes
2296 nil)))
2298 ;; body-extension = nstring / number /
2299 ;; "(" body-extension *(SP body-extension) ")"
2300 ;; ; Future expansion. Client implementations
2301 ;; ; MUST accept body-extension fields. Server
2302 ;; ; implementations MUST NOT generate
2303 ;; ; body-extension fields except as defined by
2304 ;; ; future standard or standards-track
2305 ;; ; revisions of this specification.
2321 ;; body-ext-1part = body-fld-md5 [SP body-fld-dsp [SP body-fld-lang
2322 ;; *(SP body-extension)]]
2323 ;; ; MUST NOT be returned on non-extensible
2324 ;; ; "BODY" fetch
2325 ;;
2326 ;; body-ext-mpart = body-fld-param [SP body-fld-dsp [SP body-fld-lang
2327 ;; *(SP body-extension)]]
2328 ;; ; MUST NOT be returned on non-extensible
2329 ;; ; "BODY" fetch
2353 ext))
2355 ;; body = "(" body-type-1part / body-type-mpart ")"
2356 ;;
2357 ;; body-ext-1part = body-fld-md5 [SP body-fld-dsp [SP body-fld-lang
2358 ;; *(SP body-extension)]]
2359 ;; ; MUST NOT be returned on non-extensible
2360 ;; ; "BODY" fetch
2361 ;;
2362 ;; body-ext-mpart = body-fld-param [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-fields = body-fld-param SP body-fld-id SP body-fld-desc SP
2368 ;; body-fld-enc SP body-fld-octets
2369 ;;
2370 ;; body-fld-desc = nstring
2371 ;;
2372 ;; body-fld-dsp = "(" string SP body-fld-param ")" / nil
2373 ;;
2374 ;; body-fld-enc = (DQUOTE ("7BIT" / "8BIT" / "BINARY" / "BASE64"/
2375 ;; "QUOTED-PRINTABLE") DQUOTE) / string
2376 ;;
2377 ;; body-fld-id = nstring
2378 ;;
2379 ;; body-fld-lang = nstring / "(" string *(SP string) ")"
2380 ;;
2381 ;; body-fld-lines = number
2382 ;;
2383 ;; body-fld-md5 = nstring
2384 ;;
2385 ;; body-fld-octets = number
2386 ;;
2387 ;; body-fld-param = "(" string SP string *(SP string SP string) ")" / nil
2388 ;;
2389 ;; body-type-1part = (body-type-basic / body-type-msg / body-type-text)
2390 ;; [SP body-ext-1part]
2391 ;;
2392 ;; body-type-basic = media-basic SP body-fields
2393 ;; ; MESSAGE subtype MUST NOT be "RFC822"
2394 ;;
2395 ;; body-type-msg = media-message SP body-fields SP envelope
2396 ;; SP body SP body-fld-lines
2397 ;;
2398 ;; body-type-text = media-text SP body-fields SP body-fld-lines
2399 ;;
2400 ;; body-type-mpart = 1*body SP media-subtype
2401 ;; [SP body-ext-mpart]
2402 ;;
2403 ;; media-basic = ((DQUOTE ("APPLICATION" / "AUDIO" / "IMAGE" /
2404 ;; "MESSAGE" / "VIDEO") DQUOTE) / string) SP media-subtype
2405 ;; ; Defined in [MIME-IMT]
2406 ;;
2407 ;; media-message = DQUOTE "MESSAGE" DQUOTE SP DQUOTE "RFC822" DQUOTE
2408 ;; ; Defined in [MIME-IMT]
2409 ;;
2410 ;; media-subtype = string
2411 ;; ; Defined in [MIME-IMT]
2412 ;;
2413 ;; media-text = DQUOTE "TEXT" DQUOTE SP media-subtype
2414 ;; ; Defined in [MIME-IMT]
2424 ;; buggy stalker communigate pro 3.0 insert a SPC between
2425 ;; parts in multiparts
2447 ;; next line for Sun SIMS bug
2457 ;; next `or' for Sun SIMS bug, it regard body-fld-enc as a
2458 ;; nstring and return nil instead of defaulting back to 7BIT
2459 ;; as the standard says.
2464 ;; ok, we're done parsing the required parts, what comes now is one
2465 ;; of three things:
2466 ;;
2467 ;; envelope (then we're parsing body-type-msg)
2468 ;; body-fld-lines (then we're parsing body-type-text)
2469 ;; body-ext-1part (then we're parsing body-type-basic)
2470 ;;
2471 ;; the problem is that the two first are in turn optionally followed
2472 ;; by the third. So we parse the first two here (if there are any)...
2481 ;; buggy stalker communigate pro 3.0 doesn't print
2482 ;; number of lines in message/rfc822 attachment
2492 ;; ...and then parse the third one here...
2507 '(
2508 imap-read-passwd
2509 imap-utf7-encode
2510 imap-utf7-decode
2511 imap-error-text
2512 imap-kerberos4s-p
2513 imap-kerberos4-open
2514 imap-ssl-p
2515 imap-ssl-open
2516 imap-network-p
2517 imap-network-open
2518 imap-interactive-login
2519 imap-kerberos4a-p
2520 imap-kerberos4-auth
2521 imap-cram-md5-p
2522 imap-cram-md5-auth
2523 imap-login-p
2524 imap-login-auth
2525 imap-anonymous-p
2526 imap-anonymous-auth
2527 imap-open-1
2528 imap-open
2529 imap-opened
2530 imap-authenticate
2531 imap-close
2532 imap-capability
2533 imap-namespace
2534 imap-send-command-wait
2535 imap-mailbox-put
2536 imap-mailbox-get
2537 imap-mailbox-map-1
2538 imap-mailbox-map
2539 imap-current-mailbox
2540 imap-current-mailbox-p-1
2541 imap-current-mailbox-p
2542 imap-mailbox-select-1
2543 imap-mailbox-select
2544 imap-mailbox-examine-1
2545 imap-mailbox-examine
2546 imap-mailbox-unselect
2547 imap-mailbox-expunge
2548 imap-mailbox-close
2549 imap-mailbox-create-1
2550 imap-mailbox-create
2551 imap-mailbox-delete
2552 imap-mailbox-rename
2553 imap-mailbox-lsub
2554 imap-mailbox-list
2555 imap-mailbox-subscribe
2556 imap-mailbox-unsubscribe
2557 imap-mailbox-status
2558 imap-mailbox-acl-get
2559 imap-mailbox-acl-set
2560 imap-mailbox-acl-delete
2561 imap-current-message
2562 imap-list-to-message-set
2563 imap-fetch-asynch
2564 imap-fetch
2565 imap-message-put
2566 imap-message-get
2567 imap-message-map
2568 imap-search
2569 imap-message-flag-permanent-p
2570 imap-message-flags-set
2571 imap-message-flags-del
2572 imap-message-flags-add
2573 imap-message-copyuid-1
2574 imap-message-copyuid
2575 imap-message-copy
2576 imap-message-appenduid-1
2577 imap-message-appenduid
2578 imap-message-append
2579 imap-body-lines
2580 imap-envelope-from
2581 imap-send-command-1
2582 imap-send-command
2583 imap-wait-for-tag
2584 imap-sentinel
2585 imap-find-next-line
2586 imap-arrival-filter
2587 imap-parse-greeting
2588 imap-parse-response
2589 imap-parse-resp-text
2590 imap-parse-resp-text-code
2591 imap-parse-data-list
2592 imap-parse-fetch
2593 imap-parse-status
2594 imap-parse-acl
2595 imap-parse-flag-list
2596 imap-parse-envelope
2597 imap-parse-body-extension
2598 imap-parse-body
2599 )))
2603 ;;; imap.el ends here