Mention how to notify user that they have quarantined mails.

This commit is contained in:
Zhang Huangbin 2016-04-03 21:20:59 +08:00
parent 660be8ba6d
commit daa2225c96
4 changed files with 72 additions and 4 deletions

View File

@ -102,6 +102,43 @@ or delete them.
Screenshots attached at the bottom.
### Notify users about quarantined mails
!!! note
This feature requires you to enable self-service for mail domain -- you can
enable it in domain profile page.
iRedAdmin-Pro ships a script you can run to notify users about quarantined
mails: `tools/notify_quarantined_recipients.py`.
The notification email is read from template file
`tools/notify_quarantined_recipients.html`, you're free to modify it to match
your needs. (don't forget to backup it before upgrading iRedAdmin-Pro.)
The notification email will show the link of iRedAdmin-Pro so that users can
click it and login to manage quarantined mails. You must change the URL by
adding below parameter with proper URL in iRedAdmin-Pro config file:
```
NOTIFICATION_IREDADMIN_URL = 'https://[your_server]/iredadmin/'
```
To notify user, please add a cron job to run
`tools/notify_quarantined_recipients.py`. for example, every 6 hours:
```
1 */12 * * * python /path/to/tools/notify_quarantined_recipients.py >/dev/null
```
Don't forget to use the correct path to `notify_quarantined_recipients.py` on your server.
You can also run this script manually to notify users. for example, on RHEL/CentOS:
```
cd /var/www/iredadmin/tools/
python notify_quarantined_recipients.py
```
## Quarantine clean emails
Note: If you just want to quarantine clean emails sent from/to certain local

View File

@ -100,7 +100,7 @@ The order of plugin names doesn't matter.
* sql_user_restrictions
* amavisd_message_size_limit
First 3 plugins are replaced by `amavisd_wblist', last one is replaced by
First 3 plugins are replaced by `amavisd_wblist`, last one is replaced by
plugin `throttle`.
### Disable Cluebringer in Postfix

View File

@ -117,8 +117,8 @@ plugins = [..., 'amavisd_wblist', 'greylisting', 'throttle']
<li>sql_user_restrictions</li>
<li>amavisd_message_size_limit</li>
</ul>
<p>First 3 plugins are replaced by <code>amavisd_wblist', last one is replaced by
plugin</code>throttle`.</p>
<p>First 3 plugins are replaced by <code>amavisd_wblist</code>, last one is replaced by
plugin <code>throttle</code>.</p>
</li>
</ul>
<h3 id="disable-cluebringer-in-postfix">Disable Cluebringer in Postfix</h3>

View File

@ -13,7 +13,10 @@
<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></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>
@ -107,6 +110,34 @@ web server) is required.</p>
<code>System -&gt; 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>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This feature requires you to enable self-service for mail domain -- you can
enable it in domain profile page.</p>
</div>
<p>iRedAdmin-Pro ships a script you can run to notify users about quarantined
mails: <code>tools/notify_quarantined_recipients.py</code>.</p>
<p>The notification email is read from template file
<code>tools/notify_quarantined_recipients.html</code>, you're free to modify it to match
your needs. (don't forget to backup it before upgrading iRedAdmin-Pro.)</p>
<p>The notification email will show the link of iRedAdmin-Pro so that users can
click it and login to manage quarantined mails. You must change the URL by
adding below parameter with proper URL in iRedAdmin-Pro config file:</p>
<pre><code>NOTIFICATION_IREDADMIN_URL = 'https://[your_server]/iredadmin/'
</code></pre>
<p>To notify user, please add a cron job to run
<code>tools/notify_quarantined_recipients.py</code>. for example, every 6 hours:</p>
<pre><code>1 */12 * * * python /path/to/tools/notify_quarantined_recipients.py &gt;/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
</code></pre>
<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: