| 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>sieveshell — 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="sivtest" href="sivtest.html" /> |
| 24 |
<link rel="prev" title="pop3test" href="pop3test.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"><a class="reference internal" href="../index.html#system-commands">(8) System Commands</a></li> |
| 59 |
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#user-commands">(1) User Commands</a><ul class="current"> |
| 60 |
<li class="toctree-l4"><a class="reference internal" href="arbitronsort.pl.html"><strong>arbitronsort.pl</strong></a></li> |
| 61 |
<li class="toctree-l4"><a class="reference internal" href="dav_reconstruct.html"><strong>dav_reconstruct</strong></a></li> |
| 62 |
<li class="toctree-l4"><a class="reference internal" href="httptest.html"><strong>httptest</strong></a></li> |
| 63 |
<li class="toctree-l4"><a class="reference internal" href="imtest.html"><strong>imtest</strong></a></li> |
| 64 |
<li class="toctree-l4"><a class="reference internal" href="installsieve.html"><strong>installsieve</strong></a></li> |
| 65 |
<li class="toctree-l4"><a class="reference internal" href="lmtptest.html"><strong>lmtptest</strong></a></li> |
| 66 |
<li class="toctree-l4"><a class="reference internal" href="mupdatetest.html"><strong>mupdatetest</strong></a></li> |
| 67 |
<li class="toctree-l4"><a class="reference internal" href="nntptest.html"><strong>nntptest</strong></a></li> |
| 68 |
<li class="toctree-l4"><a class="reference internal" href="pop3test.html"><strong>pop3test</strong></a></li> |
| 69 |
<li class="toctree-l4 current"><a class="current reference internal" href="#"><strong>sieveshell</strong></a></li> |
| 70 |
<li class="toctree-l4"><a class="reference internal" href="sivtest.html"><strong>sivtest</strong></a></li> |
| 71 |
<li class="toctree-l4"><a class="reference internal" href="smtptest.html"><strong>smtptest</strong></a></li> |
| 72 |
<li class="toctree-l4"><a class="reference internal" href="synctest.html"><strong>synctest</strong></a></li> |
| 73 |
</ul> |
| 74 |
</li> |
| 75 |
</ul> |
| 76 |
</li> |
| 77 |
<li class="toctree-l2"><a class="reference internal" href="../../admin.html">Administrator Guide</a></li> |
| 78 |
<li class="toctree-l2"><a class="reference internal" href="../../faq.html">Frequently Asked Questions</a></li> |
| 79 |
</ul> |
| 80 |
</li> |
| 81 |
<li class="toctree-l1"><a class="reference internal" href="../../../../developers.html">Developers</a></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="../../../../operations.html">Operations</a></li> |
| 104 |
<li class="breadcrumb-item"><a href="../index.html">Man pages</a></li> |
| 105 |
<li class="breadcrumb-item active"><strong>sieveshell</strong></li> |
| 106 |
<li class="wy-breadcrumbs-aside"> |
| 107 |
<a href="https://github.com/cyrusimap/cyrus-imapd/blob/master/docsrc/imap/reference/manpages/usercommands/sieveshell.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 |
<section id="sieveshell"> |
| 116 |
<h1><strong>sieveshell</strong><a class="headerlink" href="#sieveshell" title="Link to this heading"></a></h1> |
| 117 |
<section id="name"> |
| 118 |
<span id="imap-reference-manpages-usercommands-sieveshell"></span><span id="std-cyrusman-sieveshell-1"></span><h2>NAME<a class="headerlink" href="#name" title="Link to this heading"></a></h2> |
| 119 |
<p>sieveshell - remotely manipulate sieve scripts</p> |
| 120 |
</section> |
| 121 |
<section id="synopsis"> |
| 122 |
<h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Link to this heading"></a></h2> |
| 123 |
<p>sieveshell [<strong>--user</strong>=<em>user</em>] [<strong>--authname</strong>=<em>authname</em>] |
| 124 |
[<strong>--realm</strong>=<em>realm</em>] [<strong>--password</strong>=<em>password</em>] |
| 125 |
[<strong>--exec</strong>=<em>script</em>] [<strong>--execfile</strong>=<em>file</em>] <em>server</em>[<strong>:</strong><em>port</em>]</p> |
| 126 |
<p>sieveshell <strong>--help</strong></p> |
| 127 |
</section> |
| 128 |
<section id="description"> |
| 129 |
<h2>DESCRIPTION<a class="headerlink" href="#description" title="Link to this heading"></a></h2> |
| 130 |
<p><strong>sieveshell</strong> allows users to manipulate their scripts on a remote |
| 131 |
server. It works via MANAGESIEVE, a work in progress.</p> |
| 132 |
<p>The following commands are recognized:</p> |
| 133 |
<p><strong>list</strong> list scripts on server.</p> |
| 134 |
<p><strong>put</strong> <filename> upload script to server.</p> |
| 135 |
<p><strong>get</strong> <name> [<filename>] get script. if no filename display to stdout</p> |
| 136 |
<p><strong>delete</strong> <name> delete script.</p> |
| 137 |
<p><strong>activate</strong> <name> activate script.</p> |
| 138 |
<p><strong>deactivate</strong> deactivate all scripts.</p> |
| 139 |
</section> |
| 140 |
<section id="options"> |
| 141 |
<h2>OPTIONS<a class="headerlink" href="#options" title="Link to this heading"></a></h2> |
| 142 |
<ul class="simple"> |
| 143 |
<li><p><strong>-u</strong> <em>user</em>, <strong>--user</strong>=<em>user</em></p></li> |
| 144 |
</ul> |
| 145 |
<blockquote> |
| 146 |
<div><p>The user whose mailboxes you want to work on. If not specified, it uses the same |
| 147 |
as -a.</p> |
| 148 |
</div></blockquote> |
| 149 |
<ul class="simple"> |
| 150 |
<li><p><strong>-a</strong> <em>authname</em>, <strong>--authname</strong>=<em>authname</em></p></li> |
| 151 |
</ul> |
| 152 |
<blockquote> |
| 153 |
<div><p>The user to use for authentication. If not specified, it defaults to the |
| 154 |
current login user.</p> |
| 155 |
</div></blockquote> |
| 156 |
<ul class="simple"> |
| 157 |
<li><p><strong>-r</strong> <em>realm</em>, <strong>--realm</strong>=<em>realm</em></p></li> |
| 158 |
</ul> |
| 159 |
<blockquote> |
| 160 |
<div><p>The realm to attempt authentication in.</p> |
| 161 |
</div></blockquote> |
| 162 |
<ul class="simple"> |
| 163 |
<li><p><strong>-p</strong> <em>password</em>, <strong>--password</strong>=<em>password</em></p></li> |
| 164 |
</ul> |
| 165 |
<blockquote> |
| 166 |
<div><p>The password to use when authenticating to server. Note that this |
| 167 |
parameter can be seen in the process list. <strong>Use with caution!</strong></p> |
| 168 |
</div></blockquote> |
| 169 |
<ul class="simple"> |
| 170 |
<li><p><strong>-e</strong> <em>script</em>, <strong>--exec</strong>=<em>script</em></p></li> |
| 171 |
</ul> |
| 172 |
<blockquote> |
| 173 |
<div><p>Instead of working interactively, run commands from <em>script</em>, and |
| 174 |
exit when done.</p> |
| 175 |
</div></blockquote> |
| 176 |
<ul class="simple"> |
| 177 |
<li><p><strong>-f</strong> <em>file</em>, <strong>--execfile</strong>=<em>file</em></p></li> |
| 178 |
</ul> |
| 179 |
<blockquote> |
| 180 |
<div><p>Instead of working interactively, run commands from file <em>file</em> and |
| 181 |
exit when done.</p> |
| 182 |
</div></blockquote> |
| 183 |
</section> |
| 184 |
<section id="references"> |
| 185 |
<h2>REFERENCES<a class="headerlink" href="#references" title="Link to this heading"></a></h2> |
| 186 |
<p>[MANAGESIEVE] Martin, T.; "A Protocol for Remotely Managing Sieve |
| 187 |
Scripts", RFC 5804; May 2001</p> |
| 188 |
</section> |
| 189 |
<section id="author"> |
| 190 |
<h2>AUTHOR<a class="headerlink" href="#author" title="Link to this heading"></a></h2> |
| 191 |
<p>Tim Martin <<a class="reference external" href="mailto:tmartin%40mirapoint.com">tmartin<span>@</span>mirapoint<span>.</span>com</a>>, and the rest of the Cyrus |
| 192 |
team.</p> |
| 193 |
</section> |
| 194 |
</section> |
| 195 |
|
| 196 |
|
| 197 |
</div> |
| 198 |
</div> |
| 199 |
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> |
| 200 |
<a href="pop3test.html" class="btn btn-neutral float-left" title="pop3test" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
| 201 |
<a href="sivtest.html" class="btn btn-neutral float-right" title="sivtest" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> |
| 202 |
</div> |
| 203 |
|
| 204 |
<hr/> |
| 205 |
|
| 206 |
<div role="contentinfo"> |
| 207 |
<p>© Copyright 1993–2026, The Cyrus Team.</p> |
| 208 |
</div> |
| 209 |
|
| 210 |
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a |
| 211 |
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> |
| 212 |
provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| 213 |
|
| 214 |
|
| 215 |
</footer> |
| 216 |
</div> |
| 217 |
</div> |
| 218 |
</section> |
| 219 |
</div> |
| 220 |
<script> |
| 221 |
jQuery(function () { |
| 222 |
SphinxRtdTheme.Navigation.enable(true); |
| 223 |
}); |
| 224 |
</script> |
| 225 |
|
| 226 |
|
| 227 |
|
| 228 |
|
| 229 |
</body> |
| 230 |
</html> |