README

YoMail is a Laravel package that provides a real time inbox for the outgoing emails from your Laravel app. Using this you can view

HTML preview of the email.
Meta data about the email (to, from, cc, bcc etc)
Source code preview of the email.
Attachments.

Watch the video for more info.

Introduction

Installation

composer require codebitz/yomail

How to use

Once the package has been downloaded then run the artisan command:

php artisan yomail:install

This will do three things:

Run the migrations for the package.
Copy the assets (JS,CSS) into the public directory /vendor/yomail.
Create the yomail.php config file.

Once you have run the installation you can visit your project domain followed by /yomail example example.local/yomail. Here you will be greeted with the YoMail interface.

Settings

Here are the optional settings for YoMail which you can add to the .env file. Below is the settings and their defaults.

# The default route for the inbox ie example.local/yomail
YOMAIL_ROUTE=yomail
# How often the inbox will check for new emails (in milliseconds)
YOMAIL_REFRESH=1000
# If YoMail should be enabled or not
YOMAIL_ENABLED=true

Authorization

By default YoMail doesnt require any authorization when in a non production environment. To use in a production enviroment then you will need to add a gate to your AuthServiceProvider.

public function boot()
{

    // Restrict acccess to the emails in the array
    Gate::define("view-yomail", function ($user) {
        return in_array($user->email, [
            'test@example.com',
        ]);
    });

    // Allow access to all users
    Gate::define("view-yomail", function ($user) {
        return true;
    });

}

Support

⭐ If you like this package then please give it a star on Github YoMail

⚡ You can also follow me on Twitter @aaronlumsden

codebitz / yomail

Maintainers

Details