Mail

class Mail extends Facade (View source)

Properties

static protected Application	$app	The application instance being facaded.	from Facade
static protected array	$resolvedInstance	The resolved object instances.	from Facade

Methods

static void

resolved(Closure $callback)

Run a Closure when the facade has been resolved.

from Facade

static MockInterface

spy()

Convert the facade into a Mockery spy.

from Facade

static MockInterface

partialMock()

Initiate a partial mock on the facade.

from Facade

static Expectation

shouldReceive()

Initiate a mock expectation on the facade.

from Facade

static MockInterface

createFreshMockInstance()

Create a fresh mock instance for the given class.

from Facade

static MockInterface

createMock()

Create a fresh mock instance for the given class.

from Facade

static bool

isMock()

Determines whether a mock is set as the instance of the facade.

from Facade

static string|null

getMockableClass()

Get the mockable class for the bound instance.

from Facade

static void

swap(mixed $instance)

Hotswap the underlying instance behind the facade.

from Facade

static mixed

getFacadeRoot()

Get the root object behind the facade.

from Facade

static string

getFacadeAccessor()

Get the registered name of the component.

static mixed

resolveFacadeInstance(object|string $name)

Resolve the facade root instance from the container.

from Facade

static void

clearResolvedInstance(string $name)

Clear a resolved facade instance.

from Facade

static void

clearResolvedInstances()

Clear all of the resolved instances.

from Facade

static Application

getFacadeApplication()

Get the application instance behind the facade.

from Facade

static void

setFacadeApplication(Application $app)

Set the application instance.

from Facade

static mixed

__callStatic(string $method, array $args)

Handle dynamic, static calls to the object.

from Facade

static MailFake

fake()

Replace the bound instance with a fake.

static Mailer

mailer(string|null $name = null)

No description

static void

alwaysFrom(string $address, string|null $name = null)

No description

static void

alwaysReplyTo(string $address, string|null $name = null)

No description

static void

alwaysReturnPath(string $address)

No description

static void

alwaysTo(string $address, string|null $name = null)

No description

static PendingMail

bcc(mixed $users)

No description

static PendingMail

to(mixed $users)

No description

static Collection

queued(string $mailable, Closure|string $callback = null)

No description

static Collection

sent(string $mailable, Closure|string $callback = null)

No description

static array

failures()

No description

static bool

hasQueued(string $mailable)

No description

static bool

hasSent(string $mailable)

No description

static mixed

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

No description

static mixed

laterOn(string $queue, DateInterval|int $delay, Mailable|string|array $view)

No description

static mixed

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

No description

static mixed

queueOn(string $queue, Mailable|string|array $view)

No description

static void

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

No description

static void

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

No description

static void

assertNothingQueued()

No description

static void

assertNothingSent()

No description

static void

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

No description

static void

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

No description

static void

raw(string $text, mixed $callback)

No description

static void

plain(string $view, array $data, mixed $callback)

No description

static void

html(string $html, mixed $callback)

No description

static void

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

No description

Details

static void resolved(Closure $callback)

Run a Closure when the facade has been resolved.

Parameters

Closure

$callback

Return Value

void

static MockInterface spy()

Convert the facade into a Mockery spy.

Return Value

MockInterface

static MockInterface partialMock()

Initiate a partial mock on the facade.

Return Value

MockInterface

static Expectation shouldReceive()

Initiate a mock expectation on the facade.

Return Value

Expectation

static protected MockInterface createFreshMockInstance()

Create a fresh mock instance for the given class.

Return Value

MockInterface

static protected MockInterface createMock()

Create a fresh mock instance for the given class.

Return Value

MockInterface

static protected bool isMock()

Determines whether a mock is set as the instance of the facade.

Return Value

bool

static protected string|null getMockableClass()

Get the mockable class for the bound instance.

Return Value

string|null

static void swap(mixed $instance)

Hotswap the underlying instance behind the facade.

Parameters

mixed

$instance

Return Value

void

static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

static protected string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

static protected mixed resolveFacadeInstance(object|string $name)

Resolve the facade root instance from the container.

Parameters

object|string

$name

Return Value

mixed

static void clearResolvedInstance(string $name)

Clear a resolved facade instance.

Parameters

string

$name

Return Value

void

static void clearResolvedInstances()

Clear all of the resolved instances.

Return Value

void

static Application getFacadeApplication()

Get the application instance behind the facade.

Return Value

Application

static void setFacadeApplication(Application $app)

Set the application instance.

Parameters

Application

$app

Return Value

void

static mixed __callStatic(string $method, array $args)

Handle dynamic, static calls to the object.

Parameters

string	$method
array	$args

Return Value

mixed

Exceptions

RuntimeException

static MailFake fake()

Replace the bound instance with a fake.

Return Value

MailFake

static Mailer mailer(string|null $name = null)

No description

Parameters

string|null

$name

Return Value

Mailer

static void alwaysFrom(string $address, string|null $name = null)

No description

Parameters

string	$address
string\|null	$name

Return Value

void

static void alwaysReplyTo(string $address, string|null $name = null)

No description

Parameters

string	$address
string\|null	$name

Return Value

void

static void alwaysReturnPath(string $address)

No description

Parameters

string

$address

Return Value

void

static void alwaysTo(string $address, string|null $name = null)

No description

Parameters

string	$address
string\|null	$name

Return Value

void

static PendingMail bcc(mixed $users)

No description

Parameters

mixed

$users

Return Value

PendingMail

static PendingMail to(mixed $users)

No description

Parameters

mixed

$users

Return Value

PendingMail

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

No description

Parameters

string	$mailable
Closure\|string	$callback

Return Value

Collection

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

No description

Parameters

string	$mailable
Closure\|string	$callback

Return Value

Collection

static array failures()

No description

Return Value

array

static bool hasQueued(string $mailable)

No description

Parameters

string

$mailable

Return Value

bool

static bool hasSent(string $mailable)

No description

Parameters

string

$mailable

Return Value

bool

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

No description

Parameters

DateInterval\|int	$delay
Mailable\|string\|array	$view
string	$queue

Return Value

mixed

static mixed laterOn(string $queue, DateInterval|int $delay, Mailable|string|array $view)

No description

Parameters

string	$queue
DateInterval\|int	$delay
Mailable\|string\|array	$view

Return Value

mixed

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

No description

Parameters

Mailable\|string\|array	$view
string	$queue

Return Value

mixed

static mixed queueOn(string $queue, Mailable|string|array $view)

No description

Parameters

string	$queue
Mailable\|string\|array	$view

Return Value

mixed

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

No description

Parameters

string	$mailable
callable	$callback

Return Value

void

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

No description

Parameters

string	$mailable
callable\|int	$callback

Return Value

void

static void assertNothingQueued()

No description

Return Value

void

static void assertNothingSent()

No description

Return Value

void

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

No description

Parameters

Closure	$mailable
callable\|int	$callback

Return Value

void

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

No description

Parameters

Closure	$mailable
callable\|int	$callback

Return Value

void

static void raw(string $text, mixed $callback)

No description

Parameters

string	$text
mixed	$callback

Return Value

void

static void plain(string $view, array $data, mixed $callback)

No description

Parameters

string	$view
array	$data
mixed	$callback

Return Value

void

static void html(string $html, mixed $callback)

No description

Parameters

string	$html
mixed	$callback

Return Value

void

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

No description

Parameters

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

Return Value

void

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/8.x/Illuminate/Support/Facades/Mail.html