From daa2225c9645b6d9196c3db37019c86357df729d Mon Sep 17 00:00:00 2001 From: Zhang Huangbin Date: Sun, 3 Apr 2016 21:20:59 +0800 Subject: [PATCH] Mention how to notify user that they have quarantined mails. --- en_US/howto/2-quarantining.md | 37 ++++++++++++++++++++++ en_US/migrations/cluebringer.to.iredapd.md | 2 +- html/cluebringer.to.iredapd.html | 4 +-- html/quarantining.html | 33 ++++++++++++++++++- 4 files changed, 72 insertions(+), 4 deletions(-) diff --git a/en_US/howto/2-quarantining.md b/en_US/howto/2-quarantining.md index 97313548..150d3564 100644 --- a/en_US/howto/2-quarantining.md +++ b/en_US/howto/2-quarantining.md @@ -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 diff --git a/en_US/migrations/cluebringer.to.iredapd.md b/en_US/migrations/cluebringer.to.iredapd.md index 60142c98..f074766e 100644 --- a/en_US/migrations/cluebringer.to.iredapd.md +++ b/en_US/migrations/cluebringer.to.iredapd.md @@ -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 diff --git a/html/cluebringer.to.iredapd.html b/html/cluebringer.to.iredapd.html index a60132e4..47497c17 100644 --- a/html/cluebringer.to.iredapd.html +++ b/html/cluebringer.to.iredapd.html @@ -117,8 +117,8 @@ plugins = [..., 'amavisd_wblist', 'greylisting', 'throttle']
  • sql_user_restrictions
  • amavisd_message_size_limit
    • -

    First 3 plugins are replaced by amavisd_wblist', last one is replaced by -pluginthrottle`.

    +

    First 3 plugins are replaced by amavisd_wblist, last one is replaced by +plugin throttle.

    Disable Cluebringer in Postfix

    diff --git a/html/quarantining.html b/html/quarantining.html index 86caf01b..8d3a2552 100644 --- a/html/quarantining.html +++ b/html/quarantining.html @@ -13,7 +13,10 @@