| 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>Delayed Expunge — 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="Message Annotations (METADATA)" href="message-annotations.html" /> |
| 24 |
<link rel="prev" title="Delayed Delete" href="delayed-delete.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"><a class="reference internal" href="../features.html#mailbox-management">Mailbox Management</a></li> |
| 57 |
<li class="toctree-l3 current"><a class="reference internal" href="../features.html#message-management">Message Management</a><ul class="current"> |
| 58 |
<li class="toctree-l4"><a class="reference internal" href="delayed-delete.html">Delayed Delete</a></li> |
| 59 |
<li class="toctree-l4 current"><a class="current reference internal" href="#">Delayed Expunge</a></li> |
| 60 |
<li class="toctree-l4"><a class="reference internal" href="message-annotations.html">Message Annotations (METADATA)</a></li> |
| 61 |
<li class="toctree-l4"><a class="reference internal" href="duplicate-message-delivery-suppression.html">Duplicate Message Delivery Suppression</a></li> |
| 62 |
<li class="toctree-l4"><a class="reference internal" href="shared-seen-state.html">Shared Seen State</a></li> |
| 63 |
<li class="toctree-l4"><a class="reference internal" href="server-side-filtering.html">Server Side Filtering (Sieve)</a></li> |
| 64 |
<li class="toctree-l4"><a class="reference internal" href="event-notifications.html">Event Notifications</a></li> |
| 65 |
</ul> |
| 66 |
</li> |
| 67 |
<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> |
| 68 |
<li class="toctree-l3"><a class="reference internal" href="../features.html#storage">Storage</a></li> |
| 69 |
<li class="toctree-l3"><a class="reference internal" href="../features.html#load-management">Load Management</a></li> |
| 70 |
</ul> |
| 71 |
</li> |
| 72 |
<li class="toctree-l2"><a class="reference internal" href="../overview_and_concepts.html">Concepts</a></li> |
| 73 |
</ul> |
| 74 |
</li> |
| 75 |
<li class="toctree-l1"><a class="reference internal" href="../../../setup.html">Setup</a></li> |
| 76 |
<li class="toctree-l1"><a class="reference internal" href="../../../operations.html">Operations</a></li> |
| 77 |
<li class="toctree-l1"><a class="reference internal" href="../../../developers.html">Developers</a></li> |
| 78 |
<li class="toctree-l1"><a class="reference internal" href="../../../support.html">Support/Community</a></li> |
| 79 |
</ul> |
| 80 |
<p class="caption" role="heading"><span class="caption-text">Cyrus SASL</span></p> |
| 81 |
<ul> |
| 82 |
<li class="toctree-l1"><a class="reference external" href="http://www.cyrusimap.org/sasl">Cyrus SASL</a></li> |
| 83 |
</ul> |
| 84 |
|
| 85 |
</div> |
| 86 |
</div> |
| 87 |
</nav> |
| 88 |
|
| 89 |
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > |
| 90 |
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| 91 |
<a href="../../../index.html">Cyrus IMAP</a> |
| 92 |
</nav> |
| 93 |
|
| 94 |
<div class="wy-nav-content"> |
| 95 |
<div class="rst-content"> |
| 96 |
<div role="navigation" aria-label="Page navigation"> |
| 97 |
<ul class="wy-breadcrumbs"> |
| 98 |
<li><a href="../../../index.html" class="icon icon-home" aria-label="Home"></a></li> |
| 99 |
<li class="breadcrumb-item"><a href="../../../overview.html">Overview</a></li> |
| 100 |
<li class="breadcrumb-item"><a href="../features.html">Features</a></li> |
| 101 |
<li class="breadcrumb-item active">Delayed Expunge</li> |
| 102 |
<li class="wy-breadcrumbs-aside"> |
| 103 |
<a href="https://github.com/cyrusimap/cyrus-imapd/blob/master/docsrc/imap/concepts/features/delayed-expunge.rst" class="fa fa-github"> Edit on GitHub</a> |
| 104 |
</li> |
| 105 |
</ul> |
| 106 |
<hr/> |
| 107 |
</div> |
| 108 |
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| 109 |
<div itemprop="articleBody"> |
| 110 |
|
| 111 |
<section id="delayed-expunge"> |
| 112 |
<span id="imap-features-delayed-expunge"></span><h1>Delayed Expunge<a class="headerlink" href="#delayed-expunge" title="Link to this heading"></a></h1> |
| 113 |
<p>When a user or IMAP client expunges a message or an entire folder, |
| 114 |
messages become unavailable to the user.</p> |
| 115 |
<p>When the deletion is accidental, administrators may have to recover the |
| 116 |
messages from some place. When the messages are purposefully deleted, |
| 117 |
the user may have done so not with the best of intentions.</p> |
| 118 |
<p>In any case, the time between a message arriving and being deleted may |
| 119 |
not be sufficient to ensure the message is replicated, included in the |
| 120 |
next backup cycle, and generally available for recovery or compliance |
| 121 |
with the regulatory environment.</p> |
| 122 |
<p>Cyrus IMAP introduces <em>delayed expunge</em>, which ensures message files are |
| 123 |
not immediately unlinked from the filesystem, and instead makes purging |
| 124 |
the message files from the filesystem a separate event.</p> |
| 125 |
<p>This enables administrators to quickly recover access to messages that |
| 126 |
have been accidentally deleted, as well as allows the environment to |
| 127 |
ensure messages remain available for inclusion in the next backup cycle.</p> |
| 128 |
<section id="configuring-cyrus-imap-for-delayed-expunge"> |
| 129 |
<h2>Configuring Cyrus IMAP for Delayed Expunge<a class="headerlink" href="#configuring-cyrus-imap-for-delayed-expunge" title="Link to this heading"></a></h2> |
| 130 |
<p>To enable or disable Delayed Expunge, please check the following |
| 131 |
settings in <a class="reference internal" href="../../reference/manpages/configs/imapd.conf.html#std-cyrusman-imapd.conf-5">imapd.conf(5)</a>.</p> |
| 132 |
<blockquote> |
| 133 |
<div><blockquote> |
| 134 |
<div><p><code class="docutils literal notranslate"><span class="pre">expunge_mode:</span></code> delayed</p> |
| 135 |
<blockquote> |
| 136 |
<div><p>The mode in which messages (and their corresponding cache entries) |
| 137 |
are expunged. "semidelayed" mode is the old behavior in which the |
| 138 |
message files are purged at the time of the EXPUNGE, but index |
| 139 |
and cache records are retained to facilitate QRESYNC. |
| 140 |
In "delayed" mode, which is the default since Cyrus 2.5.0, |
| 141 |
the message files are also retained, allowing unexpunge to |
| 142 |
rescue them. In "immediate" mode, both the message files and the |
| 143 |
index records are removed as soon as possible. In all cases, |
| 144 |
nothing will be finally purged until all other processes have |
| 145 |
closed the mailbox to ensure they never see data disappear under |
| 146 |
them. In "semidelayed" or "delayed" mode, a later run of "cyr_expire" |
| 147 |
will clean out the retained records (and possibly message files). |
| 148 |
This reduces the amount of I/O that takes place at the time of |
| 149 |
EXPUNGE and should result in greater responsiveness for the client, |
| 150 |
especially when expunging a large number of messages. |
| 151 |
Allowed values: <em>immediate</em>, <em>semidelayed</em>, <em>delayed</em></p> |
| 152 |
</div></blockquote> |
| 153 |
</div></blockquote> |
| 154 |
</div></blockquote> |
| 155 |
<div class="admonition seealso"> |
| 156 |
<p class="admonition-title">See also</p> |
| 157 |
<ul class="simple"> |
| 158 |
<li><p><a class="reference internal" href="../../reference/manpages/systemcommands/unexpunge.html#imap-reference-manpages-systemcommands-unexpunge"><span class="std std-ref">unexpunge</span></a></p></li> |
| 159 |
<li><p><a class="reference internal" href="delayed-delete.html#imap-features-delayed-delete"><span class="std std-ref">Delayed Delete</span></a></p></li> |
| 160 |
<li><p><a class="reference internal" href="../../reference/faqs/o-deleted-expired-expunged-purged.html#imap-admin-deleted-expired-expunged-purged"><span class="std std-ref">When is What ... Deleted, Expired, Expunged or Purged?</span></a></p></li> |
| 161 |
</ul> |
| 162 |
</div> |
| 163 |
<p>Back to <a class="reference internal" href="../features.html#imap-features"><span class="std std-ref">Features</span></a></p> |
| 164 |
</section> |
| 165 |
</section> |
| 166 |
|
| 167 |
|
| 168 |
</div> |
| 169 |
</div> |
| 170 |
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> |
| 171 |
<a href="delayed-delete.html" class="btn btn-neutral float-left" title="Delayed Delete" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
| 172 |
<a href="message-annotations.html" class="btn btn-neutral float-right" title="Message Annotations (METADATA)" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> |
| 173 |
</div> |
| 174 |
|
| 175 |
<hr/> |
| 176 |
|
| 177 |
<div role="contentinfo"> |
| 178 |
<p>© Copyright 1993–2026, The Cyrus Team.</p> |
| 179 |
</div> |
| 180 |
|
| 181 |
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a |
| 182 |
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> |
| 183 |
provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| 184 |
|
| 185 |
|
| 186 |
</footer> |
| 187 |
</div> |
| 188 |
</div> |
| 189 |
</section> |
| 190 |
</div> |
| 191 |
<script> |
| 192 |
jQuery(function () { |
| 193 |
SphinxRtdTheme.Navigation.enable(true); |
| 194 |
}); |
| 195 |
</script> |
| 196 |
|
| 197 |
|
| 198 |
|
| 199 |
|
| 200 |
</body> |
| 201 |
</html> |