<!-- Creator : groff version 1.19.1 --> <!-- CreationDate: Wed Mar 26 07:55:34 2008 --> <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta name="generator" content="groff -Thtml, see www.gnu.org"> <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> <meta name="Content-Style" content="text/css"> <title>CYR_EXPIRE</title> </head> <body> <h1 align=center>CYR_EXPIRE</h1> <a href="#NAME">NAME</a><br> <a href="#SYNOPSIS">SYNOPSIS</a><br> <a href="#DESCRIPTION">DESCRIPTION</a><br> <a href="#OPTIONS">OPTIONS</a><br> <a href="#FILES">FILES</a><br> <a href="#SEE ALSO">SEE ALSO</a><br> <hr> <a name="NAME"></a> <h2>NAME</h2> <!-- INDENTATION --> <table width="100%" border=0 rules="none" frame="void" cols="2" cellspacing="0" cellpadding="0"> <tr valign="top" align="left"> <td width="11%"></td> <td width="89%"> <p>cyr_expire − expire messages and duplicate delivery database entries</p> </td> </table> <a name="SYNOPSIS"></a> <h2>SYNOPSIS</h2> <!-- INDENTATION --> <table width="100%" border=0 rules="none" frame="void" cols="2" cellspacing="0" cellpadding="0"> <tr valign="top" align="left"> <td width="11%"></td> <td width="89%"> <p><b>cyr_expire</b> [ <b>−C</b> <i>config-file</i> ] [ <b>−D</b> <i>delete-days</i> ] <b>−E</b> <i>expire-days</i> [ <b>−X</b> <i>expunge-days</i> ] [ <b>−p mailbox-prefix</b> ] [ <b>−v</b> ]</p> </td> </table> <a name="DESCRIPTION"></a> <h2>DESCRIPTION</h2> <!-- INDENTATION --> <table width="100%" border=0 rules="none" frame="void" cols="2" cellspacing="0" cellpadding="0"> <tr valign="top" align="left"> <td width="11%"></td> <td width="89%"> <p><i>Cyr_expire</i> is used to expire messages and duplicate delivery database entries. <i>Cyr_expire</i> also cleanses mailboxes of partially expunged messages (when using the "delayed" expunge mode). The expiration of messages is controlled by the <b>/vendor/cmu/cyrus-imapd/expire</b> mailbox annotation which specifies the age (in days) of messages in the given mailbox that should be deleted. Any duplicate delivery database entries which correspond to the mailbox are also deleted at the same frequency.</p> <!-- INDENTATION --> <p>The value of the <b>/vendor/cmu/cyrus-imapd/expire</b> annotation is inherited by all children of the given mailbox, so an entire mailbox tree can be expired by seting a single annotation on the root of that tree. If a mailbox does not have a <b>/vendor/cmu/cyrus-imapd/expire</b> annotation set on it (or does not inherit one), then no messages are expired from the mailbox.</p> <!-- INDENTATION --> <p><i>Cyr_expire</i> reads its configuration options out of the <i>imapd.conf</i>(5) file unless specified otherwise by <b>-C</b>.</p> </td> </table> <a name="OPTIONS"></a> <h2>OPTIONS</h2> <!-- INDENTATION --> <table width="100%" border=0 rules="none" frame="void" cols="2" cellspacing="0" cellpadding="0"> <tr valign="top" align="left"> <td width="11%"></td> <td width="89%"> <p><b>−C</b> <i>config-file</i></p></td> </table> <!-- INDENTATION --> <table width="100%" border=0 rules="none" frame="void" cols="2" cellspacing="0" cellpadding="0"> <tr valign="top" align="left"> <td width="22%"></td> <td width="78%"> <p>Read configuration options from <i>config-file</i>.</p> </td> </table> <!-- INDENTATION --> <table width="100%" border=0 rules="none" frame="void" cols="2" cellspacing="0" cellpadding="0"> <tr valign="top" align="left"> <td width="11%"></td> <td width="89%"> <p><b>−D</b> <i>delete-days</i></p></td> </table> <!-- INDENTATION --> <table width="100%" border=0 rules="none" frame="void" cols="2" cellspacing="0" cellpadding="0"> <tr valign="top" align="left"> <td width="22%"></td> <td width="78%"> <p>Remove previously deleted mailboxes older than <i>delete-days</i> (when using the "delayed" delete mode). The default is 0 (zero) days, which will delete <b>all</b> previously deleted mailboxes.</p> </td> </table> <!-- INDENTATION --> <table width="100%" border=0 rules="none" frame="void" cols="2" cellspacing="0" cellpadding="0"> <tr valign="top" align="left"> <td width="11%"></td> <td width="89%"> <p><b>−E</b> <i>expire-days</i></p></td> </table> <!-- INDENTATION --> <table width="100%" border=0 rules="none" frame="void" cols="2" cellspacing="0" cellpadding="0"> <tr valign="top" align="left"> <td width="22%"></td> <td width="78%"> <p>Prune the duplicate database of entries older than <i>expire-days</i>. This value is only used for entries which do not have a corresponding <b>/vendor/cmu/cyrus-imapd/expire</b> mailbox annotation.</p> </td> </table> <!-- INDENTATION --> <table width="100%" border=0 rules="none" frame="void" cols="2" cellspacing="0" cellpadding="0"> <tr valign="top" align="left"> <td width="11%"></td> <td width="89%"> <p><b>−X</b> <i>expunge-days</i></p></td> </table> <!-- INDENTATION --> <table width="100%" border=0 rules="none" frame="void" cols="2" cellspacing="0" cellpadding="0"> <tr valign="top" align="left"> <td width="22%"></td> <td width="78%"> <p>Expunge previously deleted messages older than <i>expunge-days</i> (when using the "delayed" expunge mode). The default is 0 (zero) days, which will expunge <b>all</b> previously deleted messages.</p> </td> </table> <!-- INDENTATION --> <table width="100%" border=0 rules="none" frame="void" cols="2" cellspacing="0" cellpadding="0"> <tr valign="top" align="left"> <td width="11%"></td> <td width="89%"> <p><b>−p</b> <i>mailbox-prefix</i></p></td> </table> <!-- INDENTATION --> <table width="100%" border=0 rules="none" frame="void" cols="2" cellspacing="0" cellpadding="0"> <tr valign="top" align="left"> <td width="22%"></td> <td width="78%"> <p>Only find mailboxes starting with this prefix. e.g. "user.justgotspammedlots"</p> </td> </table> <!-- TABS --> <table width="100%" border=0 rules="none" frame="void" cols="4" cellspacing="0" cellpadding="0"> <tr valign="top" align="left"> <td width="11%"></td> <td width="3%"> <p><b>−v</b></p> </td> <td width="8%"></td> <td width="78%"> <p>Enable verbose output.</p> </td> <tr valign="top" align="left"> <td width="11%"></td> <td width="3%"> <p><b>−a</b></p> </td> <td width="8%"></td> <td width="78%"> <p>Skip the annotation lookup, so all <b>/vendor/cmu/cyrus-imapd/expire</b> annotations are ignored entirely. It behaves as if they were not set, so only <i>expire-days</i> is considered for all mailboxes.</p> </td> </table> <a name="FILES"></a> <h2>FILES</h2> <!-- INDENTATION --> <table width="100%" border=0 rules="none" frame="void" cols="2" cellspacing="0" cellpadding="0"> <tr valign="top" align="left"> <td width="11%"></td> <td width="89%"> <p><b>/etc/imapd.conf</b></p></td> </table> <a name="SEE ALSO"></a> <h2>SEE ALSO</h2> <!-- INDENTATION --> <table width="100%" border=0 rules="none" frame="void" cols="2" cellspacing="0" cellpadding="0"> <tr valign="top" align="left"> <td width="11%"></td> <td width="89%"> <p><b>imapd.conf(5)</b>, <b>cyrus-master(8)</b></p> </td> </table> <hr> </body> </html>