| 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>Virtual Domains — 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="Mailbox Annotations (METADATA)" href="mailbox-annotations.html" /> |
| 24 |
<link rel="prev" title="Mailbox Namespaces" href="namespaces.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 current"><a class="reference internal" href="../../../overview.html">Overview</a><ul class="current"> |
| 54 |
<li class="toctree-l2 current"><a class="reference internal" href="../features.html">Features</a><ul class="current"> |
| 55 |
<li class="toctree-l3"><a class="reference internal" href="../features.html#security-and-authentication">Security and Authentication</a></li> |
| 56 |
<li class="toctree-l3 current"><a class="reference internal" href="../features.html#mailbox-management">Mailbox Management</a><ul class="current"> |
| 57 |
<li class="toctree-l4"><a class="reference internal" href="automatic-creation-of-mailboxes.html">Automatic Creation of Mailboxes</a></li> |
| 58 |
<li class="toctree-l4"><a class="reference internal" href="namespaces.html">Mailbox Namespaces</a></li> |
| 59 |
<li class="toctree-l4 current"><a class="current reference internal" href="#">Virtual Domains</a></li> |
| 60 |
<li class="toctree-l4"><a class="reference internal" href="mailbox-annotations.html">Mailbox Annotations (METADATA)</a></li> |
| 61 |
<li class="toctree-l4"><a class="reference internal" href="mailbox-distribution.html">Mailbox Distribution</a></li> |
| 62 |
</ul> |
| 63 |
</li> |
| 64 |
<li class="toctree-l3"><a class="reference internal" href="../features.html#message-management">Message Management</a></li> |
| 65 |
<li class="toctree-l3"><a class="reference internal" href="../features.html#calendar-and-contact-dav-collection-management">Calendar and Contact (DAV) Collection Management</a></li> |
| 66 |
<li class="toctree-l3"><a class="reference internal" href="../features.html#storage">Storage</a></li> |
| 67 |
<li class="toctree-l3"><a class="reference internal" href="../features.html#load-management">Load Management</a></li> |
| 68 |
</ul> |
| 69 |
</li> |
| 70 |
<li class="toctree-l2"><a class="reference internal" href="../overview_and_concepts.html">Concepts</a></li> |
| 71 |
</ul> |
| 72 |
</li> |
| 73 |
<li class="toctree-l1"><a class="reference internal" href="../../../setup.html">Setup</a></li> |
| 74 |
<li class="toctree-l1"><a class="reference internal" href="../../../operations.html">Operations</a></li> |
| 75 |
<li class="toctree-l1"><a class="reference internal" href="../../../developers.html">Developers</a></li> |
| 76 |
<li class="toctree-l1"><a class="reference internal" href="../../../support.html">Support/Community</a></li> |
| 77 |
</ul> |
| 78 |
<p class="caption" role="heading"><span class="caption-text">Cyrus SASL</span></p> |
| 79 |
<ul> |
| 80 |
<li class="toctree-l1"><a class="reference external" href="http://www.cyrusimap.org/sasl">Cyrus SASL</a></li> |
| 81 |
</ul> |
| 82 |
|
| 83 |
</div> |
| 84 |
</div> |
| 85 |
</nav> |
| 86 |
|
| 87 |
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > |
| 88 |
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| 89 |
<a href="../../../index.html">Cyrus IMAP</a> |
| 90 |
</nav> |
| 91 |
|
| 92 |
<div class="wy-nav-content"> |
| 93 |
<div class="rst-content"> |
| 94 |
<div role="navigation" aria-label="Page navigation"> |
| 95 |
<ul class="wy-breadcrumbs"> |
| 96 |
<li><a href="../../../index.html" class="icon icon-home" aria-label="Home"></a></li> |
| 97 |
<li class="breadcrumb-item"><a href="../../../overview.html">Overview</a></li> |
| 98 |
<li class="breadcrumb-item"><a href="../features.html">Features</a></li> |
| 99 |
<li class="breadcrumb-item active">Virtual Domains</li> |
| 100 |
<li class="wy-breadcrumbs-aside"> |
| 101 |
<a href="https://github.com/cyrusimap/cyrus-imapd/blob/master/docsrc/imap/concepts/features/virtual-domains.rst" class="fa fa-github"> Edit on GitHub</a> |
| 102 |
</li> |
| 103 |
</ul> |
| 104 |
<hr/> |
| 105 |
</div> |
| 106 |
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| 107 |
<div itemprop="articleBody"> |
| 108 |
|
| 109 |
<section id="virtual-domains"> |
| 110 |
<h1>Virtual Domains<a class="headerlink" href="#virtual-domains" title="Link to this heading"></a></h1> |
| 111 |
<section id="what-are-virtual-domains"> |
| 112 |
<h2>What are virtual domains?<a class="headerlink" href="#what-are-virtual-domains" title="Link to this heading"></a></h2> |
| 113 |
<p>Virtual domains means hosting a service for more than one |
| 114 |
domain on a single server. Cyrus IMAP has the ability to host IMAP/POP |
| 115 |
mailboxes for multiple domains (for example: <code class="docutils literal notranslate"><span class="pre">test@cyrusisgreat.org</span></code> and |
| 116 |
<code class="docutils literal notranslate"><span class="pre">test@ilovecyrus.com</span></code>) on a single server or Murder.</p> |
| 117 |
<p>Cyrus needs to know which domain to use when a mailbox is accessed. |
| 118 |
There are two ways in which Cyrus can determine the domain:</p> |
| 119 |
<dl class="simple"> |
| 120 |
<dt>Fully qualified userid</dt><dd><p>The client logs in with a userid |
| 121 |
containing the domain in which the user belongs (for example: |
| 122 |
<code class="docutils literal notranslate"><span class="pre">test@cyrusisgreat.org</span></code> or <code class="docutils literal notranslate"><span class="pre">test@ilovecyrus.com</span></code>)</p> |
| 123 |
</dd> |
| 124 |
<dt>IP address</dt><dd><p>The server looks up the domain based on the IP |
| 125 |
address of the receiving interface (useful for servers with multiple |
| 126 |
NICs or those using IP aliasing)</p> |
| 127 |
</dd> |
| 128 |
</dl> |
| 129 |
<p>If the <code class="docutils literal notranslate"><span class="pre">virtdomains</span></code> option is set to <code class="docutils literal notranslate"><span class="pre">off</span></code> (or <code class="docutils literal notranslate"><span class="pre">no</span></code>, <code class="docutils literal notranslate"><span class="pre">0</span></code>, <code class="docutils literal notranslate"><span class="pre">false</span></code>), |
| 130 |
Cyrus does not know or care about domains, and only ever considers the local |
| 131 |
part of email addresses. This configuration is never recommended, but is |
| 132 |
currently the default.</p> |
| 133 |
<p>If the <code class="docutils literal notranslate"><span class="pre">virtdomains</span></code> option is set to <code class="docutils literal notranslate"><span class="pre">userid</span></code>, then only the |
| 134 |
fully qualified userid is used. This is the only recommended configuration |
| 135 |
for new deployments, and in the future may become the default or only option. |
| 136 |
Existing deployments should strongly consider migrating towards this |
| 137 |
configuration.</p> |
| 138 |
<p>If the <code class="docutils literal notranslate"><span class="pre">virtdomains</span></code> option is set to <code class="docutils literal notranslate"><span class="pre">on</span></code> (or <code class="docutils literal notranslate"><span class="pre">yes</span></code>, <code class="docutils literal notranslate"><span class="pre">1</span></code>, <code class="docutils literal notranslate"><span class="pre">true</span></code>), |
| 139 |
Cyrus uses both mechanisms to work out the domain (with the fully qualified |
| 140 |
userid taking precedence). This configuration is not recommended.</p> |
| 141 |
<div class="admonition note"> |
| 142 |
<p class="admonition-title">Note</p> |
| 143 |
<p>If you are providing calendaring services, you MUST use the |
| 144 |
<code class="docutils literal notranslate"><span class="pre">virtdomains:</span> <span class="pre">userid</span></code> configuration. Calendaring services require |
| 145 |
a consistent single authoritative fully-qualified email address for |
| 146 |
each user in order to function, and this is the only configuration |
| 147 |
that provides it.</p> |
| 148 |
<p>The <code class="docutils literal notranslate"><span class="pre">virtdomains:</span> <span class="pre">off</span></code> and <code class="docutils literal notranslate"><span class="pre">virtdomains:</span> <span class="pre">on</span></code> configurations both |
| 149 |
allow users' domains to be changed from outside of Cyrus without Cyrus |
| 150 |
knowing about it, which fundamentally breaks calendaring. These |
| 151 |
configurations are only suitable for IMAP-only deployments.</p> |
| 152 |
</div> |
| 153 |
</section> |
| 154 |
<section id="concepts"> |
| 155 |
<h2>Concepts<a class="headerlink" href="#concepts" title="Link to this heading"></a></h2> |
| 156 |
<dl> |
| 157 |
<dt>Everyone is in a domain</dt><dd><p>It's best to think of every user as existing inside a domain. Unqualified users are technically inside the <code class="docutils literal notranslate"><span class="pre">defaultdomain</span></code>.</p> |
| 158 |
</dd> |
| 159 |
<dt>Names can be qualified</dt><dd><p>Global admins can reference mailboxes and IDs by qualified names. That is, for any given mailbox command, you can add <code class="docutils literal notranslate"><span class="pre">@domain</span></code> to the end of the mailbox name.</p> |
| 160 |
<p>Here are some examples:</p> |
| 161 |
<blockquote> |
| 162 |
<div><ul class="simple"> |
| 163 |
<li><p><code class="docutils literal notranslate"><span class="pre">cyradm></span> <span class="pre">create</span> <span class="pre">user/lukecage@example.net</span></code> - create a user</p></li> |
| 164 |
<li><p><code class="docutils literal notranslate"><span class="pre">cyradm></span> <span class="pre">create</span> <span class="pre">user/mercedesknight@example.net</span></code> - create another user</p></li> |
| 165 |
<li><p><code class="docutils literal notranslate"><span class="pre">cyradm></span> <span class="pre">setquota</span> <span class="pre">user/lukecage@example.net</span> <span class="pre">50000</span></code> - define a quota</p></li> |
| 166 |
<li><p><code class="docutils literal notranslate"><span class="pre">cyradm></span> <span class="pre">setaclmailbox</span> <span class="pre">user/lukecage@example.net</span> <span class="pre">mercedesknight@example.net</span> <span class="pre">read</span></code> - give Mercedes Knight read access to Luke Cage's mailbox</p></li> |
| 167 |
<li><p><code class="docutils literal notranslate"><span class="pre">cyradm></span> <span class="pre">listmailbox</span> <span class="pre">*@example.net</span></code> - list all mailboxes in the example.net domain</p></li> |
| 168 |
</ul> |
| 169 |
</div></blockquote> |
| 170 |
</dd> |
| 171 |
</dl> |
| 172 |
<p>Each mailbox exists in only one domain</p> |
| 173 |
<dl> |
| 174 |
<dt>Domains are mutually exclusive</dt><dd><p>Users only have access to mailboxes within their own domain (intra-domain). The following |
| 175 |
example will not work: <code class="docutils literal notranslate"><span class="pre">setacl</span> <span class="pre">user/mercedesknight@herdomain.com</span> |
| 176 |
<span class="pre">lukecage@hisdomain.com</span> <span class="pre">read</span></code>.</p> |
| 177 |
</dd> |
| 178 |
<dt>Global and Domain admins</dt><dd><p>The Cyrus virtual domains |
| 179 |
implementation supports per-domain administrators as well as |
| 180 |
global (inter-domain) administrators.</p> |
| 181 |
<p>Domain-specific administrators are specified with a fully qualified userid in the |
| 182 |
<code class="docutils literal notranslate"><span class="pre">admins</span></code> option (e.g., <code class="docutils literal notranslate"><span class="pre">admin@example.net</span></code>) and only |
| 183 |
have access to mailboxes in the associated domain.</p> |
| 184 |
<p>Global administrators are specified with unqualified userids.</p> |
| 185 |
</dd> |
| 186 |
</dl> |
| 187 |
<p>MOST OF THIS SHOULD BE IN DEPLOYMENT GUIDE?</p> |
| 188 |
</section> |
| 189 |
<section id="quick-start"> |
| 190 |
<h2>Quick Start<a class="headerlink" href="#quick-start" title="Link to this heading"></a></h2> |
| 191 |
<ul class="simple"> |
| 192 |
<li><p>Add <code class="docutils literal notranslate"><span class="pre">virtdomains:</span> <span class="pre">userid</span></code> to <a class="reference internal" href="../../reference/manpages/configs/imapd.conf.html#std-cyrusman-imapd.conf-5">imapd.conf(5)</a></p></li> |
| 193 |
<li><p>Add a <code class="docutils literal notranslate"><span class="pre">defaultdomain</span></code> entry to <a class="reference internal" href="../../reference/manpages/configs/imapd.conf.html#std-cyrusman-imapd.conf-5">imapd.conf(5)</a></p></li> |
| 194 |
<li><p>Use cyradm (as a global or domain admin) to create mailboxes for each domain.</p></li> |
| 195 |
</ul> |
| 196 |
</section> |
| 197 |
<section id="configuration"> |
| 198 |
<h2>Configuration<a class="headerlink" href="#configuration" title="Link to this heading"></a></h2> |
| 199 |
<p>Support for virtual domains is enabled by turning on the <code class="docutils literal notranslate"><span class="pre">virtdomains</span></code> option in <a class="reference internal" href="../../reference/manpages/configs/imapd.conf.html#std-cyrusman-imapd.conf-5">imapd.conf(5)</a>.</p> |
| 200 |
<p>When upgrading from a single domain installation to a virtual |
| 201 |
domain installation, the name of the existing domain (domain of the |
| 202 |
server hostname) should be specified using the <code class="docutils literal notranslate"><span class="pre">defaultdomain</span></code> |
| 203 |
option in <a class="reference internal" href="../../reference/manpages/configs/imapd.conf.html#std-cyrusman-imapd.conf-5">imapd.conf(5)</a>. This allows users to continue to |
| 204 |
access their mailboxes using unqualified userids. For example, if the |
| 205 |
primary IP address on your server resolves to 'www.xxx.yyy.zzz', |
| 206 |
then set <code class="docutils literal notranslate"><span class="pre">defaultdomain</span></code> to 'xxx.yyy.zzz'.</p> |
| 207 |
<p>Even for new installations, set the <code class="docutils literal notranslate"><span class="pre">defaultdomain</span></code> to the "real" |
| 208 |
domain of the server (domain of its primary hostname). |
| 209 |
See <a class="reference internal" href="#administrators">Administrators</a> for further discussion.</p> |
| 210 |
<p>Here is a sample <code class="docutils literal notranslate"><span class="pre">imapd.conf</span></code> with a minimal set of configuration |
| 211 |
options:</p> |
| 212 |
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">configdirectory</span><span class="p">:</span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">imap</span> |
| 213 |
<span class="n">partition</span><span class="o">-</span><span class="n">default</span><span class="p">:</span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">spool</span><span class="o">/</span><span class="n">cyrus</span> |
| 214 |
<span class="n">admins</span><span class="p">:</span> <span class="n">admin</span> <span class="n">lukecage</span><span class="o">.</span><span class="n">admin</span><span class="nd">@hisdomain</span><span class="o">.</span><span class="n">com</span> <span class="n">mercedesknight</span><span class="o">.</span><span class="n">admin</span><span class="nd">@herdomain</span><span class="o">.</span><span class="n">net</span> |
| 215 |
<span class="n">virtdomains</span><span class="p">:</span> <span class="n">yes</span> |
| 216 |
<span class="n">defaultdomain</span><span class="p">:</span> <span class="n">exampleisp</span><span class="o">.</span><span class="n">net</span> |
| 217 |
</pre></div> |
| 218 |
</div> |
| 219 |
<p>This example has three domains: exampleisp.net, hisdomain.com, and |
| 220 |
herdomain.net. <code class="docutils literal notranslate"><span class="pre">admin</span></code> can administer all three domains, while |
| 221 |
<code class="docutils literal notranslate"><span class="pre">lukecage.admin@hisdomain.com</span></code> and |
| 222 |
<code class="docutils literal notranslate"><span class="pre">mercedesknight.admin@herdomain.net</span></code> can only administer their respective |
| 223 |
domains.</p> |
| 224 |
<p>Everyday users should not be administrators. In the |
| 225 |
above example, Mercedes Knight and Luke Cage have separate administrative accounts for |
| 226 |
their domains.</p> |
| 227 |
<section id="multiple-ip-addresses"> |
| 228 |
<h3>Multiple IP Addresses<a class="headerlink" href="#multiple-ip-addresses" title="Link to this heading"></a></h3> |
| 229 |
<p>In order to use a multiple IP address configuration, the server must |
| 230 |
be able to do a reverse lookup on the IP address to determine the |
| 231 |
hostname of the receiving interface. For example:</p> |
| 232 |
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mf">192.168.0.1</span> <span class="o">-></span> <span class="n">mail</span><span class="o">.</span><span class="n">example</span><span class="o">.</span><span class="n">com</span> |
| 233 |
<span class="mf">192.168.0.2</span> <span class="o">-></span> <span class="n">mail</span><span class="o">.</span><span class="n">example</span><span class="o">.</span><span class="n">net</span> |
| 234 |
<span class="mf">192.168.0.3</span> <span class="o">-></span> <span class="n">mail</span><span class="o">.</span><span class="n">foo</span><span class="o">.</span><span class="n">bar</span> |
| 235 |
</pre></div> |
| 236 |
</div> |
| 237 |
<p>Once the server obtains the fully qualified hostname of the |
| 238 |
interface, it removes the localpart (i.e., 'mail') and uses the |
| 239 |
remainder as the domain for any user that logs in.</p> |
| 240 |
<p>This address to hostname mapping would usually be done via DNS, |
| 241 |
<code class="docutils literal notranslate"><span class="pre">/etc/hosts</span></code>, NIS, etc. Configuration of the various naming |
| 242 |
services is beyond the scope of this document.</p> |
| 243 |
</section> |
| 244 |
<section id="delivering-mail"> |
| 245 |
<h3>Delivering mail<a class="headerlink" href="#delivering-mail" title="Link to this heading"></a></h3> |
| 246 |
<p>To deliver mail to your virtual domains, configure your MTA so that |
| 247 |
the envelope recipient (RCPT TO) passed to <code class="docutils literal notranslate"><span class="pre">lmtpd</span></code> is fully |
| 248 |
qualified with the correct domain.</p> |
| 249 |
<section id="configuring-sendmail"> |
| 250 |
<h4>Configuring Sendmail<a class="headerlink" href="#configuring-sendmail" title="Link to this heading"></a></h4> |
| 251 |
<p>Follow the basic <a class="reference internal" href="../../installing.html#installing"><span class="std std-ref">configuration instructions</span></a>.</p> |
| 252 |
<p>Some items to be aware of:</p> |
| 253 |
<ul> |
| 254 |
<li><p>It is easiest to use the mailertable to route mail to Cyrus, |
| 255 |
rather than adding the domain to the local-host-names file ($w). |
| 256 |
This prevents Sendmail from changing the domain name to the local host name.</p> |
| 257 |
<blockquote> |
| 258 |
<div><p><code class="docutils literal notranslate"><span class="pre">example.com</span>              <span class="pre">cyrusv2:/var/imap/socket/lmtp</span></code></p> |
| 259 |
</div></blockquote> |
| 260 |
</li> |
| 261 |
<li><p>You'll have to use the Cyrus mailer in LMTP mode, and you'll have |
| 262 |
to change the mailer flags so that it provides the full domain while |
| 263 |
communicating via LMTP. Specifically these changes:</p> |
| 264 |
<blockquote> |
| 265 |
<div><p><code class="docutils literal notranslate"><span class="pre">S=EnvFromSMTP/HdrFromSMTP,</span> <span class="pre">R=EnvToSMTP</span></code></p> |
| 266 |
</div></blockquote> |
| 267 |
</li> |
| 268 |
</ul> |
| 269 |
</section> |
| 270 |
</section> |
| 271 |
<section id="mail-clients"> |
| 272 |
<h3>Mail Clients<a class="headerlink" href="#mail-clients" title="Link to this heading"></a></h3> |
| 273 |
<p>The only changes you'll need to make to mail clients is to change |
| 274 |
usernames to the fully qualified domain names, i.e., <code class="docutils literal notranslate"><span class="pre">user@example.com</span></code>. |
| 275 |
The <code class="docutils literal notranslate"><span class="pre">user%example.com</span></code> form of userid is also supported.</p> |
| 276 |
<p>Users in the default domain will not |
| 277 |
need to reconfigure their clients (as unqualified userids are assumed to |
| 278 |
be in the default domain).</p> |
| 279 |
</section> |
| 280 |
<section id="administrators"> |
| 281 |
<h3>Administrators<a class="headerlink" href="#administrators" title="Link to this heading"></a></h3> |
| 282 |
<p>The Cyrus virtual domains implementation supports per-domain |
| 283 |
administrators as well as "global" (inter-domain) administrators. |
| 284 |
Domain-specific administrators are specified with a |
| 285 |
fully qualified userid in the <code class="docutils literal notranslate"><span class="pre">admins</span></code> option |
| 286 |
(e.g., <code class="docutils literal notranslate"><span class="pre">admin@example.net</span></code>) and only have access to mailboxes in |
| 287 |
the associated domain. Mailbox names should be specified in the same |
| 288 |
fashion as on a single domain configuration.</p> |
| 289 |
<p>Global administrators are specified with an unqualified userid in the |
| 290 |
<code class="docutils literal notranslate"><span class="pre">admins</span></code> option and have access to <em>any</em> mailbox on the |
| 291 |
server. Because global admins use unqualified userids, they belong |
| 292 |
to the <code class="docutils literal notranslate"><span class="pre">defaultdomain</span></code>. As a result, you CANNOT have a global |
| 293 |
admin without specifying a <code class="docutils literal notranslate"><span class="pre">defaultdomain</span></code>. Note that when |
| 294 |
trying to login as a global admin to a multi-homed server from a remote |
| 295 |
machine, it might be necessary to fully qualify the userid with the |
| 296 |
<code class="docutils literal notranslate"><span class="pre">defaultdomain</span></code>.</p> |
| 297 |
<p>Global admins must use <code class="docutils literal notranslate"><span class="pre">mailbox@domain</span></code> syntax when |
| 298 |
specifying mailboxes outside of the <code class="docutils literal notranslate"><span class="pre">defaultdomain</span></code>. Examples |
| 299 |
(using <code class="docutils literal notranslate"><span class="pre">cyradm</span></code>):</p> |
| 300 |
<p>To create a new INBOX for user 'test' in <code class="docutils literal notranslate"><span class="pre">defaultdomain</span></code>:</p> |
| 301 |
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cm</span> <span class="n">user</span><span class="o">/</span><span class="n">test</span> |
| 302 |
</pre></div> |
| 303 |
</div> |
| 304 |
<p>To create a new INBOX for user 'test' in domain 'example.com':</p> |
| 305 |
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cm</span> <span class="n">user</span><span class="o">/</span><span class="n">test</span><span class="nd">@example</span><span class="o">.</span><span class="n">com</span> |
| 306 |
</pre></div> |
| 307 |
</div> |
| 308 |
<p>To list all mailboxes in domain 'example.com':</p> |
| 309 |
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">lm</span> <span class="o">*</span><span class="nd">@example</span><span class="o">.</span><span class="n">com</span> |
| 310 |
</pre></div> |
| 311 |
</div> |
| 312 |
</section> |
| 313 |
</section> |
| 314 |
</section> |
| 315 |
|
| 316 |
|
| 317 |
</div> |
| 318 |
</div> |
| 319 |
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> |
| 320 |
<a href="namespaces.html" class="btn btn-neutral float-left" title="Mailbox Namespaces" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
| 321 |
<a href="mailbox-annotations.html" class="btn btn-neutral float-right" title="Mailbox Annotations (METADATA)" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> |
| 322 |
</div> |
| 323 |
|
| 324 |
<hr/> |
| 325 |
|
| 326 |
<div role="contentinfo"> |
| 327 |
<p>© Copyright 1993–2026, The Cyrus Team.</p> |
| 328 |
</div> |
| 329 |
|
| 330 |
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a |
| 331 |
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> |
| 332 |
provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| 333 |
|
| 334 |
|
| 335 |
</footer> |
| 336 |
</div> |
| 337 |
</div> |
| 338 |
</section> |
| 339 |
</div> |
| 340 |
<script> |
| 341 |
jQuery(function () { |
| 342 |
SphinxRtdTheme.Navigation.enable(true); |
| 343 |
}); |
| 344 |
</script> |
| 345 |
|
| 346 |
|
| 347 |
|
| 348 |
|
| 349 |
</body> |
| 350 |
</html> |