MailFake

class MailFake implements Mailer, MailQueue (View source)

Properties

protected array $mailables All of the mailables that have been sent.
protected array $queuedMailables All of the mailables that have been queued.

Methods

void assertSent(string $mailable, callable|int|null $callback = null)

Assert if a mailable was sent based on a truth-test callback.
void assertSentTimes(string $mailable, int $times = 1)

Assert if a mailable was sent a number of times.
void assertNotSent(string $mailable, callable|null $callback = null)

Determine if a mailable was not sent based on a truth-test callback.
void assertNothingSent()

Assert that no mailables were sent.
void assertQueued(string $mailable, callable|int|null $callback = null)

Assert if a mailable was queued based on a truth-test callback.
void assertQueuedTimes(string $mailable, int $times = 1)

Assert if a mailable was queued a number of times.
void assertNotQueued(string $mailable, callable|null $callback = null)

Determine if a mailable was not queued based on a truth-test callback.
void assertNothingQueued()

Assert that no mailables were queued.
Collection sent(string $mailable, callable|null $callback = null)

Get all of the mailables matching a truth-test callback.
bool hasSent(string $mailable)

Determine if the given mailable has been sent.
Collection queued(string $mailable, callable|null $callback = null)

Get all of the queued mailables matching a truth-test callback.
bool hasQueued(string $mailable)

Determine if the given mailable has been queued.
Collection mailablesOf(string $type)

Get all of the mailed mailables for a given type.
Collection queuedMailablesOf(string $type)

Get all of the mailed mailables for a given type.
PendingMail to(mixed $users)

Begin the process of mailing a mailable class instance.
PendingMail bcc(mixed $users)

Begin the process of mailing a mailable class instance.
void raw(string $text, mixed $callback)

Send a new message with only a raw text part.
void send(Mailable|string|array $view, array $data = [], Closure|string|null $callback = null)

Send a new message using a view.
mixed queue(Mailable|string|array $view, string|null $queue = null)

Queue a new e-mail message for sending.
mixed later(DateTimeInterface|DateInterval|int $delay, Mailable|string|array $view, string|null $queue = null)

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

Get the array of failed recipients.

Details

void assertSent(string $mailable, callable|int|null $callback = null)

Assert if a mailable was sent based on a truth-test callback.

Parameters

string $mailable
callable|int|null $callback

Return Value

void

protected void assertSentTimes(string $mailable, int $times = 1)

Assert if a mailable was sent a number of times.

Parameters

string $mailable
int $times

Return Value

void

void assertNotSent(string $mailable, callable|null $callback = null)

Determine if a mailable was not sent based on a truth-test callback.

Parameters

string $mailable
callable|null $callback

Return Value

void

void assertNothingSent()

Assert that no mailables were sent.

Return Value

void

void assertQueued(string $mailable, callable|int|null $callback = null)

Assert if a mailable was queued based on a truth-test callback.

Parameters

string $mailable
callable|int|null $callback

Return Value

void

protected void assertQueuedTimes(string $mailable, int $times = 1)

Assert if a mailable was queued a number of times.

Parameters

string $mailable
int $times

Return Value

void

void assertNotQueued(string $mailable, callable|null $callback = null)

Determine if a mailable was not queued based on a truth-test callback.

Parameters

string $mailable
callable|null $callback

Return Value

void

void assertNothingQueued()

Assert that no mailables were queued.

Return Value

void

Collection sent(string $mailable, callable|null $callback = null)

Get all of the mailables matching a truth-test callback.

Parameters

string $mailable
callable|null $callback

Return Value

Collection

bool hasSent(string $mailable)

Determine if the given mailable has been sent.

Parameters

string $mailable

Return Value

bool

Collection queued(string $mailable, callable|null $callback = null)

Get all of the queued mailables matching a truth-test callback.

Parameters

string $mailable
callable|null $callback

Return Value

Collection

bool hasQueued(string $mailable)

Determine if the given mailable has been queued.

Parameters

string $mailable

Return Value

bool

protected Collection mailablesOf(string $type)

Get all of the mailed mailables for a given type.

Parameters

string $type

Return Value

Collection

protected Collection queuedMailablesOf(string $type)

Get all of the mailed mailables for a given type.

Parameters

string $type

Return Value

Collection

PendingMail to(mixed $users)

Begin the process of mailing a mailable class instance.

Parameters

mixed $users

Return Value

PendingMail

PendingMail bcc(mixed $users)

Begin the process of mailing a mailable class instance.

Parameters

mixed $users

Return Value

PendingMail

void raw(string $text, mixed $callback)

Send a new message with only a raw text part.

Parameters

string $text
mixed $callback

Return Value

void

void send(Mailable|string|array $view, array $data = [], Closure|string|null $callback = null)

Send a new message using a view.

Parameters

Mailable|string|array $view
array $data
Closure|string|null $callback

Return Value

void

mixed queue(Mailable|string|array $view, string|null $queue = null)

Queue a new e-mail message for sending.

Parameters

Mailable|string|array $view
string|null $queue

Return Value

mixed

mixed later(DateTimeInterface|DateInterval|int $delay, Mailable|string|array $view, string|null $queue = null)

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

Parameters

DateTimeInterface|DateInterval|int $delay
Mailable|string|array $view
string|null $queue

Return Value

mixed

array failures()

Get the array of failed recipients.

Return Value

array

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/6.x/Illuminate/Support/Testing/Fakes/MailFake.html