Метод success

Метод success применяется к объекту MailMessage при построении почтового уведомления. Он устанавливает стиль сообщения как успешное, что влияет на цветовое оформление заголовка и основного текста в письме. Метод не принимает параметров и возвращает тот же объект для цепочки методов.

Синтаксис

<?php
	use Illuminate\Notifications\Messages\MailMessage;
	
	$message = (new MailMessage)
		->success()
		->line('...')
		->action('...', '...');
?>

Пример

Отправим уведомление об успешной оплате заказа:

<?php
	namespace App\Notifications;
	
	use Illuminate\Bus\Queueable;
	use Illuminate\Notifications\Messages\MailMessage;
	use Illuminate\Notifications\Notification;
	use App\Models\Order;
	
	class OrderPaidNotification extends Notification
	{
		use Queueable;
		
		protected $order;
		
		public function __construct(Order $order)
		{
			$this->order = $order;
		}
		
		public function via($notifiable)
		{
			return ['mail'];
		}
		
		public function toMail($notifiable)
		{
			$res = (new MailMessage)
				->success()
				->subject('Order Paid')
				->greeting('Hello!')
				->line('Your order #' . $this->order->id . ' has been paid.')
				->line('Thank you for your purchase!')
				->action('View Order', url('/orders/' . $this->order->id));
			
			return $res;
		}
	}
?>

После вызова success письмо получит зелёное оформление, сигнализирующее об успехе.

Пример

Используем метод в уведомлении о подтверждении регистрации:

<?php
	namespace App\Notifications;
	
	use Illuminate\Bus\Queueable;
	use Illuminate\Notifications\Messages\MailMessage;
	use Illuminate\Notifications\Notification;
	use App\Models\User;
	
	class WelcomeNotification extends Notification
	{
		use Queueable;
		
		protected $user;
		
		public function __construct(User $user)
		{
			$this->user = $user;
		}
		
		public function via($notifiable)
		{
			return ['mail'];
		}
		
		public function toMail($notifiable)
		{
			$res = (new MailMessage)
				->success()
				->subject('Welcome to our site')
				->line('Your account has been successfully created.')
				->line('Email: ' . $this->user->email)
				->action('Go to Dashboard', url('/dashboard'));
			
			return $res;
		}
	}
?>

Результат выполнения кода:

"Email message with success status and green styling"

Пример

Отправим уведомление об успешном сбросе пароля:

<?php
	namespace App\Notifications;
	
	use Illuminate\Bus\Queueable;
	use Illuminate\Notifications\Messages\MailMessage;
	use Illuminate\Notifications\Notification;
	
	class PasswordResetSuccessNotification extends Notification
	{
		use Queueable;
		
		public function via($notifiable)
		{
			return ['mail'];
		}
		
		public function toMail($notifiable)
		{
			$res = (new MailMessage)
				->success()
				->subject('Password Reset Successful')
				->line('Your password has been reset successfully.')
				->line('If you did not request this, please contact support.')
				->action('Login', url('/login'));
			
			return $res;
		}
	}
?>

В результате будет отправлено письмо с зелёным заголовком и успешным стилем оформления.

Смотрите также

класс MailMessage,
который используется для построения почтовых уведомлений
метод error,
который устанавливает стиль ошибки для письма
метод greeting,
который устанавливает приветствие в письме
метод action,
который добавляет кнопку с ссылкой в письмо