Debian Codegraph @

doc/html/imap/download/installation/virus.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>Virus Scanner &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="Upgrading to 3.12" href="../upgrade.html" />
24 <link rel="prev" title="RSS Feeds" href="http/rss.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 current"><a class="reference internal" href="../../../setup.html">Setup</a><ul class="current">
55 <li class="toctree-l2"><a class="reference internal" href="../../developer/compiling.html">Compiling</a></li>
56 <li class="toctree-l2 current"><a class="reference internal" href="../../installing.html">Installing Cyrus</a><ul class="current">
57 <li class="toctree-l3"><a class="reference internal" href="../../installing.html#install-cyrus">Install Cyrus</a></li>
58 <li class="toctree-l3 current"><a class="reference internal" href="../../installing.html#optional-components">Optional Components</a><ul class="current">
59 <li class="toctree-l4"><a class="reference internal" href="manage-dav.html">HTTP modules</a></li>
60 <li class="toctree-l4 current"><a class="current reference internal" href="#">Virus Scanner</a></li>
61 </ul>
62 </li>
63 <li class="toctree-l3"><a class="reference internal" href="../../installing.html#setting-up-syslog">Setting up syslog</a></li>
64 <li class="toctree-l3"><a class="reference internal" href="../../installing.html#create-cyrus-environment">Create Cyrus environment</a></li>
65 <li class="toctree-l3"><a class="reference internal" href="../../installing.html#launch-cyrus">Launch Cyrus</a></li>
66 <li class="toctree-l3"><a class="reference internal" href="../../installing.html#send-a-test-email">Send a test email</a></li>
67 <li class="toctree-l3"><a class="reference internal" href="../../installing.html#checking-carddav-and-caldav">Checking CardDAV and CalDAV</a></li>
68 <li class="toctree-l3"><a class="reference internal" href="../../installing.html#troubleshooting">Troubleshooting</a></li>
69 </ul>
70 </li>
71 <li class="toctree-l2"><a class="reference internal" href="../upgrade.html">Upgrading to 3.12</a></li>
72 <li class="toctree-l2"><a class="reference internal" href="../../concepts/deployment.html">Configuration Guide</a></li>
73 </ul>
74 </li>
75 <li class="toctree-l1"><a class="reference internal" href="../../../operations.html">Operations</a></li>
76 <li class="toctree-l1"><a class="reference internal" href="../../../developers.html">Developers</a></li>
77 <li class="toctree-l1"><a class="reference internal" href="../../../support.html">Support/Community</a></li>
78 </ul>
79 <p class="caption" role="heading"><span class="caption-text">Cyrus SASL</span></p>
80 <ul>
81 <li class="toctree-l1"><a class="reference external" href="http://www.cyrusimap.org/sasl">Cyrus SASL</a></li>
82 </ul>
83
84 </div>
85 </div>
86 </nav>
87
88 <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
89 <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
90 <a href="../../../index.html">Cyrus IMAP</a>
91 </nav>
92
93 <div class="wy-nav-content">
94 <div class="rst-content">
95 <div role="navigation" aria-label="Page navigation">
96 <ul class="wy-breadcrumbs">
97 <li><a href="../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
98 <li class="breadcrumb-item"><a href="../../../setup.html">Setup</a></li>
99 <li class="breadcrumb-item"><a href="../../installing.html">Installing Cyrus</a></li>
100 <li class="breadcrumb-item active">Virus Scanner</li>
101 <li class="wy-breadcrumbs-aside">
102 <a href="https://github.com/cyrusimap/cyrus-imapd/blob/master/docsrc/imap/download/installation/virus.rst" class="fa fa-github"> Edit on GitHub</a>
103 </li>
104 </ul>
105 <hr/>
106 </div>
107 <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
108 <div itemprop="articleBody">
109
110 <section id="virus-scanner">
111 <span id="install-virus"></span><h1>Virus Scanner<a class="headerlink" href="#virus-scanner" title="Link to this heading"></a></h1>
112 <section id="about-virus-scan-support">
113 <h2>About virus scan support<a class="headerlink" href="#about-virus-scan-support" title="Link to this heading"></a></h2>
114 <p>Cyrus can use an external virus scanner to check for infected mail. Currently,
115 only <a class="reference external" href="https://www.clamav.net">ClamAV</a> is supported.</p>
116 <p>Infected mail can be reported on, or removed.</p>
117 <p>It is possible to use Cyrus's virus scanner support <strong>without</strong> a virus scanner,
118 by passing in an IMAP SEARCH string. Messages matching that string are treated
119 as infected.</p>
120 <p>For more information, see <a class="reference internal" href="../../reference/manpages/systemcommands/cyr_virusscan.html#std-cyrusman-cyr_virusscan-8">cyr_virusscan(8)</a>.</p>
121 </section>
122 <section id="virus-scanner-configuration">
123 <h2>Virus Scanner Configuration<a class="headerlink" href="#virus-scanner-configuration" title="Link to this heading"></a></h2>
124 <section id="general-configuration">
125 <h3>General configuration<a class="headerlink" href="#general-configuration" title="Link to this heading"></a></h3>
126 <p>Once the virus scanner has been installed, Cyrus must be recompiled: the
127 configure step will detect the presence of a supported virus library and
128 use it.</p>
129 <p><a class="reference internal" href="../../reference/manpages/systemcommands/cyr_virusscan.html#std-cyrusman-cyr_virusscan-8">cyr_virusscan(8)</a> can be run manually, or configured to run
130 periodically by cron(8) via crontab(5) or your preferred method
131 (i.e. /etc/cron.hourly), or by <a class="reference internal" href="../../reference/manpages/systemcommands/master.html#std-cyrusman-master-8">master(8)</a> in the EVENTS{} section in
132 <a class="reference internal" href="../../reference/manpages/configs/cyrus.conf.html#std-cyrusman-cyrus.conf-5">cyrus.conf(5)</a>.</p>
133 </section>
134 <section id="id1">
135 <h3>ClamAV<a class="headerlink" href="#id1" title="Link to this heading"></a></h3>
136 <p>Cyrus does not need any special configuration to work with <a class="reference external" href="https://www.clamav.net">ClamAV</a>:
137 once ClamAV is installed, compiling Cyrus will automatically detect and use
138 the ClamAV libraries.</p>
139 </section>
140 </section>
141 </section>
142
143
144 </div>
145 </div>
146 <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
147 <a href="http/rss.html" class="btn btn-neutral float-left" title="RSS Feeds" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
148 <a href="../upgrade.html" class="btn btn-neutral float-right" title="Upgrading to 3.12" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
149 </div>
150
151 <hr/>
152
153 <div role="contentinfo">
154 <p>&#169; Copyright 1993–2026, The Cyrus Team.</p>
155 </div>
156
157 Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
158 <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
159 provided by <a href="https://readthedocs.org">Read the Docs</a>.
160
161
162 </footer>
163 </div>
164 </div>
165 </section>
166 </div>
167 <script>
168 jQuery(function () {
169 SphinxRtdTheme.Navigation.enable(true);
170 });
171 </script>
172
173
174
175
176 </body>
177 </html>