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