bryanjamesmiller/laravel-inky

Foundation Inky email templates in Laravel

Maintainers

Details

github.com/bryanjamesmiller/laravel-inky

Source

Installs: 1 012

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 0

Forks: 28

v9.0.1 2019-12-07 00:31 UTC

Requires

Requires (Dev)

MIT d2bcf89921d9c0b492f4a7a198695e7ea7637c65

  • Bryan Miller <bryan.woop@kirschbaumdevelopment.com>

laravelfoundationinky

This package is auto-updated.

Last update: 2025-03-07 11:49:29 UTC

README

Allows you to use Foundation for Emails 2 (formerly Inky) email templates nicely in Laravel 6.

Any views with a .inky.php extension will be compiled with both Inky and Blade, allowing you to use both templating engines seamlessly together. CSS is automatically inlined so styles work in email clients that don't support external stylesheets.

Installation

Require with composer

composer require bryanjamesmiller/laravel-inky

Usage

Check the Foundation for Emails docs for full usage on how to use Inky and Foundation for Emails CSS.

Create an Inky view e.g. emails/welcome.inky.php

<container>
  <row>
    <columns>Welcome, {{ $name }}</columns>
  </row>
</container>

Use Mail as usual in Laravel

Mail::send('emails.welcome', ['name' => $user->name], function ($m) use ($user) {
  $m->from('hello@app.com', 'Your Application');

  $m->to($user->email, $user->name)->subject('Welcome!');
});

You can create a Blade layout to inherit from e.g. emails/layout.inky.php

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  <meta name="viewport" content="width=device-width"/>
  <link rel="stylesheet" href="foundation-emails.css">
</head>
<body>
  @yield('content')
</body>
</html>

then

@extends('emails.layout')

@section('content')
  <container>
    <row>
      <columns>Welcome, {{ $name }}</columns>
    </row>
  </container>
@stop

CSS Inlining

<style> and <link rel="stylesheet"> are automatically inlined.

The location of your <link rel="stylesheet"> href is resolved to the resources/assets/css directory, so in the example above it expects some CSS at resources/assets/css/foundation-emails.css.

Here's a handy reference for CSS in emails: CSS Support Guide for Email Clients

Licence

MIT Licence