PHPackages                             cwbit/cakephp-emailqueue - 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. [Queues & Workers](/categories/queues)
4. /
5. cwbit/cakephp-emailqueue

ActiveCakephp-plugin[Queues & Workers](/categories/queues)

cwbit/cakephp-emailqueue
========================

A configurable, queue-based plugin for queuing and sending Emails in CakePHP 3

2.1.1(9y ago)1861MITPHPPHP >=5.6.0

Since Jun 15Pushed 7y ago1 watchersCompare

[ Source](https://github.com/cwbit/cakephp-emailqueue)[ Packagist](https://packagist.org/packages/cwbit/cakephp-emailqueue)[ RSS](/packages/cwbit-cakephp-emailqueue/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (5)Versions (10)Used By (0)

CakePHP 3 - EmailQueue Plugin
=============================

[](#cakephp-3---emailqueue-plugin)

This is a plugin for CakePHP 3 that let's you quickly Queue emails to be sent whenever a process function is called.

Supports **Mustache** templating and **Markdown** by default.

***WHY?***

It's not cool to bomb or hold up an order because you can't send an email confirmation. Better to queue the emails and process them in a batch later on, no?

Install
-------

[](#install)

Use Composer (sorry if you're not sure what that is yet - go learn, it's a world-changer)

```
composer require cwbit/cakephp-emailqueue:dev-master

```

### Load the plugin

[](#load-the-plugin)

Then configure your App to actually load this plugin

```
	# in ../config/bootstrap.php
Plugin::load('EmailQueue', [
    'bootstrap' => true,        # let the plugin load its boostrap file
    'routes' => true,           # load the plugin routes file
    'ignoreMissing' => true,    # ignore missing routes or bootstrap file(s)
    'autoload' => true,      	# uncomment if you can't get composer to set the namespace/class location
    ]);
```

### Database Installation

[](#database-installation)

Run the following migration command from inside your app directory to build the database for this plugin

```
 cd /path/to/your/app/root
 bin/cake migrations migrate --plugin EmailQueue
```

### Adjust `Configure` settings

[](#adjust-configure-settings)

Copy `emailqueue.sample.php` to `emailqueue.php` and change any settings you need. This is where you can set up default mail settings like `sender` and `replyTo` or even what `transport` layer you want to use as default.

If you need specific emails to send to specific people or through a specific transport layer then just make sure to set those in your `EmailTemplate` record in the database.

### Set up your Mail Templates

[](#set-up-your-mail-templates)

In your Database, set up some `EmailTemplates`, one for each type of email you want to send.

The columns in this table are modeled after the `Email::profile()` and pretty much anything that `profile` accepts can be set in the record.

You'll want one of these for each of the email types you want to send out; e.g. if you have a `password-reset` email just create a `EmailTemplate` where `email_type = password-reset`.

`message_html` and `message_text` are `TEXT` fields where you can specify the body of the email for both the `html` and `text` messages respectively.

The default `provider`(s) in `Configure::('EmailQueue.default.provider')` allow for both `Mustache` templating and `Markdown` parsing. You can make your own providers if needed and just set them in your `EmailTemplate`

Plugin Usage
============

[](#plugin-usage)

Actually sending email with EmailQueue is a simple two-step process

1. Set up the Template
2. Queue the email
3. Process the email queue (CRON)

#### Set up the Template

[](#set-up-the-template)

Templates in this version of the plugin can fully support both **Mustache** and **Markdown** and are processed in that order (by default) - so Mustache variables are expanded first, and then the whole thing is parsed into HTML thru Markdown.

To set up a template, add a record for the `email_type` (e.g. `order-confirmation`) in the database, set some basic meta info like `subject` and add a `message_text` and `message_html` block.

If you take a look in the `EmailQueue\config\Seeds\EmailTemplatesSeed.php` you can see an example of a `contact` email.

The `view_vars` can either be passed in when Queuing the email, or set by default in the `EmailTemplate` or both. They are passed to the email processors in exactly the same way that view variables are passed to the view file from a controller, and so will be accessible by name in **Mustache**'s `{{varName}}` format (if you're using the default processor).

Ok, let's look at an actual email template example for something like `email_type = order-confirmation`.

If we assume that `$order` is a entity with order details that we've passed in when Queuing the email (see next section), then we can set `view_vars` to `array('order'=>$order)` and then in our template record set `message_html` and/or `message_text` to something like this

```
# Order Confirmation

Hello, {{order.name}}

You ordered the following
{{#order.items}}
* Item Name: {{name}}; Price: {{price}}
{{/order.items}}

```

Which, when sent, would get parsed out into the following (using default processors)

```
Order Confirmation

Hello, Arthur Dent

You ordered the following

	Item Name: Hitchhikers Guide; Price: $100000

```

#### Queue an Email

[](#queue-an-email)

Add the EmailQueue component to your controller

```
	# ../src/Controller/DemoController.php

	public function initialize()
	{
		parent::initialize();

		# load the EmailQueue's EmailQueueComponent
		$this->loadComponent('EmailQueue.EmailQueue');
	}
```

And then to actually Queue an email, just specify the email **`type`**, who it's **`to`**, and any **`viewVars`** the Template (*set in the config `EmailQueue.specific.{$type}`*) will need when rendering itself.

```
	# in your controller function
	public function someRandomFunction()
	{
		# ... do some stuff ...

        $this->EmailQueue->quickAdd('demo', 'test@user.com', ['name'=>'Test User']);

	}
```

#### Sending Queued Emails

[](#sending-queued-emails)

Manually run, or add to CRON, the following commandline command

```
bin/cake EmailQueue.process
```

The shell has the following options:

- `--limit n` or `-l n`
    - will set the query limit() to `n` where n is an integer.
    - default `20`
- `--status foo` or `-s foo`
    - will process only emails with status `foo`
    - choice(s) : `pending|failed|sent`
    - default `pending`
- `--type foo` or `-t foo`
    - will only process emails of type `foo`
    - choice(s) are built from `Configure::read('EmailQueue.specific');`
    - default `all`
- `--id foo`
    - will only process emails with id `foo` (as long as it also matched the other filters/config settings)

All the options can be chained together.

### CLI Examples

[](#cli-examples)

To send all pending emails, run the following

```
bin/cake EmailQueue.process
```

To explicitly send all `pending` emails, run the following

```
bin/cake EmailQueue.process -s pending
```

To send all emails of type `order-confirmation`, run the following

```
bin/cake EmailQueue.process -t order-confirmation
```

To send up to `100` emails at once, run the following

```
bin/cake EmailQueue.process -l 100
```

To send a specific email, run the following

```
bin/cake EmailQueue.process --id "5869e7fd-ccf3-46c2-9b15-844335b9a86d"
```

To send up to `100`, `failed`, `user-resetpw` emails, run the following

```
bin/cake EmailQueue.process -l 100 -s failed -t user-resetpw
```

###  Health Score

29

—

LowBetter than 59% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity12

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity64

Established project with proven stability

 Bus Factor1

Top contributor holds 98.9% 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 ~89 days

Recently: every ~73 days

Total

8

Last Release

3366d ago

Major Versions

1.1.3 → 2.0.02016-08-19

PHP version history (2 changes)1.1.1PHP >=5.5.9

2.1.0PHP >=5.6.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/474fb8a03f077a57b5421dcc5b93a8c30f16e0ecbf0f17a239e46a0ebd8ab5f7?d=identicon)[cwbit](/maintainers/cwbit)

---

Top Contributors

[![cwbit](https://avatars.githubusercontent.com/u/6501207?v=4)](https://github.com/cwbit "cwbit (90 commits)")[![ruchirkakkad](https://avatars.githubusercontent.com/u/8864272?v=4)](https://github.com/ruchirkakkad "ruchirkakkad (1 commits)")

### Embed Badge

![Health badge](/badges/cwbit-cakephp-emailqueue/health.svg)

```
[![Health](https://phpackages.com/badges/cwbit-cakephp-emailqueue/health.svg)](https://phpackages.com/packages/cwbit-cakephp-emailqueue)
```

###  Alternatives

[dereuromark/cakephp-queue

The Queue plugin for CakePHP provides deferred task execution.

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

CakePHP skeleton app

3831.7M1](/packages/cakephp-app)[lorenzo/cakephp-sqs

CakePHP Aws Simple Queue System

19302.4k](/packages/lorenzo-cakephp-sqs)[fotografde/cakephp-sms

SMS Plugin for CakePHP

1273.2k](/packages/fotografde-cakephp-sms)[cvo-technologies/cakephp-gearman

A gearman plugin for CakePHP 3

1243.5k](/packages/cvo-technologies-cakephp-gearman)[bedita/manager

BEdita Manager - official admin webapp for BEdita4 API

131.0k](/packages/bedita-manager)

PHPackages © 2026

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