| 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>translatesieve — 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="unexpunge" href="unexpunge.html" /> |
| 24 |
<link rel="prev" title="tls_prune" href="tls_prune.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 current"><a class="reference internal" href="../../../../operations.html">Operations</a><ul class="current"> |
| 56 |
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Man pages</a><ul class="current"> |
| 57 |
<li class="toctree-l3"><a class="reference internal" href="../index.html#configuration-files">(5) Configuration Files</a></li> |
| 58 |
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#system-commands">(8) System Commands</a><ul class="current"> |
| 59 |
<li class="toctree-l4"><a class="reference internal" href="arbitron.html"><strong>arbitron</strong></a></li> |
| 60 |
<li class="toctree-l4"><a class="reference internal" href="calalarmd.html"><strong>calalarmd</strong></a></li> |
| 61 |
<li class="toctree-l4"><a class="reference internal" href="chk_cyrus.html"><strong>chk_cyrus</strong></a></li> |
| 62 |
<li class="toctree-l4"><a class="reference internal" href="ctl_conversationsdb.html"><strong>ctl_conversationsdb</strong></a></li> |
| 63 |
<li class="toctree-l4"><a class="reference internal" href="ctl_cyrusdb.html"><strong>ctl_cyrusdb</strong></a></li> |
| 64 |
<li class="toctree-l4"><a class="reference internal" href="ctl_deliver.html"><strong>ctl_deliver</strong></a></li> |
| 65 |
<li class="toctree-l4"><a class="reference internal" href="ctl_mboxlist.html"><strong>ctl_mboxlist</strong></a></li> |
| 66 |
<li class="toctree-l4"><a class="reference internal" href="ctl_zoneinfo.html"><strong>ctl_zoneinfo</strong></a></li> |
| 67 |
<li class="toctree-l4"><a class="reference internal" href="cvt_cyrusdb.html"><strong>cvt_cyrusdb</strong></a></li> |
| 68 |
<li class="toctree-l4"><a class="reference internal" href="cvt_xlist_specialuse.html"><strong>cvt_xlist_specialuse</strong></a></li> |
| 69 |
<li class="toctree-l4"><a class="reference internal" href="cyr_buildinfo.html"><strong>cyr_buildinfo</strong></a></li> |
| 70 |
<li class="toctree-l4"><a class="reference internal" href="cyr_dbtool.html"><strong>cyr_dbtool</strong></a></li> |
| 71 |
<li class="toctree-l4"><a class="reference internal" href="cyr_deny.html"><strong>cyr_deny</strong></a></li> |
| 72 |
<li class="toctree-l4"><a class="reference internal" href="cyr_df.html"><strong>cyr_df</strong></a></li> |
| 73 |
<li class="toctree-l4"><a class="reference internal" href="cyr_expire.html"><strong>cyr_expire</strong></a></li> |
| 74 |
<li class="toctree-l4"><a class="reference internal" href="cyr_info.html"><strong>cyr_info</strong></a></li> |
| 75 |
<li class="toctree-l4"><a class="reference internal" href="cyr_ls.html"><strong>cyr_ls</strong></a></li> |
| 76 |
<li class="toctree-l4"><a class="reference internal" href="cyr_synclog.html"><strong>cyr_synclog</strong></a></li> |
| 77 |
<li class="toctree-l4"><a class="reference internal" href="cyr_userseen.html"><strong>cyr_userseen</strong></a></li> |
| 78 |
<li class="toctree-l4"><a class="reference internal" href="cyr_virusscan.html"><strong>cyr_virusscan</strong></a></li> |
| 79 |
<li class="toctree-l4"><a class="reference internal" href="cyr_withlock_run.html"><strong>cyr_withlock_run</strong></a></li> |
| 80 |
<li class="toctree-l4"><a class="reference internal" href="cyradm.html"><strong>cyradm</strong></a></li> |
| 81 |
<li class="toctree-l4"><a class="reference internal" href="cyrdump.html"><strong>cyrdump</strong></a></li> |
| 82 |
<li class="toctree-l4"><a class="reference internal" href="deliver.html"><strong>deliver</strong></a></li> |
| 83 |
<li class="toctree-l4"><a class="reference internal" href="fetchnews.html"><strong>fetchnews</strong></a></li> |
| 84 |
<li class="toctree-l4"><a class="reference internal" href="fud.html"><strong>fud</strong></a></li> |
| 85 |
<li class="toctree-l4"><a class="reference internal" href="httpd.html"><strong>httpd</strong></a></li> |
| 86 |
<li class="toctree-l4"><a class="reference internal" href="idled.html"><strong>idled</strong></a></li> |
| 87 |
<li class="toctree-l4"><a class="reference internal" href="imapd.html"><strong>imapd</strong></a></li> |
| 88 |
<li class="toctree-l4"><a class="reference internal" href="ipurge.html"><strong>ipurge</strong></a></li> |
| 89 |
<li class="toctree-l4"><a class="reference internal" href="lmtpd.html"><strong>lmtpd</strong></a></li> |
| 90 |
<li class="toctree-l4"><a class="reference internal" href="lmtpproxyd.html"><strong>lmtpproxyd</strong></a></li> |
| 91 |
<li class="toctree-l4"><a class="reference internal" href="masssievec.html"><strong>masssievec</strong></a></li> |
| 92 |
<li class="toctree-l4"><a class="reference internal" href="master.html"><strong>master</strong></a></li> |
| 93 |
<li class="toctree-l4"><a class="reference internal" href="mbexamine.html"><strong>mbexamine</strong></a></li> |
| 94 |
<li class="toctree-l4"><a class="reference internal" href="mbpath.html"><strong>mbpath</strong></a></li> |
| 95 |
<li class="toctree-l4"><a class="reference internal" href="mbtool.html"><strong>mbtool</strong></a></li> |
| 96 |
<li class="toctree-l4"><a class="reference internal" href="mkimap.html"><strong>mkimap</strong></a></li> |
| 97 |
<li class="toctree-l4"><a class="reference internal" href="mknewsgroups.html"><strong>mknewsgroups</strong></a></li> |
| 98 |
<li class="toctree-l4"><a class="reference internal" href="mupdate.html"><strong>mupdate</strong></a></li> |
| 99 |
<li class="toctree-l4"><a class="reference internal" href="nntpd.html"><strong>nntpd</strong></a></li> |
| 100 |
<li class="toctree-l4"><a class="reference internal" href="notifyd.html"><strong>notifyd</strong></a></li> |
| 101 |
<li class="toctree-l4"><a class="reference internal" href="pop3d.html"><strong>pop3d</strong></a></li> |
| 102 |
<li class="toctree-l4"><a class="reference internal" href="pop3proxyd.html"><strong>pop3proxyd</strong></a></li> |
| 103 |
<li class="toctree-l4"><a class="reference internal" href="promstatsd.html"><strong>promstatsd</strong></a></li> |
| 104 |
<li class="toctree-l4"><a class="reference internal" href="proxyd.html"><strong>proxyd</strong></a></li> |
| 105 |
<li class="toctree-l4"><a class="reference internal" href="ptdump.html"><strong>ptdump</strong></a></li> |
| 106 |
<li class="toctree-l4"><a class="reference internal" href="ptexpire.html"><strong>ptexpire</strong></a></li> |
| 107 |
<li class="toctree-l4"><a class="reference internal" href="ptloader.html"><strong>ptloader</strong></a></li> |
| 108 |
<li class="toctree-l4"><a class="reference internal" href="quota.html"><strong>quota</strong></a></li> |
| 109 |
<li class="toctree-l4"><a class="reference internal" href="reconstruct.html"><strong>reconstruct</strong></a></li> |
| 110 |
<li class="toctree-l4"><a class="reference internal" href="rehash.html"><strong>rehash</strong></a></li> |
| 111 |
<li class="toctree-l4"><a class="reference internal" href="relocate_by_id.html"><strong>relocate_by_id</strong></a></li> |
| 112 |
<li class="toctree-l4"><a class="reference internal" href="sievec.html"><strong>sievec</strong></a></li> |
| 113 |
<li class="toctree-l4"><a class="reference internal" href="sieved.html"><strong>sieved</strong></a></li> |
| 114 |
<li class="toctree-l4"><a class="reference internal" href="smmapd.html"><strong>smmapd</strong></a></li> |
| 115 |
<li class="toctree-l4"><a class="reference internal" href="squatter.html"><strong>squatter</strong></a></li> |
| 116 |
<li class="toctree-l4"><a class="reference internal" href="sync_client.html"><strong>sync_client</strong></a></li> |
| 117 |
<li class="toctree-l4"><a class="reference internal" href="sync_reset.html"><strong>sync_reset</strong></a></li> |
| 118 |
<li class="toctree-l4"><a class="reference internal" href="sync_server.html"><strong>sync_server</strong></a></li> |
| 119 |
<li class="toctree-l4"><a class="reference internal" href="timsieved.html"><strong>timsieved</strong></a></li> |
| 120 |
<li class="toctree-l4"><a class="reference internal" href="tls_prune.html"><strong>tls_prune</strong></a></li> |
| 121 |
<li class="toctree-l4 current"><a class="current reference internal" href="#"><strong>translatesieve</strong></a></li> |
| 122 |
<li class="toctree-l4"><a class="reference internal" href="unexpunge.html"><strong>unexpunge</strong></a></li> |
| 123 |
</ul> |
| 124 |
</li> |
| 125 |
<li class="toctree-l3"><a class="reference internal" href="../index.html#user-commands">(1) User Commands</a></li> |
| 126 |
</ul> |
| 127 |
</li> |
| 128 |
<li class="toctree-l2"><a class="reference internal" href="../../admin.html">Administrator Guide</a></li> |
| 129 |
<li class="toctree-l2"><a class="reference internal" href="../../faq.html">Frequently Asked Questions</a></li> |
| 130 |
</ul> |
| 131 |
</li> |
| 132 |
<li class="toctree-l1"><a class="reference internal" href="../../../../developers.html">Developers</a></li> |
| 133 |
<li class="toctree-l1"><a class="reference internal" href="../../../../support.html">Support/Community</a></li> |
| 134 |
</ul> |
| 135 |
<p class="caption" role="heading"><span class="caption-text">Cyrus SASL</span></p> |
| 136 |
<ul> |
| 137 |
<li class="toctree-l1"><a class="reference external" href="http://www.cyrusimap.org/sasl">Cyrus SASL</a></li> |
| 138 |
</ul> |
| 139 |
|
| 140 |
</div> |
| 141 |
</div> |
| 142 |
</nav> |
| 143 |
|
| 144 |
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > |
| 145 |
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| 146 |
<a href="../../../../index.html">Cyrus IMAP</a> |
| 147 |
</nav> |
| 148 |
|
| 149 |
<div class="wy-nav-content"> |
| 150 |
<div class="rst-content"> |
| 151 |
<div role="navigation" aria-label="Page navigation"> |
| 152 |
<ul class="wy-breadcrumbs"> |
| 153 |
<li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li> |
| 154 |
<li class="breadcrumb-item"><a href="../../../../operations.html">Operations</a></li> |
| 155 |
<li class="breadcrumb-item"><a href="../index.html">Man pages</a></li> |
| 156 |
<li class="breadcrumb-item active"><strong>translatesieve</strong></li> |
| 157 |
<li class="wy-breadcrumbs-aside"> |
| 158 |
<a href="https://github.com/cyrusimap/cyrus-imapd/blob/master/docsrc/imap/reference/manpages/systemcommands/translatesieve.rst" class="fa fa-github"> Edit on GitHub</a> |
| 159 |
</li> |
| 160 |
</ul> |
| 161 |
<hr/> |
| 162 |
</div> |
| 163 |
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| 164 |
<div itemprop="articleBody"> |
| 165 |
|
| 166 |
<span class="target" id="std-cyrusman-translatesieve-8"></span><section id="translatesieve"> |
| 167 |
<span id="imap-reference-manpages-systemcommands-translatesieve"></span><h1><strong>translatesieve</strong><a class="headerlink" href="#translatesieve" title="Link to this heading"></a></h1> |
| 168 |
<p>Translate sieve scripts to use unixhierarchysep and/or altnamespace.</p> |
| 169 |
<section id="synopsis"> |
| 170 |
<h2>Synopsis<a class="headerlink" href="#synopsis" title="Link to this heading"></a></h2> |
| 171 |
<pre class="literal-block"><strong>translatesieve</strong> [<strong>-f</strong>] [<strong>-a</strong>] [<strong>-u</strong>] [<strong>-n</strong>] [<strong>-v</strong>] [<strong>-C</strong> <em>imapd.conf</em>]</pre> |
| 172 |
</section> |
| 173 |
<section id="description"> |
| 174 |
<h2>Description<a class="headerlink" href="#description" title="Link to this heading"></a></h2> |
| 175 |
<p><strong>translatesieve</strong> can both translate the mailbox separator characters |
| 176 |
in sieve scripts from traditional netnews style -- '.' -- to new Unix |
| 177 |
style -- '/' -- and vice versa. It can also convert sieve scripts to |
| 178 |
use <code class="docutils literal notranslate"><span class="pre">altnamespace</span></code> mailbox naming conventions. Please also see |
| 179 |
<a class="reference internal" href="../../../concepts/features/namespaces.html#mailbox-namespaces"><span class="std std-ref">Mailbox namespaces</span></a> for details.</p> |
| 180 |
<p>In its default mode, <strong>translatesieve</strong> assumes that the old configuration |
| 181 |
used <em>both</em> <code class="docutils literal notranslate"><span class="pre">unixhierarchysep:</span> <span class="pre">no</span></code> and <code class="docutils literal notranslate"><span class="pre">altnamespace:</span> <span class="pre">no</span></code>. If your |
| 182 |
configuration was already using one of these, then use the appropriate |
| 183 |
flag, <strong>-u</strong> for <code class="docutils literal notranslate"><span class="pre">unixhierarchysep:</span> <span class="pre">yes</span></code> or <strong>-a</strong> for |
| 184 |
<code class="docutils literal notranslate"><span class="pre">altnamespace:</span> <span class="pre">yes</span></code>. Failure to do so may ruin your sieve scripts.</p> |
| 185 |
<p>A "Dry run" mode is available via <strong>-n</strong> and you are strongly encouraged |
| 186 |
to use this.</p> |
| 187 |
<p><strong>translatesieve</strong> reads its configuration options out of the <a class="reference internal" href="../configs/imapd.conf.html#std-cyrusman-imapd.conf-5">imapd.conf(5)</a> file unless specified otherwise by <strong>-C</strong>.</p> |
| 188 |
<p>Must be run as the cyrus user.</p> |
| 189 |
</section> |
| 190 |
<section id="options"> |
| 191 |
<h2>Options<a class="headerlink" href="#options" title="Link to this heading"></a></h2> |
| 192 |
<dl class="std option"> |
| 193 |
<dt class="sig sig-object std" id="cmdoption-translatesieve-f"> |
| 194 |
<span class="sig-name descname"><span class="pre">-f</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-translatesieve-f" title="Link to this definition"></a></dt> |
| 195 |
<dd><p>Keep going on errors.</p> |
| 196 |
</dd></dl> |
| 197 |
|
| 198 |
<dl class="std option"> |
| 199 |
<dt class="sig sig-object std" id="cmdoption-translatesieve-a"> |
| 200 |
<span class="sig-name descname"><span class="pre">-a</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-translatesieve-a" title="Link to this definition"></a></dt> |
| 201 |
<dd><p>Translate from a configuration which already used <code class="docutils literal notranslate"><span class="pre">altnamespace:</span> <span class="pre">yes</span></code>.</p> |
| 202 |
</dd></dl> |
| 203 |
|
| 204 |
<dl class="std option"> |
| 205 |
<dt class="sig sig-object std" id="cmdoption-translatesieve-u"> |
| 206 |
<span class="sig-name descname"><span class="pre">-u</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-translatesieve-u" title="Link to this definition"></a></dt> |
| 207 |
<dd><p>Translate from a configuration which already used <code class="docutils literal notranslate"><span class="pre">unixhierarchysep:</span> <span class="pre">yes</span></code>.</p> |
| 208 |
</dd></dl> |
| 209 |
|
| 210 |
<dl class="std option"> |
| 211 |
<dt class="sig sig-object std" id="cmdoption-translatesieve-n"> |
| 212 |
<span class="sig-name descname"><span class="pre">-n</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-translatesieve-n" title="Link to this definition"></a></dt> |
| 213 |
<dd><p>Dry-run mode. No changes will be written, but you'll be shown what would |
| 214 |
be changed.</p> |
| 215 |
</dd></dl> |
| 216 |
|
| 217 |
<dl class="std option"> |
| 218 |
<dt class="sig sig-object std" id="cmdoption-translatesieve-v"> |
| 219 |
<span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-translatesieve-v" title="Link to this definition"></a></dt> |
| 220 |
<dd><p>Verbose mode. Note: -n implies -v.</p> |
| 221 |
</dd></dl> |
| 222 |
|
| 223 |
<dl class="std option"> |
| 224 |
<dt class="sig sig-object std" id="cmdoption-translatesieve-C"> |
| 225 |
<span class="sig-name descname"><span class="pre">-C</span></span><span class="sig-prename descclassname"> <span class="pre">config-file</span></span><a class="headerlink" href="#cmdoption-translatesieve-C" title="Link to this definition"></a></dt> |
| 226 |
<dd><p>Use the specified configuration file <em>config-file</em> rather than the default <a class="reference internal" href="../configs/imapd.conf.html#std-cyrusman-imapd.conf-5">imapd.conf(5)</a>.</p> |
| 227 |
</dd></dl> |
| 228 |
|
| 229 |
</section> |
| 230 |
<section id="see-also"> |
| 231 |
<h2>See Also<a class="headerlink" href="#see-also" title="Link to this heading"></a></h2> |
| 232 |
<p><a class="reference internal" href="../configs/imapd.conf.html#std-cyrusman-imapd.conf-5">imapd.conf(5)</a></p> |
| 233 |
</section> |
| 234 |
</section> |
| 235 |
|
| 236 |
|
| 237 |
</div> |
| 238 |
</div> |
| 239 |
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> |
| 240 |
<a href="tls_prune.html" class="btn btn-neutral float-left" title="tls_prune" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
| 241 |
<a href="unexpunge.html" class="btn btn-neutral float-right" title="unexpunge" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> |
| 242 |
</div> |
| 243 |
|
| 244 |
<hr/> |
| 245 |
|
| 246 |
<div role="contentinfo"> |
| 247 |
<p>© Copyright 1993–2026, The Cyrus Team.</p> |
| 248 |
</div> |
| 249 |
|
| 250 |
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a |
| 251 |
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> |
| 252 |
provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| 253 |
|
| 254 |
|
| 255 |
</footer> |
| 256 |
</div> |
| 257 |
</div> |
| 258 |
</section> |
| 259 |
</div> |
| 260 |
<script> |
| 261 |
jQuery(function () { |
| 262 |
SphinxRtdTheme.Navigation.enable(true); |
| 263 |
}); |
| 264 |
</script> |
| 265 |
|
| 266 |
|
| 267 |
|
| 268 |
|
| 269 |
</body> |
| 270 |
</html> |