Mailer
Mailer class for sending mail.

 class Winter\Storm\Mail\Mailer
extends Illuminate\Mail\Mailer

Traits

Trait	Description
`Emitter`	Adds event related features to any class.

Properties

protected $pretendingOriginal : string

Original driver before pretending.

protected $emitterEventCollection : array = `[]`

Inherited from Emitter

Collection of registered events.

protected $emitterEventSorted : array = `[]`

Inherited from Emitter

Sorted collection of events.

protected $emitterSingleEventCollection : array = `[]`

Inherited from Emitter

Collection of registered events to be fired once only.

Methods

public later (int $delay, MailableContract | string | array $view, array $data = `null`, Closure | string $callback = `null`, string | null $queue = `null`) : mixed

Queue a new e-mail message for sending after (n) seconds.

Parameters

Property	Type	Description
$delay	int	int
$view	MailableContract \| string \| array	MailableContract \| string \| array
$data	array	array
$callback	Closure \| string	Closure \| string
$queue	string \| null	string \| null

Returns

mixed

public laterOn (string $queue, int $delay, string | array $view, array $data = `null`, Closure | string $callback = `null`) : mixed

Queue a new e-mail message for sending after (n) seconds on the given queue.

Parameters

Property	Type	Description
$queue	string	string
$delay	int	int
$view	string \| array	string \| array
$data	array	array
$callback	Closure \| string	Closure \| string

Returns

mixed

public pretend (boolean $value = `true`) : void

Tell the mailer to not really send messages.

Parameters

Property	Type	Description
$value	boolean	boolean

Returns

void

public queue (MailableContract | string | array $view, array $data = `null`, Closure | string $callback = `null`, string | null $queue = `null`) : mixed

Queue a new e-mail message for sending.

Parameters

Property	Type	Description
$view	MailableContract \| string \| array	MailableContract \| string \| array
$data	array	array
$callback	Closure \| string	Closure \| string
$queue	string \| null	string \| null

Returns

mixed

public queueOn (string $queue, string | array $view, array $data = `null`, Closure | string $callback = `null`) : mixed

Queue a new e-mail message for sending on the given queue.

Parameters

Property	Type	Description
$queue	string	string
$view	string \| array	string \| array
$data	array	array
$callback	Closure \| string	Closure \| string

Returns

mixed

public raw (string | array $view, mixed $callback) : Illuminate\Mail\SentMessage | null

Send a new message when only a raw text part.

Parameters

Property	Type	Description
$view	string \| array	string \| array
$callback	mixed	mixed

Returns

Illuminate\Mail\SentMessage | null

public rawTo (array $recipients, array | string $view, mixed $callback = `null`, array $options = `[]`) : Illuminate\Mail\SentMessage | null

Helper for raw() method, send a new message when only a raw text part.

Parameters

Property	Type	Description
$recipients	array	array
$view	array \| string	array \| string
$callback	mixed	mixed
$options	array	array

Returns

Illuminate\Mail\SentMessage | null

public send (Illuminate\Contracts\Mail\Mailable | string | array $view, array $data = `[]`, Closure | string | null $callback = `null`) : Illuminate\Mail\SentMessage | null

Send a new message using a view.

Overrides the Laravel defaults to provide the following functionality:

Events (global & local):
mailer.beforeSend
mailer.prepareSend
mailer.send
Custom addContent() behavior
Support for bypassing all addContent behavior when passing $view['raw' => true]

Parameters

Property	Type	Description
$view	Illuminate\Contracts\Mail\Mailable \| string \| array	Illuminate\Contracts\Mail\Mailable \| string \| array
$data	array	array
$callback	Closure \| string \| null	Closure \| string \| null

Returns

Illuminate\Mail\SentMessage | null

public sendTo (array $recipients, string | array $view, array $data = `[]`, mixed $callback = `null`, array $options = `[]`) : mixed

Helper for send() method, the first argument can take a single email or an array of recipients where the key is the address and the value is the name.

Parameters

Property	Type	Description
$recipients	array	array
$view	string \| array	string \| array
$data	array	array
$callback	mixed	mixed
$options	array	array

Returns

mixed

protected addContent (Illuminate\Mail\Message $message, string | null $view = `null`, string | null $plain = `null`, string | null $raw = `null`, array | null $data = `null`) : void

Add the content to a given message.

Overrides the Laravel defaults to provide the following functionality:

Events (global & local):
mailer.beforeAddContent
mailer.addContent
Support for the Winter MailParser

Parameters

Property	Type	Description
$message	Illuminate\Mail\Message	Illuminate\Mail\Message
$view	string \| null	string \| null
$plain	string \| null	string \| null
$raw	string \| null	string \| null
$data	array \| null	array \| null

Returns

void

protected addContentRaw (Illuminate\Mail\Message $message, string | null $html = `null`, string | null $text = `null`) : void

Add the raw content to the provided message.

Parameters

Property	Type	Description
$message	Illuminate\Mail\Message	Illuminate\Mail\Message
$html	string \| null	string \| null
$text	string \| null	string \| null

Returns

void

protected buildQueueMailable ($view, $data, mixed $callback, $queueName = `null`) : mixed

Build the mailable for a queued e-mail job.

Parameters

Property	Type	Description
$view	mixed	mixed
$data	mixed	mixed
$callback	mixed	mixed
$queueName	mixed	mixed

Returns

mixed

protected processRecipients (mixed $recipients) : array

Process a recipients object, which can look like the following:

(string) 'admin@domain.tld'
(array) ['admin@domain.tld', 'other@domain.tld']
(object) ['email' => 'admin@domain.tld', 'name' => 'Adam Person']
(array) ['admin@domain.tld' => 'Adam Person', ...]
(array) [ (object|array) ['email' => 'admin@domain.tld', 'name' => 'Adam Person'], [...] ]

Parameters

Property	Type	Description
$recipients	mixed	mixed

Returns

array

public bindEvent (string | Closure | QueuedClosure $event, mixed $callback = `null`, integer $priority) : self

Inherited from Emitter

Create a new event binding.

Parameters

Property	Type	Description
$event	string \| Closure \| QueuedClosure	string \| Closure \| QueuedClosure
$callback	mixed	mixed when the third parameter is omitted and a Closure or QueuedClosure is provided this parameter is used as an integer this is used as priority variable
$priority	integer	integer

Returns

self

public bindEventOnce (string | Closure | QueuedClosure $event, QueuedClosure | Closure | null $callback = `null`) : self

Inherited from Emitter

Create a new event binding that fires once only

Parameters

Property	Type	Description
$event	string \| Closure \| QueuedClosure	string \| Closure \| QueuedClosure
$callback	QueuedClosure \| Closure \| null	QueuedClosure \| Closure \| null When a Closure or QueuedClosure is provided as the first parameter this parameter can be omitted

Returns

self

public fireEvent (string $event, array $params = `[]`, boolean $halt = `false`) : array | mixed | null

Inherited from Emitter

Fire an event and call the listeners.

Parameters

Property	Type	Description
$event	string	string Event name
$params	array	array Event parameters
$halt	boolean	boolean Halt after first non-null result

Returns

array | mixed | null

If halted, the first non-null result. If not halted, an array of event results. Returns null if no listeners returned a result.

public unbindEvent (string | array | object $event = `null`) : self

Inherited from Emitter

Destroys an event binding.

Parameters

Property	Type	Description
$event	string \| array \| object	string \| array \| object Event to destroy

Returns

self

protected emitterEventSortEvents (string $eventName) : void

Inherited from Emitter

Sort the listeners for a given event by priority.

Parameters

Property	Type	Description
$eventName	string	string

Returns

void

protected parseEventAndPayload (mixed $event, mixed $payload = `null`) : array

Inherited from Emitter

Parse the given event and payload and prepare them for dispatching.

Parameters

Property	Type	Description
$event	mixed	mixed
$payload	mixed	mixed

Returns

array

← Winter\Storm\Mail\Mailable Winter\Storm\Network\Http →

Mailer Mailer class for sending mail.

# Traits

# Properties

# protected $pretendingOriginal : string

# protected $emitterEventCollection : array = []

# protected $emitterEventSorted : array = []

# protected $emitterSingleEventCollection : array = []

# Methods

# public later (int $delay, MailableContract | string | array $view, array $data = null, Closure | string $callback = null, string | null $queue = null) : mixed

# public laterOn (string $queue, int $delay, string | array $view, array $data = null, Closure | string $callback = null) : mixed

# public pretend (boolean $value = true) : void

# public queue (MailableContract | string | array $view, array $data = null, Closure | string $callback = null, string | null $queue = null) : mixed

# public queueOn (string $queue, string | array $view, array $data = null, Closure | string $callback = null) : mixed

# public raw (string | array $view, mixed $callback) : Illuminate\Mail\SentMessage | null

# public rawTo (array $recipients, array | string $view, mixed $callback = null, array $options = []) : Illuminate\Mail\SentMessage | null

# public send (Illuminate\Contracts\Mail\Mailable | string | array $view, array $data = [], Closure | string | null $callback = null) : Illuminate\Mail\SentMessage | null

# public sendTo (array $recipients, string | array $view, array $data = [], mixed $callback = null, array $options = []) : mixed

# protected addContent (Illuminate\Mail\Message $message, string | null $view = null, string | null $plain = null, string | null $raw = null, array | null $data = null) : void

# protected addContentRaw (Illuminate\Mail\Message $message, string | null $html = null, string | null $text = null) : void

# protected buildQueueMailable ($view, $data, mixed $callback, $queueName = null) : mixed

# protected processRecipients (mixed $recipients) : array

# public bindEvent (string | Closure | QueuedClosure $event, mixed $callback = null, integer $priority) : self

# public bindEventOnce (string | Closure | QueuedClosure $event, QueuedClosure | Closure | null $callback = null) : self

# public fireEvent (string $event, array $params = [], boolean $halt = false) : array | mixed | null

# public unbindEvent (string | array | object $event = null) : self

# protected emitterEventSortEvents (string $eventName) : void

# protected parseEventAndPayload (mixed $event, mixed $payload = null) : array

Mailer
Mailer class for sending mail.

Traits

Properties

protected $pretendingOriginal : string

protected $emitterEventCollection : array = `[]`

protected $emitterEventSorted : array = `[]`

protected $emitterSingleEventCollection : array = `[]`

Methods

public later (int $delay, MailableContract | string | array $view, array $data = `null`, Closure | string $callback = `null`, string | null $queue = `null`) : mixed

public laterOn (string $queue, int $delay, string | array $view, array $data = `null`, Closure | string $callback = `null`) : mixed

public pretend (boolean $value = `true`) : void

public queue (MailableContract | string | array $view, array $data = `null`, Closure | string $callback = `null`, string | null $queue = `null`) : mixed

public queueOn (string $queue, string | array $view, array $data = `null`, Closure | string $callback = `null`) : mixed

public raw (string | array $view, mixed $callback) : Illuminate\Mail\SentMessage | null

public rawTo (array $recipients, array | string $view, mixed $callback = `null`, array $options = `[]`) : Illuminate\Mail\SentMessage | null

public send (Illuminate\Contracts\Mail\Mailable | string | array $view, array $data = `[]`, Closure | string | null $callback = `null`) : Illuminate\Mail\SentMessage | null

public sendTo (array $recipients, string | array $view, array $data = `[]`, mixed $callback = `null`, array $options = `[]`) : mixed

protected addContent (Illuminate\Mail\Message $message, string | null $view = `null`, string | null $plain = `null`, string | null $raw = `null`, array | null $data = `null`) : void

protected addContentRaw (Illuminate\Mail\Message $message, string | null $html = `null`, string | null $text = `null`) : void

protected buildQueueMailable ($view, $data, mixed $callback, $queueName = `null`) : mixed

protected processRecipients (mixed $recipients) : array

public bindEvent (string | Closure | QueuedClosure $event, mixed $callback = `null`, integer $priority) : self

public bindEventOnce (string | Closure | QueuedClosure $event, QueuedClosure | Closure | null $callback = `null`) : self

public fireEvent (string $event, array $params = `[]`, boolean $halt = `false`) : array | mixed | null

public unbindEvent (string | array | object $event = `null`) : self

protected emitterEventSortEvents (string $eventName) : void

protected parseEventAndPayload (mixed $event, mixed $payload = `null`) : array