fedeisas/laravel-mail-css-inliner

Inline the CSS of your HTML emails using Laravel

Installs: 44 492

Dependents: 2

Stars: 120

Watchers: 7

Forks: 30

Open Issues: 1

1.5 2016-04-19 07:02 UTC

README

Travis Badge Coverage Status Latest Stable Version Latest Unstable Version Total Downloads License

Why?

Most email clients won't render CSS (on a <link> or a <style>). The solution is inline your CSS directly on the HTML. Doing this by hand easily turns into unmantainable templates. The goal of this package is to automate the process of inlining that CSS before sending the emails.

How?

Using a wonderful CSS inliner package wraped in a SwiftMailer plugin and served as a Service Provider it justs works without any configuration.

Turns:

<html>
    <head>
        <style>
            h1 {
                font-size: 24px;
                color: #000;
            }
        </style>
    </head>
    <body>
        <h1>Hey you</h1>
    </body>
</html>

Into this:

<html>
    <head>
    </head>
    <body>
        <h1 style="font-size: 24px; color: #000;">Hey you</h1>
    </body>
</html>

Installation

Begin by installing this package through Composer. Edit your project's composer.json file to require fedeisas/laravel-mail-css-inliner.

This package needs Laravel 5.x

{
  "require": {
        "fedeisas/laravel-mail-css-inliner": "~1.4"
    }
}

Next, update Composer from the Terminal:

$ composer update

Once this operation completes, you must add the service provider. Open app/config/app.php, and add a new item to the providers array.

'Fedeisas\LaravelMailCssInliner\LaravelMailCssInlinerServiceProvider',

At this point the inliner should be already working with the default options. If you want to fine-tune these options, you can do so by publishing the configuration file:

$ php artisan vendor:publish --provider='Fedeisas\\LaravelMailCssInliner\\LaravelMailCssInlinerServiceProvider'

and changing the settings on the generated config/css-inliner.php file.

Contributing

$ composer install
$ ./vendor/bin/phpunit

In addition to a full test suite, there is Travis integration.

Found a bug?

Please, let me know! Send a pull request or a patch. Questions? Ask! I will respond to all filed issues.

Inspiration

This package is greatly inspired, and mostly copied, from SwiftMailer CSS Inliner. I just made an easy drop-in solution for Laravel.

License

This package is open-sourced software licensed under the MIT license