binarybuilds/nova-mail-manager

A Laravel Nova tool to easily resend system generated mails without going through application flow.

v1.0.1 2020-08-02 01:09 UTC

This package is auto-updated.

Last update: 2024-12-20 00:46:52 UTC


README

A Laravel Nova tool to easily resend your system generated emails without going through entire application flow.

Internally this package uses Laravel Mail Manager to record and resend emails.

Tool Screenshot

Installation

This package can be installed using composer.

composer require binarybuilds/nova-mail-manager

Next you must register the package's service provider by adding the below line to providers array inside config/app.php file.

    'providers' => [
        //
        \BinaryBuilds\NovaMailManager\NovaMailManagerServiceProvider::class
    ]

Conflicts With Laravel Telescope

The dependent package(Laravel Mail Manager) currently conflicts with laravel telescope. If you are using laravel telescope in your application, Make sure you register the nova mail manager package's service provider after the telescope service provider is registered.

If you are registering telescope using config/app.php file, Then add the service provider after the telescope service provider as shown below.

    'providers' => [
        //
        App\Providers\TelescopeServiceProvider::class,
        \BinaryBuilds\NovaMailManager\NovaMailManagerServiceProvider::class
    ]

If you are registering telescope manually using AppServiceProvider.php file or any other service provider, Then register this package service provider after the telescope service provider is registered as shown below.

$this->app->register(TelescopeServiceProvider::class);
$this->app->register(NovaMailManagerServiceProvider::class);

Next, Publish the package configuration file by running

php artisan vendor:publish --tag=laravel-mail-manager-config

Run migrations to create the table required to store the emails.

php artisan migrate

This will create a table mail_manager_mails. You can configure the table name using the published configuration file located in config/mail_manager.php

Next, Inside your App/Providers/NovaServiceProvider.php file, register the tool inside the tools method as shown below.

public function tools()
{
    return [
        //
        new \BinaryBuilds\NovaMailManager\NovaMailManager()
    ];
}

Usage

After installation, You will see Mail Manager in the nova navigation menu. Clicking on the link will take you to the tool page where you can view and resend mails.

The dependent package(Laravel Mail Manager) has few commands which you can use to manage mails. Checkout the readme file of Laravel Mail Manager package for details.

Contributing

Thank you for considering contributing to Nova mail manager! Please create a pull request with your contributions with detailed explanation of the changes you are proposing.

License

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