| rev |
line source |
|
yuuji@0
|
1 /* ========================================================================
|
|
yuuji@0
|
2 * Copyright 1988-2006 University of Washington
|
|
yuuji@0
|
3 *
|
|
yuuji@0
|
4 * Licensed under the Apache License, Version 2.0 (the "License");
|
|
yuuji@0
|
5 * you may not use this file except in compliance with the License.
|
|
yuuji@0
|
6 * You may obtain a copy of the License at
|
|
yuuji@0
|
7 *
|
|
yuuji@0
|
8 * http://www.apache.org/licenses/LICENSE-2.0
|
|
yuuji@0
|
9 *
|
|
yuuji@0
|
10 *
|
|
yuuji@0
|
11 * ========================================================================
|
|
yuuji@0
|
12 */
|
|
yuuji@0
|
13
|
|
yuuji@0
|
14 Mailbox Name Conventions
|
|
yuuji@0
|
15 Mark Crispin
|
|
yuuji@0
|
16 5 October 2005
|
|
yuuji@0
|
17
|
|
yuuji@0
|
18
|
|
yuuji@0
|
19 Please refer to the file drivers.txt for related information.
|
|
yuuji@0
|
20
|
|
yuuji@0
|
21
|
|
yuuji@0
|
22 I. Special names
|
|
yuuji@0
|
23
|
|
yuuji@0
|
24 Special names appear by themselves.
|
|
yuuji@0
|
25
|
|
yuuji@0
|
26 I.a. INBOX
|
|
yuuji@0
|
27
|
|
yuuji@0
|
28 The name INBOX is special and refers to primary incoming message
|
|
yuuji@0
|
29 mailbox on the local system.
|
|
yuuji@0
|
30
|
|
yuuji@0
|
31
|
|
yuuji@0
|
32 I.b. #mhinbox (UNIX only)
|
|
yuuji@0
|
33
|
|
yuuji@0
|
34 The name #mhinbox is special and refers to the primary incoming mh
|
|
yuuji@0
|
35 format mailbox on the local system. Don't worry about this if you
|
|
yuuji@0
|
36 don't know what mh format is.
|
|
yuuji@0
|
37
|
|
yuuji@0
|
38
|
|
yuuji@0
|
39 II. Special prefixes
|
|
yuuji@0
|
40
|
|
yuuji@0
|
41 All names which start with a "#" have a "special prefix" which
|
|
yuuji@0
|
42 identifies an alternative namespace. Special prefixes appear in front
|
|
yuuji@0
|
43 of some additional text which constitutes a suffix.
|
|
yuuji@0
|
44
|
|
yuuji@0
|
45 II.a. #mh/ (UNIX only)
|
|
yuuji@0
|
46
|
|
yuuji@0
|
47 The prefix #mh/ is special and refers to the mh format mailbox named
|
|
yuuji@0
|
48 with the suffix. For example, #mh/foo refers to the mh format mailbox
|
|
yuuji@0
|
49 named foo. Don't worry about this if you don't know what mh format is.
|
|
yuuji@0
|
50
|
|
yuuji@0
|
51
|
|
yuuji@0
|
52 II.b. #news. (UNIX only)
|
|
yuuji@0
|
53
|
|
yuuji@0
|
54 The prefix #news. is special and refers to the newsgroup named with
|
|
yuuji@0
|
55 the suffix. For example, #news.comp.mail.misc refers to the newsgroup
|
|
yuuji@0
|
56 named comp.mail.misc.
|
|
yuuji@0
|
57
|
|
yuuji@0
|
58
|
|
yuuji@0
|
59 II.c. #ftp/ (UNIX only)
|
|
yuuji@0
|
60
|
|
yuuji@0
|
61 The prefix #ftp/ is special and refers to the anonymous ftp filesystem
|
|
yuuji@0
|
62 named with the suffix. For example, #ftp/foo/bar refers to the file
|
|
yuuji@0
|
63 /foo/bar in the anonymous FTP filesystem. Anonymous FTP files are
|
|
yuuji@0
|
64 available to anonymous IMAP logins.
|
|
yuuji@0
|
65
|
|
yuuji@0
|
66
|
|
yuuji@0
|
67 II.d. #public/ (UNIX only)
|
|
yuuji@0
|
68
|
|
yuuji@0
|
69 The prefix #public/ is special and refers to the public files
|
|
yuuji@0
|
70 filesystem named with the suffix. For example, #public/foo/bar refers
|
|
yuuji@0
|
71 to the file /foo/bar in the public filesystem. Public files are
|
|
yuuji@0
|
72 available to anonymous IMAP logins.
|
|
yuuji@0
|
73
|
|
yuuji@0
|
74
|
|
yuuji@0
|
75 II.e. #shared/ (UNIX only)
|
|
yuuji@0
|
76
|
|
yuuji@0
|
77 The prefix #shared/ is special and refers to the shared files
|
|
yuuji@0
|
78 filesystem named with the suffix. For example, #shared/foo/bar
|
|
yuuji@0
|
79 frefers to the file /foo/bar in the shared filesystem.
|
|
yuuji@0
|
80
|
|
yuuji@0
|
81
|
|
yuuji@0
|
82 III. Remote names
|
|
yuuji@0
|
83
|
|
yuuji@0
|
84 All names which start with "{" are remote names, and are in the form
|
|
yuuji@0
|
85 "{" remote_system_name [":" port] [flags] "}" [mailbox_name]
|
|
yuuji@0
|
86 where:
|
|
yuuji@0
|
87 remote_system_name Internet domain name or bracketed IP address
|
|
yuuji@0
|
88 of server.
|
|
yuuji@0
|
89 port optional TCP port number, default is the
|
|
yuuji@0
|
90 default port for that service
|
|
yuuji@0
|
91 flags optional flags, one of the following:
|
|
yuuji@0
|
92 "/service=" service mailbox access service, default is "imap"
|
|
yuuji@0
|
93 "/user=" user remote user name for login on the server
|
|
yuuji@0
|
94 "/authuser=" user remote authentication user; if specified this
|
|
yuuji@0
|
95 is the user name whose password is used (e.g.
|
|
yuuji@0
|
96 administrator)
|
|
yuuji@0
|
97 "/anonymous" remote access as anonymous user
|
|
yuuji@0
|
98 "/debug" record protocol telemetry in application's
|
|
yuuji@0
|
99 debug log
|
|
yuuji@0
|
100 "/secure" do not transmit a plaintext password over
|
|
yuuji@0
|
101 the network
|
|
yuuji@0
|
102 "/imap", "/imap2", "/imap2bis", "/imap4", "/imap4rev1"
|
|
yuuji@0
|
103 equivalent to /service=imap
|
|
yuuji@0
|
104 "/pop3" equivalent to /service=pop3
|
|
yuuji@0
|
105 "/nntp" equivalent to /service=nntp
|
|
yuuji@0
|
106 "/norsh" do not use rsh or ssh to establish a preauthenticated
|
|
yuuji@0
|
107 IMAP session
|
|
yuuji@0
|
108 "/ssl" use the Secure Socket Layer to encrypt the session
|
|
yuuji@0
|
109 "/validate-cert" validate certificates from TLS/SSL server (this is the
|
|
yuuji@0
|
110 default behavior)
|
|
yuuji@0
|
111 "/novalidate-cert" do not validate certificates from TLS/SSL server,
|
|
yuuji@0
|
112 needed if server uses self-signed certificates
|
|
yuuji@0
|
113 "/tls" force use of start-TLS to encrypt the session, and
|
|
yuuji@0
|
114 reject connection to servers that do not support it
|
|
yuuji@0
|
115 "/tls-sslv23" use the depreciated SSLv23 client when negotiating
|
|
yuuji@0
|
116 TLS to the server. This is necessary with some
|
|
yuuji@0
|
117 broken servers which (incorrectly) think that TLS
|
|
yuuji@0
|
118 is just another way of doing SSL.
|
|
yuuji@0
|
119 "/notls" do not do start-TLS to encrypt the session, even
|
|
yuuji@0
|
120 with servers that support it
|
|
yuuji@0
|
121 "/readonly" request read-only mailbox open (IMAP only; ignored
|
|
yuuji@0
|
122 on NNTP, and an error with SMTP and POP3)
|
|
yuuji@0
|
123 "/loser" disable various protocol features and perform various
|
|
yuuji@0
|
124 client-side workarounds; for example, it disables
|
|
yuuji@0
|
125 the SEARCH command in IMAP and does client-side
|
|
yuuji@0
|
126 searching instead. The precise measures taken by
|
|
yuuji@0
|
127 /loser depend upon the protocol and are subject to
|
|
yuuji@0
|
128 change over time. /loser is intended for use with
|
|
yuuji@0
|
129 defective servers which do not implement the
|
|
yuuji@0
|
130 protocol specification correctly. It should be used
|
|
yuuji@0
|
131 only as a last resort since it will seriously
|
|
yuuji@0
|
132 degrade performance.
|
|
yuuji@0
|
133 mailbox_name remote mailbox name, default is INBOX
|
|
yuuji@0
|
134
|
|
yuuji@0
|
135 For example:
|
|
yuuji@0
|
136 {imap.foo.com}INBOX
|
|
yuuji@0
|
137 opens an IMAP connection to system imap.foo.com and selects INBOX.
|
|
yuuji@0
|
138
|
|
yuuji@0
|
139
|
|
yuuji@0
|
140 IV. All other names
|
|
yuuji@0
|
141
|
|
yuuji@0
|
142 All other names are treated as local file names, relative to the
|
|
yuuji@0
|
143 user's home directory. Read drivers.txt for more details.
|
