burzum/cakephp-zurb-inky

This package is abandoned and no longer maintained. No replacement package was suggested.

1.0.0 2020-05-14 22:12 UTC

Requires

• php: >=7.1.0
• cakephp/cakephp: ^3.5
• lorenzo/pinky: ^1.0
• pelago/emogrifier: ~3.1

Requires (Dev)

• cakephp/cakephp-codesniffer: ^3.0
• phpunit/phpunit: ^6.0

MIT

README

A plugin to render Inky views. This will render HTML and CSS in a way it should work with most of the mail clients. It basically turns divs and external CSS files into very old fashioned tables and inline CSS so that the retarded mail implementations will hopefully display it correctly.

• https://foundation.zurb.com/emails/docs/inky.html

Libraries used by this plugin

• https://github.com/lorenzo/pinky
• https://github.com/MyIntervals/emogrifier

Requires php 7.1

How to use it

Assuming you are using a custom mailer as explained here just set the view renderer for all mails of this mailer:

class MyExampleMailer extends Mailer
{
	public function __construct(Email $email = null)
	{
		parent::__construct($email);

		$this->setViewRenderer('Burzum/ZurbInky.Inky');
	}
}

If you want to parse the CSS as inline CSS call setCssFiles() in your views.

In your layout or action set the CSS files you want to use with Inky.

$this->setCssFiles([
	'one',
	'two'
]);

The files are set using the same notation as UrlHelper::css() and are looked up in the apps webroot/css folder by default.

License

Copyright Florian Krämer

Licensed under The MIT License Redistributions of files must retain the above copyright notice.