MailFake
class MailFake implements Factory, Fake, Mailer, MailQueue (View source)
Traits
Properties
| MailManager | $manager | The mailer instance. |
|
| protected string | $currentMailer | The mailer currently being used to send a message. |
|
| protected array | $mailables | All of the mailables that have been sent. |
|
| protected array | $queuedMailables | All of the mailables that have been queued. |
Methods
| mixed | forwardCallTo(mixed $object, string $method, array $parameters) Forward a method call to the given object. |
from ForwardsCalls |
| mixed | forwardDecoratedCallTo(mixed $object, string $method, array $parameters) Forward a method call to the given object, returning $this if the forwarded call returned itself. |
from ForwardsCalls |
| static void | throwBadMethodCallException(string $method) Throw a bad method call exception for the given method. |
from ForwardsCalls |
| string | firstClosureParameterType(Closure $closure) Get the class name of the first parameter of the given Closure. |
from ReflectsClosures |
| array | firstClosureParameterTypes(Closure $closure) Get the class names of the first parameter of the given Closure, including union types. |
from ReflectsClosures |
| array | closureParameterTypes(Closure $closure) Get the class names / types of the parameters of the given Closure. |
from ReflectsClosures |
| void | __construct(MailManager $manager) Create a new mail fake. |
|
| void | assertSent(string|Closure $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 | assertNotOutgoing(string|Closure $mailable, callable|null $callback = null) Determine if a mailable was not sent or queued to be sent based on a truth-test callback. |
|
| void | assertNotSent(string|Closure $mailable, callable|null $callback = null) Determine if a mailable was not sent based on a truth-test callback. |
|
| void | assertNothingOutgoing() Assert that no mailables were sent or queued to be sent. |
|
| void | assertNothingSent() Assert that no mailables were sent. |
|
| void | assertQueued(string|Closure $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|Closure $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|Closure $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|Closure $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. |
|
| Mailer | mailer(string|null $name = null) Get a mailer instance by name. |
|
| PendingMail | to(mixed $users) Begin the process of mailing a mailable class instance. |
|
| PendingMail | cc(mixed $users) Begin the process of mailing a mailable class instance. |
|
| PendingMail | bcc(mixed $users) Begin the process of mailing a mailable class instance. |
|
| SentMessage|null | raw(string $text, mixed $callback) Send a new message with only a raw text part. |
|
| SentMessage|null | 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 | prepareMailableAndCallback(string|Closure $mailable, callable|null $callback) Infer mailable class using reflection if a typehinted closure is passed to assertion. |
|
| $this | forgetMailers() Forget all of the resolved mailer instances. |
|
| mixed | __call(string $method, array $parameters) Handle dynamic method calls to the mailer. |
Details
protected mixed forwardCallTo(mixed $object, string $method, array $parameters)
Forward a method call to the given object.
protected mixed forwardDecoratedCallTo(mixed $object, string $method, array $parameters)
Forward a method call to the given object, returning $this if the forwarded call returned itself.
static protected void throwBadMethodCallException(string $method)
Throw a bad method call exception for the given method.
protected string firstClosureParameterType(Closure $closure)
Get the class name of the first parameter of the given Closure.
protected array firstClosureParameterTypes(Closure $closure)
Get the class names of the first parameter of the given Closure, including union types.
protected array closureParameterTypes(Closure $closure)
Get the class names / types of the parameters of the given Closure.
void __construct(MailManager $manager)
Create a new mail fake.
void assertSent(string|Closure $mailable, callable|int|null $callback = null)
Assert if a mailable was sent based on a truth-test callback.
protected void assertSentTimes(string $mailable, int $times = 1)
Assert if a mailable was sent a number of times.
void assertNotOutgoing(string|Closure $mailable, callable|null $callback = null)
Determine if a mailable was not sent or queued to be sent based on a truth-test callback.
void assertNotSent(string|Closure $mailable, callable|null $callback = null)
Determine if a mailable was not sent based on a truth-test callback.
void assertNothingOutgoing()
Assert that no mailables were sent or queued to be sent.
void assertNothingSent()
Assert that no mailables were sent.
void assertQueued(string|Closure $mailable, callable|int|null $callback = null)
Assert if a mailable was queued based on a truth-test callback.
protected void assertQueuedTimes(string $mailable, int $times = 1)
Assert if a mailable was queued a number of times.
void assertNotQueued(string|Closure $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|Closure $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|Closure $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.
protected Collection mailablesOf(string $type)
Get all of the mailed mailables for a given type.
protected Collection queuedMailablesOf(string $type)
Get all of the mailed mailables for a given type.
Mailer mailer(string|null $name = null)
Get a mailer instance by name.
PendingMail to(mixed $users)
Begin the process of mailing a mailable class instance.
PendingMail cc(mixed $users)
Begin the process of mailing a mailable class instance.
PendingMail bcc(mixed $users)
Begin the process of mailing a mailable class instance.
SentMessage|null raw(string $text, mixed $callback)
Send a new message with only a raw text part.
SentMessage|null 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.
protected array prepareMailableAndCallback(string|Closure $mailable, callable|null $callback)
Infer mailable class using reflection if a typehinted closure is passed to assertion.
$this forgetMailers()
Forget all of the resolved mailer instances.
mixed __call(string $method, array $parameters)
Handle dynamic method calls to the mailer.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/10.x/Illuminate/Support/Testing/Fakes/MailFake.html