PHPackages                             cboelter/contao-lead-optin - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. cboelter/contao-lead-optin

ActiveContao-module[Utility & Helpers](/categories/utility)

cboelter/contao-lead-optin
==========================

Opt-In functions for the contao-leads extension

2.1.2(3y ago)57.8k11[1 issues](https://github.com/cboelter/contao-leads-optin/issues)LGPL-3.0+PHPPHP ^7.4 || ^8.0

Since Jan 11Pushed 2y ago2 watchersCompare

[ Source](https://github.com/cboelter/contao-leads-optin)[ Packagist](https://packagist.org/packages/cboelter/contao-lead-optin)[ Docs](https://boelter.eu)[ RSS](/packages/cboelter-contao-lead-optin/feed)WikiDiscussions develop Synced today

READMEChangelog (10)Dependencies (5)Versions (22)Used By (0)

Contao Lead-OptIn
=================

[](#contao-lead-optin)

[![Latest Version on Packagist](https://camo.githubusercontent.com/75dbcb425c0d2e4d672caba05c682090c2acb4499b56daaa916c0352c0d1d86d/687474703a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f63626f656c7465722f636f6e74616f2d6c6561642d6f7074696e2e7376673f7374796c653d666c6174)](https://packagist.org/packages/cboelter/contao-lead-optin)[![Installations via composer per month](https://camo.githubusercontent.com/ab77b1c76b38277f4b1dd4e7db53283c8a425637ec3117bac93f71fc31212f26/687474703a2f2f696d672e736869656c64732e696f2f7061636b61676973742f646d2f63626f656c7465722f636f6e74616f2d6c6561642d6f7074696e2e7376673f7374796c653d666c6174)](https://packagist.org/packages/cboelter/contao-lead-optin)[![Installations via composer total](https://camo.githubusercontent.com/c4d440c42018618e2efe9aff581388f3b5b2d840df9446a4a44e89600a77d6db/687474703a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f63626f656c7465722f636f6e74616f2d6c6561642d6f7074696e2e7376673f7374796c653d666c6174)](https://packagist.org/packages/cboelter/contao-lead-optin)

Most of the work for Version 2.X was done by [Sebastian Zoglowek](https://github.com/zoglo) thanks for this!

This Extension provides double opt-in functions for the [Contao-Leads](https://github.com/terminal42/contao-leads) extension.

Setup
-----

[](#setup)

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

[![Contao Manager](docs/screenshot-contao-manager.png)](docs/screenshot-contao-manager.png)

Configuration
-------------

[](#configuration)

#### Notifications

[](#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".

[![Notification list](docs/screenshot-notification-list.png)](docs/screenshot-notification-list.png)

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`.

[![Notification](docs/screenshot-notification.png)](docs/screenshot-notification.png)

2. 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.

[![Notification Success](docs/screenshot-notification-success.png)](docs/screenshot-notification-success.png)

*General note: The known simpletoken ##form\_\*## will not work in this extension, you need to use ##lead\_\*## instead.*

#### Form configuration

[](#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.

[![Form configuration](docs/screenshot-form-configuration.png)](docs/screenshot-form-configuration.png)

*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

[](#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.

[![Module verification configuration](docs/screenshot-optin-verification.png)](docs/screenshot-optin-verification.png)

#### Export

[](#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.

[![Export configuration](docs/screenshot-optin-export.png)](docs/screenshot-optin-export.png)

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!).

###  Health Score

39

—

LowBetter than 84% of packages

Maintenance16

Infrequent updates — may be unmaintained

Popularity30

Limited adoption so far

Community16

Small or concentrated contributor base

Maturity77

Established project with proven stability

 Bus Factor1

Top contributor holds 92.3% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~128 days

Recently: every ~177 days

Total

18

Last Release

1274d ago

Major Versions

1.3 → 2.0.02023-01-05

PHP version history (3 changes)v1.0-beta1PHP >=5.6

1.0.0PHP ^5.6 || ^7.0

2.0.0PHP ^7.4 || ^8.0

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/550207?v=4)[Christopher Bölter](/maintainers/cboelter)[@cboelter](https://github.com/cboelter)

---

Top Contributors

[![cboelter](https://avatars.githubusercontent.com/u/550207?v=4)](https://github.com/cboelter "cboelter (36 commits)")[![davidmaack](https://avatars.githubusercontent.com/u/988290?v=4)](https://github.com/davidmaack "davidmaack (1 commits)")[![fritzmg](https://avatars.githubusercontent.com/u/4970961?v=4)](https://github.com/fritzmg "fritzmg (1 commits)")[![zoglo](https://avatars.githubusercontent.com/u/55794780?v=4)](https://github.com/zoglo "zoglo (1 commits)")

---

Tags

contaoleadscontao leads optinoptin

### Embed Badge

![Health badge](/badges/cboelter-contao-lead-optin/health.svg)

```
[![Health](https://phpackages.com/badges/cboelter-contao-lead-optin/health.svg)](https://phpackages.com/packages/cboelter-contao-lead-optin)
```

###  Alternatives

[markocupic/calendar-event-booking-bundle

Contao Calendar Event Booking Bundle

135.2k1](/packages/markocupic-calendar-event-booking-bundle)[codefog/contao-news_categories

News Categories bundle for Contao Open Source CMS

3189.0k6](/packages/codefog-contao-news-categories)[terminal42/contao-node

Node bundle for Contao Open Source CMS

3177.0k6](/packages/terminal42-contao-node)[terminal42/contao-mp_forms

An extension for Contao Open Source CMS to create multi steps forms using the form generator

2535.2k6](/packages/terminal42-contao-mp-forms)[codefog/tags-bundle

Tags bundle for Contao Open Source CMS

1398.4k13](/packages/codefog-tags-bundle)[metamodels/core

MetaModels core

10156.4k68](/packages/metamodels-core)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)