Debian Codegraph @

doc/html/imap/developer/guidance/special_chars.html

raw
1 <!DOCTYPE html>
2 <html class="writer-html5" lang="en" data-content_root="../../../">
3 <head>
4 <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
5
6 <meta name="viewport" content="width=device-width, initial-scale=1.0" />
7 <title>Cyrus IMAP Server: Special Characters &mdash; Cyrus IMAP 3.12.3 documentation</title>
8 <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=fa44fd50" />
9 <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=86f27845" />
10 <link rel="stylesheet" type="text/css" href="../../../_static/graphviz.css?v=eafc0fe6" />
11 <link rel="stylesheet" href="../../../_static/cyrus.css" type="text/css" />
12
13
14
15 <script src="../../../_static/jquery.js?v=8dae8fb0"></script>
16 <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
17 <script src="../../../_static/documentation_options.js?v=2c828074"></script>
18 <script src="../../../_static/doctools.js?v=888ff710"></script>
19 <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
20 <script src="../../../_static/js/theme.js"></script>
21 <link rel="index" title="Index" href="../../../genindex.html" />
22 <link rel="search" title="Search" href="../../../search.html" />
23 <link rel="next" title="Cyrus IMAP Server: var directory structure" href="var_directory_structure.html" />
24 <link rel="prev" title="Cyrus IMAP Server: Replication Protocol v2.4+" href="replication_protocol.html" />
25 </head>
26
27 <body class="wy-body-for-nav">
28 <div class="wy-grid-for-nav">
29 <nav data-toggle="wy-nav-shift" class="wy-nav-side">
30 <div class="wy-side-scroll">
31 <div class="wy-side-nav-search" >
32
33
34
35 <a href="../../../index.html" class="icon icon-home">
36 Cyrus IMAP
37 </a>
38 <div class="version">
39 3.12.3
40 </div>
41 <div role="search">
42 <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
43 <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
44 <input type="hidden" name="check_keywords" value="yes" />
45 <input type="hidden" name="area" value="default" />
46 </form>
47 </div>
48 </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
49 <p class="caption" role="heading"><span class="caption-text">Cyrus IMAP</span></p>
50 <ul class="current">
51 <li class="toctree-l1"><a class="reference internal" href="../../../download.html">Download</a></li>
52 <li class="toctree-l1"><a class="reference internal" href="../../../quickstart.html">Quickstart Guide</a></li>
53 <li class="toctree-l1"><a class="reference internal" href="../../../overview.html">Overview</a></li>
54 <li class="toctree-l1"><a class="reference internal" href="../../../setup.html">Setup</a></li>
55 <li class="toctree-l1"><a class="reference internal" href="../../../operations.html">Operations</a></li>
56 <li class="toctree-l1 current"><a class="reference internal" href="../../../developers.html">Developers</a><ul class="current">
57 <li class="toctree-l2"><a class="reference internal" href="../../../contribute.html">We need your help</a></li>
58 <li class="toctree-l2"><a class="reference internal" href="../documentation.html">Contribute docs</a></li>
59 <li class="toctree-l2"><a class="reference internal" href="../../developer.html">Contribute code and tests</a></li>
60 <li class="toctree-l2"><a class="reference internal" href="../cyrusworks.html">Cyrus.Works</a></li>
61 <li class="toctree-l2 current"><a class="reference internal" href="../../../developers.html#cyrus-internals">Cyrus Internals</a><ul class="current">
62 <li class="toctree-l3"><a class="reference internal" href="../API.html">Cyrus APIs</a></li>
63 <li class="toctree-l3"><a class="reference internal" href="../thoughts.html">Thoughts &amp; Notes</a></li>
64 <li class="toctree-l3 current"><a class="reference internal" href="../guidance.html">Guidance for Developers</a><ul class="current">
65 <li class="toctree-l4"><a class="reference internal" href="hacking.html">Cyrus IMAP Server: Hacking</a></li>
66 <li class="toctree-l4"><a class="reference internal" href="internationalization.html">Cyrus IMAP Server: Internationalization</a></li>
67 <li class="toctree-l4"><a class="reference internal" href="locking.html">Cyrus IMAP Server: Locking</a></li>
68 <li class="toctree-l4"><a class="reference internal" href="mailbox-format.html">Cyrus IMAP Server: Mailbox File Formats</a></li>
69 <li class="toctree-l4"><a class="reference internal" href="namelocks.html">Cyrus IMAP Server: Namelocks</a></li>
70 <li class="toctree-l4"><a class="reference internal" href="prot.html">Cyrus IMAP Server: prot layer</a></li>
71 <li class="toctree-l4"><a class="reference internal" href="replication_examples.html">Cyrus IMAP Server: Replication Examples</a></li>
72 <li class="toctree-l4"><a class="reference internal" href="replication_protocol.html">Cyrus IMAP Server: Replication Protocol v2.4+</a></li>
73 <li class="toctree-l4 current"><a class="current reference internal" href="#">Cyrus IMAP Server: Special Characters</a></li>
74 <li class="toctree-l4"><a class="reference internal" href="var_directory_structure.html">Cyrus IMAP Server: var directory structure</a></li>
75 </ul>
76 </li>
77 </ul>
78 </li>
79 <li class="toctree-l2"><a class="reference internal" href="../../../developers.html#unit-tests">Unit Tests</a></li>
80 </ul>
81 </li>
82 <li class="toctree-l1"><a class="reference internal" href="../../../support.html">Support/Community</a></li>
83 </ul>
84 <p class="caption" role="heading"><span class="caption-text">Cyrus SASL</span></p>
85 <ul>
86 <li class="toctree-l1"><a class="reference external" href="http://www.cyrusimap.org/sasl">Cyrus SASL</a></li>
87 </ul>
88
89 </div>
90 </div>
91 </nav>
92
93 <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
94 <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
95 <a href="../../../index.html">Cyrus IMAP</a>
96 </nav>
97
98 <div class="wy-nav-content">
99 <div class="rst-content">
100 <div role="navigation" aria-label="Page navigation">
101 <ul class="wy-breadcrumbs">
102 <li><a href="../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
103 <li class="breadcrumb-item"><a href="../../../developers.html">Developers</a></li>
104 <li class="breadcrumb-item"><a href="../guidance.html">Developer Guidance</a></li>
105 <li class="breadcrumb-item active">Cyrus IMAP Server: Special Characters</li>
106 <li class="wy-breadcrumbs-aside">
107 <a href="https://github.com/cyrusimap/cyrus-imapd/blob/master/docsrc/imap/developer/guidance/special_chars.rst" class="fa fa-github"> Edit on GitHub</a>
108 </li>
109 </ul>
110 <hr/>
111 </div>
112 <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
113 <div itemprop="articleBody">
114
115 <span class="target" id="imap-developer-guidance-special-chars"></span><section id="cyrus-imap-server-special-characters">
116 <h1>Cyrus IMAP Server: Special Characters<a class="headerlink" href="#cyrus-imap-server-special-characters" title="Link to this heading"></a></h1>
117 <p>This document is supposed to be a repository of &quot;special characters&quot;
118 used in Cyrus naming of users, folders, directory paths, etc.</p>
119 <section id="current-uses">
120 <h2>Current Uses<a class="headerlink" href="#current-uses" title="Link to this heading"></a></h2>
121 <div class="line-block">
122 <div class="line"><br /></div>
123 <div class="line">Character: +</div>
124 </div>
125 <ul class="simple">
126 <li><p>(LMTP) Separation of postuser and target mailbox for delivery</p></li>
127 <li><p>(LMTP) Separation of username and submailbox for delivery</p></li>
128 <li><p>(IMAP) Flag at end of login name that indicates that LIST should
129 return LSUB results (when imapmagicplus is set)</p></li>
130 <li><p>(POP3) POP a subfolder directly (e.g. rjs3+foo POPs user.rjs3.foo)</p></li>
131 </ul>
132 <div class="line-block">
133 <div class="line"><br /></div>
134 <div class="line">Character: . /</div>
135 </div>
136 <ul class="simple">
137 <li><p>[mailbox names] Hierarchy separators</p></li>
138 </ul>
139 <div class="line-block">
140 <div class="line"><br /></div>
141 <div class="line">Character: ^</div>
142 </div>
143 <ul class="simple">
144 <li><p>[mailbox names] In unixhierarchysep, ^ is the part of the internal
145 name that represents a '.'</p></li>
146 </ul>
147 <div class="line-block">
148 <div class="line"><br /></div>
149 <div class="line">Characters: &#64; %</div>
150 </div>
151 <ul class="simple">
152 <li><p>[usernames] These are realm separators for the purposes of
153 authentication</p></li>
154 </ul>
155 <div class="line-block">
156 <div class="line"><br /></div>
157 </div>
158 </section>
159 <section id="future-uses">
160 <h2>Future Uses<a class="headerlink" href="#future-uses" title="Link to this heading"></a></h2>
161 <div class="line-block">
162 <div class="line">Character: +</div>
163 </div>
164 <ul class="simple">
165 <li><p>IMAP LIST filters (e.g. rjs3+foo will only list folders that match
166 foo*)</p></li>
167 <li><p>possibly other interpretations here:
168 - rjs3+foo will do an effective chroot(foo.)
169 - rjs3+foo will only list folders in user.rjs3.foo*</p></li>
170 </ul>
171 </section>
172 </section>
173
174
175 </div>
176 </div>
177 <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
178 <a href="replication_protocol.html" class="btn btn-neutral float-left" title="Cyrus IMAP Server: Replication Protocol v2.4+" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
179 <a href="var_directory_structure.html" class="btn btn-neutral float-right" title="Cyrus IMAP Server: var directory structure" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
180 </div>
181
182 <hr/>
183
184 <div role="contentinfo">
185 <p>&#169; Copyright 1993–2026, The Cyrus Team.</p>
186 </div>
187
188 Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
189 <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
190 provided by <a href="https://readthedocs.org">Read the Docs</a>.
191
192
193 </footer>
194 </div>
195 </div>
196 </section>
197 </div>
198 <script>
199 jQuery(function () {
200 SphinxRtdTheme.Navigation.enable(true);
201 });
202 </script>
203
204
205
206
207 </body>
208 </html>