cboelter/contao-lead-optin

Opt-In functions for the contao-leads extension

2.1.2 2023-01-06 11:48 UTC

Requires

• php: ^7.4 || ^8.0
• ext-mbstring: *
• codefog/contao-haste: ^4.25
• contao/core-bundle: ^4.9
• terminal42/contao-leads: ~1.4
• terminal42/notification_center: ~1.4

Requires (Dev)

• contao/manager-plugin: ^2.3.1

Conflicts

• contao/core: *
• contao/manager-plugin: <2.0 || >=3.0

LGPL-3.0+

• Christopher Bölter

• contao
• leads
• contao leads optin
• optin

README

Most of the work for Version 2.X was done by Sebastian Zoglowek thanks for this!

This Extension provides double opt-in functions for the Contao-Leads extension.

Setup

Setup is currently only possible by composer or the contao manager. Just require or search for cboelter/contao-lead-optin and install it.

Configuration

Notifications

The extension knows two different types of notifications. One is the notification sent to the user, if he submits the form. This contains the optin link and additional informations. It is called "Anfragen speichern: OptIn". The second one is a notification which is sent, if a user successfully clicked on the opt in link. It is called "Anfragen speichern: OptIn Bestätigung".

1. Anfragen speichern: OptIn

This notification can use the following simple tokens to send nofications to the user:

lead_*, formconfig_*, admin_email, raw_data, optin_token, optin_url

The token lead_* can use every form form like this way: lead_email. The token formconfig_* can use every form config like this way: formconfig_id.

1. Anfragen speichern: OptIn Bestätigung

This notification can use the following simple tokens to send nofications to the user:

lead_*, formconfig_*, admin_email

The token lead_* can use every form field like this way: lead_email. The token formconfig_* can use every form config like this way: formconfig_id.

It is not mandatory and can be used e.g for notify the admin about a new registration.

General note: The known simpletoken ##form_*## will not work in this extension, you need to use ##lead_*## instead.

Form configuration

To use the module, there must be a contao form. Create the form and the form field inside the contao form manager. This extension is an addon for the leads extension. So you need to enable this inside the form you want to use the extension.

You have to enable the "Anfragen speichern" checkbox inside the form configuration. After enabling the checkbox, you will see the base configuration for leads and another checkbox "Anfragen speicher OptIn". You have to setup the base configuration, then you can enable the opt in. Simply choose a notifaction you have created in the first step, select the ip tracking or not and finally choose a redirect page for the OptIn-Link.

General note: You have to enable the email field to be stored by leads, if it is not enable, the extension will not work

OptIn-Page / Handling module

To get the extension working you have to create a new frontend module of the type "OptIn Verarbeitung".

In this module you can define a note for the successfull optin and a note for an optin with errors. The module automatically decides which text it will show to the user. As a third configuration you can select a sucess notification (see notifications section).

Include this module on the page, you have selected in form configuration as the "OptIn Zielseite". The opt in will now work.

Export

This extension provides a custom exporter for the opt in. In the export configuration you can see a new export type called "OptIn-Export CSV (.csv)". It provides a custom data collector and exporter to export all needed data for the optin. You only need to select this exporter and give it a name.

The people icon in the backend list of leads shows you the opt in state -> green means opt in is done -> grey means opt in is not done right now.

This is it ... you can now use the extension. If you think you have found a bug, feel free to open a github issue or a pull request :-) Thanks!

This documentation is sponsored by Stefan Senn (Thanks for that!).