2017 © Pedro Peláez
 

cakephp-plugin cakephp-email-queue

Queue, preview and and send emails stored in the database

image

lorenzo/cakephp-email-queue

Queue, preview and and send emails stored in the database

  • Tuesday, June 19, 2018
  • by lorenzo
  • Repository
  • 6 Watchers
  • 44 Stars
  • 16,702 Installations
  • PHP
  • 1 Dependents
  • 1 Suggesters
  • 15 Forks
  • 3 Open issues
  • 14 Versions
  • 11 % Grown

The README.md

CakePHP Email Queue plugin

This plugin provides an interface for creating emails on the fly and store them in a queue to be processed later by an offline worker using a cakephp shell command., (*1)

It also contains a handy shell for previewing queued emails, a very handy tool for modifying email templates and watching the result., (*2)

Requirements

  • CakePHP 4.x

Installation

composer require lorenzo/cakephp-email-queue

The plugin uses Debug email transport, so make sure your email config contain it:, (*3)

'EmailTransport' => [
        'Debug' => [
            'className' => 'Debug'
        ],
]

Enable plugin

bin/cake plugin load EmailQueue

Load required database table

In order to use this plugin, you need to create a database table. Required SQL is located at, (*4)

# config/Schema/email_queue.sql

Just load it into your database. You are free to change the file to use an integer primary key instead of UUIDs., (*5)

Or run migrations command:, (*6)

bin/cake migrations migrate --plugin EmailQueue

Usage

Whenever you need to send an email, use the EmailQueue model to create and queue a new one by storing the correct data:, (*7)

use EmailQueue\EmailQueue;
EmailQueue::enqueue($to, $data, $options);

enqueue method receives 3 arguments:, (*8)

  • First argument is a string or array of email addresses that will be treated as recipients.
  • Second arguments is an array of view variables to be passed to the email template
  • Third arguments is an array of options, possible options are
    • subject: Email's subject
    • send_at: date time sting representing the time this email should be sent at (in UTC)
    • template: the name of the element to use as template for the email message. (maximum supported length is 100 chars)
    • layout: the name of the layout to be used to wrap email message
    • format: Type of template to use (html, text or both)
    • headers: A key-value list of headers to send in the email
    • theme: The View Theme to find the email templates
    • config: the name of the email config to be used for sending
    • from_name: String with from name. Must be supplied together with from_email.
    • from_email: String with from email. Must be supplied together with from_name.

Previewing emails

It is possible to preview emails that are still in the queue, this is very handy during development to check if the rendered email looks at it should; no need to queue the email again, just make the changes to the template and run the preview again:, (*9)

# bin/cake EmailQueue.preview

Sending emails

Emails should be sent using bundled Sender command, use -h modifier to read available options, (*10)

# bin/cake EmailQueue.sender -h

You can configure this command to be run under a cron or any other tool you wish to use., (*11)

Contributing

Run the tests

./vendor/bin/phpunit tests/

Check style

./vendor/bin/phpcs ./src ./tests/ --standard=vendor/cakephp/cakephp-codesniffer/CakePHP

The Versions

19/06 2018

dev-master

9999999-dev https://github.com/lorenzo/cakephp-email-queue

Queue, preview and and send emails stored in the database

  Sources   Download

MIT

The Requires

 

The Development Requires

by Jose Lorenzo Rodriguez

email cakephp queue cron preview

11/08 2016

3.1.4

3.1.4.0 https://github.com/lorenzo/cakephp-email-queue

Queue, preview and and send emails stored in the database

  Sources   Download

MIT

The Requires

 

The Development Requires

by Jose Lorenzo Rodriguez

email cakephp queue cron preview

27/04 2016

3.1.3

3.1.3.0 https://github.com/lorenzo/cakephp-email-queue

Queue, preview and and send emails stored in the database

  Sources   Download

MIT

The Requires

 

The Development Requires

by Jose Lorenzo Rodriguez

email cakephp queue cron preview

13/04 2016

3.1.2

3.1.2.0 https://github.com/lorenzo/cakephp-email-queue

Queue, preview and and send emails stored in the database

  Sources   Download

MIT

The Requires

 

The Development Requires

by Jose Lorenzo Rodriguez

email cakephp queue cron preview

24/03 2016

3.1.1

3.1.1.0 https://github.com/lorenzo/cakephp-email-queue

Queue, preview and and send emails stored in the database

  Sources   Download

MIT

The Requires

 

The Development Requires

by Jose Lorenzo Rodriguez

email cakephp queue cron preview

24/03 2016

3.1.0

3.1.0.0 https://github.com/lorenzo/cakephp-email-queue

Queue, preview and and send emails stored in the database

  Sources   Download

MIT

The Requires

 

The Development Requires

by Jose Lorenzo Rodriguez

email cakephp queue cron preview

20/03 2016

3.0.3

3.0.3.0 https://github.com/lorenzo/cakephp-email-queue

Queue, preview and and send emails stored in the database

  Sources   Download

MIT

The Requires

 

The Development Requires

by Jose Lorenzo Rodriguez

email cakephp queue cron preview

20/03 2016

3.0.2

3.0.2.0 https://github.com/lorenzo/cakephp-email-queue

Queue, preview and and send emails stored in the database

  Sources   Download

MIT

The Requires

 

The Development Requires

by Jose Lorenzo Rodriguez

email cakephp queue cron preview

20/03 2016

3.0.1

3.0.1.0 https://github.com/lorenzo/cakephp-email-queue

Queue, preview and and send emails stored in the database

  Sources   Download

MIT

The Requires

 

The Development Requires

by Jose Lorenzo Rodriguez

email cakephp queue cron preview

17/03 2016

3.0.0

3.0.0.0 https://github.com/lorenzo/cakephp-email-queue

Queue, preview and and send emails stored in the database

  Sources   Download

MIT

The Requires

 

The Development Requires

by Jose Lorenzo Rodriguez

email cakephp queue cron preview

26/01 2016

2.0.2

2.0.2.0 https://github.com/lorenzo/cakephp-email-queue

Queue, preview and and send emails stored in the database

  Sources   Download

MIT

The Requires

 

by Jose Lorenzo Rodriguez

email cakephp queue cron preview

11/08 2015

2.0.1

2.0.1.0 https://github.com/lorenzo/cakephp-email-queue

Queue, preview and and send emails stored in the database

  Sources   Download

MIT

The Requires

 

by Jose Lorenzo Rodriguez

email cakephp queue cron preview

01/07 2014

2.0.0

2.0.0.0 https://github.com/lorenzo/cakephp-email-queue

Queue, preview and and send emails stored in the database

  Sources   Download

MIT

The Requires

 

by Jose Lorenzo Rodriguez

email cakephp queue cron preview

13/03 2014

1.0.0

1.0.0.0 https://github.com/lorenzo/cakephp-email-queue

Queue, preview and and send emails stored in the database

  Sources   Download

MIT

The Requires

 

by Jose Lorenzo Rodriguez

email cakephp queue cron preview