1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/docs/naming.txt	Mon Sep 14 15:17:45 2009 +0900
     1.3 @@ -0,0 +1,143 @@
     1.4 +/* ========================================================================
     1.5 + * Copyright 1988-2006 University of Washington
     1.6 + *
     1.7 + * Licensed under the Apache License, Version 2.0 (the "License");
     1.8 + * you may not use this file except in compliance with the License.
     1.9 + * You may obtain a copy of the License at
    1.10 + *
    1.11 + *     http://www.apache.org/licenses/LICENSE-2.0
    1.12 + *
    1.13 + * 
    1.14 + * ========================================================================
    1.15 + */
    1.16 +
    1.17 +		       Mailbox Name Conventions
    1.18 +			     Mark Crispin
    1.19 +			    5 October 2005
    1.20 +
    1.21 +
    1.22 +Please refer to the file drivers.txt for related information.
    1.23 +
    1.24 +
    1.25 +I. Special names
    1.26 +
    1.27 +Special names appear by themselves.
    1.28 +
    1.29 +I.a. INBOX
    1.30 +
    1.31 +The name INBOX is special and refers to primary incoming message
    1.32 +mailbox on the local system.
    1.33 +
    1.34 +
    1.35 +I.b. #mhinbox (UNIX only)
    1.36 +
    1.37 +The name #mhinbox is special and refers to the primary incoming mh
    1.38 +format mailbox on the local system.  Don't worry about this if you
    1.39 +don't know what mh format is.
    1.40 +
    1.41 +
    1.42 +II.  Special prefixes
    1.43 +
    1.44 +All names which start with a "#" have a "special prefix" which
    1.45 +identifies an alternative namespace.  Special prefixes appear in front
    1.46 +of some additional text which constitutes a suffix.
    1.47 +
    1.48 +II.a. #mh/ (UNIX only)
    1.49 +
    1.50 +The prefix #mh/ is special and refers to the mh format mailbox named
    1.51 +with the suffix.  For example, #mh/foo refers to the mh format mailbox
    1.52 +named foo.  Don't worry about this if you don't know what mh format is.
    1.53 +
    1.54 +
    1.55 +II.b. #news. (UNIX only)
    1.56 +
    1.57 +The prefix #news. is special and refers to the newsgroup named with
    1.58 +the suffix.  For example, #news.comp.mail.misc refers to the newsgroup
    1.59 +named comp.mail.misc.
    1.60 +
    1.61 +
    1.62 +II.c. #ftp/ (UNIX only)
    1.63 +
    1.64 +The prefix #ftp/ is special and refers to the anonymous ftp filesystem
    1.65 +named with the suffix.  For example, #ftp/foo/bar refers to the file
    1.66 +/foo/bar in the anonymous FTP filesystem.  Anonymous FTP files are
    1.67 +available to anonymous IMAP logins.
    1.68 +
    1.69 +
    1.70 +II.d. #public/ (UNIX only)
    1.71 +
    1.72 +The prefix #public/ is special and refers to the public files
    1.73 +filesystem named with the suffix.  For example, #public/foo/bar refers
    1.74 +to the file /foo/bar in the public filesystem.  Public files are
    1.75 +available to anonymous IMAP logins.
    1.76 +
    1.77 +
    1.78 +II.e. #shared/ (UNIX only)
    1.79 +
    1.80 +The prefix #shared/ is special and refers to the shared files
    1.81 +filesystem named with the suffix.  For example, #shared/foo/bar
    1.82 +frefers to the file /foo/bar in the shared filesystem.
    1.83 +
    1.84 +
    1.85 +III. Remote names
    1.86 +
    1.87 +All names which start with "{" are remote names, and are in the form
    1.88 +	"{" remote_system_name [":" port] [flags] "}" [mailbox_name]
    1.89 +where:
    1.90 + remote_system_name	Internet domain name or bracketed IP address
    1.91 +			 of server.
    1.92 + port			optional TCP port number, default is the
    1.93 +			 default port for that service		
    1.94 + flags			optional flags, one of the following:
    1.95 +  "/service=" service	mailbox access service, default is "imap"
    1.96 +  "/user=" user		remote user name for login on the server
    1.97 +  "/authuser=" user	remote authentication user; if specified this
    1.98 +			 is the user name whose password is used (e.g.
    1.99 +			 administrator)
   1.100 +  "/anonymous"		remote access as anonymous user
   1.101 +  "/debug"		record protocol telemetry in application's
   1.102 +			 debug log
   1.103 +  "/secure"		do not transmit a plaintext password over
   1.104 +			 the network
   1.105 +  "/imap", "/imap2", "/imap2bis", "/imap4", "/imap4rev1"
   1.106 +			equivalent to /service=imap
   1.107 +  "/pop3"		equivalent to /service=pop3
   1.108 +  "/nntp"		equivalent to /service=nntp
   1.109 +  "/norsh"		do not use rsh or ssh to establish a preauthenticated
   1.110 +			 IMAP session
   1.111 +  "/ssl"		use the Secure Socket Layer to encrypt the session
   1.112 +  "/validate-cert"	validate certificates from TLS/SSL server (this is the
   1.113 +			 default behavior)
   1.114 +  "/novalidate-cert"	do not validate certificates from TLS/SSL server,
   1.115 +			 needed if server uses self-signed certificates
   1.116 +  "/tls"		force use of start-TLS to encrypt the session, and
   1.117 +			 reject connection to servers that do not support it
   1.118 +  "/tls-sslv23"		use the depreciated SSLv23 client when negotiating
   1.119 +			 TLS to the server.  This is necessary with some
   1.120 +			 broken servers which (incorrectly) think that TLS
   1.121 +			 is just another way of doing SSL.
   1.122 +  "/notls"		do not do start-TLS to encrypt the session, even
   1.123 +			 with servers that support it
   1.124 +  "/readonly"		request read-only mailbox open (IMAP only; ignored
   1.125 +			 on NNTP, and an error with SMTP and POP3)
   1.126 +  "/loser"		disable various protocol features and perform various
   1.127 +			 client-side workarounds; for example, it disables
   1.128 +			 the SEARCH command in IMAP and does client-side
   1.129 +			 searching instead.  The precise measures taken by
   1.130 +			 /loser depend upon the protocol and are subject to
   1.131 +			 change over time.  /loser is intended for use with
   1.132 +			 defective servers which do not implement the
   1.133 +			 protocol specification correctly.  It should be used
   1.134 +			 only as a last resort since it will seriously
   1.135 +			 degrade performance.
   1.136 + mailbox_name		remote mailbox name, default is INBOX
   1.137 +
   1.138 +For example:
   1.139 +	{imap.foo.com}INBOX
   1.140 +opens an IMAP connection to system imap.foo.com and selects INBOX.
   1.141 +
   1.142 +
   1.143 +IV. All other names
   1.144 +
   1.145 +All other names are treated as local file names, relative to the
   1.146 +user's home directory.  Read drivers.txt for more details.