README

This package for sebastienheyd/boilerplate allows developers to manage emails for their applications. It allows you to create layouts and then define editors who will only be able to edit texts without being able to modify the layouts.

Installation

In order to install Laravel Boilerplate Email Editor run :

composer require sebastienheyd/boilerplate-email-editor

Then run :

php artisan migrate

You can go to the admin and start using the email management panel.

Optional : publish configuration file

php artisan vendor:publish --tag=email-editor-config

Modify the default HTML layout

To edit the default HTML layout, you can use the following command

php artisan vendor:publish --tag=email-editor-layout

You will find the layout in /resources/views/vendor/boilerplate-email-editor/layout

Generating a new email layout

To generate a new layout, you can use the following artisan command :

php artisan email:layout {name}

This command will generate a new blade file in the resources/views/email-layouts folder.

To change the default folder, change the value of layouts_path in the email-editor configuration file.

However, you must publish the configuration file in order to do so. To do this, use the following command:

php artisan vendor:publish --tag=email-editor-config

You can also remove a layout by using the --remove option

php artisan email:layout --remove {name}

Defining editors

This package is provided with two permissions that can be used depending on the desired profile.

Email development : to be reserved for developers, it allows to define the slug, the description and the layout.
Email edition : for users who will be able to edit the content of emails.

Permissions and roles are manageable by default with sebastienheyd/boilerplate

Email variables

In the editing of the content of an e-mail, you will find a "Insert a variable" button. This button allows you to insert a variable in the e-mail and make it uneditable.

However, you can also enter the variables by hand by framing them with [ and ]. In this manner, you can also add variables to the subject line of the email.

Example : "Hello [first_name]"

Sending an email

use Sebastienheyd\BoilerplateEmailEditor\Models\Email;

// Setting data
$data = ['first_name' => 'John', 'last_name' => 'Doe'];

// Sending email by his slug
Email::findBySlug('my_slug')->send('email@tld.com', $data);

// Or by his id
Email::find(1)->send('email@tld.com', $data);

Tests / Coding standards

This package is delivered with a Makefile used to launch checks for the respect of coding standards and the unit tests

Just call make to see the list of commands.

Credits

License

This package is free software distributed under the terms of the MIT license.

sebastienheyd / boilerplate-email-editor

Maintainers

Details