From 4218208c6713e1175e911f462a1119ecad5e3c82 Mon Sep 17 00:00:00 2001 From: Martijn van Nieuwenhoven Date: Thu, 4 Jul 2024 21:01:01 +0200 Subject: [PATCH] more docs --- docs/installation.md | 2 +- docs/introduction.md | 15 +++++++++++++++ docs/laravel-email-viewer.md | 2 +- 3 files changed, 17 insertions(+), 2 deletions(-) diff --git a/docs/installation.md b/docs/installation.md index acafd06..74bf513 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -15,7 +15,7 @@ Publish the database migration and configuration file: php artisan vendor:publish --provider="Axyr\EmailViewer\EmailViewerServiceProvider" ``` -By default the package provides a set of routes for the Blade UI and the Vue UI. You can disabled them in the config file. +By default this package provides a set of routes for the Blade UI and the Vue UI. You can disabled them in the config file. You can access the Blade UI by visiting: diff --git a/docs/introduction.md b/docs/introduction.md index e10b99d..cd8696e 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -1 +1,16 @@ # Introduction + +This package allows copying and viewing all outgoing emails locally from your Laravel application. + +This can be used in production to ensure you application actually sent the emails. +For example when users say they did not receive an email and you want to verify the email was sent from the application. + +But this package can also replace tools like Mailhog or Mailtrap to inspect emails sent from test or staging environments. +Sometimes you might want to or are not allowed to using an external service to catch emails. + +In that case you will probably use the ``log`` or ``array`` mail driver to ensure emails will never leave the system. + +To make inspecting those emails easier or allow test users to view the emails in the application, you can use this package to inspect and test emails in your non-local and non-production environments. +In this way, can still test features like password reset or other transactional email features. + +![](img/screenshot.png) diff --git a/docs/laravel-email-viewer.md b/docs/laravel-email-viewer.md index aac8f29..92a98e2 100644 --- a/docs/laravel-email-viewer.md +++ b/docs/laravel-email-viewer.md @@ -2,7 +2,7 @@ View and inspect all emails sent from your Laravel application. -![](docs/img/mailboxes.png) +![](img/mailboxes.png) Laravel Email Viewer is a package that allows you to view all emails sent from you application in the browser. This allows you to ensure your application has actually sent the mail. When using log as an email driver for your local or staging environment, you can inspect emails without the need for external tools like Mailtrap or Mailhog, so emails never have to leave your server at all.