Debian Codegraph @

doc/html/imap/reference/manpages/usercommands/sivtest.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>sivtest &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="smtptest" href="smtptest.html" />
24 <link rel="prev" title="sieveshell" href="sieveshell.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"><a class="reference internal" href="sieveshell.html"><strong>sieveshell</strong></a></li>
70 <li class="toctree-l4 current"><a class="current reference internal" href="#"><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>sivtest</strong></li>
106 <li class="wy-breadcrumbs-aside">
107 <a href="https://github.com/cyrusimap/cyrus-imapd/blob/master/docsrc/imap/reference/manpages/usercommands/sivtest.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="std-cyrusman-sivtest-1"></span><section id="sivtest">
116 <span id="imap-reference-manpages-usercommands-sivtest"></span><h1><strong>sivtest</strong><a class="headerlink" href="#sivtest" title="Link to this heading"></a></h1>
117 <p>Interactive MANAGESIEVE test program.</p>
118 <p>This is actually installed as a hard linked copy of <a class="reference internal" href="imtest.html#std-cyrusman-imtest-1">imtest(1)</a>.</p>
119 <p>It allows you to authenticate and send MANAGESIEVE commands to the server.</p>
120 <section id="synopsis">
121 <h2>Synopsis<a class="headerlink" href="#synopsis" title="Link to this heading"></a></h2>
122 <pre class="literal-block"><strong>imtest</strong> [ <strong>-t</strong> <em>keyfile</em> ] [ <strong>-p</strong> <em>port</em> ] [ <strong>-m</strong> <em>mechanism</em> ]
123 [ <strong>-a</strong> <em>userid</em> ] [ <strong>-u</strong> <em>userid</em> ] [ <strong>-k</strong> <em>num</em> ] [ <strong>-l</strong> <em>num</em> ]
124 [ <strong>-r</strong> <em>realm</em> ] [ <strong>-f</strong> <em>file</em> ] [ <strong>-n</strong> <em>num</em> ] [ <strong>-s</strong> ] [ <strong>-q</strong> ]
125 [ <strong>-c</strong> ] [ <strong>-i</strong> ] [ <strong>-z</strong> ] [ <strong>-v</strong> ] [ <strong>-I</strong> <em>file</em> ] [ <strong>-x</strong> <em>file</em> ]
126 [ <strong>-X</strong> <em>file</em> ] [ <strong>-w</strong> <em>passwd</em> ] [ <strong>-o</strong> <em>option</em>=<em>value</em> ]
127 [ <strong>-H</strong> <em>client-ip</em> ] <em>hostname</em></pre>
128 </section>
129 <section id="description">
130 <h2>Description<a class="headerlink" href="#description" title="Link to this heading"></a></h2>
131 <p><strong>imtest</strong> is a utility that allows you to authenticate to an IMAP server
132 and interactively issue commands to it. Once authenticated you may issue
133 any IMAP command by simply typing it in. It is capable of multiple SASL
134 authentication mechanisms and handles encryption layers transparently.
135 This utility is often used for testing the operation of an IMAP server.
136 Also those developing IMAP clients find it useful.</p>
137 </section>
138 <section id="options">
139 <h2>Options<a class="headerlink" href="#options" title="Link to this heading"></a></h2>
140 <dl class="std option">
141 <dt class="sig sig-object std" id="cmdoption-imtest-t">
142 <span id="cmdoption-imtest-keyfile"></span><span class="sig-name descname"><span class="pre">-t</span></span><span class="sig-prename descclassname"> <span class="pre">keyfile</span></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--keyfile</span></span><span class="sig-prename descclassname"><span class="pre">=keyfile</span></span><a class="headerlink" href="#cmdoption-imtest-t" title="Link to this definition"></a></dt>
143 <dd><p>Enable TLS. <em>keyfile</em> contains the TLS public and private keys.
144 Specify <strong>&quot;&quot;</strong> to negotiate a TLS encryption layer but not use TLS
145 authentication.</p>
146 </dd></dl>
147
148 <dl class="std option">
149 <dt class="sig sig-object std" id="cmdoption-imtest-p">
150 <span id="cmdoption-imtest-port"></span><span class="sig-name descname"><span class="pre">-p</span></span><span class="sig-prename descclassname"> <span class="pre">port</span></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--port</span></span><span class="sig-prename descclassname"><span class="pre">=port</span></span><a class="headerlink" href="#cmdoption-imtest-p" title="Link to this definition"></a></dt>
151 <dd><p>Port to connect to. If left off this defaults to <strong>imap</strong> as defined
152 in <code class="docutils literal notranslate"><span class="pre">/etc/services</span></code>.</p>
153 </dd></dl>
154
155 <dl class="std option">
156 <dt class="sig sig-object std" id="cmdoption-imtest-m">
157 <span id="cmdoption-imtest-mechanism"></span><span class="sig-name descname"><span class="pre">-m</span></span><span class="sig-prename descclassname"> <span class="pre">mechanism</span></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--mechanism</span></span><span class="sig-prename descclassname"><span class="pre">=mechanism</span></span><a class="headerlink" href="#cmdoption-imtest-m" title="Link to this definition"></a></dt>
158 <dd><p>Force <strong>imtest</strong> to use <em>mechanism</em> for authentication. If not
159 specified the strongest authentication mechanism supported by the
160 server is chosen. Specify <em>login</em> to use the LOGIN command instead
161 of AUTHENTICATE.</p>
162 </dd></dl>
163
164 <dl class="std option">
165 <dt class="sig sig-object std" id="cmdoption-imtest-a">
166 <span id="cmdoption-imtest-authname"></span><span class="sig-name descname"><span class="pre">-a</span></span><span class="sig-prename descclassname"> <span class="pre">userid</span></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--authname</span></span><span class="sig-prename descclassname"><span class="pre">=userid</span></span><a class="headerlink" href="#cmdoption-imtest-a" title="Link to this definition"></a></dt>
167 <dd><p>Userid to use for authentication; defaults to the current user.
168 This is the userid whose password or credentials will be presented to
169 the server for verification.</p>
170 </dd></dl>
171
172 <dl class="std option">
173 <dt class="sig sig-object std" id="cmdoption-imtest-u">
174 <span id="cmdoption-imtest-username"></span><span class="sig-name descname"><span class="pre">-u</span></span><span class="sig-prename descclassname"> <span class="pre">userid</span></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--username</span></span><span class="sig-prename descclassname"><span class="pre">=userid</span></span><a class="headerlink" href="#cmdoption-imtest-u" title="Link to this definition"></a></dt>
175 <dd><p>Userid to use for authorization; defaults to the current user.
176 This is the userid whose identity will be assumed after
177 authentication.</p>
178 <div class="admonition note">
179 <p class="admonition-title">Note</p>
180 <p>This is only used with SASL mechanisms that allow proxying
181 (e.g. PLAIN).</p>
182 </div>
183 </dd></dl>
184
185 <dl class="std option">
186 <dt class="sig sig-object std" id="cmdoption-imtest-k">
187 <span id="cmdoption-imtest-minssf"></span><span class="sig-name descname"><span class="pre">-k</span></span><span class="sig-prename descclassname"> <span class="pre">num</span></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--minssf</span></span><span class="sig-prename descclassname"><span class="pre">=num</span></span><a class="headerlink" href="#cmdoption-imtest-k" title="Link to this definition"></a></dt>
188 <dd><p>Minimum protection layer required.</p>
189 </dd></dl>
190
191 <dl class="std option">
192 <dt class="sig sig-object std" id="cmdoption-imtest-l">
193 <span id="cmdoption-imtest-maxssf"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"> <span class="pre">num</span></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--maxssf</span></span><span class="sig-prename descclassname"><span class="pre">=num</span></span><a class="headerlink" href="#cmdoption-imtest-l" title="Link to this definition"></a></dt>
194 <dd><p>Maximum protection layer to use (<strong>0</strong>=none; <strong>1</strong>=integrity;
195 etc). For example if you are using the GSSAPI authentication
196 mechanism specifying <strong>0</strong> will force imtest to not use any layer
197 and specifying <strong>1</strong> will force it to use the integrity layer. By
198 default the maximum supported protection layer will be used.</p>
199 </dd></dl>
200
201 <dl class="std option">
202 <dt class="sig sig-object std" id="cmdoption-imtest-r">
203 <span id="cmdoption-imtest-realm"></span><span class="sig-name descname"><span class="pre">-r</span></span><span class="sig-prename descclassname"> <span class="pre">realm</span></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--realm</span></span><span class="sig-prename descclassname"><span class="pre">=realm</span></span><a class="headerlink" href="#cmdoption-imtest-r" title="Link to this definition"></a></dt>
204 <dd><p>Specify the <em>realm</em> to use. Certain authentication mechanisms
205 may require one to specify the realm.</p>
206 </dd></dl>
207
208 <dl class="std option">
209 <dt class="sig sig-object std" id="cmdoption-imtest-f">
210 <span id="cmdoption-imtest-input-filename"></span><span class="sig-name descname"><span class="pre">-f</span></span><span class="sig-prename descclassname"> <span class="pre">file</span></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--input-filename</span></span><span class="sig-prename descclassname"><span class="pre">=file</span></span><a class="headerlink" href="#cmdoption-imtest-f" title="Link to this definition"></a></dt>
211 <dd><p>Pipe <em>file</em> into connection after authentication.</p>
212 </dd></dl>
213
214 <dl class="std option">
215 <dt class="sig sig-object std" id="cmdoption-imtest-n">
216 <span id="cmdoption-imtest-reauth-attempts"></span><span class="sig-name descname"><span class="pre">-n</span></span><span class="sig-prename descclassname"> <span class="pre">num</span></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--reauth-attempts</span></span><span class="sig-prename descclassname"><span class="pre">=num</span></span><a class="headerlink" href="#cmdoption-imtest-n" title="Link to this definition"></a></dt>
217 <dd><p>Number of authentication attempts; default = 1. The client will
218 attempt to do SSL/TLS session reuse and/or fast reauth if possible.</p>
219 </dd></dl>
220
221 <dl class="std option">
222 <dt class="sig sig-object std" id="cmdoption-imtest-s">
223 <span id="cmdoption-imtest-require-tls"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--require-tls</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-imtest-s" title="Link to this definition"></a></dt>
224 <dd><p>Enable SSL over chosen protocol.</p>
225 </dd></dl>
226
227 <dl class="std option">
228 <dt class="sig sig-object std" id="cmdoption-imtest-q">
229 <span id="cmdoption-imtest-require-compression"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--require-compression</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-imtest-q" title="Link to this definition"></a></dt>
230 <dd><p>Enable IMAP COMPRESSion (after authentication).</p>
231 </dd></dl>
232
233 <dl class="std option">
234 <dt class="sig sig-object std" id="cmdoption-imtest-c">
235 <span id="cmdoption-imtest-do-challenge"></span><span class="sig-name descname"><span class="pre">-c</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--do-challenge</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-imtest-c" title="Link to this definition"></a></dt>
236 <dd><p>Enable challenge prompt callbacks. This will cause the OTP mechanism
237 to ask for the one-time password instead of the secret pass-phrase
238 (library generates the correct response).</p>
239 </dd></dl>
240
241 <dl class="std option">
242 <dt class="sig sig-object std" id="cmdoption-imtest-i">
243 <span id="cmdoption-imtest-no-initial-response"></span><span class="sig-name descname"><span class="pre">-i</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--no-initial-response</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-imtest-i" title="Link to this definition"></a></dt>
244 <dd><p>Don't send an initial client response for SASL mechanisms, even if
245 the protocol supports it.</p>
246 </dd></dl>
247
248 <dl class="std option">
249 <dt class="sig sig-object std" id="cmdoption-imtest-I">
250 <span id="cmdoption-imtest-pidfile"></span><span class="sig-name descname"><span class="pre">-I</span></span><span class="sig-prename descclassname"> <span class="pre">file</span></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--pidfile</span></span><span class="sig-prename descclassname"><span class="pre">=file</span></span><a class="headerlink" href="#cmdoption-imtest-I" title="Link to this definition"></a></dt>
251 <dd><p>Echo the PID of the running process into <em>file</em> (This can be useful
252 with -X).</p>
253 </dd></dl>
254
255 <dl class="std option">
256 <dt class="sig sig-object std" id="cmdoption-imtest-v">
257 <span id="cmdoption-imtest-verbose"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--verbose</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-imtest-v" title="Link to this definition"></a></dt>
258 <dd><p>Verbose. Print out more information than usual.</p>
259 </dd></dl>
260
261 <dl class="std option">
262 <dt class="sig sig-object std" id="cmdoption-imtest-z">
263 <span id="cmdoption-imtest-run-stress-test"></span><span class="sig-name descname"><span class="pre">-z</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--run-stress-test</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-imtest-z" title="Link to this definition"></a></dt>
264 <dd><p>Timing test.</p>
265 </dd></dl>
266
267 <dl class="std option">
268 <dt class="sig sig-object std" id="cmdoption-imtest-x">
269 <span id="cmdoption-imtest-output-socket"></span><span class="sig-name descname"><span class="pre">-x</span></span><span class="sig-prename descclassname"> <span class="pre">file</span></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--output-socket</span></span><span class="sig-prename descclassname"><span class="pre">=file</span></span><a class="headerlink" href="#cmdoption-imtest-x" title="Link to this definition"></a></dt>
270 <dd><p>Open the named socket for the interactive portion.</p>
271 </dd></dl>
272
273 <dl class="std option">
274 <dt class="sig sig-object std" id="cmdoption-imtest-X">
275 <span class="sig-name descname"><span class="pre">-X</span></span><span class="sig-prename descclassname"> <span class="pre">file</span></span><a class="headerlink" href="#cmdoption-imtest-X" title="Link to this definition"></a></dt>
276 <dd><p>Like -x, only close all file descriptors &amp; daemonize the process.</p>
277 </dd></dl>
278
279 <dl class="std option">
280 <dt class="sig sig-object std" id="cmdoption-imtest-w">
281 <span id="cmdoption-imtest-password"></span><span class="sig-name descname"><span class="pre">-w</span></span><span class="sig-prename descclassname"> <span class="pre">password</span></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--password</span></span><span class="sig-prename descclassname"><span class="pre">=password</span></span><a class="headerlink" href="#cmdoption-imtest-w" title="Link to this definition"></a></dt>
282 <dd><p>Password to use (if not supplied, we will prompt).</p>
283 </dd></dl>
284
285 <dl class="std option">
286 <dt class="sig sig-object std" id="cmdoption-imtest-o">
287 <span id="cmdoption-imtest-sasl-option"></span><span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"> <span class="pre">option=value</span></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--sasl-option</span></span><span class="sig-prename descclassname"><span class="pre">=option=value</span></span><a class="headerlink" href="#cmdoption-imtest-o" title="Link to this definition"></a></dt>
288 <dd><p>Set the SASL <em>option</em> to <em>value</em>.</p>
289 </dd></dl>
290
291 <dl class="std option">
292 <dt class="sig sig-object std" id="cmdoption-imtest-H">
293 <span class="sig-name descname"><span class="pre">-H</span></span><span class="sig-prename descclassname"> <span class="pre">client-ip</span></span><a class="headerlink" href="#cmdoption-imtest-H" title="Link to this definition"></a></dt>
294 <dd><p>Enable the HAProxy protocol and send the specified client IP
295 address in a v1 header. If the address is &quot;unknown&quot;, a v1 header
296 with UNKNOWN protocol will be sent. If the address is &quot;local&quot;,
297 a v2 header with LOCAL command will be sent.</p>
298 </dd></dl>
299
300 </section>
301 <section id="examples">
302 <h2>Examples<a class="headerlink" href="#examples" title="Link to this heading"></a></h2>
303 </section>
304 <section id="see-also">
305 <h2>See Also<a class="headerlink" href="#see-also" title="Link to this heading"></a></h2>
306 <p><a class="reference internal" href="../systemcommands/imapd.html#std-cyrusman-imapd-8">imapd(8)</a></p>
307 <p><a class="reference internal" href="../systemcommands/timsieved.html#std-cyrusman-timsieved-8">timsieved(8)</a></p>
308 </section>
309 </section>
310
311
312 </div>
313 </div>
314 <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
315 <a href="sieveshell.html" class="btn btn-neutral float-left" title="sieveshell" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
316 <a href="smtptest.html" class="btn btn-neutral float-right" title="smtptest" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
317 </div>
318
319 <hr/>
320
321 <div role="contentinfo">
322 <p>&#169; Copyright 1993–2026, The Cyrus Team.</p>
323 </div>
324
325 Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
326 <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
327 provided by <a href="https://readthedocs.org">Read the Docs</a>.
328
329
330 </footer>
331 </div>
332 </div>
333 </section>
334 </div>
335 <script>
336 jQuery(function () {
337 SphinxRtdTheme.Navigation.enable(true);
338 });
339 </script>
340
341
342
343
344 </body>
345 </html>