V3 Release

V3 Release

Author: MasterRO94

.github/workflows/tests.yml

@@ -13,14 +13,8 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        php: [8.1, 8.2, 8.3, 8.4]
+        php: [8.2, 8.3, 8.4, 8.5]
         stability: [prefer-lowest, prefer-stable]
-        exclude:
-          - php: 8.2
-            stability: prefer-lowest
-            
-          - php: 8.3
-            stability: prefer-lowest
 
     name: PHP ${{ matrix.php }} - ${{ matrix.stability }}
 
@@ -39,4 +33,4 @@ jobs:
         run: composer update --${{ matrix.stability }} --prefer-dist --no-interaction --no-progress
 
       - name: Execute tests
-        run: vendor/bin/phpunit
+        run: vendor/bin/pest

.gitignore

@@ -5,3 +5,4 @@ composer.lock
 .idea
 .phpunit.result.cache
 .phpunit.cache
+.eslintcache

.prettierignore

@@ -0,0 +1 @@
+resources/old-assets/*

.prettierrc

@@ -0,0 +1,16 @@
+{
+    "semi": true,
+    "singleQuote": true,
+    "singleAttributePerLine": true,
+    "htmlWhitespaceSensitivity": "css",
+    "printWidth": 150,
+    "plugins": [
+        "prettier-plugin-organize-imports",
+        "prettier-plugin-tailwindcss"
+    ],
+    "tailwindFunctions": [
+        "clsx",
+        "cn"
+    ],
+    "tabWidth": 2
+}

README.md

@@ -20,112 +20,167 @@
     </a>
 </p>
 
-# Mail logger and viewer for Laravel
+# Laravel Mail Viewer
+
+Easily log, view, and search outgoing emails directly in your browser.
+
+![Screenshot of Laravel Mail Viewer - Light Mode](./art/v3-light.png "Preview Light")
+![Screenshot of Laravel Mail Viewer - Dark Mode](./art/v3-dark.png "Preview Dark")
+
+This package logs all outgoing emails to a database and provides a web interface to view them, formatted as they appear in modern email clients like Gmail.
+
+---
+
+<!-- TOC -->
+* [Laravel Mail Viewer](#laravel-mail-viewer)
+  * [Features](#features)
+  * [Installation](#installation)
+    * [Step 1: Install via Composer](#step-1-install-via-composer)
+    * [Step 2: Publish Assets & Configurations](#step-2-publish-assets--configurations)
+    * [Step 3: Run Migrations](#step-3-run-migrations)
+    * [Step 4: View Emails](#step-4-view-emails)
+  * [Configuration](#configuration)
+    * [Data Pruning](#data-pruning)
+  * [Production Usage](#production-usage)
+    * [Restrict Access with Middleware](#restrict-access-with-middleware)
+    * [Disable package in production mode](#disable-package-in-production-mode)
+      * [Disable auto-discovery:](#disable-auto-discovery)
+      * [Register package for non-production environments](#register-package-for-non-production-environments)
+  * [License](#license)
+  * [Credits](#credits)
+<!-- TOC -->
+
+## Features
+- Logs all outgoing emails to the database
+- Modern in-browser email viewer
+- Searchable UI with auto-refreshing entries
+- Configurable route and access protection
+- Optional email pruning
 
-### Easily log, view and search in browser all outgoing emails.
+## Installation
+### Step 1: Install via Composer
+
+Run the following command in your terminal:
+
+```sh
+composer require masterro/laravel-mail-viewer
+```
 
-![preview](https://github.com/MasterRO94/packages/blob/master/mail-viewer/Mail%20Viewer%20V2.png "Preview")
+### Step 2: Publish Assets & Configurations
 
-This package gives an ability to log all outgoing emails to a database and view them all from a browser like they will
-be shown in a modern mail clients (gmail, etc.).
+```sh
+php artisan mail-viewer:publish
+```
 
-## Version Compatibility
+### Step 3: Run Migrations
 
-| Laravel     | Mail Viewer |
-|:------------|:------------|
-| 5.5.x - 8.* | 1.3.x       |
-| 9.x - 10.x  | 2.x.x       |
+```sh
+php artisan migrate
+```
 
-## Upgrade from v1 to v2
+### Step 4: View Emails
 
-Version 2 has been almost totally rewritten and brings totally new fresh UI build with Vue.js 3 and TailwindCss 3.  
-It works **only with Laravel 9+** as of Symfony Mailer replacement for previously used Swift Mailer.
+Visit `/_mail-viewer` in your browser to access the email viewer.
 
-### Upgrade Steps
+> **Note:** The route can be customized in the configuration file.
 
-#### Composer Dependencies
+---
 
-You should update the dependency in your application's composer.json file:
+## Configuration
 
-`masterro/laravel-mail-viewer` to ^2.0
+You can adjust default settings in the `config/mail-viewer.php` file.
 
-#### Database migrations
+### Data Pruning
 
-Run package migrations (requires `doctrine/dbal` to be installed):
+The package supports Laravel's [Model Pruning](https://laravel.com/docs/eloquent#pruning-models). Define how many days emails should be retained in the configuration:
 
-```shell
-php artisan migrate
+```php
+'prune_older_than_days' => 365,
 ```
 
-#### Publish assets
+---
 
-Run publish command:
+## Production Usage
 
-```shell
-php artisan mail-viewer:publish --views
-```
+By default, the email viewer is publicly accessible. 
+In a production environment, it's highly recommended to restrict access 
+using middleware or something like [Access Screen](https://github.com/MasterRO94/laravel-access-screen) package.
+Alternatively, you can disable the package in production environments.
 
-#### Update configs
+### Restrict Access with Middleware
 
-V2 uses separate date format for date and time, update these in your `config/mail-viewer.php` file
+Modify your `config/mail-viewer.php` to apply authorization:
 
 ```php
-'date_format' => 'd.m.Y',
-'time_format' => 'H:i:s',
+'middleware' => ['web', 'can:viewMailLogs'],
 ```
 
-#### Data pruning
+> **Note:** `viewMailLogs` is just an example ability you can register via Laravel’s [Authorization Gate](https://laravel.com/docs/authorization#writing-gates). 
+> This ability is not included in the package.
 
-V2 allows prune old records easily using `mail-viewer:prune` command. You can add it to your Scheduler.
+You can also limit access by IP address in `App\Http\Middleware\RestrictMailViewerAccess.php`:
 
 ```php
-// Console/Kernel.php
-$schedule->command('mail-viewer:prune')->daily();
+namespace App\Http\Middleware;
+
+use Closure;
+use Illuminate\Http\Request;
+
+class RestrictMailViewerAccess
+{
+    public function handle(Request $request, Closure $next)
+    {
+        if (!in_array($request->ip(), ['127.0.0.1', '::1', 'YOUR_ALLOWED_IP'])) {
+            abort(403);
+        }
+
+        return $next($request);
+    }
+}
 ```
 
-You can specify how many days data will be stored before pruning using config. Default value is 31 days.
+Apply it in config:
 
 ```php
-'prune_older_than_days' => 31,
+'middleware' => ['web', RestrictMailViewerAccess::class],
 ```
 
-## Installation
-
-### Step 1: Composer
+Now, only authorized users or allowed IPs can access the mail viewer.
 
-From the command line, run:
+---
 
+### Disable package in production mode
+#### Disable auto-discovery:
+```json
+"extra": {
+  "laravel": {
+    "dont-discover": [
+      "masterro/laravel-mail-viewer"
+    ]
+  }
+},
 ```
-composer require masterro/laravel-mail-viewer
-```
-
-### Step 2: Publish assets and configs
-
-```
-php artisan mail-viewer:publish
-```
-
-You have to publish _**assets,**_ and _**views,**_ _configs_ are optional.
-
-### Step 3: Run migrations
 
-```
-php artisan migrate
+#### Register package for non-production environments
+In your application's `ServiceProvider`
+```php
+use MasterRO\MailViewer\Providers\MailViewerServiceProvider;
+
+public function register(): void
+{
+    if (!$this->app->environment('production')) {
+        $this->app->register(MailViewerServiceProvider::class);
+    }
+}
 ```
 
-### Step 4: View emails
+## License
 
-All ongoing emails you can find on `/_mail-viewer` page.
+This package is open-source software licensed under the [MIT license](LICENSE).
 
-## Configuration
+---
 
-You can review and change all the default configuration values in published `config/mail-viewer.php` file.
+## Credits
 
-#### Data pruning (v2+)
+Developed by [MasterRO](https://github.com/MasterRO94).
 
-The package allows you to prune old records easily using `mail-viewer:prune` command. You can add it to your Scheduler.
-
-```php
-// Console/Kernel.php
-$schedule->command('mail-viewer:prune')->daily();
-```

art/v3-dark.png

@@ -15,29 +15,37 @@
         "log"
     ],
     "require": {
-        "illuminate/support": "^9.0|^10.0|^11.0|^12.0",
-        "illuminate/events": "^9.0|^10.0|^11.0|^12.0",
-        "illuminate/database": "^9.0|^10.0|^11.0|^12.0",
-        "illuminate/routing": "^9.0|^10.0|^11.0|^12.0",
-        "illuminate/view": "^9.0|^10.0|^11.0|^12.0",
-        "illuminate/mail": "^9.0|^10.0|^11.0|^12.0",
         "doctrine/dbal": "^3.5 | ^4.0 | ^5.0",
-        "nesbot/carbon": ">=2.62.1"
+        "illuminate/database": "^10.0|^11.0|^12.0",
+        "illuminate/events": "^10.0|^11.0|^12.0",
+        "illuminate/mail": "^10.0|^11.0|^12.0",
+        "illuminate/routing": "^10.0|^11.0|^12.0",
+        "illuminate/support": "^10.0|^11.0|^12.0",
+        "illuminate/view": "^10.0|^11.0|^12.0",
+        "nesbot/carbon": ">=2.62.1",
+        "opcodesio/mail-parser": "^0.2.1"
     },
     "require-dev": {
-        "orchestra/testbench": "^7.0|^8.0|^9.0|^10.0"
+        "orchestra/testbench": "^7.0|^8.0|^9.0|^10.0",
+        "pestphp/pest": "^3.8"
     },
     "autoload": {
         "psr-4": {
-            "MasterRO\\MailViewer\\": "src/app",
+            "MasterRO\\MailViewer\\": "src/",
             "MasterRO\\MailViewer\\Tests\\": "tests/"
         }
     },
     "minimum-stability": "dev",
     "prefer-stable": true,
     "config": {
         "sort-packages": true,
-        "optimize-autoloader": true
+        "optimize-autoloader": true,
+        "allow-plugins": {
+            "pestphp/pest-plugin": true
+        }
+    },
+    "scripts": {
+        "test": "./vendor/bin/pest"
     },
     "extra": {
         "laravel": {

art/v3-light.png

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+return [
+    'table' => 'mail_logs',
+    'middleware' => ['web'],
+    'uri_prefix' => env('MAIL_VIEWER_URI_PREFIX', '_mail-viewer'),
+    'date_format' => env('MAIL_VIEWER_DATE_FORMAT', 'd.m.Y'),
+    'time_format' => env('MAIL_VIEWER_DATE_FORMAT', 'H:i:s'),
+    'timezone' => env('MAIL_VIEWER_TIMEZONE', env('APP_TIMEZONE', 'UTC')),
+    'emails_per_page' => env('MAIL_VIEWER_EMAILS_PER_PAGE', 20),
+    'prune_older_than_days' => env('MAIL_VIEWER_PRUNE_OLDER_THAN_DAYS', 0),
+    'site_url' => env('MAIL_VIEWER_SITE_URL'),
+];