Spamexperts: Difference between revisions
No edit summary |
|||
| (5 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
= Introduction = | |||
This | This package connects the [http://www.spamexperts.com/ SpamExperts] system with Open-Xchange. | ||
It allows to access your SpamExperts settings from within Open-Xchange and use the spam- and ham | |||
learning mechanisms of SpamExperts directly from within the Open-Xchange UI. | |||
{{InstallPlugin|pluginname=open-xchange-spamhandler-spamexperts open-xchange-spamhandler-spamexperts-gui|sopath=stable}} | {{InstallPlugin|pluginname=open-xchange-spamhandler-spamexperts open-xchange-spamhandler-spamexperts-gui|sopath=6.22/backend|version=v6.22.x}} | ||
{{InstallPlugin|pluginname=open-xchange-spamhandler-spamexperts open-xchange-appsuite-spamexperts|toplevel=products|sopath=appsuite/stable/backend|version=App Suite}} | |||
=Components= | =Components= | ||
OX UI | == OX UI Plugin == | ||
The UI plugin extends the OX settings tree with a new subtree to access the "Antispam" management WEB UI of Spamexperts.com | The UI plugin extends the OX settings tree with a new subtree to access the "Antispam" management WEB UI of Spamexperts.com | ||
OX | == OX Backend Plugin == | ||
The | The backend plugin consists of a servlet which can create an authentication ticket for the currently active OX user by using the | ||
Spamexperts.com API and then sends the ticket back to the UI plugin which will do the redirect to the external Spamexperts.com management WEB UI. | Spamexperts.com API and then sends the ticket back to the UI plugin which will do the redirect to the external Spamexperts.com management WEB UI. | ||
=Configuration file= | = Configuration = | ||
You need to adapt the settings in <tt>/opt/open-xchange/etc/spamexperts.properties</tt> | |||
Settings can be separated in two sections: | |||
== SpamExperts UI integration == | |||
Define your custom parameters in order to integrate your branded SpamExperts UI into Open-Xchange | |||
== SpamExperts SPAM/HAM learning integration == | |||
'''Note: This requires backend version 7.6.0 or newer.''' | |||
Configure you personal parameters to access the SpamExperts IMAP server in order to use the SPAM/HAM | |||
learning mechanism. | |||
In addition, you have to tell the Open-Xchange mail backend what spamhandler to use for SPAM/HAM learning. | |||
This must be done in the configuration file <tt>/opt/open-xchange/etc/imap.properties</tt>. You have to set | |||
com.openexchange.imap.spamHandler=SpamExperts | |||
exactly like this, or the SPAM/HAM learning mechanism will not work. | |||
= Provisioning = | |||
'''Note: This requires backend version 7.6.0 or newer.''' | |||
In order to activate SPAM/HAM learning in OX Webmail, you have to turn that on for the users by using one of the following ways: | |||
* using create- or changeuser, provide the option <tt>--gui_spam_filter_capabilities_enabled true</tt> or | |||
* setting <tt>com.openexchange.spamhandler.enabled</tt> to <tt>true</tt> via ConfigCascade | |||
In order to add the spamexperts link to OX Webmail, provide the option <tt>--capabilities-to-add com.spamexperts</tt> | |||
[[Category: Administrator]] | |||
[[Category: OX6]] | |||
[[Category: AppSuite]] | |||
[[Category: Spamhandling]] | |||
Latest revision as of 10:38, 14 February 2017
Introduction
This package connects the SpamExperts system with Open-Xchange. It allows to access your SpamExperts settings from within Open-Xchange and use the spam- and ham learning mechanisms of SpamExperts directly from within the Open-Xchange UI.
Install on OX v6.22.x
Debian GNU/Linux 11.0
Add the following entry to /etc/apt/sources.list.d/open-xchange.list if not already present:
deb https://software.open-xchange.com/products/6.22/backend/DebianBullseye/ /
# if you have a valid maintenance subscription, please uncomment the
# following and add the ldb account data to the url so that the most recent
# packages get installed
# deb https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/products/6.22/backend/updates/DebianBullseye/ /
and run
$ apt-get update $ apt-get install open-xchange-spamhandler-spamexperts open-xchange-spamhandler-spamexperts-gui
Debian GNU/Linux 12.0
Add the following entry to /etc/apt/sources.list.d/open-xchange.list if not already present:
deb https://software.open-xchange.com/products/6.22/backend/DebianBookworm/ /
# if you have a valid maintenance subscription, please uncomment the
# following and add the ldb account data to the url so that the most recent
# packages get installed
# deb https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/products/6.22/backend/updates/DebianBookworm/ /
and run
$ apt-get update $ apt-get install open-xchange-spamhandler-spamexperts open-xchange-spamhandler-spamexperts-gui
Install on OX App Suite
Debian GNU/Linux 11.0
Add the following entry to /etc/apt/sources.list.d/open-xchange.list if not already present:
deb https://software.open-xchange.com/products/appsuite/stable/backend/DebianBullseye/ /
# if you have a valid maintenance subscription, please uncomment the
# following and add the ldb account data to the url so that the most recent
# packages get installed
# deb https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/products/appsuite/stable/backend/updates/DebianBullseye/ /
and run
$ apt-get update $ apt-get install open-xchange-spamhandler-spamexperts open-xchange-appsuite-spamexperts
Debian GNU/Linux 12.0
Add the following entry to /etc/apt/sources.list.d/open-xchange.list if not already present:
deb https://software.open-xchange.com/products/appsuite/stable/backend/DebianBookworm/ /
# if you have a valid maintenance subscription, please uncomment the
# following and add the ldb account data to the url so that the most recent
# packages get installed
# deb https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/products/appsuite/stable/backend/updates/DebianBookworm/ /
and run
$ apt-get update $ apt-get install open-xchange-spamhandler-spamexperts open-xchange-appsuite-spamexperts
Components
OX UI Plugin
The UI plugin extends the OX settings tree with a new subtree to access the "Antispam" management WEB UI of Spamexperts.com
OX Backend Plugin
The backend plugin consists of a servlet which can create an authentication ticket for the currently active OX user by using the Spamexperts.com API and then sends the ticket back to the UI plugin which will do the redirect to the external Spamexperts.com management WEB UI.
Configuration
You need to adapt the settings in /opt/open-xchange/etc/spamexperts.properties
Settings can be separated in two sections:
SpamExperts UI integration
Define your custom parameters in order to integrate your branded SpamExperts UI into Open-Xchange
SpamExperts SPAM/HAM learning integration
Note: This requires backend version 7.6.0 or newer.
Configure you personal parameters to access the SpamExperts IMAP server in order to use the SPAM/HAM learning mechanism.
In addition, you have to tell the Open-Xchange mail backend what spamhandler to use for SPAM/HAM learning. This must be done in the configuration file /opt/open-xchange/etc/imap.properties. You have to set
com.openexchange.imap.spamHandler=SpamExperts
exactly like this, or the SPAM/HAM learning mechanism will not work.
Provisioning
Note: This requires backend version 7.6.0 or newer.
In order to activate SPAM/HAM learning in OX Webmail, you have to turn that on for the users by using one of the following ways:
- using create- or changeuser, provide the option --gui_spam_filter_capabilities_enabled true or
- setting com.openexchange.spamhandler.enabled to true via ConfigCascade
In order to add the spamexperts link to OX Webmail, provide the option --capabilities-to-add com.spamexperts