====== Botbouncer ======

---- plugin ----
description: The plugin checks subscription emails for spam using the Botbouncer class https://github.com/michield/botbouncer.
author     : Duncan Cameron
type       : 
lastupdate : 2022-06-23
compatible : 
depends    : 
conflicts  : 
similar    : 
tags       : spam

downloadurl: https://github.com/bramley/phplist-plugin-botbouncer/archive/master.zip
sourcerepo : https://github.com/bramley/phplist-plugin-botbouncer
----

The plugin checks subscription emails and IP addresses for spam using the Botbouncer class https://github.com/michield/botbouncer.


It currently supports any combination of the following services:

  * [[https://www.stopforumspam.com/|Stop Forum Spam]] (no registration required, enabled by default)
  * [[https://akismet.com/|Akismet]] (free for personal use, commercial use paid)
  * [[https://www.projecthoneypot.org/|Project Honeypot]] (free registration required)
  * <del>[[http://www.mollom.com/|Mollom]]</del> (service ended)
  * [[https://getipintel.net/|IP Intel]] (no registration required, limit 500 IPs/day)

===== Installation =====

The recommended way to install is through the Plugins page (menu Config > Manage plugins) using the package URL %%https://github.com/bramley/phplist-plugin-botbouncer/archive/master.zip%%

Then enable the plugin.

===== Configuration =====

On the Settings page there is a Bot bouncer settings group where you can specify:

  * The message to be displayed to the subscriber when the subscription attempt is rejected
  * Whether to write a record to the event log for each failed subscription attempt (Yes).
  * Whether to send an email to the admin for each failed subscription attempt (No).
  * Whether to validate email addresses submitted on a subscribe page (Yes).
  * Whether to validate email addresses submitted on an asubscribe (AJAX) page (Yes).

<WRAP center round box 60%>
{{ :plugin:botbouncer_event_log.png?nolink&600 |}}
</WRAP>


<WRAP center round box 60%>

{{ :plugin:botbouncer_email.png?nolink&600 |}}
</WRAP>


You can control which services the Botbouncer class will use by setting these variables in the config.php file

  * ''$honeyPotApiKey'' - Set to API key to enable Project Honey Pot
  * ''$akismetApiKey''
  * ''$akismetBlogURL''
  * ''<del>$mollomPrivateKey</del>''
  * ''<del>$mollomPublicKey</del>''
  * ''$ipIntelContact'' - IP Intel requires an admin contact e-mail address (but no registration)
  * ''$sfsEnabled'' - set to ''false'' to disable Stop Forum Spam check

Additionally you can set these variables which are used by the Botbouncer class

  * ''$logRoot'' - Output various logs into this folder
  * ''$memCachedServer'' - Reduce duplicate API lookups by caching results with memcached


See the [[https://github.com/michield/botbouncer|Botbouncer repository]] for more information on how these settings are used.