====== Simple Captcha ======

---- plugin ----

description: This plugin provides a CAPTCHA field on subscription forms.
author     : Duncan Cameron
type       : 
compatible : 3.x
depends    : 
conflicts  : 
similar    : 
tags       : spam

sourcerepo : https://github.com/bramley/phplist-plugin-simple-captcha

----

This plugin provides a CAPTCHA field on subscription forms using the [[https://github.com/S1SYPHOS/php-simple-captcha|Simple Captcha]] package.

The CAPTCHA requires that the user type the letters and digits of a distorted image.
{{:plugin:simplecaptcha1.png?nolink&500|}}


For other approaches to captcha see the [[https://resources.phplist.com/plugin/recaptcha|reCAPTCHA plugin]] and the [[https://resources.phplist.com/plugin/recaptchav3|reCAPTCHAv3 plugin]].
====== Installation ======

Install on the Plugins page (menu Config > Plugins) using the package URL

''%%https://github.com/bramley/phplist-plugin-simple-captcha/archive/master.zip%%''

====== Configuration ======

===== Settings =====

On the Settings page you can specify:

  * The prompt for the CAPTCHA field
  * The message to be displayed to the subscriber when the entered CAPTCHA is incorrect
  * Whether to write a record to the event log for each incorrect CAPTCHA and subscription attempt
  * Whether to send an email to the admin for each incorrect CAPTCHA and subscription attempt

===== Subscribe pages =====

For each subscribe page that you create you can select whether it should include a simple-captcha field.

===== Internationalisation =====

If your subscribe pages are in a language other than English then on the Settings page you can change the prompt and messages that are displayed to the subscriber to be in the local language.

====== Test that it works ======

On your phplist subscription page enter all of the mandatory fields and an incorrect value in the CAPTCHA field. The subscription attempt should be rejected.

====== Support ======
Report any issues or questions in the support forum https://discuss.phplist.org/