PHPackages                             gourmet/email - 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. gourmet/email

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

gourmet/email
=============

Gourmet Email Plugin for rapid CakePHP application development.

v3.1.2(9y ago)175.2k11[3 issues](https://github.com/gourmet/email/issues)[2 PRs](https://github.com/gourmet/email/pulls)MITPHP

Since Jan 27Pushed 8y ago7 watchersCompare

[ Source](https://github.com/gourmet/email)[ Packagist](https://packagist.org/packages/gourmet/email)[ Docs](https://github.com/gourmet/email)[ RSS](/packages/gourmet-email/feed)WikiDiscussions master Synced 3d ago

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

Email
=====

[](#email)

[![Build Status](https://camo.githubusercontent.com/94a954848173db1a08db08aff63dd53b16b1227d75cad466b612d81aa511223c/68747470733a2f2f7472617669732d63692e6f72672f676f75726d65742f656d61696c2e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/gourmet/email)[![Total Downloads](https://camo.githubusercontent.com/9a358958a917dee6c4c54d0fafe3c137e6c4e505039849fc8da435b9e6fc131d/68747470733a2f2f706f7365722e707567782e6f72672f676f75726d65742f656d61696c2f646f776e6c6f6164732e737667)](https://packagist.org/packages/gourmet/email)[![License](https://camo.githubusercontent.com/f65034eab783da1abd1046b1dd56c29b3e0d204d1eb6df90f6435efbc6ce3431/68747470733a2f2f706f7365722e707567782e6f72672f676f75726d65742f656d61696c2f6c6963656e73652e737667)](https://packagist.org/packages/gourmet/email)

Makes [CakePHP 3](http://cakephp.org)'s `Email` even better by adding:

- 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
-------

[](#install)

Using [Composer](http://getcomposer.org):

```
composer require gourmet/email:~3.0

```

You then need to load the plugin. In `boostrap.php`, something like:

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

Usage
-----

[](#usage)

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

```
'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:

```
// app/Template/Email/html/welcome.ctp
Welcome

Please confirm your account by clicking on the link below: