No description, website, or topics provided.
Clone or download
Latest commit 18e5002 Nov 28, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src Merge pull request #10 from odinti/master Nov 28, 2018
.coveralls.yml Genesis May 2, 2018
.gitignore Genesis May 2, 2018
.styleci.yml Genesis May 2, 2018
.travis.yml Genesis May 2, 2018
README.md Updated Readme May 3, 2018
composer.json Added HTML2Text Dependency May 11, 2018
composer.lock Add support for basic MJML conversion May 2, 2018
phpunit.xml Genesis May 2, 2018

README.md

Laravel MJML

Build responsive e-mails easily using MJML and Laravel Mailables.

MJML

MJML is an awesome tool from MailJet that allows us to create responsive emails very easily. For more information on how to use it, head to their documentation here

Installation

To install this package, require this package using composer as follows:

composer require asahasrabuddhe/laravel-mjml

After composer installs the packages and all the dependencies, publish the package configuration using artisan command:

php artisan vendor:publish

Select the laravel-mjml in the list. You will also need to install the MJML CLI:

npm install --save mjml

Getting Started

  1. Create a view containing MJML in your resources/views directory.

  2. Create a mailable class using artisan command: php artisan make:mail MJMLEmail

  3. In the mailable class, replace

    use Illuminate\Mail\Mailable;

    with

    use Asahasrabuddhe\LaravelMJML\Mail\Mailable;

  4. In the build method, use: $this->mjml('view.name');

Configuration

By default, the package will automatically detect the path of the MJML CLI installed locally in the project. In case this does not happen or the MJML CLI is installed globally, please update the configuration file likewise.

That's it! You have successfully installed and configured the MJML package for use. Just create new views and use them in the mailables class.