MailChannel
in package
Table of Contents
Properties
Methods
- __construct() : void
- Create a new mail channel instance.
- send() : void
- Send the given notification.
- addAttachments() : void
- Add the attachments to the message.
- additionalMessageData() : array<string, mixed>
- Get additional meta-data to pass along with the view data.
- addressMessage() : void
- Address the mail message.
- addSender() : void
- Add the "from" and "reply to" addresses to the message.
- buildMessage() : void
- Build the mail message.
- buildView() : string|array<string|int, mixed>
- Build the notification's view.
- getRecipients() : mixed
- Get the recipients of the given message.
- messageBuilder() : Closure
- Get the mailer Closure for the message.
- runCallbacks() : MailChannel
- Run the callbacks for the message.
Properties
$mailer
The mailer implementation.
protected
Factory
$mailer
$markdown
The markdown implementation.
protected
Markdown
$markdown
Methods
__construct()
Create a new mail channel instance.
public
__construct(Factory $mailer, Markdown $markdown) : void
Parameters
- $mailer : Factory
- $markdown : Markdown
send()
Send the given notification.
public
send( $notifiable, $notification) : void
Parameters
addAttachments()
Add the attachments to the message.
protected
addAttachments(Message $mailMessage, MailMessage $message) : void
Parameters
- $mailMessage : Message
- $message : MailMessage
additionalMessageData()
Get additional meta-data to pass along with the view data.
protected
additionalMessageData(Notification $notification) : array<string, mixed>
Parameters
- $notification : Notification
Return values
array<string, mixed>addressMessage()
Address the mail message.
protected
addressMessage(Message $mailMessage, IsNotifiable $notifiable, Notification $notification, MailMessage $message) : void
Parameters
- $mailMessage : Message
- $notifiable : IsNotifiable
- $notification : Notification
- $message : MailMessage
addSender()
Add the "from" and "reply to" addresses to the message.
protected
addSender(Message $mailMessage, MailMessage $message) : void
Parameters
- $mailMessage : Message
- $message : MailMessage
buildMessage()
Build the mail message.
protected
buildMessage(Message $mailMessage, IsNotifiable $notifiable, Notification $notification, MailMessage $message) : void
Parameters
- $mailMessage : Message
- $notifiable : IsNotifiable
- $notification : Notification
- $message : MailMessage
buildView()
Build the notification's view.
protected
buildView(MailMessage $message) : string|array<string|int, mixed>
Parameters
- $message : MailMessage
Return values
string|array<string|int, mixed>getRecipients()
Get the recipients of the given message.
protected
getRecipients(IsNotifiable $notifiable, Notification $notification) : mixed
Parameters
- $notifiable : IsNotifiable
- $notification : Notification
messageBuilder()
Get the mailer Closure for the message.
protected
messageBuilder(IsNotifiable $notifiable, Notification $notification, MailMessage $message) : Closure
Parameters
- $notifiable : IsNotifiable
- $notification : Notification
- $message : MailMessage
Return values
ClosurerunCallbacks()
Run the callbacks for the message.
protected
runCallbacks(Message $mailMessage, MailMessage $message) : MailChannel
Parameters
- $mailMessage : Message
- $message : MailMessage