PHPackages                             misterbk/optinmail - 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. [Mail & Notifications](/categories/mail)
4. /
5. misterbk/optinmail

ActiveCraft-plugin[Mail & Notifications](/categories/mail)

misterbk/optinmail
==================

A plugin that simplifies the implementation of opt-in process for any input forms in Craft CMS.

2.0.3(1y ago)2971[1 PRs](https://github.com/mister-bk/craft-plugin-optinmail/pulls)proprietaryPHPCI passing

Since Apr 2Pushed 1mo ago2 watchersCompare

[ Source](https://github.com/mister-bk/craft-plugin-optinmail)[ Packagist](https://packagist.org/packages/misterbk/optinmail)[ RSS](/packages/misterbk-optinmail/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (7)Dependencies (1)Versions (14)Used By (0)

optinmail
=========

[](#optinmail)

A plugin that simplifies the implementation of opt-in process for any input forms.

This is a Plugin for developers, as you will need to provide your own template-files.

Prerequisites
-------------

[](#prerequisites)

This plugin requires Craft CMS 4.0.0 or later

Installing
----------

[](#installing)

##### go to the project directory

[](#go-to-the-project-directory)

```
cd /path/to/my-project.test

```

##### tell Composer to load the plugin

[](#tell-composer-to-load-the-plugin)

```
composer require misterbk/optinmail

```

##### tell Craft to install the plugin

[](#tell-craft-to-install-the-plugin)

```
./craft install/plugin opt-in-mail

```

Setup
-----

[](#setup)

To get this plugin to work, you need to create or link your own template files.

##### 1. Settings

[](#1-settings)

To do this, please open the Controll-Center setup page in the admin section of Craft:
"Settings > Plug-ins > Opt In Mail"
Set the path to all three template files. An example is provided in the examples-folder of this plugin. You can see how to access the variables provided in these views and see example implementations of the emails/sites

##### 2. Qualified Field Names

[](#2-qualified-field-names)

To prevent database-injection you have to provide "qualified field names", which means, that you whitelist the fields you want to accept in the form you want to connect with an opt-in-procedure. Just add the names of your input fields under the corresponding formHandle in the "opt-in-mail.php file". You find this file under: "config/opt-in-mail.php"
If that file does not exist, you can copy our example config file from "craft-plugin-optInMail/src/examples/opt-in-mail.php" to Craft's config folder and add your field names there.

##### 3. Hook up your form

[](#3-hook-up-your-form)

When everything is set up you can connect your form to the plugin by adding a hidden input field to your form with the following format:\\

```

```

whereas {{handle}} is the formHandle you provided in the "opt-in-mail.php" config file in step 2

##### 4. Test your form

[](#4-test-your-form)

If Craft's mailing settings are set you can submit your form and see if you receive the opt-in-mail.

Additional Info
---------------

[](#additional-info)

This is one of our first Plug-ins for Craft 3, so we rely on your feedback. If you have any suggestions or found any bugs, please contact us over our Github-Account :  or via email: [mister-bk!](mailto:s.karst@mister-bk.de)

###  Health Score

42

—

FairBetter than 90% of packages

Maintenance66

Regular maintenance activity

Popularity13

Limited adoption so far

Community13

Small or concentrated contributor base

Maturity67

Established project with proven stability

 Bus Factor1

Top contributor holds 55.6% 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 ~502 days

Total

5

Last Release

585d ago

Major Versions

1.0.2 → 2.0.02022-09-27

### Community

Maintainers

![](https://www.gravatar.com/avatar/3cf31b6b41c0e0ee8a18739cf0fb784bef235ec5047194bdb2177ba6f99337fc?d=identicon)[misterbk](/maintainers/misterbk)

---

Top Contributors

[![Konsti-O](https://avatars.githubusercontent.com/u/2579170?v=4)](https://github.com/Konsti-O "Konsti-O (15 commits)")[![dominikfeilbach](https://avatars.githubusercontent.com/u/66304928?v=4)](https://github.com/dominikfeilbach "dominikfeilbach (9 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (2 commits)")[![SKarst](https://avatars.githubusercontent.com/u/39827272?v=4)](https://github.com/SKarst "SKarst (1 commits)")

---

Tags

pluginmailCraftcraftcmscraft-pluginopt indouble-opt-in

### Embed Badge

![Health badge](/badges/misterbk-optinmail/health.svg)

```
[![Health](https://phpackages.com/badges/misterbk-optinmail/health.svg)](https://phpackages.com/packages/misterbk-optinmail)
```

###  Alternatives

[craftpulse/craft-notifications

Send notifications across a variety of delivery channels, including mail and Slack. Notifications may also be stored in a database so they may be displayed in your web interface.

551.2k](/packages/craftpulse-craft-notifications)

PHPackages © 2026

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