josegonzalez/cakephp-mail-preview

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

CakePHP plugin for use with previewing emails during development

0.0.1 2016-12-21 00:33 UTC

Requires

• php: >=5.5
• cakephp/cakephp: ~3.0

Requires (Dev)

• cakephp/cakephp-codesniffer: dev-master
• phpunit/phpunit: *
• satooshi/php-coveralls: dev-master

MIT

• Jose Diaz-Gonzalez

• mail
• email
• cakephp
• preview

README

MailPreview Plugin

This is Deprecated in favor of functionality built into DebugKit

A simple CakePHP plugin for use with previewing emails during development.

This plugin was inspired by the Rails 4.1 feature, Action Mailer Previews, as well as the 37signals mail_view gem.

Alternatives to this plugin include any of the following:

• CatchMe: A nodejs app to catch, display and validate emails
• MailCatcher: A super simple SMTP server which catches any message sent to it to display in a web interface.
• MailHog: A Web and API based SMTP testing service.
• MailTrap: An email testing service

This plugin is specifically meant to bring Rapid Application Development to email development by enabling developers to simply update a template and reload the browser. Developers are encouraged to use other tools as their needs change.

Requirements

• CakePHP 3.x
• PHP 5.5+

Features

• preview HTML or plain text emails from within your web browser
• emails are reloaded with each view so you can tweak/save/refresh for instant verification
• integrates perfectly with existing test fixtures
• only exposes routes in development mode to prevent leaking into production mode

Documentation

For documentation, please see the docs.

License

The MIT License (MIT)

Copyright (c) 2016 Jose Diaz-Gonzalez

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.