fedeisas / laravel-mail-css-inliner by fedeisas

Inline the CSS of your HTML emails using Laravel
3,168,229
574
11
Package Data
Maintainer Username: fedeisas
Maintainer Contact: fedeisas@hotmail.com (Fede Isas)
Package Create Date: 2014-02-06
Package Last Update: 2024-04-12
Language: PHP
License: MIT
Last Refreshed: 2024-04-25 15:07:18
Package Statistics
Total Downloads: 3,168,229
Monthly Downloads: 50,632
Daily Downloads: 2,369
Total Stars: 574
Total Watchers: 11
Total Forks: 117
Total Open Issues: 4

Laravel Mail CSS Inliner

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 wrapped in a SwiftMailer plugin and served as a Service Provider it just works without any configuration.

Turns style tag:

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

Or the link tag:

<html>
    <head>
        <link rel="stylesheet" type="text/css" href="./tests/css/test.css">
    </head>
    <body>
        <h1>Hey you</h1>
    </body>
</html>

Into this:

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

Installation

This package needs Laravel 5.x

Begin by installing this package through Composer. Require it directly from the Terminal to take the last stable version:

$ composer require fedeisas/laravel-mail-css-inliner

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

'providers' => [
    // ...
    Fedeisas\LaravelMailCssInliner\LaravelMailCssInlinerServiceProvider::class,
],

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
$ ./vendor/bin/phpcs --standard=phpcs.xml ./src/
$ ./vendor/bin/phpcs --standard=phpcs.xml ./tests/;

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