2017 © Pedro Peláez
 

cakephp-plugin email

Gourmet Email Plugin for rapid CakePHP application development.

image

gourmet/email

Gourmet Email Plugin for rapid CakePHP application development.

  • Saturday, June 18, 2016
  • by jadb
  • Repository
  • 7 Watchers
  • 17 Stars
  • 2,443 Installations
  • PHP
  • 1 Dependents
  • 0 Suggesters
  • 9 Forks
  • 5 Open issues
  • 8 Versions
  • 3 % Grown

The README.md

Email

Build Status Total Downloads License, (*1)

Makes CakePHP 3's Email even better by adding:, (*2)

  • Default email layout with basic styling (safe for emails)
  • EmailHelper which extends HtmlHelper to automatically format paragraphs, links, etc.
  • Built-in support/configuration for major providers (Mailchimp, Sendgrid, Mandrill, etc.) - coming soon.
  • Admin email preview - coming soon.

Install

Using Composer:, (*3)

composer require gourmet/email:~3.0

You then need to load the plugin. In boostrap.php, something like:, (*4)

\Cake\Core\Plugin::load('Gourmet/Email');

Usage

Change your default email configuration (or create a new one) in config/app.php:, (*5)

'Email' => [
    'default' => [
        'transport' => 'default',
        'from' => 'you@localhost',
        'layout' => 'Gourmet/Email.default',
        'helpers' => ['Html', 'Gourmet/Email.Email'],
        'emailFormat' => 'both',
    ]
]

In your email views, you can now use the Gourmet/Email.Email helper:, (*6)

// app/Template/Email/html/welcome.ctp
Welcome = $user['username'] ?>

Please confirm your account by clicking on the link below:

= $this->Email->link('Confirm account', '/') ?>

If for any reason, you are unable to click the link above, copy/paste the following to your browser's address bar:

= \Cake\Routing\Router::url('/') ?>

Thank you for choosing us,

Company name

= $this->Email->image('logo.jpg') ?>

For the text version, you only need to symlink the same template. We'll symlink all text templates to html:, (*7)

$ ln -s html app/Template/Email/text

It's finally ready to send an email:, (*8)

$email = new Email();
$email->to('john@doe.com');
$email->template('welcome');
$email->viewVars(['user' => ['username' => 'johndoe']]);
$email->send();

Patches & Features

  • Fork
  • Mod, fix
  • Test - this is important, so it's not unintentionally broken
  • Commit - do not mess with license, todo, version, etc. (if you do change any, bump them into commits of their own that I can ignore when I pull)
  • Pull request - bonus point for topic branches

Bugs & Feedback

http://github.com/gourmet/emails/issues, (*9)

License

Copyright (c) 2014, Jad Bitar and licensed under The MIT License., (*10)

The Versions

18/06 2016

dev-master

9999999-dev https://github.com/gourmet/email

Gourmet Email Plugin for rapid CakePHP application development.

  Sources   Download

MIT

The Requires

 

The Development Requires

plugin email cakephp gourmet

18/06 2016

v3.1.2

3.1.2.0 https://github.com/gourmet/email

Gourmet Email Plugin for rapid CakePHP application development.

  Sources   Download

MIT

The Requires

 

The Development Requires

plugin email cakephp gourmet

14/07 2015

v3.1.1

3.1.1.0 https://github.com/gourmet/email

Gourmet Email Plugin for rapid CakePHP application development.

  Sources   Download

MIT

The Development Requires

plugin email cakephp gourmet

27/03 2015

v3.0.1

3.0.1.0 https://github.com/gourmet/email

Gourmet Email Plugin for rapid CakePHP application development.

  Sources   Download

MIT

The Requires

 

The Development Requires

plugin email cakephp gourmet

03/01 2015

dev-multi-transports

dev-multi-transports https://github.com/gourmet/email

Gourmet Email Plugin for rapid CakePHP application development.

  Sources   Download

MIT

The Requires

 

The Development Requires

plugin email cakephp gourmet

06/12 2014

v3.0.0

3.0.0.0 https://github.com/gourmet/email

Gourmet Email Plugin for rapid CakePHP application development.

  Sources   Download

MIT

The Requires

 

The Development Requires

plugin email cakephp gourmet

27/01 2014

dev-develop

dev-develop https://github.com/gourmet/email

Gourmet Email Plugin for rapid CakePHP application development.

  Sources   Download

MIT

The Requires

 

plugin email cakephp gourmet

27/01 2014

0.1.0

0.1.0.0 https://github.com/gourmet/email

Gourmet Email Plugin for rapid CakePHP application development.

  Sources   Download

MIT

The Requires

 

plugin email cakephp gourmet