Laravel Mail Peek
, (*1)
MailPeek provides a simple local inbox right in your browser to enable you preview emails being sent from your application. Suport multiple recepients, attachments and more., (*2)
TL:DR;
- For < Laravel 5.5 composer require misma/laravel-mailpeek "1.0.x-dev"
- For Laravel 5.5+ composer require misma/laravel-mailpeek "2.0.x-dev"
- Misma\MailPeek\MailPeekProvider::class,
- Misma\MailPeek\MailPeekMailProvider::class
- php artisan vendor:publish
- MAIL_DRIVER=mailpeek
That's it!
Installation
Step 1/4: Install the package using composer
To install the package simple run one of the below command from your command line, (*3)
For Laravel versions < 5.5, (*4)
composer require misma/laravel-mailpeek "1.0.x-dev"
For Laravel versions 5.5 and above, (*5)
composer require misma/laravel-mailpeek "2.0.x-dev"
Step 2/4: Register service providers
Once installation is complete, you will need to register the service providers.
Open up config/app.php and add the following to the providers array., (*6)
- Misma\MailPeek\MailPeekProvider::class,
- Misma\MailPeek\MailPeekMailProvider::class
Step 3/4 : Publish assets & config
Publish required asset/config files into your application, (*7)
php artisan vendor:publish
Step 4/4 : Set MailPeek as your mail driver
Finally, change MAIL_DRIVER
to mailpeek
in your .env
file:, (*8)
MAIL_DRIVER=mailpeek
How it works
Once MailPeek is installed and configured, you can navigate to http://<your-amazing-app-url>/mailpeek
and that will open your 'inbox'. Whenever any email is sent from the application,it will show up in the inbox. It's that easy., (*9)
Package Configuration
Mailpeek pretty much doesn't require any post-installation configuration. After running php artisan vendor:publish
, available options are contained in the config/mailpeek.php
., (*10)
Contribution
Contributions are highly welcomed. Please feel free to fork, tweak, send a PR, and "betterize" whatever you can., (*11)
★
If you like this package show me some star love, ★ this repo., (*12)
Author
Mohammed Isma (Twitter), (*13)
License
Laravel MailPeek is open-sourced software licensed under the MIT license., (*14)