224 lines
9.7 KiB
HTML
224 lines
9.7 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
<title>Quarantining</title>
|
|
<link rel="stylesheet" type="text/css" href="./css/markdown.css" />
|
|
</head>
|
|
<body>
|
|
|
|
<div id="navigation">
|
|
<a href="https://www.iredmail.org" target="_blank">
|
|
<img alt="iRedMail web site"
|
|
src="./images/logo-iredmail.png"
|
|
style="vertical-align: middle; height: 30px;"
|
|
/>
|
|
<span>iRedMail</span>
|
|
</a>
|
|
// <a href="./index.html">Document Index</a></div><h1 id="quarantining">Quarantining</h1>
|
|
<div class="toc">
|
|
<ul>
|
|
<li><a href="#quarantining">Quarantining</a><ul>
|
|
<li><a href="#quarantining-spam-virus-banned-and-bad-header-messages">Quarantining spam, virus, banned and bad header messages</a></li>
|
|
<li><a href="#configure-iredadmin-pro-to-manage-quarantined-mails">Configure iRedAdmin-Pro to manage quarantined mails</a><ul>
|
|
<li><a href="#notify-users-about-quarantined-mails">Notify users about quarantined mails</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#quarantine-clean-emails">Quarantine clean emails</a></li>
|
|
<li><a href="#screenshots">Screenshots</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<p>Since iRedMail-<code>0.7.0</code>, quarantining related settings in Amavisd are configured
|
|
by iRedMail but disabled by default, you can easily enable quarantining with
|
|
this tutorial.</p>
|
|
<p>With below steps, Virus/Spam/Banned emails will be quarantined into SQL database.
|
|
You can then manage quarantined emails with iRedAdmin-Pro.</p>
|
|
<h2 id="quarantining-spam-virus-banned-and-bad-header-messages">Quarantining spam, virus, banned and bad header messages</h2>
|
|
<p>Edit Amavisd config file, find below settings and update them. If it doesn't
|
|
exist, please add them.</p>
|
|
<ul>
|
|
<li>on Red Hat Enterprise Linux, CentOS, Scientific Linux, it's <code>/etc/amavisd/amavisd.conf</code>
|
|
or <code>/etc/amavisd.conf</code>.</li>
|
|
<li>on Debian/Ubuntu, it's <code>/etc/amavis/conf.d/50-user</code>.</li>
|
|
<li>on FreeBSD, it's <code>/usr/local/etc/amavisd.conf</code>.</li>
|
|
<li>on OpenBSD, it's <code>/etc/amavisd.conf</code>.</li>
|
|
</ul>
|
|
<pre><code># Part of file: /etc/amavisd/amavisd.conf
|
|
|
|
# Change values of below parameters to D_DISCARD.
|
|
# Detected spams/virus/banned messages will not be delivered to user's mailbox.
|
|
$final_virus_destiny = D_DISCARD;
|
|
$final_spam_destiny = D_DISCARD;
|
|
$final_banned_destiny = D_DISCARD;
|
|
$final_bad_header_destiny = D_DISCARD;
|
|
|
|
# Quarantine SPAM into SQL server.
|
|
$spam_quarantine_to = 'spam-quarantine';
|
|
$spam_quarantine_method = 'sql:';
|
|
|
|
# Quarantine VIRUS into SQL server.
|
|
$virus_quarantine_to = 'virus-quarantine';
|
|
$virus_quarantine_method = 'sql:';
|
|
|
|
# Quarantine BANNED message into SQL server.
|
|
$banned_quarantine_to = 'banned-quarantine';
|
|
$banned_files_quarantine_method = 'sql:';
|
|
|
|
# Quarantine Bad Header message into SQL server.
|
|
$bad_header_quarantine_method = 'sql:';
|
|
$bad_header_quarantine_to = 'bad-header-quarantine';
|
|
</code></pre>
|
|
<p>Also, make sure you have below lines configured in same config file:</p>
|
|
<pre><code class="language-perl"># For MySQL/MariaDB/OpenLDAP backends
|
|
@storage_sql_dsn = (
|
|
['DBI:mysql:database=amavisd;host=127.0.0.1;port=3306', 'amavisd', 'password'],
|
|
);
|
|
|
|
# For PostgreSQL
|
|
#@storage_sql_dsn = (
|
|
# ['DBI:Pg:database=amavisd;host=127.0.0.1;port=5432', 'amavisd', 'password'],
|
|
#);
|
|
</code></pre>
|
|
<p>Restarting amavisd service is required.</p>
|
|
<h2 id="configure-iredadmin-pro-to-manage-quarantined-mails">Configure iRedAdmin-Pro to manage quarantined mails</h2>
|
|
<p>Update iRedAdmin-Pro config file, make sure you have correct settings for Amavisd:</p>
|
|
<ul>
|
|
<li>on Red Hat Enterprise Linux, CentOS, Scientific Linux, it's <code>/var/www/iredadmin/settings.py</code>.</li>
|
|
<li>on Debian, Ubuntu, it's <code>/opt/www/iredadmin/settings.py</code> or <code>/usr/share/apache2/iredadmin/settings.py</code>.</li>
|
|
<li>on FreeBSD, it's <code>/usr/local/www/iredadmin/settings.py</code>.</li>
|
|
<li>on OpenBSD, it's <code>/var/www/iredadmin/settings.py</code>.</li>
|
|
</ul>
|
|
<pre><code class="language-python"># File: settings.py
|
|
|
|
amavisd_db_host = '127.0.0.1'
|
|
amavisd_db_port = 3306
|
|
amavisd_db_name = 'amavisd'
|
|
amavisd_db_user = 'amavisd'
|
|
amavisd_db_password = 'password'
|
|
|
|
# Log basic info of inbound/outbound, no mail body stored.
|
|
amavisd_enable_logging = True
|
|
|
|
# Quarantining management
|
|
amavisd_enable_quarantine = True
|
|
amavisd_quarantine_port = 9998
|
|
|
|
# Per-recipient policy lookup
|
|
amavisd_enable_policy_lookup = True
|
|
</code></pre>
|
|
<p>Restarting Apache web server or <code>uwsgi</code> service (if you're running Nginx as
|
|
web server) is required.</p>
|
|
<p>You can now login to iRedAdmin-Pro, and manage quarantined messages via menu
|
|
<code>System -> Quarantined Mails</code>. Choose action in drop-down menu list to release
|
|
or delete them.</p>
|
|
<p>Screenshots attached at the bottom.</p>
|
|
<h3 id="notify-users-about-quarantined-mails">Notify users about quarantined mails</h3>
|
|
<p>iRedAdmin-Pro ships script <code>tools/notify_quarantined_recipients.py</code> to notify
|
|
users which have email quarantined in SQL database.</p>
|
|
<p>Default notification email contains basic info of each quarantined email:</p>
|
|
<ul>
|
|
<li>mail subject</li>
|
|
<li>sender</li>
|
|
<li>recipient</li>
|
|
<li>spam level (score)</li>
|
|
<li>mail arrived time</li>
|
|
</ul>
|
|
<p>The notification email message is read from (HTML) template file
|
|
<code>tools/notify_quarantined_recipients.html</code>, if you want to modify it, please
|
|
copy it to <code>tools/notify_quarantined_recipients.html.custom</code> then modify it.
|
|
During upgrading iRedAdmin-Pro, this custom file will be copied to
|
|
new iRedAdmin-Pro directory, so you won't lose your customization.</p>
|
|
<p>Several parameters are required by this script in iRedAdmin-Pro config file:</p>
|
|
<pre><code># SMTP server address, port, username, password used to send notification mail.
|
|
NOTIFICATION_SMTP_SERVER = 'localhost'
|
|
NOTIFICATION_SMTP_PORT = 587
|
|
NOTIFICATION_SMTP_STARTTLS = True
|
|
NOTIFICATION_SMTP_USER = 'no-reply@localhost.local'
|
|
NOTIFICATION_SMTP_PASSWORD = ''
|
|
NOTIFICATION_SMTP_DEBUG_LEVEL = 0
|
|
|
|
# URL of your iRedAdmin-Pro login page which will be shown in notification
|
|
# email, so that user can login to manage quarantined emails.
|
|
# Sample: 'https://your_server.com/iredadmin/'
|
|
#
|
|
# Note: mail domain must have self-service enabled, otherwise normal
|
|
# mail user cannot login to iRedAdmin-Pro for self-service.
|
|
NOTIFICATION_URL_SELF_SERVICE = 'https://[your_server]/iredadmin/'
|
|
|
|
# Subject of notification email. Available placeholders:
|
|
# - %(total)d -- number of quarantined mails in total
|
|
NOTIFICATION_QUARANTINE_MAIL_SUBJECT = '[Attention] You have %(total)d emails quarantined and not delivered to mailbox'
|
|
</code></pre>
|
|
<p>To notify user periodly, please add a cron job for root user to run
|
|
<code>tools/notify_quarantined_recipients.py</code>. For example, every 6 hours ('6 hours'
|
|
is just an example, the period is totally up to you):</p>
|
|
<pre><code>1 */6 * * * /usr/bin/python /var/www/iredadmin/tools/notify_quarantined_recipients.py --force-all >/dev/null
|
|
</code></pre>
|
|
<p>Don't forget to use the correct path to <code>notify_quarantined_recipients.py</code> on your server.</p>
|
|
<p>You can also run this script manually to notify users. for example,
|
|
on RHEL/CentOS:</p>
|
|
<pre><code>cd /var/www/iredadmin/tools/
|
|
python notify_quarantined_recipients.py --force-all
|
|
</code></pre>
|
|
<p><code>notify_quarantined_recipients.py</code> supports few arguments:</p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Argument</th>
|
|
<th>Comment</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--force-all</code></td>
|
|
<td>Send notification to all users which have email quarantined</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--force-all-time</code></td>
|
|
<td>Notify users for their all quarantined emails instead of just new ones since last notification.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--notify-backupmx</code></td>
|
|
<td>Send notification to all recipients under backup mx domain</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="quarantine-clean-emails">Quarantine clean emails</h2>
|
|
<p>Note: If you just want to quarantine clean emails sent from/to certain local
|
|
user, please refer to this document instead:
|
|
<a href="./quarantine.clean.mails.per-user.html">Quarantine clean emails sent from/to certain local user</a></p>
|
|
<p>If you want to quarantine clean emails into SQL database for further approval
|
|
or whatever reason, please follow below steps:</p>
|
|
<ul>
|
|
<li>Update below parameters in Amavisd config file <code>amavisd.conf</code>:</li>
|
|
</ul>
|
|
<pre><code class="language-perl">$clean_quarantine_method = 'sql:';
|
|
$clean_quarantine_to = 'clean-quarantine';
|
|
</code></pre>
|
|
<ul>
|
|
<li>Find policy bank <code>ORIGINATING</code>, append two lines in this policy bank:</li>
|
|
</ul>
|
|
<pre><code class="language-perl">$policy_bank{'ORIGINATING'} = {
|
|
...
|
|
clean_quarantine_method => 'sql:',
|
|
final_destiny_by_ccat => {CC_CLEAN, D_DISCARD},
|
|
}
|
|
</code></pre>
|
|
<ul>
|
|
<li>Restart Amavisd service.</li>
|
|
</ul>
|
|
<p>Now all clean emails sent by your mail users will be quarantined into SQL
|
|
database.</p>
|
|
<h2 id="screenshots">Screenshots</h2>
|
|
<ul>
|
|
<li>View quarantined mails:</li>
|
|
</ul>
|
|
<p><img alt="" src="./images/iredadmin/system_maillog_quarantined.png" /></p>
|
|
<ul>
|
|
<li>Expand quarantined mail to view mail body and headers.</li>
|
|
</ul>
|
|
<p><img alt="" src="./images/iredadmin/system_maillog_quarantined_expanded.png" /></p><div class="footer">
|
|
<p style="text-align: center; color: grey;">All documents are available in <a href="https://github.com/iredmail/docs/">GitHub repository</a>, and published under <a href="http://creativecommons.org/licenses/by-nd/3.0/us/" target="_blank">Creative Commons</a> license. You can <a href="https://github.com/iredmail/docs/archive/master.zip">download the latest version</a> for offline reading. If you found something wrong, please do <a href="https://www.iredmail.org/contact.html">contact us</a> to fix it.</p>
|
|
</div></body></html> |