From 78c8658f499d1349753e51b9bc31b8704c20b9b0 Mon Sep 17 00:00:00 2001 From: Kilian Trunk Date: Fri, 11 Jul 2025 14:02:54 +0200 Subject: [PATCH 01/12] feat(emails): implement send email functionality --- resources/lang/en/email.php | 30 ++++ resources/lang/hr/email.php | 30 ++++ resources/lang/sl/email.php | 30 ++++ resources/lang/sr/email.php | 30 ++++ .../filament/pages/send-email-user.blade.php | 9 + .../views/mail/send-email-to-user.blade.php | 97 ++++++++++ src/Filament/Actions/SendEmailAction.php | 20 +++ src/Filament/Actions/SendEmailTableAction.php | 21 +++ src/Filament/Resources/UserResource.php | 3 + .../Resources/UserResource/Pages/ViewUser.php | 2 + src/Filament/Traits/SendEmailActionTrait.php | 147 ++++++++++++++++ src/Mail/SendEmailToUser.php | 83 +++++++++ src/Policies/UserPolicy.php | 8 + tests/Feature/UserEmailTest.php | 165 ++++++++++++++++++ 14 files changed, 675 insertions(+) create mode 100644 resources/lang/en/email.php create mode 100644 resources/lang/hr/email.php create mode 100644 resources/lang/sl/email.php create mode 100644 resources/lang/sr/email.php create mode 100644 resources/views/filament/pages/send-email-user.blade.php create mode 100644 resources/views/mail/send-email-to-user.blade.php create mode 100644 src/Filament/Actions/SendEmailAction.php create mode 100644 src/Filament/Actions/SendEmailTableAction.php create mode 100644 src/Filament/Traits/SendEmailActionTrait.php create mode 100644 src/Mail/SendEmailToUser.php create mode 100644 tests/Feature/UserEmailTest.php diff --git a/resources/lang/en/email.php b/resources/lang/en/email.php new file mode 100644 index 0000000..e2dab40 --- /dev/null +++ b/resources/lang/en/email.php @@ -0,0 +1,30 @@ + 'Send Email', + 'send_email_to' => 'Send Email to :name', + 'sender' => 'Sender', + 'recipient' => 'Recipient', + 'cc' => 'CC', + 'cc_help' => 'Additional recipients', + 'bcc' => 'BCC', + 'bcc_help' => 'Hidden recipients', + 'subject' => 'Subject', + 'subject_placeholder' => 'Enter email subject', + 'message' => 'Message', + 'message_placeholder' => 'Enter message content...', + 'send' => 'Send', + 'cancel' => 'Cancel', + 'email_sent' => 'Email sent', + 'email_sent_to' => 'Email to :email has been successfully sent.', + 'permission_denied' => 'Permission denied', + 'permission_denied_message' => 'You do not have permission to send emails.', + 'error' => 'Error', + 'send_error_message' => 'An error occurred while sending the email: :error', + 'email_form_title' => 'Send Email', + 'email_form_description' => 'Send an email to the selected user', + 'your_email' => 'Your email address', + 'recipient_email' => 'Recipient email address', + 'invalid_cc_email' => 'One or more CC email addresses are invalid.', + 'invalid_bcc_email' => 'One or more BCC email addresses are invalid.', +]; diff --git a/resources/lang/hr/email.php b/resources/lang/hr/email.php new file mode 100644 index 0000000..cf01042 --- /dev/null +++ b/resources/lang/hr/email.php @@ -0,0 +1,30 @@ + 'Pošaljite e-mail', + 'send_email_to' => 'Pošaljite e-mail korisniku :name', + 'sender' => 'Pošaljitelj', + 'recipient' => 'Primatelj', + 'cc' => 'CC', + 'cc_help' => 'Dodatni primatelji', + 'bcc' => 'BCC', + 'bcc_help' => 'Skriveni primatelji', + 'subject' => 'Predmet', + 'subject_placeholder' => 'Unesite predmet e-maila', + 'message' => 'Poruka', + 'message_placeholder' => 'Unesite sadržaj poruke...', + 'send' => 'Pošaljite', + 'cancel' => 'Otkaži', + 'email_sent' => 'E-mail poslan', + 'email_sent_to' => 'E-mail poslan na :email je uspješno poslan.', + 'permission_denied' => 'Dozvola odbijena', + 'permission_denied_message' => 'Nemate dozvolu za slanje e-mailova.', + 'error' => 'Greška', + 'send_error_message' => 'Došlo je do greške prilikom slanja e-maila: :error', + 'email_form_title' => 'Pošaljite e-mail', + 'email_form_description' => 'Pošaljite e-mail odabranom korisniku', + 'your_email' => 'Vaša e-mail adresa', + 'recipient_email' => 'E-mail adresa primatelja', + 'invalid_cc_email' => 'Jedna ili više CC e-mail adresa nije valjana.', + 'invalid_bcc_email' => 'Jedna ili više BCC e-mail adresa nije valjana.', +]; diff --git a/resources/lang/sl/email.php b/resources/lang/sl/email.php new file mode 100644 index 0000000..b625f6d --- /dev/null +++ b/resources/lang/sl/email.php @@ -0,0 +1,30 @@ + 'Pošlji e-pošto', + 'send_email_to' => 'Pošlji e-pošto uporabniku :name', + 'sender' => 'Pošiljatelj', + 'recipient' => 'Prejemnik', + 'cc' => 'Kp (CC)', + 'cc_help' => 'Dodatni prejemniki', + 'bcc' => 'Skp (BCC)', + 'bcc_help' => 'Skriti prejemniki', + 'subject' => 'Zadeva', + 'subject_placeholder' => 'Vnesite zadevo sporočila', + 'message' => 'Sporočilo', + 'message_placeholder' => 'Vnesite vsebino sporočila...', + 'send' => 'Pošlji', + 'cancel' => 'Prekliči', + 'email_sent' => 'E-pošta poslana', + 'email_sent_to' => 'E-pošta je bila uspešno poslana na :email.', + 'permission_denied' => 'Dostop zavrnjen', + 'permission_denied_message' => 'Nimate dovoljenja za pošiljanje e-pošte.', + 'error' => 'Napaka', + 'send_error_message' => 'Prišlo je do napake pri pošiljanju e-pošte: :error', + 'email_form_title' => 'Pošiljanje e-pošte', + 'email_form_description' => 'Pošljite e-pošto izbranemu uporabniku', + 'your_email' => 'Vaš e-poštni naslov', + 'recipient_email' => 'Prejemnik e-pošte', + 'invalid_cc_email' => 'En ali več CC e-poštnih naslovov ni veljavnih.', + 'invalid_bcc_email' => 'En ali več BCC e-poštnih naslovov ni veljavnih.', +]; diff --git a/resources/lang/sr/email.php b/resources/lang/sr/email.php new file mode 100644 index 0000000..2beb9e9 --- /dev/null +++ b/resources/lang/sr/email.php @@ -0,0 +1,30 @@ + 'Pošalji imejl', + 'send_email_to' => 'Pošalji imejl korisniku :name', + 'sender' => 'Pošaljilac', + 'recipient' => 'Primalac', + 'cc' => 'CC', + 'cc_help' => 'Dodatni primaoci', + 'bcc' => 'BCC', + 'bcc_help' => 'Skriveni primaoci', + 'subject' => 'Predmet', + 'subject_placeholder' => 'Unesite predmet imejla', + 'message' => 'Poruka', + 'message_placeholder' => 'Unesite sadržaj poruke...', + 'send' => 'Pošalji', + 'cancel' => 'Otkaži', + 'email_sent' => 'Imejl poslan', + 'email_sent_to' => 'Imejl poslan na :email je uspešno poslan.', + 'permission_denied' => 'Dozvola odbijena', + 'permission_denied_message' => 'Nemate dozvolu za slanje imejlova.', + 'error' => 'Greška', + 'send_error_message' => 'Došlo je do greške prilikom slanja imejla: :error', + 'email_form_title' => 'Pošalji imejl', + 'email_form_description' => 'Pošalji imejl odabranom korisniku', + 'your_email' => 'Vaša imejl adresa', + 'recipient_email' => 'Imejl adresa primaoca', + 'invalid_cc_email' => 'Jedna ili više CC imejl adresa nije validna.', + 'invalid_bcc_email' => 'Jedna ili više BCC imejl adresa nije validna.', +]; diff --git a/resources/views/filament/pages/send-email-user.blade.php b/resources/views/filament/pages/send-email-user.blade.php new file mode 100644 index 0000000..29c94dd --- /dev/null +++ b/resources/views/filament/pages/send-email-user.blade.php @@ -0,0 +1,9 @@ + + + {{ $this->form }} + + + + \ No newline at end of file diff --git a/resources/views/mail/send-email-to-user.blade.php b/resources/views/mail/send-email-to-user.blade.php new file mode 100644 index 0000000..11fd8e4 --- /dev/null +++ b/resources/views/mail/send-email-to-user.blade.php @@ -0,0 +1,97 @@ + + + + + + {{ $subject ?? __('eclipse::email.email_sent') }} + + + +
+
+

{{ config('app.name') }}

+
+ + @if($sender) +
+

{{ __('eclipse::email.sender') }}: {{ $sender->name }} ({{ $sender->email }})

+
+ @endif + +
+

{{ __('eclipse::email.message') }}:

+
{{ $messageContent }}
+
+ +
+

{{ __('This email was sent through :app_name system.', ['app_name' => config('app.name')]) }}

+

{{ __('eclipse::email.recipient') }}: {{ $recipient->name }} ({{ $recipient->email }})

+
+
+ + \ No newline at end of file diff --git a/src/Filament/Actions/SendEmailAction.php b/src/Filament/Actions/SendEmailAction.php new file mode 100644 index 0000000..36d473d --- /dev/null +++ b/src/Filament/Actions/SendEmailAction.php @@ -0,0 +1,20 @@ +authorize(fn () => auth()->user()->can('sendEmail', User::class)) + ); + } +} diff --git a/src/Filament/Actions/SendEmailTableAction.php b/src/Filament/Actions/SendEmailTableAction.php new file mode 100644 index 0000000..26cd588 --- /dev/null +++ b/src/Filament/Actions/SendEmailTableAction.php @@ -0,0 +1,21 @@ +authorize(fn () => auth()->user()->can('sendEmail', User::class)) + ->visible(fn ($record) => ! $record->trashed()) + ); + } +} diff --git a/src/Filament/Resources/UserResource.php b/src/Filament/Resources/UserResource.php index 10d5055..818bdd9 100644 --- a/src/Filament/Resources/UserResource.php +++ b/src/Filament/Resources/UserResource.php @@ -3,6 +3,7 @@ namespace Eclipse\Core\Filament\Resources; use BezhanSalleh\FilamentShield\Contracts\HasShieldPermissions; +use Eclipse\Core\Filament\Actions\SendEmailTableAction; use Eclipse\Core\Filament\Exports\TableExport; use Eclipse\Core\Filament\Resources; use Eclipse\Core\Models\User; @@ -213,6 +214,7 @@ public static function table(Table $table): Table Tables\Actions\ActionGroup::make([ Tables\Actions\ViewAction::make(), Tables\Actions\EditAction::make(), + SendEmailTableAction::make(), Impersonate::make() ->grouped() ->redirectTo(route('filament.admin.tenant')), @@ -357,6 +359,7 @@ public static function getPermissionPrefixes(): array 'force_delete', 'force_delete_any', 'impersonate', + 'send_email', ]; } } diff --git a/src/Filament/Resources/UserResource/Pages/ViewUser.php b/src/Filament/Resources/UserResource/Pages/ViewUser.php index d7f450e..d695f67 100644 --- a/src/Filament/Resources/UserResource/Pages/ViewUser.php +++ b/src/Filament/Resources/UserResource/Pages/ViewUser.php @@ -2,6 +2,7 @@ namespace Eclipse\Core\Filament\Resources\UserResource\Pages; +use Eclipse\Core\Filament\Actions\SendEmailAction; use Eclipse\Core\Filament\Resources\UserResource; use Filament\Actions; use Filament\Resources\Pages\ViewRecord; @@ -15,6 +16,7 @@ protected function getHeaderActions(): array { return [ Actions\EditAction::make(), + SendEmailAction::make(), Impersonate::make() ->record($this->getRecord()) ->redirectTo(route('filament.admin.tenant')), diff --git a/src/Filament/Traits/SendEmailActionTrait.php b/src/Filament/Traits/SendEmailActionTrait.php new file mode 100644 index 0000000..dd089f0 --- /dev/null +++ b/src/Filament/Traits/SendEmailActionTrait.php @@ -0,0 +1,147 @@ +description(__('eclipse::email.email_form_description')) + ->schema([ + Grid::make() + ->schema([ + TextInput::make('sender_email') + ->label(__('eclipse::email.sender')) + ->default(fn () => auth()->user()->email) + ->disabled() + ->dehydrated(false) + ->helperText(__('eclipse::email.your_email')), + + TextInput::make('recipient_email') + ->label(__('eclipse::email.recipient')) + ->default(fn ($record = null) => $record?->email) + ->disabled() + ->dehydrated(false) + ->helperText(__('eclipse::email.recipient_email')), + ]) + ->columns(2), + + Grid::make() + ->schema([ + TagsInput::make('cc') + ->label(__('eclipse::email.cc')) + ->helperText(__('eclipse::email.cc_help')) + ->placeholder('email1@example.com') + ->splitKeys(['Enter', 'Tab', ' ', ',']) + ->nestedRecursiveRules(['email']), + + TagsInput::make('bcc') + ->label(__('eclipse::email.bcc')) + ->helperText(__('eclipse::email.bcc_help')) + ->placeholder('email1@example.com') + ->splitKeys(['Enter', 'Tab', ' ', ',']) + ->nestedRecursiveRules(['email']), + ]) + ->columns(2), + + TextInput::make('subject') + ->label(__('eclipse::email.subject')) + ->required() + ->maxLength(255) + ->placeholder(__('eclipse::email.subject_placeholder')), + + Textarea::make('message') + ->label(__('eclipse::email.message')) + ->required() + ->rows(8) + ->placeholder(__('eclipse::email.message_placeholder')), + + Hidden::make('recipient_id') + ->default(fn ($record = null) => $record?->id), + ]) + ->columns(1), + ]; + } + + protected static function getEmailActionClosure(): \Closure + { + return function (array $data) { + try { + Validator::make($data, [ + 'cc' => ['nullable', 'array'], + 'cc.*' => ['email'], + 'bcc' => ['nullable', 'array'], + 'bcc.*' => ['email'], + ], [ + 'cc.*.email' => __('eclipse::email.invalid_cc_email'), + 'bcc.*.email' => __('eclipse::email.invalid_bcc_email'), + ])->validate(); + + $recipient = User::findOrFail($data['recipient_id']); + + $ccEmails = ! empty($data['cc']) ? implode(',', $data['cc']) : null; + $bccEmails = ! empty($data['bcc']) ? implode(',', $data['bcc']) : null; + + Mail::queue(new SendEmailToUser( + $recipient, + $data['subject'], + $data['message'], + $ccEmails, + $bccEmails, + auth()->user() + )); + + Notification::make() + ->title(__('eclipse::email.email_sent')) + ->body(__('eclipse::email.email_sent_to', ['email' => $recipient->email])) + ->success() + ->sendToDatabase(auth()->user()) + ->broadcast([auth()->user()]); + } catch (\Illuminate\Validation\ValidationException $e) { + $errors = collect($e->errors())->flatten()->implode(' '); + + Notification::make() + ->title(__('eclipse::email.error')) + ->body(__('eclipse::email.send_error_message', ['error' => $errors])) + ->danger() + ->sendToDatabase(auth()->user()) + ->broadcast([auth()->user()]); + } catch (\Exception $e) { + Notification::make() + ->title(__('eclipse::email.error')) + ->body(__('eclipse::email.send_error_message', ['error' => $e->getMessage()])) + ->danger() + ->sendToDatabase(auth()->user()) + ->broadcast([auth()->user()]); + } + }; + } + + protected static function configureEmailAction($action) + { + return $action + ->label(fn () => __('eclipse::email.send_email')) + ->icon('heroicon-o-envelope') + ->form(static::getEmailFormSchema()) + ->action(static::getEmailActionClosure()) + ->modalHeading(fn ($record) => __('eclipse::email.send_email_to', ['name' => $record->name])) + ->modalSubmitActionLabel(__('eclipse::email.send')) + ->modalCancelActionLabel(__('eclipse::email.cancel')) + ->modalWidth('2xl') + ->modalFooterActionsAlignment('end'); + } +} diff --git a/src/Mail/SendEmailToUser.php b/src/Mail/SendEmailToUser.php new file mode 100644 index 0000000..dfd0ade --- /dev/null +++ b/src/Mail/SendEmailToUser.php @@ -0,0 +1,83 @@ +emailSubject, + to: [$this->recipient->email] + ); + + if ($this->ccEmails) { + $ccEmailsArray = array_filter(array_map('trim', explode(',', $this->ccEmails))); + if (! empty($ccEmailsArray)) { + $envelope = $envelope->cc($ccEmailsArray); + } + } + + if ($this->bccEmails) { + $bccEmailsArray = array_filter(array_map('trim', explode(',', $this->bccEmails))); + if (! empty($bccEmailsArray)) { + $envelope = $envelope->bcc($bccEmailsArray); + } + } + + return $envelope; + } + + /** + * Get the message content definition. + */ + public function content(): Content + { + return new Content( + view: 'eclipse::mail.send-email-to-user', + with: [ + 'recipient' => $this->recipient, + 'messageContent' => $this->emailMessage, + 'sender' => $this->sender, + 'subject' => $this->emailSubject, + ] + ); + } + + /** + * Get the attachments for the message. + * + * @return array + */ + public function attachments(): array + { + return []; + } +} diff --git a/src/Policies/UserPolicy.php b/src/Policies/UserPolicy.php index 42c1211..125befe 100644 --- a/src/Policies/UserPolicy.php +++ b/src/Policies/UserPolicy.php @@ -100,4 +100,12 @@ public function impersonate(User $user): bool { return $user->can('impersonate_user'); } + + /** + * Determine whether the user can send emails to other users. + */ + public function sendEmail(User $user): bool + { + return $user->can('send_email_user'); + } } diff --git a/tests/Feature/UserEmailTest.php b/tests/Feature/UserEmailTest.php new file mode 100644 index 0000000..c3939c4 --- /dev/null +++ b/tests/Feature/UserEmailTest.php @@ -0,0 +1,165 @@ +set_up_super_admin_and_tenant(); + + // Create additional permissions + Permission::firstOrCreate(['name' => 'send_email_user']); + + // Create role with email permission + $this->emailRole = Role::firstOrCreate(['name' => 'email_sender']); + $this->emailRole->givePermissionTo(['send_email_user', 'view_any_user']); + + // Create role without email permission + $this->regularRole = Role::firstOrCreate(['name' => 'regular_user']); + $this->regularRole->givePermissionTo(['view_any_user']); + + // Create users with site association + $site = \Eclipse\Core\Models\Site::first(); + + $this->authorizedUser = User::factory()->create(); + $this->authorizedUser->assignRole($this->emailRole); + $this->authorizedUser->sites()->attach($site); + + $this->unauthorizedUser = User::factory()->create(); + $this->unauthorizedUser->assignRole($this->regularRole); + $this->unauthorizedUser->sites()->attach($site); + + $this->recipientUser = User::factory()->create(); + $this->recipientUser->sites()->attach($site); +}); + +test('authorized user has send email permission', function () { + $this->actingAs($this->authorizedUser); + + expect($this->authorizedUser->can('sendEmail', User::class))->toBeTrue(); +}); + +test('unauthorized user does not have send email permission', function () { + $this->actingAs($this->unauthorizedUser); + + expect($this->unauthorizedUser->can('sendEmail', User::class))->toBeFalse(); +}); + +test('send email action requires authorization', function () { + // Test authorization through the policy directly + $this->actingAs($this->authorizedUser); + expect($this->authorizedUser->can('sendEmail', User::class))->toBeTrue(); + + $this->actingAs($this->unauthorizedUser); + expect($this->unauthorizedUser->can('sendEmail', User::class))->toBeFalse(); + + // Test that action is properly configured + $action = \Eclipse\Core\Filament\Actions\SendEmailTableAction::make(); + expect($action->getName())->toBe('sendEmail'); + expect($action->getIcon())->toBe('heroicon-o-envelope'); +}); + +test('send email action visibility rules', function () { + $this->actingAs($this->authorizedUser); + + // Test that action has the proper visibility configuration + $action = \Eclipse\Core\Filament\Actions\SendEmailTableAction::make(); + + // Action should be properly configured + expect($action)->not->toBeNull(); + expect($action->getName())->toBe('sendEmail'); + expect($action->getIcon())->toBe('heroicon-o-envelope'); + + // Test that trashed user detection works + expect($this->recipientUser->trashed())->toBeFalse(); + + $this->recipientUser->delete(); + expect($this->recipientUser->trashed())->toBeTrue(); +}); + +test('send email functionality queues mail', function () { + Queue::fake(); + Mail::fake(); + + $this->actingAs($this->authorizedUser); + + // Send email directly using the Mail class + $emailData = [ + 'subject' => 'Test Subject', + 'message' => 'Test message content', + 'cc' => 'cc1@example.com, cc2@example.com', + 'bcc' => 'bcc1@example.com', + ]; + + Mail::queue(new SendEmailToUser( + $this->recipientUser, + $emailData['subject'], + $emailData['message'], + $emailData['cc'], + $emailData['bcc'], + $this->authorizedUser + )); + + // Assert email was queued + Mail::assertQueued(SendEmailToUser::class, function ($mail) use ($emailData) { + return $mail->recipient->id === $this->recipientUser->id + && $mail->emailSubject === $emailData['subject'] + && $mail->emailMessage === $emailData['message'] + && $mail->ccEmails === $emailData['cc'] + && $mail->bccEmails === $emailData['bcc'] + && $mail->sender->id === $this->authorizedUser->id; + }); +}); + +test('email template renders correctly', function () { + $mail = new SendEmailToUser( + $this->recipientUser, + 'Test Subject', + 'Test message content', + 'cc@example.com', + 'bcc@example.com', + $this->authorizedUser + ); + + $view = $mail->content()->view; + $data = $mail->content()->with; + + expect($view)->toBe('eclipse::mail.send-email-to-user'); + expect($data['recipient']->id)->toBe($this->recipientUser->id); + expect($data['messageContent'])->toBe('Test message content'); + expect($data['sender']->id)->toBe($this->authorizedUser->id); + expect($data['subject'])->toBe('Test Subject'); +}); + +test('email envelope has correct recipients', function () { + $mail = new SendEmailToUser( + $this->recipientUser, + 'Test Subject', + 'Test message content', + 'cc1@example.com, cc2@example.com', + 'bcc1@example.com, bcc2@example.com', + $this->authorizedUser + ); + + $envelope = $mail->envelope(); + + expect($envelope->subject)->toBe('Test Subject'); + + // Test recipients + expect($envelope->to)->toHaveCount(1); + expect($envelope->to[0]->address)->toBe($this->recipientUser->email); + + // Test CC + expect($envelope->cc)->toHaveCount(2); + expect($envelope->cc[0]->address)->toBe('cc1@example.com'); + expect($envelope->cc[1]->address)->toBe('cc2@example.com'); + + // Test BCC + expect($envelope->bcc)->toHaveCount(2); + expect($envelope->bcc[0]->address)->toBe('bcc1@example.com'); + expect($envelope->bcc[1]->address)->toBe('bcc2@example.com'); +}); From 1a495bdfc178ac6d3a936c387f7375eae3e0b094 Mon Sep 17 00:00:00 2001 From: Kilian Trunk Date: Fri, 11 Jul 2025 14:47:53 +0200 Subject: [PATCH 02/12] chore(emails): implement email sent listener --- resources/lang/en/email.php | 2 + resources/lang/hr/email.php | 2 + resources/lang/sl/email.php | 2 + resources/lang/sr/email.php | 2 + src/EclipseServiceProvider.php | 4 ++ src/Filament/Traits/SendEmailActionTrait.php | 4 +- .../SendEmailSuccessNotification.php | 52 +++++++++++++++++++ src/Mail/SendEmailToUser.php | 33 ++++++++++++ 8 files changed, 99 insertions(+), 2 deletions(-) create mode 100644 src/Listeners/SendEmailSuccessNotification.php diff --git a/resources/lang/en/email.php b/resources/lang/en/email.php index e2dab40..0229ef7 100644 --- a/resources/lang/en/email.php +++ b/resources/lang/en/email.php @@ -15,6 +15,8 @@ 'message_placeholder' => 'Enter message content...', 'send' => 'Send', 'cancel' => 'Cancel', + 'email_queued' => 'Email queued', + 'email_queued_to' => 'Email to :email has been queued for sending.', 'email_sent' => 'Email sent', 'email_sent_to' => 'Email to :email has been successfully sent.', 'permission_denied' => 'Permission denied', diff --git a/resources/lang/hr/email.php b/resources/lang/hr/email.php index cf01042..37b5f70 100644 --- a/resources/lang/hr/email.php +++ b/resources/lang/hr/email.php @@ -15,6 +15,8 @@ 'message_placeholder' => 'Unesite sadržaj poruke...', 'send' => 'Pošaljite', 'cancel' => 'Otkaži', + 'email_queued' => 'E-mail je u redu za slanje', + 'email_queued_to' => 'E-mail za :email je dodan u red za slanje.', 'email_sent' => 'E-mail poslan', 'email_sent_to' => 'E-mail poslan na :email je uspješno poslan.', 'permission_denied' => 'Dozvola odbijena', diff --git a/resources/lang/sl/email.php b/resources/lang/sl/email.php index b625f6d..2a7596f 100644 --- a/resources/lang/sl/email.php +++ b/resources/lang/sl/email.php @@ -15,6 +15,8 @@ 'message_placeholder' => 'Vnesite vsebino sporočila...', 'send' => 'Pošlji', 'cancel' => 'Prekliči', + 'email_queued' => 'E-pošta v čakalni vrsti', + 'email_queued_to' => 'E-pošta za :email je dodana v čakalno vrsto za pošiljanje.', 'email_sent' => 'E-pošta poslana', 'email_sent_to' => 'E-pošta je bila uspešno poslana na :email.', 'permission_denied' => 'Dostop zavrnjen', diff --git a/resources/lang/sr/email.php b/resources/lang/sr/email.php index 2beb9e9..8484377 100644 --- a/resources/lang/sr/email.php +++ b/resources/lang/sr/email.php @@ -15,6 +15,8 @@ 'message_placeholder' => 'Unesite sadržaj poruke...', 'send' => 'Pošalji', 'cancel' => 'Otkaži', + 'email_queued' => 'Imejl je u redu za slanje', + 'email_queued_to' => 'Imejl za :email je dodat u red za slanje.', 'email_sent' => 'Imejl poslan', 'email_sent_to' => 'Imejl poslan na :email je uspešno poslan.', 'permission_denied' => 'Dozvola odbijena', diff --git a/src/EclipseServiceProvider.php b/src/EclipseServiceProvider.php index ffeb8a8..197fbef 100644 --- a/src/EclipseServiceProvider.php +++ b/src/EclipseServiceProvider.php @@ -8,6 +8,7 @@ use Eclipse\Core\Console\Commands\ClearCommand; use Eclipse\Core\Console\Commands\DeployCommand; use Eclipse\Core\Console\Commands\PostComposerUpdate; +use Eclipse\Core\Listeners\SendEmailSuccessNotification; use Eclipse\Core\Models\Locale; use Eclipse\Core\Models\User; use Eclipse\Core\Models\User\Permission; @@ -21,6 +22,7 @@ use Filament\Tables\Columns\Column; use Illuminate\Auth\Events\Login; use Illuminate\Database\Eloquent\Model; +use Illuminate\Mail\Events\MessageSent; use Illuminate\Support\Facades\Config; use Illuminate\Support\Facades\DB; use Illuminate\Support\Facades\Event; @@ -79,6 +81,8 @@ public function register(): self } }); + Event::listen(MessageSent::class, SendEmailSuccessNotification::class); + $this->app->register(AdminPanelProvider::class); if ($this->app->environment('local')) { diff --git a/src/Filament/Traits/SendEmailActionTrait.php b/src/Filament/Traits/SendEmailActionTrait.php index dd089f0..2939aaa 100644 --- a/src/Filament/Traits/SendEmailActionTrait.php +++ b/src/Filament/Traits/SendEmailActionTrait.php @@ -106,8 +106,8 @@ protected static function getEmailActionClosure(): \Closure )); Notification::make() - ->title(__('eclipse::email.email_sent')) - ->body(__('eclipse::email.email_sent_to', ['email' => $recipient->email])) + ->title(__('eclipse::email.email_queued')) + ->body(__('eclipse::email.email_queued_to', ['email' => $recipient->email])) ->success() ->sendToDatabase(auth()->user()) ->broadcast([auth()->user()]); diff --git a/src/Listeners/SendEmailSuccessNotification.php b/src/Listeners/SendEmailSuccessNotification.php new file mode 100644 index 0000000..87df59b --- /dev/null +++ b/src/Listeners/SendEmailSuccessNotification.php @@ -0,0 +1,52 @@ +message; + + $headers = $message->getHeaders(); + + if (! $headers->has('X-Eclipse-Email-Type') || + $headers->get('X-Eclipse-Email-Type')->getBodyAsString() !== 'SendEmailToUser') { + return; + } + + if (! $headers->has('X-Eclipse-Sender-ID')) { + return; + } + + $senderId = $headers->get('X-Eclipse-Sender-ID')->getBodyAsString(); + if (empty($senderId)) { + return; + } + + if (! $headers->has('X-Eclipse-Recipient-Email')) { + return; + } + + $recipientEmail = $headers->get('X-Eclipse-Recipient-Email')->getBodyAsString(); + + $sender = User::find($senderId); + if (! $sender) { + return; + } + + Notification::make() + ->title(__('eclipse::email.email_sent')) + ->body(__('eclipse::email.email_sent_to', ['email' => $recipientEmail])) + ->success() + ->sendToDatabase($sender) + ->broadcast([$sender]); + } +} diff --git a/src/Mail/SendEmailToUser.php b/src/Mail/SendEmailToUser.php index dfd0ade..99ad150 100644 --- a/src/Mail/SendEmailToUser.php +++ b/src/Mail/SendEmailToUser.php @@ -3,11 +3,13 @@ namespace Eclipse\Core\Mail; use Eclipse\Core\Models\User; +use Filament\Notifications\Notification; use Illuminate\Bus\Queueable; use Illuminate\Contracts\Queue\ShouldQueue; use Illuminate\Mail\Mailable; use Illuminate\Mail\Mailables\Content; use Illuminate\Mail\Mailables\Envelope; +use Illuminate\Mail\Mailables\Headers; use Illuminate\Queue\SerializesModels; class SendEmailToUser extends Mailable implements ShouldQueue @@ -55,6 +57,20 @@ public function envelope(): Envelope return $envelope; } + /** + * Get the message headers. + */ + public function headers(): Headers + { + return new Headers( + text: [ + 'X-Eclipse-Email-Type' => 'SendEmailToUser', + 'X-Eclipse-Sender-ID' => $this->sender?->id ?? '', + 'X-Eclipse-Recipient-Email' => $this->recipient->email, + ] + ); + } + /** * Get the message content definition. */ @@ -80,4 +96,21 @@ public function attachments(): array { return []; } + + /** + * Handle a job failure. + */ + public function failed(\Throwable $exception): void + { + if ($this->sender) { + Notification::make() + ->title(__('eclipse::email.error')) + ->body(__('eclipse::email.send_error_message', [ + 'error' => $exception->getMessage(), + ])) + ->danger() + ->sendToDatabase($this->sender) + ->broadcast([$this->sender]); + } + } } From 06a3ca0aa4a8f456d66f8b0b0bc197826f3a9d67 Mon Sep 17 00:00:00 2001 From: Kilian Trunk Date: Wed, 16 Jul 2025 14:57:58 +0200 Subject: [PATCH 03/12] chore(emails): add reply-to, refactor send email action, use WYSIWYG editor --- .../views/mail/send-email-to-user.blade.php | 2 +- src/Filament/Actions/SendEmailAction.php | 152 +++++++++++++++++- src/Filament/Actions/SendEmailTableAction.php | 10 +- src/Filament/Traits/SendEmailActionTrait.php | 147 ----------------- src/Mail/SendEmailToUser.php | 21 ++- 5 files changed, 174 insertions(+), 158 deletions(-) delete mode 100644 src/Filament/Traits/SendEmailActionTrait.php diff --git a/resources/views/mail/send-email-to-user.blade.php b/resources/views/mail/send-email-to-user.blade.php index 11fd8e4..aa41a2b 100644 --- a/resources/views/mail/send-email-to-user.blade.php +++ b/resources/views/mail/send-email-to-user.blade.php @@ -85,7 +85,7 @@

{{ __('eclipse::email.message') }}:

-
{{ $messageContent }}
+
{!! $messageContent !!}
diff --git a/src/Filament/Actions/SendEmailAction.php b/src/Filament/Actions/SendEmailAction.php index 36d473d..ab95bb0 100644 --- a/src/Filament/Actions/SendEmailAction.php +++ b/src/Filament/Actions/SendEmailAction.php @@ -2,14 +2,21 @@ namespace Eclipse\Core\Filament\Actions; -use Eclipse\Core\Filament\Traits\SendEmailActionTrait; +use Eclipse\Core\Mail\SendEmailToUser; use Eclipse\Core\Models\User; use Filament\Actions\Action; +use Filament\Forms\Components\Grid; +use Filament\Forms\Components\Hidden; +use Filament\Forms\Components\RichEditor; +use Filament\Forms\Components\Section; +use Filament\Forms\Components\TagsInput; +use Filament\Forms\Components\TextInput; +use Filament\Notifications\Notification; +use Illuminate\Support\Facades\Mail; +use Illuminate\Support\Facades\Validator; class SendEmailAction { - use SendEmailActionTrait; - public static function make(): Action { return static::configureEmailAction( @@ -17,4 +24,143 @@ public static function make(): Action ->authorize(fn () => auth()->user()->can('sendEmail', User::class)) ); } + + protected static function getEmailFormSchema(): array + { + return [ + Section::make(__('eclipse::email.email_form_title')) + ->description(__('eclipse::email.email_form_description')) + ->schema([ + Grid::make() + ->schema([ + TextInput::make('sender_email') + ->label(__('eclipse::email.sender')) + ->default(fn () => auth()->user()->email) + ->disabled() + ->dehydrated(false) + ->helperText(__('eclipse::email.your_email')), + + TextInput::make('recipient_email') + ->label(__('eclipse::email.recipient')) + ->default(fn ($record = null) => $record?->email) + ->disabled() + ->dehydrated(false) + ->helperText(__('eclipse::email.recipient_email')), + ]) + ->columns(2), + + Grid::make() + ->schema([ + TagsInput::make('cc') + ->label(__('eclipse::email.cc')) + ->helperText(__('eclipse::email.cc_help')) + ->placeholder('email1@example.com') + ->splitKeys(['Enter', 'Tab', ' ', ',']) + ->nestedRecursiveRules(['email']), + + TagsInput::make('bcc') + ->label(__('eclipse::email.bcc')) + ->helperText(__('eclipse::email.bcc_help')) + ->placeholder('email1@example.com') + ->splitKeys(['Enter', 'Tab', ' ', ',']) + ->nestedRecursiveRules(['email']), + ]) + ->columns(2), + + TextInput::make('subject') + ->label(__('eclipse::email.subject')) + ->required() + ->maxLength(255) + ->placeholder(__('eclipse::email.subject_placeholder')), + + RichEditor::make('message') + ->label(__('eclipse::email.message')) + ->required() + ->placeholder(__('eclipse::email.message_placeholder')) + ->toolbarButtons([ + 'bold', + 'italic', + 'underline', + 'strike', + 'link', + 'bulletList', + 'orderedList', + 'h2', + 'h3', + ]), + + Hidden::make('recipient_id') + ->default(fn ($record = null) => $record?->id), + ]) + ->columns(1), + ]; + } + + protected static function getEmailActionClosure(): \Closure + { + return function (array $data) { + try { + Validator::make($data, [ + 'cc' => ['nullable', 'array'], + 'cc.*' => ['email'], + 'bcc' => ['nullable', 'array'], + 'bcc.*' => ['email'], + ], [ + 'cc.*.email' => __('eclipse::email.invalid_cc_email'), + 'bcc.*.email' => __('eclipse::email.invalid_bcc_email'), + ])->validate(); + + $recipient = User::findOrFail($data['recipient_id']); + + $ccEmails = ! empty($data['cc']) ? implode(',', $data['cc']) : null; + $bccEmails = ! empty($data['bcc']) ? implode(',', $data['bcc']) : null; + + Mail::queue(new SendEmailToUser( + $recipient, + $data['subject'], + $data['message'], + $ccEmails, + $bccEmails, + auth()->user() + )); + + Notification::make() + ->title(__('eclipse::email.email_queued')) + ->body(__('eclipse::email.email_queued_to', ['email' => $recipient->email])) + ->success() + ->sendToDatabase(auth()->user()) + ->broadcast([auth()->user()]); + } catch (\Illuminate\Validation\ValidationException $e) { + $errors = collect($e->errors())->flatten()->implode(' '); + + Notification::make() + ->title(__('eclipse::email.error')) + ->body(__('eclipse::email.send_error_message', ['error' => $errors])) + ->danger() + ->sendToDatabase(auth()->user()) + ->broadcast([auth()->user()]); + } catch (\Exception $e) { + Notification::make() + ->title(__('eclipse::email.error')) + ->body(__('eclipse::email.send_error_message', ['error' => $e->getMessage()])) + ->danger() + ->sendToDatabase(auth()->user()) + ->broadcast([auth()->user()]); + } + }; + } + + protected static function configureEmailAction($action) + { + return $action + ->label(fn () => __('eclipse::email.send_email')) + ->icon('heroicon-o-envelope') + ->form(static::getEmailFormSchema()) + ->action(static::getEmailActionClosure()) + ->modalHeading(fn ($record) => __('eclipse::email.send_email_to', ['name' => $record->name])) + ->modalSubmitActionLabel(__('eclipse::email.send')) + ->modalCancelActionLabel(__('eclipse::email.cancel')) + ->modalWidth('2xl') + ->modalFooterActionsAlignment('end'); + } } diff --git a/src/Filament/Actions/SendEmailTableAction.php b/src/Filament/Actions/SendEmailTableAction.php index 26cd588..5c77991 100644 --- a/src/Filament/Actions/SendEmailTableAction.php +++ b/src/Filament/Actions/SendEmailTableAction.php @@ -2,18 +2,16 @@ namespace Eclipse\Core\Filament\Actions; -use Eclipse\Core\Filament\Traits\SendEmailActionTrait; use Eclipse\Core\Models\User; -use Filament\Tables\Actions\Action; +use Filament\Actions\Action; +use Filament\Tables\Actions\Action as TableAction; -class SendEmailTableAction +class SendEmailTableAction extends SendEmailAction { - use SendEmailActionTrait; - public static function make(): Action { return static::configureEmailAction( - Action::make('sendEmail') + TableAction::make('sendEmail') ->authorize(fn () => auth()->user()->can('sendEmail', User::class)) ->visible(fn ($record) => ! $record->trashed()) ); diff --git a/src/Filament/Traits/SendEmailActionTrait.php b/src/Filament/Traits/SendEmailActionTrait.php deleted file mode 100644 index 2939aaa..0000000 --- a/src/Filament/Traits/SendEmailActionTrait.php +++ /dev/null @@ -1,147 +0,0 @@ -description(__('eclipse::email.email_form_description')) - ->schema([ - Grid::make() - ->schema([ - TextInput::make('sender_email') - ->label(__('eclipse::email.sender')) - ->default(fn () => auth()->user()->email) - ->disabled() - ->dehydrated(false) - ->helperText(__('eclipse::email.your_email')), - - TextInput::make('recipient_email') - ->label(__('eclipse::email.recipient')) - ->default(fn ($record = null) => $record?->email) - ->disabled() - ->dehydrated(false) - ->helperText(__('eclipse::email.recipient_email')), - ]) - ->columns(2), - - Grid::make() - ->schema([ - TagsInput::make('cc') - ->label(__('eclipse::email.cc')) - ->helperText(__('eclipse::email.cc_help')) - ->placeholder('email1@example.com') - ->splitKeys(['Enter', 'Tab', ' ', ',']) - ->nestedRecursiveRules(['email']), - - TagsInput::make('bcc') - ->label(__('eclipse::email.bcc')) - ->helperText(__('eclipse::email.bcc_help')) - ->placeholder('email1@example.com') - ->splitKeys(['Enter', 'Tab', ' ', ',']) - ->nestedRecursiveRules(['email']), - ]) - ->columns(2), - - TextInput::make('subject') - ->label(__('eclipse::email.subject')) - ->required() - ->maxLength(255) - ->placeholder(__('eclipse::email.subject_placeholder')), - - Textarea::make('message') - ->label(__('eclipse::email.message')) - ->required() - ->rows(8) - ->placeholder(__('eclipse::email.message_placeholder')), - - Hidden::make('recipient_id') - ->default(fn ($record = null) => $record?->id), - ]) - ->columns(1), - ]; - } - - protected static function getEmailActionClosure(): \Closure - { - return function (array $data) { - try { - Validator::make($data, [ - 'cc' => ['nullable', 'array'], - 'cc.*' => ['email'], - 'bcc' => ['nullable', 'array'], - 'bcc.*' => ['email'], - ], [ - 'cc.*.email' => __('eclipse::email.invalid_cc_email'), - 'bcc.*.email' => __('eclipse::email.invalid_bcc_email'), - ])->validate(); - - $recipient = User::findOrFail($data['recipient_id']); - - $ccEmails = ! empty($data['cc']) ? implode(',', $data['cc']) : null; - $bccEmails = ! empty($data['bcc']) ? implode(',', $data['bcc']) : null; - - Mail::queue(new SendEmailToUser( - $recipient, - $data['subject'], - $data['message'], - $ccEmails, - $bccEmails, - auth()->user() - )); - - Notification::make() - ->title(__('eclipse::email.email_queued')) - ->body(__('eclipse::email.email_queued_to', ['email' => $recipient->email])) - ->success() - ->sendToDatabase(auth()->user()) - ->broadcast([auth()->user()]); - } catch (\Illuminate\Validation\ValidationException $e) { - $errors = collect($e->errors())->flatten()->implode(' '); - - Notification::make() - ->title(__('eclipse::email.error')) - ->body(__('eclipse::email.send_error_message', ['error' => $errors])) - ->danger() - ->sendToDatabase(auth()->user()) - ->broadcast([auth()->user()]); - } catch (\Exception $e) { - Notification::make() - ->title(__('eclipse::email.error')) - ->body(__('eclipse::email.send_error_message', ['error' => $e->getMessage()])) - ->danger() - ->sendToDatabase(auth()->user()) - ->broadcast([auth()->user()]); - } - }; - } - - protected static function configureEmailAction($action) - { - return $action - ->label(fn () => __('eclipse::email.send_email')) - ->icon('heroicon-o-envelope') - ->form(static::getEmailFormSchema()) - ->action(static::getEmailActionClosure()) - ->modalHeading(fn ($record) => __('eclipse::email.send_email_to', ['name' => $record->name])) - ->modalSubmitActionLabel(__('eclipse::email.send')) - ->modalCancelActionLabel(__('eclipse::email.cancel')) - ->modalWidth('2xl') - ->modalFooterActionsAlignment('end'); - } -} diff --git a/src/Mail/SendEmailToUser.php b/src/Mail/SendEmailToUser.php index 99ad150..814c465 100644 --- a/src/Mail/SendEmailToUser.php +++ b/src/Mail/SendEmailToUser.php @@ -4,6 +4,8 @@ use Eclipse\Core\Models\User; use Filament\Notifications\Notification; +use HTMLPurifier; +use HTMLPurifier_Config; use Illuminate\Bus\Queueable; use Illuminate\Contracts\Queue\ShouldQueue; use Illuminate\Mail\Mailable; @@ -27,7 +29,20 @@ public function __construct( public ?string $bccEmails = null, public ?User $sender = null ) { - // + $this->emailMessage = $this->purifyHtml($this->emailMessage); + } + + /** + * Purify HTML content to prevent XSS attacks and clean up malicious code. + */ + protected function purifyHtml(string $html): string + { + $config = HTMLPurifier_Config::createDefault(); + $config->set('HTML.Trusted', true); + $config->set('Core.Encoding', 'UTF-8'); + $purifier = new HTMLPurifier($config); + + return $purifier->purify($html); } /** @@ -40,6 +55,10 @@ public function envelope(): Envelope to: [$this->recipient->email] ); + if ($this->sender && $this->sender->email) { + $envelope = $envelope->replyTo($this->sender->email, $this->sender->name); + } + if ($this->ccEmails) { $ccEmailsArray = array_filter(array_map('trim', explode(',', $this->ccEmails))); if (! empty($ccEmailsArray)) { From 03b76dbd4a07bfee40320f0596218d181bc2be3f Mon Sep 17 00:00:00 2001 From: Kilian Trunk Date: Fri, 18 Jul 2025 19:48:01 +0200 Subject: [PATCH 04/12] chore(emails): fix sending emails through table action --- src/Filament/Actions/SendEmailTableAction.php | 7 +++---- src/Filament/Resources/UserResource.php | 2 +- tests/Feature/UserEmailTest.php | 4 ++-- 3 files changed, 6 insertions(+), 7 deletions(-) diff --git a/src/Filament/Actions/SendEmailTableAction.php b/src/Filament/Actions/SendEmailTableAction.php index 5c77991..fac0170 100644 --- a/src/Filament/Actions/SendEmailTableAction.php +++ b/src/Filament/Actions/SendEmailTableAction.php @@ -3,15 +3,14 @@ namespace Eclipse\Core\Filament\Actions; use Eclipse\Core\Models\User; -use Filament\Actions\Action; -use Filament\Tables\Actions\Action as TableAction; +use Filament\Tables\Actions\Action; class SendEmailTableAction extends SendEmailAction { - public static function make(): Action + public static function makeAction(): Action { return static::configureEmailAction( - TableAction::make('sendEmail') + Action::make('sendEmail') ->authorize(fn () => auth()->user()->can('sendEmail', User::class)) ->visible(fn ($record) => ! $record->trashed()) ); diff --git a/src/Filament/Resources/UserResource.php b/src/Filament/Resources/UserResource.php index 818bdd9..62ad341 100644 --- a/src/Filament/Resources/UserResource.php +++ b/src/Filament/Resources/UserResource.php @@ -214,7 +214,7 @@ public static function table(Table $table): Table Tables\Actions\ActionGroup::make([ Tables\Actions\ViewAction::make(), Tables\Actions\EditAction::make(), - SendEmailTableAction::make(), + SendEmailTableAction::makeAction(), Impersonate::make() ->grouped() ->redirectTo(route('filament.admin.tenant')), diff --git a/tests/Feature/UserEmailTest.php b/tests/Feature/UserEmailTest.php index c3939c4..ccd7fcb 100644 --- a/tests/Feature/UserEmailTest.php +++ b/tests/Feature/UserEmailTest.php @@ -58,7 +58,7 @@ expect($this->unauthorizedUser->can('sendEmail', User::class))->toBeFalse(); // Test that action is properly configured - $action = \Eclipse\Core\Filament\Actions\SendEmailTableAction::make(); + $action = \Eclipse\Core\Filament\Actions\SendEmailTableAction::makeAction(); expect($action->getName())->toBe('sendEmail'); expect($action->getIcon())->toBe('heroicon-o-envelope'); }); @@ -67,7 +67,7 @@ $this->actingAs($this->authorizedUser); // Test that action has the proper visibility configuration - $action = \Eclipse\Core\Filament\Actions\SendEmailTableAction::make(); + $action = \Eclipse\Core\Filament\Actions\SendEmailTableAction::makeAction(); // Action should be properly configured expect($action)->not->toBeNull(); From 552cc20c8cb215815a8c755e0825b6d01f4e5f3d Mon Sep 17 00:00:00 2001 From: Kilian Trunk Date: Fri, 25 Jul 2025 22:47:35 +0200 Subject: [PATCH 05/12] feat(emails): implement email outbox --- ...25_07_25_183516_create_mail_logs_table.php | 53 +++++ ..._190010_add_sent_at_to_mail_logs_table.php | 28 +++ resources/lang/en/email.php | 27 +++ resources/lang/hr/email.php | 27 +++ resources/lang/sl/email.php | 27 +++ resources/lang/sr/email.php | 27 +++ src/EclipseServiceProvider.php | 4 +- src/Filament/Resources/MailLogResource.php | 208 ++++++++++++++++++ .../MailLogResource/Pages/ListMailLogs.php | 18 ++ src/Listeners/LogEmailToDatabase.php | 95 ++++++++ src/Mail/SendEmailToUser.php | 82 +++---- src/Models/MailLog.php | 76 +++++++ src/Models/Site.php | 6 + 13 files changed, 639 insertions(+), 39 deletions(-) create mode 100644 database/migrations/2025_07_25_183516_create_mail_logs_table.php create mode 100644 database/migrations/2025_07_25_190010_add_sent_at_to_mail_logs_table.php create mode 100644 src/Filament/Resources/MailLogResource.php create mode 100644 src/Filament/Resources/MailLogResource/Pages/ListMailLogs.php create mode 100644 src/Listeners/LogEmailToDatabase.php create mode 100644 src/Models/MailLog.php diff --git a/database/migrations/2025_07_25_183516_create_mail_logs_table.php b/database/migrations/2025_07_25_183516_create_mail_logs_table.php new file mode 100644 index 0000000..d92e96e --- /dev/null +++ b/database/migrations/2025_07_25_183516_create_mail_logs_table.php @@ -0,0 +1,53 @@ +increments('id'); + + $table->foreignId('site_id')->nullable()->constrained('sites')->onDelete('cascade'); + + $table->string('from')->nullable(); + $table->string('to')->nullable(); + $table->string('cc')->nullable(); + $table->string('bcc')->nullable(); + $table->string('subject'); + $table->text('body'); + $table->text('headers')->nullable(); + $table->longText('attachments')->nullable(); + $table->uuid('message_id')->nullable(); + $table->string('status')->nullable(); + $table->longText('data')->nullable(); + $table->timestamp('opened')->nullable(); + $table->timestamp('delivered')->nullable(); + $table->timestamp('complaint')->nullable(); + $table->timestamp('bounced')->nullable(); + + $table->foreignId('sender_id')->nullable()->constrained('users')->onDelete('set null'); + $table->foreignId('recipient_id')->nullable()->constrained('users')->onDelete('set null'); + + $table->timestamps(); + + $table->index('message_id'); + $table->index('status'); + $table->index(['site_id', 'created_at']); + }); + } + + /** + * Reverse the migrations. + */ + public function down(): void + { + Schema::dropIfExists('mail_logs'); + } +}; diff --git a/database/migrations/2025_07_25_190010_add_sent_at_to_mail_logs_table.php b/database/migrations/2025_07_25_190010_add_sent_at_to_mail_logs_table.php new file mode 100644 index 0000000..4d2d2c4 --- /dev/null +++ b/database/migrations/2025_07_25_190010_add_sent_at_to_mail_logs_table.php @@ -0,0 +1,28 @@ +timestamp('sent_at')->nullable()->after('status'); + }); + } + + /** + * Reverse the migrations. + */ + public function down(): void + { + Schema::table('mail_logs', function (Blueprint $table) { + $table->dropColumn('sent_at'); + }); + } +}; diff --git a/resources/lang/en/email.php b/resources/lang/en/email.php index 0229ef7..c084445 100644 --- a/resources/lang/en/email.php +++ b/resources/lang/en/email.php @@ -29,4 +29,31 @@ 'recipient_email' => 'Recipient email address', 'invalid_cc_email' => 'One or more CC email addresses are invalid.', 'invalid_bcc_email' => 'One or more BCC email addresses are invalid.', + + // Mail Log / Outbox + 'outbox' => 'Email Outbox', + 'outbox_description' => 'View all outgoing emails', + 'email_details' => 'Email Details', + 'email_body' => 'Email Body', + 'metadata' => 'Metadata', + 'user_information' => 'User Information', + 'headers' => 'Headers', + 'from' => 'From', + 'to' => 'To', + 'sent_at' => 'Sent At', + 'message_id' => 'Message ID', + 'status' => 'Status', + 'sent' => 'Sent', + 'sending' => 'Sending', + 'failed' => 'Failed', + 'sent_today' => 'Sent Today', + 'sent_this_week' => 'Sent This Week', + 'back_to_outbox' => 'Back to Outbox', + 'view_email' => 'View Email', + 'no_emails' => 'No emails found', + 'email_log' => 'Email Log', + 'show_html' => 'Show HTML', + 'show_preview' => 'Show Preview', + 'email_preview' => 'Email Preview', + 'html_source' => 'HTML Source', ]; diff --git a/resources/lang/hr/email.php b/resources/lang/hr/email.php index 37b5f70..08bdf67 100644 --- a/resources/lang/hr/email.php +++ b/resources/lang/hr/email.php @@ -29,4 +29,31 @@ 'recipient_email' => 'E-mail adresa primatelja', 'invalid_cc_email' => 'Jedna ili više CC e-mail adresa nije valjana.', 'invalid_bcc_email' => 'Jedna ili više BCC e-mail adresa nije valjana.', + + // Mail Log / Outbox + 'outbox' => 'Odlazni e-mailovi', + 'outbox_description' => 'Pregled svih odlaznih e-mailova', + 'email_details' => 'Detalji e-maila', + 'email_body' => 'Sadržaj e-maila', + 'metadata' => 'Metapodaci', + 'user_information' => 'Informacije o korisnicima', + 'headers' => 'Zaglavlja', + 'from' => 'Od', + 'to' => 'Za', + 'sent_at' => 'Poslano u', + 'message_id' => 'ID poruke', + 'status' => 'Status', + 'sent' => 'Poslano', + 'sending' => 'Šalje se', + 'failed' => 'Neuspješno', + 'sent_today' => 'Poslano danas', + 'sent_this_week' => 'Poslano ovaj tjedan', + 'back_to_outbox' => 'Natrag na odlazne poruke', + 'view_email' => 'Prikaži e-mail', + 'no_emails' => 'Nema pronađenih e-mailova', + 'email_log' => 'Dnevnik e-mailova', + 'show_html' => 'Prikaži HTML', + 'show_preview' => 'Prikaži pregled', + 'email_preview' => 'Pregled e-maila', + 'html_source' => 'HTML kod', ]; diff --git a/resources/lang/sl/email.php b/resources/lang/sl/email.php index 2a7596f..0086f04 100644 --- a/resources/lang/sl/email.php +++ b/resources/lang/sl/email.php @@ -29,4 +29,31 @@ 'recipient_email' => 'Prejemnik e-pošte', 'invalid_cc_email' => 'En ali več CC e-poštnih naslovov ni veljavnih.', 'invalid_bcc_email' => 'En ali več BCC e-poštnih naslovov ni veljavnih.', + + // Mail Log / Outbox + 'outbox' => 'Odhodna e-pošta', + 'outbox_description' => 'Pregled vse odhodne e-pošte', + 'email_details' => 'Podrobnosti e-pošte', + 'email_body' => 'Vsebina e-pošte', + 'metadata' => 'Metapodatki', + 'user_information' => 'Podatki o uporabnikih', + 'headers' => 'Glave', + 'from' => 'Od', + 'to' => 'Za', + 'sent_at' => 'Poslano ob', + 'message_id' => 'ID sporočila', + 'status' => 'Status', + 'sent' => 'Poslano', + 'sending' => 'Pošiljanje', + 'failed' => 'Neuspešno', + 'sent_today' => 'Poslano danes', + 'sent_this_week' => 'Poslano ta teden', + 'back_to_outbox' => 'Nazaj na odhodna sporočila', + 'view_email' => 'Prikaži e-pošto', + 'no_emails' => 'Ni najdenih e-poštnih sporočil', + 'email_log' => 'Dnevnik e-pošte', + 'show_html' => 'Prikaži HTML', + 'show_preview' => 'Prikaži predogled', + 'email_preview' => 'Predogled e-pošte', + 'html_source' => 'HTML koda', ]; diff --git a/resources/lang/sr/email.php b/resources/lang/sr/email.php index 8484377..f9bb425 100644 --- a/resources/lang/sr/email.php +++ b/resources/lang/sr/email.php @@ -29,4 +29,31 @@ 'recipient_email' => 'Imejl adresa primaoca', 'invalid_cc_email' => 'Jedna ili više CC imejl adresa nije validna.', 'invalid_bcc_email' => 'Jedna ili više BCC imejl adresa nije validna.', + + // Mail Log / Outbox + 'outbox' => 'Odlazni imejlovi', + 'outbox_description' => 'Pregled svih odlaznih imejlova', + 'email_details' => 'Detalji imejla', + 'email_body' => 'Sadržaj imejla', + 'metadata' => 'Metapodaci', + 'user_information' => 'Informacije o korisnicima', + 'headers' => 'Zaglavlja', + 'from' => 'Od', + 'to' => 'Za', + 'sent_at' => 'Poslano u', + 'message_id' => 'ID poruke', + 'status' => 'Status', + 'sent' => 'Poslano', + 'sending' => 'Šalje se', + 'failed' => 'Neuspešno', + 'sent_today' => 'Poslano danas', + 'sent_this_week' => 'Poslano ove nedelje', + 'back_to_outbox' => 'Nazad na odlazne poruke', + 'view_email' => 'Prikaži imejl', + 'no_emails' => 'Nema pronađenih imejlova', + 'email_log' => 'Dnevnik imejlova', + 'show_html' => 'Prikaži HTML', + 'show_preview' => 'Prikaži pregled', + 'email_preview' => 'Pregled imejla', + 'html_source' => 'HTML kod', ]; diff --git a/src/EclipseServiceProvider.php b/src/EclipseServiceProvider.php index 1f31a76..b9ac4f4 100644 --- a/src/EclipseServiceProvider.php +++ b/src/EclipseServiceProvider.php @@ -8,9 +8,10 @@ use Eclipse\Core\Console\Commands\ClearCommand; use Eclipse\Core\Console\Commands\DeployCommand; use Eclipse\Core\Console\Commands\PostComposerUpdate; -use Eclipse\Core\Listeners\SendEmailSuccessNotification; use Eclipse\Core\Console\Commands\SetupReverb; use Eclipse\Core\Health\Checks\ReverbCheck; +use Eclipse\Core\Listeners\LogEmailToDatabase; +use Eclipse\Core\Listeners\SendEmailSuccessNotification; use Eclipse\Core\Models\Locale; use Eclipse\Core\Models\User; use Eclipse\Core\Models\User\Permission; @@ -86,6 +87,7 @@ public function register(): self }); Event::listen(MessageSent::class, SendEmailSuccessNotification::class); + Event::listen(MessageSent::class, LogEmailToDatabase::class); $this->app->register(AdminPanelProvider::class); diff --git a/src/Filament/Resources/MailLogResource.php b/src/Filament/Resources/MailLogResource.php new file mode 100644 index 0000000..a91843f --- /dev/null +++ b/src/Filament/Resources/MailLogResource.php @@ -0,0 +1,208 @@ +schema([ + Forms\Components\Section::make(__('eclipse::email.email_details')) + ->schema([ + Forms\Components\TextInput::make('from') + ->label(__('eclipse::email.from')) + ->disabled(), + Forms\Components\TextInput::make('to') + ->label(__('eclipse::email.to')) + ->disabled(), + Forms\Components\TextInput::make('cc') + ->label(__('eclipse::email.cc')) + ->disabled(), + Forms\Components\TextInput::make('bcc') + ->label(__('eclipse::email.bcc')) + ->disabled(), + Forms\Components\TextInput::make('subject') + ->label(__('eclipse::email.subject')) + ->disabled(), + Forms\Components\Textarea::make('body') + ->label(__('eclipse::email.email_body')) + ->rows(10) + ->disabled(), + ]) + ->columns(2), + + Forms\Components\Section::make(__('eclipse::email.metadata')) + ->schema([ + Forms\Components\TextInput::make('status') + ->label(__('eclipse::email.status')) + ->disabled(), + Forms\Components\DateTimePicker::make('sent_at') + ->label(__('eclipse::email.sent_at')) + ->disabled(), + Forms\Components\TextInput::make('message_id') + ->label(__('eclipse::email.message_id')) + ->disabled(), + ]) + ->columns(3), + + Forms\Components\Section::make(__('eclipse::email.headers')) + ->schema([ + Forms\Components\KeyValue::make('headers') + ->label('') + ->disabled(), + ]), + ]); + } + + public static function table(Table $table): Table + { + return $table + ->columns([ + Tables\Columns\TextColumn::make('sent_at') + ->label(__('eclipse::email.sent_at')) + ->dateTime() + ->sortable(), + + Tables\Columns\TextColumn::make('from') + ->label(__('eclipse::email.from')) + ->limit(30) + ->tooltip(fn (MailLog $record): ?string => $record->from), + + Tables\Columns\TextColumn::make('to') + ->label(__('eclipse::email.to')) + ->limit(30) + ->tooltip(fn (MailLog $record): ?string => $record->to), + + Tables\Columns\TextColumn::make('subject') + ->label(__('eclipse::email.subject')) + ->limit(50) + ->tooltip(fn (MailLog $record): ?string => $record->subject), + + Tables\Columns\TextColumn::make('status') + ->label(__('eclipse::email.status')) + ->badge() + ->color(fn (string $state): string => match ($state) { + 'sent' => 'success', + 'sending' => 'warning', + 'failed' => 'danger', + default => 'gray', + }), + ]) + ->filters([ + Tables\Filters\SelectFilter::make('status') + ->label(__('eclipse::email.status')) + ->options([ + 'sent' => __('eclipse::email.sent'), + 'sending' => __('eclipse::email.sending'), + 'failed' => __('eclipse::email.failed'), + ]), + + Tables\Filters\Filter::make('sent_today') + ->label(__('eclipse::email.sent_today')) + ->query(fn (Builder $query): Builder => $query->whereDate('sent_at', today())), + + Tables\Filters\Filter::make('sent_this_week') + ->label(__('eclipse::email.sent_this_week')) + ->query(fn (Builder $query): Builder => $query->whereBetween('sent_at', [now()->startOfWeek(), now()->endOfWeek()])), + ]) + ->actions([ + Tables\Actions\ViewAction::make() + ->label(__('eclipse::email.view_email')) + ->modalHeading(fn (MailLog $record): string => __('eclipse::email.view_email').': '.$record->subject) + ->modalWidth('7xl') + ->form([ + Forms\Components\Placeholder::make('email_preview') + ->label('') + ->content(fn (MailLog $record) => static::buildEmailPreview($record)) + ->columnSpanFull(), + ]), + ]) + ->defaultSort('sent_at', 'desc') + ->poll('30s') + ->emptyStateHeading(__('eclipse::email.no_emails')) + ->emptyStateDescription(__('eclipse::email.outbox_description')) + ->emptyStateIcon('heroicon-o-envelope'); + } + + protected static function buildEmailPreview(MailLog $record): HtmlString + { + $subject = htmlspecialchars($record->subject ?? '', ENT_QUOTES, 'UTF-8'); + $body = htmlspecialchars($record->body ?? '', ENT_QUOTES, 'UTF-8'); + $showPreviewText = __('eclipse::email.show_preview'); + $showHtmlText = __('eclipse::email.show_html'); + + return new HtmlString(" +
+
+ {$subject} + +
+ +
+
+ +
+
+ +
+
+ 
{$body}
+
+
+
+ "); + } + + public static function getPages(): array + { + return [ + 'index' => MailLogResource\Pages\ListMailLogs::route('/'), + ]; + } + + public static function getEloquentQuery(): Builder + { + $query = parent::getEloquentQuery()->latest('created_at'); + + if ($currentSite = Registry::getSite()) { + $query->where('site_id', $currentSite->id); + } + + return $query; + } +} diff --git a/src/Filament/Resources/MailLogResource/Pages/ListMailLogs.php b/src/Filament/Resources/MailLogResource/Pages/ListMailLogs.php new file mode 100644 index 0000000..4c49e4a --- /dev/null +++ b/src/Filament/Resources/MailLogResource/Pages/ListMailLogs.php @@ -0,0 +1,18 @@ +message; + $headers = $message->getHeaders(); + + $messageId = $this->extractHeaderValue($headers, 'Message-ID'); + $siteId = $this->extractHeaderValue($headers, 'X-Eclipse-Site-ID'); + $senderId = $this->extractHeaderValue($headers, 'X-Eclipse-Sender-ID'); + $recipientId = $this->extractHeaderValue($headers, 'X-Eclipse-Recipient-ID'); + + MailLog::create([ + 'site_id' => $siteId ? (int) $siteId : null, + 'message_id' => $messageId, + 'from' => $this->extractHeaderValue($headers, 'From'), + 'to' => $this->extractHeaderValue($headers, 'To'), + 'cc' => $this->extractHeaderValue($headers, 'Cc'), + 'bcc' => $this->extractHeaderValue($headers, 'Bcc'), + 'subject' => $message->getSubject() ?? '', + 'body' => $this->extractEmailBody($message), + 'headers' => $this->collectAllHeaders($headers), + 'sender_id' => $senderId ? (int) $senderId : null, + 'recipient_id' => $recipientId ? (int) $recipientId : null, + 'status' => 'sent', + 'sent_at' => now(), + ]); + } catch (\Exception $e) { + Log::error('Email logging failed: '.$e->getMessage(), [ + 'exception' => $e, + 'trace' => $e->getTraceAsString(), + ]); + } + } + + /** + * Extract a header value from the headers. + */ + private function extractHeaderValue(\Symfony\Component\Mime\Header\Headers $headers, string $headerName): ?string + { + if (! $headers->has($headerName)) { + return null; + } + + try { + return $headers->get($headerName)->getBodyAsString(); + } catch (\Exception $e) { + Log::warning("Failed to extract header {$headerName}: ".$e->getMessage()); + + return null; + } + } + + /** + * Extract the email body from the message. + */ + private function extractEmailBody(\Symfony\Component\Mime\Email $message): string + { + if (method_exists($message, 'getHtmlBody')) { + return $message->getHtmlBody() ?? ''; + } + + if (method_exists($message, 'getTextBody')) { + return $message->getTextBody() ?? ''; + } + + return ''; + } + + /** + * Collect all headers from the message. + */ + private function collectAllHeaders(\Symfony\Component\Mime\Header\Headers $headers): array + { + $allHeaders = []; + + foreach ($headers->all() as $name => $header) { + $allHeaders[$name] = $header->getBodyAsString(); + } + + return $allHeaders; + } +} diff --git a/src/Mail/SendEmailToUser.php b/src/Mail/SendEmailToUser.php index 814c465..8949384 100644 --- a/src/Mail/SendEmailToUser.php +++ b/src/Mail/SendEmailToUser.php @@ -3,6 +3,7 @@ namespace Eclipse\Core\Mail; use Eclipse\Core\Models\User; +use Eclipse\Core\Services\Registry; use Filament\Notifications\Notification; use HTMLPurifier; use HTMLPurifier_Config; @@ -27,26 +28,27 @@ public function __construct( public string $emailMessage, public ?string $ccEmails = null, public ?string $bccEmails = null, - public ?User $sender = null + public ?User $sender = null, + public ?int $siteId = null ) { $this->emailMessage = $this->purifyHtml($this->emailMessage); + $this->siteId = $this->siteId ?? Registry::getSite()?->id; } /** - * Purify HTML content to prevent XSS attacks and clean up malicious code. + * Purify the HTML content. */ protected function purifyHtml(string $html): string { $config = HTMLPurifier_Config::createDefault(); $config->set('HTML.Trusted', true); $config->set('Core.Encoding', 'UTF-8'); - $purifier = new HTMLPurifier($config); - return $purifier->purify($html); + return (new HTMLPurifier($config))->purify($html); } /** - * Get the message envelope. + * Get the envelope for the email. */ public function envelope(): Envelope { @@ -55,43 +57,49 @@ public function envelope(): Envelope to: [$this->recipient->email] ); - if ($this->sender && $this->sender->email) { + if ($this->sender?->email) { $envelope = $envelope->replyTo($this->sender->email, $this->sender->name); } - if ($this->ccEmails) { - $ccEmailsArray = array_filter(array_map('trim', explode(',', $this->ccEmails))); - if (! empty($ccEmailsArray)) { - $envelope = $envelope->cc($ccEmailsArray); - } + if ($ccEmails = $this->parseEmailList($this->ccEmails)) { + $envelope = $envelope->cc($ccEmails); } - if ($this->bccEmails) { - $bccEmailsArray = array_filter(array_map('trim', explode(',', $this->bccEmails))); - if (! empty($bccEmailsArray)) { - $envelope = $envelope->bcc($bccEmailsArray); - } + if ($bccEmails = $this->parseEmailList($this->bccEmails)) { + $envelope = $envelope->bcc($bccEmails); } return $envelope; } /** - * Get the message headers. + * Parse the email list. + */ + protected function parseEmailList(?string $emails): array + { + if (! $emails) { + return []; + } + + return array_filter(array_map('trim', explode(',', $emails))); + } + + /** + * Get the headers for the email. */ public function headers(): Headers { - return new Headers( - text: [ - 'X-Eclipse-Email-Type' => 'SendEmailToUser', - 'X-Eclipse-Sender-ID' => $this->sender?->id ?? '', - 'X-Eclipse-Recipient-Email' => $this->recipient->email, - ] - ); + return new Headers(text: [ + 'X-Eclipse-Email-Type' => 'SendEmailToUser', + 'X-Eclipse-Sender-ID' => (string) ($this->sender?->id ?? ''), + 'X-Eclipse-Recipient-ID' => (string) $this->recipient->id, + 'X-Eclipse-Recipient-Email' => $this->recipient->email, + 'X-Eclipse-Site-ID' => (string) ($this->siteId ?? ''), + ]); } /** - * Get the message content definition. + * Get the content for the email. */ public function content(): Content { @@ -107,9 +115,7 @@ public function content(): Content } /** - * Get the attachments for the message. - * - * @return array + * Get the attachments for the email. */ public function attachments(): array { @@ -117,19 +123,19 @@ public function attachments(): array } /** - * Handle a job failure. + * Handle the failed event. */ public function failed(\Throwable $exception): void { - if ($this->sender) { - Notification::make() - ->title(__('eclipse::email.error')) - ->body(__('eclipse::email.send_error_message', [ - 'error' => $exception->getMessage(), - ])) - ->danger() - ->sendToDatabase($this->sender) - ->broadcast([$this->sender]); + if (! $this->sender) { + return; } + + Notification::make() + ->title(__('eclipse::email.error')) + ->body(__('eclipse::email.send_error_message', ['error' => $exception->getMessage()])) + ->danger() + ->sendToDatabase($this->sender) + ->broadcast([$this->sender]); } } diff --git a/src/Models/MailLog.php b/src/Models/MailLog.php new file mode 100644 index 0000000..4f85386 --- /dev/null +++ b/src/Models/MailLog.php @@ -0,0 +1,76 @@ + 'array', + 'attachments' => 'array', + 'data' => 'array', + 'sent_at' => 'datetime', + 'opened' => 'datetime', + 'delivered' => 'datetime', + 'complaint' => 'datetime', + 'bounced' => 'datetime', + ]; + + /** + * Get the site that the mail log belongs to. + */ + public function site(): BelongsTo + { + return $this->belongsTo(Site::class); + } + + /** + * Get the sender that the mail log belongs to. + */ + public function sender(): BelongsTo + { + return $this->belongsTo(User::class, 'sender_id'); + } + + /** + * Get the recipient that the mail log belongs to. + */ + public function recipient(): BelongsTo + { + return $this->belongsTo(User::class, 'recipient_id'); + } +} diff --git a/src/Models/Site.php b/src/Models/Site.php index 98a2b23..83d5dd6 100644 --- a/src/Models/Site.php +++ b/src/Models/Site.php @@ -44,4 +44,10 @@ public function roles(): HasMany { return $this->hasMany(Role::class); } + + /** @return HasMany */ + public function mailLogs(): HasMany + { + return $this->hasMany(MailLog::class); + } } From 394130a38a7c07f236de412a64930136b7c13a69 Mon Sep 17 00:00:00 2001 From: Kilian Trunk Date: Fri, 25 Jul 2025 23:13:21 +0200 Subject: [PATCH 06/12] feat(workflows): fix ref --- .github/workflows/linter.yml | 2 +- .github/workflows/test-runner.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/linter.yml b/.github/workflows/linter.yml index a548779..737b3a5 100644 --- a/.github/workflows/linter.yml +++ b/.github/workflows/linter.yml @@ -22,7 +22,7 @@ jobs: - name: Checkout code uses: actions/checkout@v4 with: - ref: ${{ github.head_ref }} + ref: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.sha || github.sha }} - name: Run Laravel Pint uses: aglipanci/laravel-pint-action@latest diff --git a/.github/workflows/test-runner.yml b/.github/workflows/test-runner.yml index b430b07..b78f75f 100644 --- a/.github/workflows/test-runner.yml +++ b/.github/workflows/test-runner.yml @@ -41,7 +41,7 @@ jobs: - name: Checkout code uses: actions/checkout@v4 with: - ref: ${{ github.head_ref }} + ref: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.sha || github.sha }} - name: Validate composer.json and composer.lock run: composer validate --strict From a33cfd87e972366ee0dd585ca7d91d10eb4beb49 Mon Sep 17 00:00:00 2001 From: Kilian Trunk Date: Fri, 25 Jul 2025 23:28:06 +0200 Subject: [PATCH 07/12] chore(emails): add MailLogResource test --- database/factories/MailLogFactory.php | 87 ++++++++++++++++ src/Models/MailLog.php | 12 +++ .../Resources/MailLogResourceTest.php | 98 +++++++++++++++++++ 3 files changed, 197 insertions(+) create mode 100644 database/factories/MailLogFactory.php create mode 100644 tests/Feature/Filament/Resources/MailLogResourceTest.php diff --git a/database/factories/MailLogFactory.php b/database/factories/MailLogFactory.php new file mode 100644 index 0000000..b379e04 --- /dev/null +++ b/database/factories/MailLogFactory.php @@ -0,0 +1,87 @@ + + */ +class MailLogFactory extends Factory +{ + /** + * The name of the factory's corresponding model. + * + * @var class-string<\Illuminate\Database\Eloquent\Model> + */ + protected $model = MailLog::class; + + /** + * Define the model's default state. + * + * @return array + */ + public function definition(): array + { + return [ + 'site_id' => Site::inRandomOrder()->first()?->id ?? Site::factory()->create()->id, + 'message_id' => fake()->uuid(), + 'from' => fake()->email(), + 'to' => fake()->email(), + 'cc' => null, + 'bcc' => null, + 'subject' => fake()->sentence(), + 'body' => '

'.fake()->paragraph().'

', + 'headers' => [ + 'Content-Type' => 'text/html; charset=UTF-8', + 'X-Mailer' => 'Laravel', + ], + 'attachments' => [], + 'sender_id' => User::inRandomOrder()->first()?->id ?? User::factory()->create()->id, + 'recipient_id' => null, + 'status' => fake()->randomElement(['sent', 'sending', 'failed']), + 'sent_at' => fake()->dateTimeBetween('-1 month', 'now'), + 'data' => [], + 'opened' => null, + 'delivered' => null, + 'complaint' => null, + 'bounced' => null, + ]; + } + + /** + * Indicate that the mail log is sent. + */ + public function sent(): static + { + return $this->state(fn (array $attributes) => [ + 'status' => 'sent', + 'sent_at' => now(), + ]); + } + + /** + * Indicate that the mail log is sending. + */ + public function sending(): static + { + return $this->state(fn (array $attributes) => [ + 'status' => 'sending', + 'sent_at' => null, + ]); + } + + /** + * Indicate that the mail log failed. + */ + public function failed(): static + { + return $this->state(fn (array $attributes) => [ + 'status' => 'failed', + 'sent_at' => null, + ]); + } +} diff --git a/src/Models/MailLog.php b/src/Models/MailLog.php index 4f85386..22a6090 100644 --- a/src/Models/MailLog.php +++ b/src/Models/MailLog.php @@ -2,11 +2,15 @@ namespace Eclipse\Core\Models; +use Eclipse\Core\Database\Factories\MailLogFactory; +use Illuminate\Database\Eloquent\Factories\HasFactory; use Illuminate\Database\Eloquent\Model; use Illuminate\Database\Eloquent\Relations\BelongsTo; class MailLog extends Model { + use HasFactory; + /** * The attributes that are mass assignable. * @@ -73,4 +77,12 @@ public function recipient(): BelongsTo { return $this->belongsTo(User::class, 'recipient_id'); } + + /** + * Get the factory for the model. + */ + protected static function newFactory() + { + return MailLogFactory::new(); + } } diff --git a/tests/Feature/Filament/Resources/MailLogResourceTest.php b/tests/Feature/Filament/Resources/MailLogResourceTest.php new file mode 100644 index 0000000..0b14540 --- /dev/null +++ b/tests/Feature/Filament/Resources/MailLogResourceTest.php @@ -0,0 +1,98 @@ +set_up_super_admin_and_tenant(); +}); + +test('authorized access can be allowed', function () { + $this->get(MailLogResource::getUrl()) + ->assertOk(); +}); + +test('mail logs table page can be rendered', function () { + livewire(ListMailLogs::class)->assertSuccessful(); +}); + +test('mail logs can be searched', function () { + // Create 5 mail logs + MailLog::factory()->count(5)->create(); + + // Get first mail log + $mailLog = MailLog::first(); + + // Get second mail log + $mailLog2 = MailLog::skip(1)->first(); + + livewire(ListMailLogs::class) + ->searchTable($mailLog->subject) + ->assertSee($mailLog->subject); +}); + +test('mail logs can be filtered by status', function () { + // Create mail logs with different statuses + MailLog::factory()->create(['status' => 'sent']); + MailLog::factory()->create(['status' => 'failed']); + MailLog::factory()->create(['status' => 'sending']); + + $component = livewire(ListMailLogs::class); + + // Filter by sent status + $component->filterTable('status', 'sent') + ->assertSee('sent'); +}); + +test('mail log can be viewed', function () { + $mailLog = MailLog::factory()->create([ + 'from' => 'test@example.com', + 'to' => 'recipient@example.com', + 'subject' => 'Test Email', + 'body' => '

Test email body

', + 'status' => 'sent', + ]); + + livewire(ListMailLogs::class) + ->assertSuccessful() + ->assertTableActionExists(ViewAction::class) + ->assertTableActionEnabled(ViewAction::class, $mailLog) + ->callTableAction(ViewAction::class, $mailLog) + ->assertSee($mailLog->subject) + ->assertSee($mailLog->from) + ->assertSee($mailLog->to); +}); + +test('mail logs table shows correct columns', function () { + $mailLog = MailLog::factory()->create([ + 'sent_at' => now(), + 'from' => 'sender@example.com', + 'to' => 'recipient@example.com', + 'subject' => 'Test Subject', + 'status' => 'sent', + ]); + + livewire(ListMailLogs::class) + ->assertSee($mailLog->from) + ->assertSee($mailLog->to) + ->assertSee($mailLog->subject) + ->assertSee($mailLog->status); +}); + +test('mail logs are sorted by sent_at desc by default', function () { + $oldMailLog = MailLog::factory()->create(['sent_at' => now()->subDays(1)]); + $newMailLog = MailLog::factory()->create(['sent_at' => now()]); + + livewire(ListMailLogs::class) + ->assertSeeInOrder([$newMailLog->subject, $oldMailLog->subject]); +}); + +test('mail logs table shows empty state when no records', function () { + livewire(ListMailLogs::class) + ->assertSuccessful() + ->assertSee('No emails found'); +}); From 3e350f58c055aaa845e60be063ab073571565810 Mon Sep 17 00:00:00 2001 From: Kilian Trunk Date: Sat, 26 Jul 2025 00:21:27 +0200 Subject: [PATCH 08/12] chore(emails): add LogEmailToDatabase test --- .../Unit/Listeners/LogEmailToDatabaseTest.php | 95 +++++++++++++++++++ 1 file changed, 95 insertions(+) create mode 100644 tests/Unit/Listeners/LogEmailToDatabaseTest.php diff --git a/tests/Unit/Listeners/LogEmailToDatabaseTest.php b/tests/Unit/Listeners/LogEmailToDatabaseTest.php new file mode 100644 index 0000000..df6f89f --- /dev/null +++ b/tests/Unit/Listeners/LogEmailToDatabaseTest.php @@ -0,0 +1,95 @@ +subject('Hello World') + ->text('Plain text body') + ->html('

HTML body

') + ->from('from@example.com') + ->to('to@example.com') + ->cc('cc@example.com') + ->bcc('bcc@example.com'); + + $headers = $email->getHeaders(); + + // Add Message-ID header manually + $headers->add(new IdentificationHeader('Message-ID', 'test-123@example.com')); + + // Add custom application headers + $headers->addTextHeader('X-Eclipse-Site-ID', '123'); + $headers->addTextHeader('X-Eclipse-Sender-ID', '456'); + $headers->addTextHeader('X-Eclipse-Recipient-ID', '789'); + + // Create a mock SentMessage that wraps the Email + $sentMessage = Mockery::mock(LaravelSentMessage::class); + $sentMessage->shouldReceive('getOriginalMessage')->andReturn($email); + + // Invoke the listener with the MessageSent event + (new LogEmailToDatabase())->handle(new MessageSent($sentMessage, [])); + + $log = MailLog::first(); + + expect(MailLog::count())->toBe(1) + ->and($log->message_id)->toBe('') + ->and($log->site_id)->toBe(123) + ->and($log->sender_id)->toBe(456) + ->and($log->recipient_id)->toBe(789) + ->and($log->from)->toBe('from@example.com') + ->and($log->to)->toBe('to@example.com') + ->and($log->cc)->toBe('cc@example.com') + ->and($log->bcc)->toBe('bcc@example.com') + ->and($log->subject)->toBe('Hello World') + ->and($log->body)->toBe('

HTML body

') + ->and(is_array($log->headers))->toBeTrue() + ->and($log->status)->toBe('sent'); + + expect($log->sent_at)->not()->toBeNull(); +}); + + +test('it handles missing headers gracefully and still logs minimum fields', function () { + // Create Email with only required From/To + $email = (new Email()) + ->subject('No Headers') + ->html('

Body only

') + ->from('foo@example.com') + ->to('bar@example.com'); + + // No custom headers added + + $sentMessage = Mockery::mock(LaravelSentMessage::class); + $sentMessage->shouldReceive('getOriginalMessage')->andReturn($email); + + (new LogEmailToDatabase())->handle(new MessageSent($sentMessage, [])); + + $log = MailLog::first(); + + expect(MailLog::count())->toBe(1) + ->and($log->message_id)->toBeNull() + ->and($log->site_id)->toBeNull() + ->and($log->sender_id)->toBeNull() + ->and($log->recipient_id)->toBeNull() + ->and($log->from)->toBe('foo@example.com') + ->and($log->to)->toBe('bar@example.com') + ->and($log->cc)->toBeNull() + ->and($log->bcc)->toBeNull() + ->and($log->subject)->toBe('No Headers') + ->and($log->body)->toBe('

Body only

') + ->and(is_array($log->headers))->toBeTrue() + ->and($log->status)->toBe('sent'); + + expect($log->sent_at)->not()->toBeNull(); +}); From 4999721a2a8221607049a54cf2c0b5e03cb5fef0 Mon Sep 17 00:00:00 2001 From: Kilian Trunk Date: Sat, 26 Jul 2025 00:22:26 +0200 Subject: [PATCH 09/12] chore(emails): format test --- tests/Unit/Listeners/LogEmailToDatabaseTest.php | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/tests/Unit/Listeners/LogEmailToDatabaseTest.php b/tests/Unit/Listeners/LogEmailToDatabaseTest.php index df6f89f..06b0bc3 100644 --- a/tests/Unit/Listeners/LogEmailToDatabaseTest.php +++ b/tests/Unit/Listeners/LogEmailToDatabaseTest.php @@ -2,19 +2,19 @@ namespace Tests\Unit\Listeners; -use Illuminate\Mail\Events\MessageSent; -use Illuminate\Mail\SentMessage as LaravelSentMessage; use Eclipse\Core\Listeners\LogEmailToDatabase; use Eclipse\Core\Models\MailLog; +use Illuminate\Mail\Events\MessageSent; +use Illuminate\Mail\SentMessage as LaravelSentMessage; +use Mockery; use Symfony\Component\Mime\Email; use Symfony\Component\Mime\Header\IdentificationHeader; -use Mockery; // Tests for the LogEmailToDatabase listener test('it logs email to database when MessageSent event is handled', function () { // Create a Symfony Email instance with body and recipients - $email = (new Email()) + $email = (new Email) ->subject('Hello World') ->text('Plain text body') ->html('

HTML body

') @@ -38,7 +38,7 @@ $sentMessage->shouldReceive('getOriginalMessage')->andReturn($email); // Invoke the listener with the MessageSent event - (new LogEmailToDatabase())->handle(new MessageSent($sentMessage, [])); + (new LogEmailToDatabase)->handle(new MessageSent($sentMessage, [])); $log = MailLog::first(); @@ -59,10 +59,9 @@ expect($log->sent_at)->not()->toBeNull(); }); - test('it handles missing headers gracefully and still logs minimum fields', function () { // Create Email with only required From/To - $email = (new Email()) + $email = (new Email) ->subject('No Headers') ->html('

Body only

') ->from('foo@example.com') @@ -73,7 +72,7 @@ $sentMessage = Mockery::mock(LaravelSentMessage::class); $sentMessage->shouldReceive('getOriginalMessage')->andReturn($email); - (new LogEmailToDatabase())->handle(new MessageSent($sentMessage, [])); + (new LogEmailToDatabase)->handle(new MessageSent($sentMessage, [])); $log = MailLog::first(); From 3dc78cc61e657d5da76d05232c498af55226180c Mon Sep 17 00:00:00 2001 From: Kilian Trunk Date: Sat, 26 Jul 2025 00:31:58 +0200 Subject: [PATCH 10/12] chore(emails): improve MailLogResource test --- .../Resources/MailLogResourceTest.php | 27 +++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/tests/Feature/Filament/Resources/MailLogResourceTest.php b/tests/Feature/Filament/Resources/MailLogResourceTest.php index 0b14540..c5f6520 100644 --- a/tests/Feature/Filament/Resources/MailLogResourceTest.php +++ b/tests/Feature/Filament/Resources/MailLogResourceTest.php @@ -96,3 +96,30 @@ ->assertSuccessful() ->assertSee('No emails found'); }); + +test('mail log view action shows headers in modal', function () { + $mailLog = MailLog::factory()->create([ + 'headers' => [ + 'From' => 'sender@example.com', + 'To' => 'recipient@example.com', + 'Subject' => 'Test Subject', + ], + ]); + + livewire(ListMailLogs::class) + ->callTableAction(ViewAction::class, $mailLog) + ->assertSee('From') + ->assertSee('To') + ->assertSee('Subject'); +}); + +test('mail log view action modal has correct heading', function () { + $mailLog = MailLog::factory()->create([ + 'subject' => 'Test Email Subject', + ]); + + livewire(ListMailLogs::class) + ->callTableAction(ViewAction::class, $mailLog) + ->assertSee(__('eclipse::email.view_email')) + ->assertSee('Test Email Subject'); +}); From ae047cc98f1652e4de4066d959130744e220f3b7 Mon Sep 17 00:00:00 2001 From: Kilian Trunk Date: Tue, 29 Jul 2025 15:46:38 +0200 Subject: [PATCH 11/12] chore(emails): increase test coverage, ui fixes --- src/Filament/Resources/MailLogResource.php | 79 ++++++++++++++++++- .../MailLogResource/Pages/ListMailLogs.php | 3 + src/Models/Site.php | 6 -- .../Resources/MailLogResourceTest.php | 8 ++ 4 files changed, 88 insertions(+), 8 deletions(-) diff --git a/src/Filament/Resources/MailLogResource.php b/src/Filament/Resources/MailLogResource.php index a91843f..1ebf7b7 100644 --- a/src/Filament/Resources/MailLogResource.php +++ b/src/Filament/Resources/MailLogResource.php @@ -18,9 +18,9 @@ class MailLogResource extends Resource protected static ?string $navigationIcon = 'heroicon-o-envelope'; - protected static ?string $navigationGroup = 'Communication'; + protected static ?string $navigationGroup = 'Tools'; - protected static ?int $navigationSort = 10; + protected static ?int $navigationSort = 2; public static function getNavigationLabel(): string { @@ -91,6 +91,17 @@ public static function table(Table $table): Table { return $table ->columns([ + Tables\Columns\TextColumn::make('id') + ->label('ID') + ->sortable() + ->toggleable(isToggledHiddenByDefault: true), + + Tables\Columns\TextColumn::make('message_id') + ->label(__('eclipse::email.message_id')) + ->limit(20) + ->tooltip(fn (MailLog $record): ?string => $record->message_id) + ->toggleable(isToggledHiddenByDefault: true), + Tables\Columns\TextColumn::make('sent_at') ->label(__('eclipse::email.sent_at')) ->dateTime() @@ -106,6 +117,18 @@ public static function table(Table $table): Table ->limit(30) ->tooltip(fn (MailLog $record): ?string => $record->to), + Tables\Columns\TextColumn::make('cc') + ->label(__('eclipse::email.cc')) + ->limit(30) + ->tooltip(fn (MailLog $record): ?string => $record->cc) + ->toggleable(isToggledHiddenByDefault: true), + + Tables\Columns\TextColumn::make('bcc') + ->label(__('eclipse::email.bcc')) + ->limit(30) + ->tooltip(fn (MailLog $record): ?string => $record->bcc) + ->toggleable(isToggledHiddenByDefault: true), + Tables\Columns\TextColumn::make('subject') ->label(__('eclipse::email.subject')) ->limit(50) @@ -120,6 +143,58 @@ public static function table(Table $table): Table 'failed' => 'danger', default => 'gray', }), + + Tables\Columns\TextColumn::make('sender.name') + ->label('Sender') + ->toggleable(isToggledHiddenByDefault: true), + + Tables\Columns\TextColumn::make('recipient.name') + ->label('Recipient') + ->toggleable(isToggledHiddenByDefault: true), + + Tables\Columns\IconColumn::make('opened') + ->label('Opened') + ->boolean() + ->trueIcon('heroicon-o-eye') + ->falseIcon('heroicon-o-eye-slash') + ->toggleable(isToggledHiddenByDefault: true), + + Tables\Columns\IconColumn::make('delivered') + ->label('Delivered') + ->boolean() + ->trueIcon('heroicon-o-check-circle') + ->falseIcon('heroicon-o-x-circle') + ->toggleable(isToggledHiddenByDefault: true), + + Tables\Columns\IconColumn::make('complaint') + ->label('Complaint') + ->boolean() + ->trueIcon('heroicon-o-exclamation-triangle') + ->falseIcon('heroicon-o-check') + ->toggleable(isToggledHiddenByDefault: true), + + Tables\Columns\IconColumn::make('bounced') + ->label('Bounced') + ->boolean() + ->trueIcon('heroicon-o-arrow-uturn-left') + ->falseIcon('heroicon-o-check') + ->toggleable(isToggledHiddenByDefault: true), + + Tables\Columns\TextColumn::make('site.name') + ->label('Site') + ->toggleable(isToggledHiddenByDefault: true), + + Tables\Columns\TextColumn::make('created_at') + ->label('Created At') + ->dateTime() + ->sortable() + ->toggleable(isToggledHiddenByDefault: true), + + Tables\Columns\TextColumn::make('updated_at') + ->label('Updated At') + ->dateTime() + ->sortable() + ->toggleable(isToggledHiddenByDefault: true), ]) ->filters([ Tables\Filters\SelectFilter::make('status') diff --git a/src/Filament/Resources/MailLogResource/Pages/ListMailLogs.php b/src/Filament/Resources/MailLogResource/Pages/ListMailLogs.php index 4c49e4a..f272ee9 100644 --- a/src/Filament/Resources/MailLogResource/Pages/ListMailLogs.php +++ b/src/Filament/Resources/MailLogResource/Pages/ListMailLogs.php @@ -4,11 +4,14 @@ use Eclipse\Core\Filament\Resources\MailLogResource; use Filament\Resources\Pages\ListRecords; +use Filament\Support\Enums\MaxWidth; class ListMailLogs extends ListRecords { protected static string $resource = MailLogResource::class; + protected ?string $maxContentWidth = MaxWidth::Full->value; + protected function getHeaderActions(): array { return [ diff --git a/src/Models/Site.php b/src/Models/Site.php index 83d5dd6..98a2b23 100644 --- a/src/Models/Site.php +++ b/src/Models/Site.php @@ -44,10 +44,4 @@ public function roles(): HasMany { return $this->hasMany(Role::class); } - - /** @return HasMany */ - public function mailLogs(): HasMany - { - return $this->hasMany(MailLog::class); - } } diff --git a/tests/Feature/Filament/Resources/MailLogResourceTest.php b/tests/Feature/Filament/Resources/MailLogResourceTest.php index c5f6520..31357d2 100644 --- a/tests/Feature/Filament/Resources/MailLogResourceTest.php +++ b/tests/Feature/Filament/Resources/MailLogResourceTest.php @@ -16,6 +16,14 @@ ->assertOk(); }); +test('unauthenticated users cannot access mail log index', function () { + // Clear any authenticated user + auth()->logout(); + + $this->get(MailLogResource::getUrl()) + ->assertRedirect(); // Should redirect to login +}); + test('mail logs table page can be rendered', function () { livewire(ListMailLogs::class)->assertSuccessful(); }); From e991e3b6ea246230c499cc3cfde68106bebdf15c Mon Sep 17 00:00:00 2001 From: Kilian Trunk Date: Wed, 30 Jul 2025 12:44:10 +0200 Subject: [PATCH 12/12] chore(emails): fix permissions --- src/Filament/Resources/MailLogResource.php | 11 ++++++++- src/Policies/MailLogPolicy.php | 28 ++++++++++++++++++++++ 2 files changed, 38 insertions(+), 1 deletion(-) create mode 100644 src/Policies/MailLogPolicy.php diff --git a/src/Filament/Resources/MailLogResource.php b/src/Filament/Resources/MailLogResource.php index 1ebf7b7..afafc13 100644 --- a/src/Filament/Resources/MailLogResource.php +++ b/src/Filament/Resources/MailLogResource.php @@ -2,6 +2,7 @@ namespace Eclipse\Core\Filament\Resources; +use BezhanSalleh\FilamentShield\Contracts\HasShieldPermissions; use Eclipse\Core\Models\MailLog; use Eclipse\Core\Services\Registry; use Filament\Forms; @@ -12,7 +13,7 @@ use Illuminate\Database\Eloquent\Builder; use Illuminate\Support\HtmlString; -class MailLogResource extends Resource +class MailLogResource extends Resource implements HasShieldPermissions { protected static ?string $model = MailLog::class; @@ -280,4 +281,12 @@ public static function getEloquentQuery(): Builder return $query; } + + public static function getPermissionPrefixes(): array + { + return [ + 'view_any', + 'view', + ]; + } } diff --git a/src/Policies/MailLogPolicy.php b/src/Policies/MailLogPolicy.php new file mode 100644 index 0000000..09f123e --- /dev/null +++ b/src/Policies/MailLogPolicy.php @@ -0,0 +1,28 @@ +can('view_any_mail::log'); + } + + /** + * Determine whether the user can view the model. + */ + public function view(User $user, MailLog $mailLog): bool + { + return $user->can('view_mail::log'); + } +}