Deliver notifications in email

Hello,

I am wondering if there is any way to extend the Filament Notification class to be able to send notifications in email in a way that is similar to

->toBroadcast($user)

->toBroadcast($user)

that is like

->toEmail($user)

->toEmail($user)

. It doesn't need to be the most perfect email but my code is mostly based around Filament notifications so something simple to implement across the whole app is required.

Solution

<?php

namespace App\Notifications;

use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Notifications\Messages\MailMessage;
use Illuminate\Notifications\Notification;

class FilamentNotificationEmail extends Notification
{
    use Queueable;

    protected \Filament\Notifications\Notification $filament_notification;

    /**
     * Create a new notification instance.
     */
    public function __construct(\Filament\Notifications\Notification $filament_notification)
    {
        $this->filament_notification = $filament_notification;
    }

    /**
     * Get the notification's delivery channels.
     *
     * @return array<int, string>
     */
    public function via(object $notifiable): array
    {
        return ['mail'];
    }

    /**
     * Get the mail representation of the notification.
     */
    public function toMail(object $notifiable): MailMessage
    {

        $action = $this->filament_notification->getActions();
        $action = $action[0] ?? null;

        return (new MailMessage)
                    ->subject($this->filament_notification->getTitle())
                    ->greeting('Hello ' . $notifiable->name . ',')
                    ->line($this->filament_notification->getBody())
                    ->action($action ? $action->getLabel() : "Visit App", $action ? $action->getUrl() : env("APP_URL"));
    }

    /**
     * Get the array representation of the notification.
     *
     * @return array<string, mixed>
     */
    public function toArray(object $notifiable): array
    {
        return [
            //
        ];
    }
}

<?php

namespace App\Notifications;

use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Notifications\Messages\MailMessage;
use Illuminate\Notifications\Notification;

class FilamentNotificationEmail extends Notification
{
    use Queueable;

    protected \Filament\Notifications\Notification $filament_notification;

    /**
     * Create a new notification instance.
     */
    public function __construct(\Filament\Notifications\Notification $filament_notification)
    {
        $this->filament_notification = $filament_notification;
    }

    /**
     * Get the notification's delivery channels.
     *
     * @return array<int, string>
     */
    public function via(object $notifiable): array
    {
        return ['mail'];
    }

    /**
     * Get the mail representation of the notification.
     */
    public function toMail(object $notifiable): MailMessage
    {

        $action = $this->filament_notification->getActions();
        $action = $action[0] ?? null;

        return (new MailMessage)
                    ->subject($this->filament_notification->getTitle())
                    ->greeting('Hello ' . $notifiable->name . ',')
                    ->line($this->filament_notification->getBody())
                    ->action($action ? $action->getLabel() : "Visit App", $action ? $action->getUrl() : env("APP_URL"));
    }

    /**
     * Get the array representation of the notification.
     *
     * @return array<string, mixed>
     */
    public function toArray(object $notifiable): array
    {
        return [
            //
        ];
    }
}

Jump to solution

Dennis Koch•8/16/24, 12:59 PM

Look at implementation of or . It's quite simple. You could extend and add , then add a generic that takes that data and sends mails.

Yiğit KeremOP•8/16/24, 1:04 PM

Do I just create a new class than extends Filament\Notification?

Yiğit KeremOP•8/16/24, 1:05 PM

or does it need to be a plugin?

Dennis Koch•8/16/24, 1:11 PM

No need to be a plugin. Just a normal class using PHP. And instead of using the Filament class use your new class then

Yiğit KeremOP•8/16/24, 1:12 PM

Thank you so much! Is it okay if I keep this discussion open while I try to implement it for any issues that may arise or should I reopen if any help is required?

Dennis Koch•8/16/24, 1:14 PM

Keep it open and come back if you need further assistance.

Yiğit KeremOP•8/16/24, 4:47 PM

Hey, is there any way to accomplish this without having to change the namespaces? (Adding the modifier to the original Filament class) Not sure if that is possible in terms of how php itself works, obviously

Dennis Koch•8/16/24, 5:08 PM

Laravel has a Macro feature that is used by the Notification class. So you can define your own method. Check this article:
https://levelup.gitconnected.com/understanding-laravel-macros-e2f493484a38

Medium

Understanding Laravel Macros

Laravel macros allow us to add custom functionality to Laravel core components or classes. In other words, they allow us to extend Laravel…

Yiğit KeremOP•8/16/24, 5:16 PM

Thank you so much!

Solution

Yiğit Kerem•8/16/24, 5:35 PM

<?php

namespace App\Notifications;

use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Notifications\Messages\MailMessage;
use Illuminate\Notifications\Notification;

class FilamentNotificationEmail extends Notification
{
    use Queueable;

    protected \Filament\Notifications\Notification $filament_notification;

    /**
     * Create a new notification instance.
     */
    public function __construct(\Filament\Notifications\Notification $filament_notification)
    {
        $this->filament_notification = $filament_notification;
    }

    /**
     * Get the notification's delivery channels.
     *
     * @return array<int, string>
     */
    public function via(object $notifiable): array
    {
        return ['mail'];
    }

    /**
     * Get the mail representation of the notification.
     */
    public function toMail(object $notifiable): MailMessage
    {

        $action = $this->filament_notification->getActions();
        $action = $action[0] ?? null;

        return (new MailMessage)
                    ->subject($this->filament_notification->getTitle())
                    ->greeting('Hello ' . $notifiable->name . ',')
                    ->line($this->filament_notification->getBody())
                    ->action($action ? $action->getLabel() : "Visit App", $action ? $action->getUrl() : env("APP_URL"));
    }

    /**
     * Get the array representation of the notification.
     *
     * @return array<string, mixed>
     */
    public function toArray(object $notifiable): array
    {
        return [
            //
        ];
    }
}

<?php

namespace App\Notifications;

use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Notifications\Messages\MailMessage;
use Illuminate\Notifications\Notification;

class FilamentNotificationEmail extends Notification
{
    use Queueable;

    protected \Filament\Notifications\Notification $filament_notification;

    /**
     * Create a new notification instance.
     */
    public function __construct(\Filament\Notifications\Notification $filament_notification)
    {
        $this->filament_notification = $filament_notification;
    }

    /**
     * Get the notification's delivery channels.
     *
     * @return array<int, string>
     */
    public function via(object $notifiable): array
    {
        return ['mail'];
    }

    /**
     * Get the mail representation of the notification.
     */
    public function toMail(object $notifiable): MailMessage
    {

        $action = $this->filament_notification->getActions();
        $action = $action[0] ?? null;

        return (new MailMessage)
                    ->subject($this->filament_notification->getTitle())
                    ->greeting('Hello ' . $notifiable->name . ',')
                    ->line($this->filament_notification->getBody())
                    ->action($action ? $action->getLabel() : "Visit App", $action ? $action->getUrl() : env("APP_URL"));
    }

    /**
     * Get the array representation of the notification.
     *
     * @return array<string, mixed>
     */
    public function toArray(object $notifiable): array
    {
        return [
            //
        ];
    }
}

Yiğit KeremOP•8/16/24, 5:36 PM

Yiğit KeremOP•8/16/24, 5:37 PM

This is how I solved it for future reference for anybody who needs it. I'm not sure if it is the cleanest way of doing things but I would however believe such a simple addition to the upstream could be helpful in many cases. Is there any reason it is neglected?

YYiğit Kerem This is how I solved it for future reference for anybody who needs it. I'm not s...

Dennis Koch•8/16/24, 5:39 PM

Thanks for sharing.

Is there any reason it is neglected?

I just think it's not that common. Filament Notifications are mostly meant to be inside Filament

Yiğit KeremOP•8/16/24, 6:24 PM

Thank you for the awesome project and the help. Take care!