PHPackages                             abolkog/newsletter - 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. abolkog/newsletter

AbandonedArchivedCakephp-plugin

abolkog/newsletter
==================

Newsletter plugin for CakePHP

1.0-beta(8y ago)2141MITPHP

Since Aug 15Pushed 8y ago1 watchersCompare

[ Source](https://github.com/abolkog/cakephp-newsletter)[ Packagist](https://packagist.org/packages/abolkog/newsletter)[ RSS](/packages/abolkog-newsletter/feed)WikiDiscussions master Synced yesterday

READMEChangelogDependencies (2)Versions (2)Used By (0)

Newsletter plugin for CakePHP
=============================

[](#newsletter-plugin-for-cakephp)

This plugins adds a basic News Letter functionality to your CakePHP based application.

Requirements
------------

[](#requirements)

- CakePHP 3.x

Installation
------------

[](#installation)

```
    composer require abolkog/Newsletter

```

- Enable the plugin within your config/bootstrap.php

    ```
      Plugin::load('Newsletter', ['bootstrap' => false, 'routes' => true]);

    ```
- Run the following command in the CakePHP console to create the tables using the Migrations plugin:

    ```
      bin/cake migrations migrate -p newsletter

    ```

Usage
-----

[](#usage)

### Displaying the Subscribe Form

[](#displaying-the-subscribe-form)

- Load the **Newsletter component** in your controller

    ```
      $this->loadComponent('Newsletter.Newsletter');

    ```
- Display the form using the **SubscribeWidget** in your views

    ```

    ```

### Example

[](#example)

in AppController.php

```
    namespace App\Controller;

    use Cake\Controller\Controller;
    use Cake\Event\Event;

    class AppController extends Controller
    {

        public function initialize()
        {
            parent::initialize();
            $this->loadComponent('Newsletter.Newsletter');
        }
    }

```

in footer.ctp

```

```

### Accessing the admin area

[](#accessing-the-admin-area)

- The easiest way is to add the following link to your navigation to access the admin area of the news letter

    ```

    ```

### Sender Shell

[](#sender-shell)

The sender shell is used to send out emails as well as showing current emails in the queue

- To list all emails in the queue

    ```
      bin/cake newsletter.sender  show

    ```
- To start Processing the email queue

    ```
      bin/cake newsletter.sender  run

    ```

This run command will processs 50 emails per time. you can override it by passing the **limit** argument

```
    bin/cake newsletter.sender run -l 100

```

- To see all available commmands

    ```
      bin/cake newsletter.sender

    ```

License
-------

[](#license)

Licensed under the [MIT](http://www.opensource.org/licenses/mit-license.php) License. Redistributions of the source code included in this repository must retain the copyright notice found in each file.

###  Health Score

24

—

LowBetter than 32% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity10

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity49

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% 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

Unknown

Total

1

Last Release

3193d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/cd342e47345fd9f281cebc5b4df7ff7bb7d229d8786f0a95bba4bcc933923723?d=identicon)[abolkog](/maintainers/abolkog)

---

Top Contributors

[![abolkog](https://avatars.githubusercontent.com/u/3861725?v=4)](https://github.com/abolkog "abolkog (18 commits)")

---

Tags

cakephpnewslettermailing

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/abolkog-newsletter/health.svg)

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

###  Alternatives

[cakephp/bake

Bake plugin for CakePHP

11211.2M158](/packages/cakephp-bake)[dereuromark/cakephp-tools

A CakePHP plugin containing lots of useful and reusable tools

338920.1k32](/packages/dereuromark-cakephp-tools)[dereuromark/cakephp-queue

The Queue plugin for CakePHP provides deferred task execution.

308850.3k14](/packages/dereuromark-cakephp-queue)[dereuromark/cakephp-ide-helper

CakePHP IdeHelper Plugin to improve auto-completion

1862.1M27](/packages/dereuromark-cakephp-ide-helper)[dereuromark/cakephp-tinyauth

A CakePHP plugin to handle user authentication and authorization the easy way.

129228.6k10](/packages/dereuromark-cakephp-tinyauth)[cakephp/queue

Queue plugin for CakePHP

36257.9k12](/packages/cakephp-queue)

PHPackages © 2026

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