1. class
  2. Illuminate
  3. \
  4. Support
  5. \
  6. Facades
  7. \
  8. Mail

Mail

class Mail extends Facade (View source)

Properties

static protected Application|null $app

The application instance being facaded.

 from  Facade
static protected array $resolvedInstance

The resolved object instances.

 from  Facade
static protected bool $cached

Indicates if the resolved instance should be cached.

 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 Expectation
expects()

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 bool
isFake()

Determines whether a "fake" has been set as the facade instance.

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(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 Collection
defaultAliases()

Get the application default aliases.

from  Facade
static Application|null
getFacadeApplication()

Get the application instance behind the facade.

from  Facade
static void
setFacadeApplication(Application|null $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 Mailer
driver(string|null $driver = null)

No description

static Mailer
build(array $config)

No description

static TransportInterface
createSymfonyTransport(array $config)

No description

static string
getDefaultDriver()

No description

static void
setDefaultDriver(string $name)

No description

static void
purge(string|null $name = null)

No description

static MailManager
extend(string $driver, Closure $callback)

No description

static Application
getApplication()

No description

static MailManager
setApplication(Application $app)

No description

static MailManager
forgetMailers()

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
to(mixed $users, string|null $name = null)

No description

static PendingMail
cc(mixed $users, string|null $name = null)

No description

static PendingMail
bcc(mixed $users, string|null $name = null)

No description

static SentMessage|null
html(string $html, mixed $callback)

No description

static SentMessage|null
raw(string $text, mixed $callback)

No description

static SentMessage|null
plain(string $view, array $data, mixed $callback)

No description

static string
render(string|array $view, array $data = [])

No description

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

No description

static SentMessage|null
sendNow(Mailable|string|array $mailable, array $data = [], Closure|string|null $callback = null)

No description

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

No description

static mixed
onQueue(BackedEnum|string|null $queue, Mailable $view)

No description

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

No description

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

No description

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

No description

static TransportInterface
getSymfonyTransport()

No description

static Factory
getViewFactory()

No description

static void
setSymfonyTransport(TransportInterface $transport)

No description

static Mailer
setQueue(Factory $queue)

No description

static void
macro(string $name, object|callable $macro)

No description

static void
mixin(object $mixin, bool $replace = true)

No description

static bool
hasMacro(string $name)

No description

static void
flushMacros()

No description

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

No description

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

No description

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

No description

static void
assertNothingOutgoing()

No description

static void
assertNothingSent()

No description

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

No description

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

No description

static void
assertNothingQueued()

No description

static void
assertSentCount(int $count)

No description

static void
assertQueuedCount(int $count)

No description

static void
assertOutgoingCount(int $count)

No description

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

No description

static bool
hasSent(string $mailable)

No description

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

No description

static bool
hasQueued(string $mailable)

No description

Details

in Facade at line 48
static void resolved(Closure $callback)

Run a Closure when the facade has been resolved.

Parameters

Closure $callback

Return Value

void

in Facade at line 66
static MockInterface spy()

Convert the facade into a Mockery spy.

Return Value

MockInterface

in Facade at line 82
static MockInterface partialMock()

Initiate a partial mock on the facade.

Return Value

MockInterface

in Facade at line 98
static Expectation shouldReceive()

Initiate a mock expectation on the facade.

Return Value

Expectation

in Facade at line 114
static Expectation expects()

Initiate a mock expectation on the facade.

Return Value

Expectation

in Facade at line 130
static protected MockInterface createFreshMockInstance()

Create a fresh mock instance for the given class.

Return Value

MockInterface

in Facade at line 144
static protected MockInterface createMock()

Create a fresh mock instance for the given class.

Return Value

MockInterface

in Facade at line 156
static protected bool isMock()

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

Return Value

bool

in Facade at line 169
static protected string|null getMockableClass()

Get the mockable class for the bound instance.

Return Value

string|null

in Facade at line 182
static void swap(mixed $instance)

Hotswap the underlying instance behind the facade.

Parameters

mixed $instance

Return Value

void

in Facade at line 196
static bool isFake()

Determines whether a "fake" has been set as the facade instance.

Return Value

bool

in Facade at line 209
static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

at line 87
static protected string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

in Facade at line 232
static protected mixed resolveFacadeInstance(string $name)

Resolve the facade root instance from the container.

Parameters

string $name

Return Value

mixed

in Facade at line 253
static void clearResolvedInstance(string $name)

Clear a resolved facade instance.

Parameters

string $name

Return Value

void

in Facade at line 263
static void clearResolvedInstances()

Clear all of the resolved instances.

Return Value

void

in Facade at line 273
static Collection defaultAliases()

Get the application default aliases.

Return Value

Collection

in Facade at line 330
static Application|null getFacadeApplication()

Get the application instance behind the facade.

Return Value

Application|null

in Facade at line 341
static void setFacadeApplication(Application|null $app)

Set the application instance.

Parameters

Application|null $app

Return Value

void

in Facade at line 355
static mixed __callStatic(string $method, array $args)

Handle dynamic, static calls to the object.

Parameters

string $method
array $args

Return Value

mixed

Exceptions

RuntimeException

at line 71
static MailFake fake()

Replace the bound instance with a fake.

Return Value

MailFake

at line 64
static Mailer mailer(string|null $name = null)

No description

Parameters

string|null $name

Return Value

Mailer

at line 64
static Mailer driver(string|null $driver = null)

No description

Parameters

string|null $driver

Return Value

Mailer

at line 64
static Mailer build(array $config)

No description

Parameters

array $config

Return Value

Mailer

at line 64
static TransportInterface createSymfonyTransport(array $config)

No description

Parameters

array $config

Return Value

TransportInterface

at line 64
static string getDefaultDriver()

No description

Return Value

string

at line 64
static void setDefaultDriver(string $name)

No description

Parameters

string $name

Return Value

void

at line 64
static void purge(string|null $name = null)

No description

Parameters

string|null $name

Return Value

void

at line 64
static MailManager extend(string $driver, Closure $callback)

No description

Parameters

string $driver
Closure $callback

Return Value

MailManager

at line 64
static Application getApplication()

No description

Return Value

Application

at line 64
static MailManager setApplication(Application $app)

No description

Parameters

Application $app

Return Value

MailManager

at line 64
static MailManager forgetMailers()

No description

Return Value

MailManager

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

No description

Parameters

string $address
string|null $name

Return Value

void

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

No description

Parameters

string $address
string|null $name

Return Value

void

at line 64
static void alwaysReturnPath(string $address)

No description

Parameters

string $address

Return Value

void

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

No description

Parameters

string $address
string|null $name

Return Value

void

at line 64
static PendingMail to(mixed $users, string|null $name = null)

No description

Parameters

mixed $users
string|null $name

Return Value

PendingMail

at line 64
static PendingMail cc(mixed $users, string|null $name = null)

No description

Parameters

mixed $users
string|null $name

Return Value

PendingMail

at line 64
static PendingMail bcc(mixed $users, string|null $name = null)

No description

Parameters

mixed $users
string|null $name

Return Value

PendingMail

at line 64
static SentMessage|null html(string $html, mixed $callback)

No description

Parameters

string $html
mixed $callback

Return Value

SentMessage|null

at line 64
static SentMessage|null raw(string $text, mixed $callback)

No description

Parameters

string $text
mixed $callback

Return Value

SentMessage|null

at line 64
static SentMessage|null plain(string $view, array $data, mixed $callback)

No description

Parameters

string $view
array $data
mixed $callback

Return Value

SentMessage|null

at line 64
static string render(string|array $view, array $data = [])

No description

Parameters

string|array $view
array $data

Return Value

string

at line 64
static SentMessage|null send(Mailable|string|array $view, array $data = [], Closure|string|null $callback = null)

No description

Parameters

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

Return Value

SentMessage|null

at line 64
static SentMessage|null sendNow(Mailable|string|array $mailable, array $data = [], Closure|string|null $callback = null)

No description

Parameters

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

Return Value

SentMessage|null

at line 64
static mixed queue(Mailable $view, BackedEnum|string|null $queue = null)

No description

Parameters

Mailable $view
BackedEnum|string|null $queue

Return Value

mixed

at line 64
static mixed onQueue(BackedEnum|string|null $queue, Mailable $view)

No description

Parameters

BackedEnum|string|null $queue
Mailable $view

Return Value

mixed

at line 64
static mixed queueOn(string $queue, Mailable $view)

No description

Parameters

string $queue
Mailable $view

Return Value

mixed

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

No description

Parameters

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

Return Value

mixed

at line 64
static mixed laterOn(string $queue, DateInterval|int $delay, Mailable $view)

No description

Parameters

string $queue
DateInterval|int $delay
Mailable $view

Return Value

mixed

at line 64
static TransportInterface getSymfonyTransport()

No description

Return Value

TransportInterface

at line 64
static Factory getViewFactory()

No description

Return Value

Factory

at line 64
static void setSymfonyTransport(TransportInterface $transport)

No description

Parameters

TransportInterface $transport

Return Value

void

at line 64
static Mailer setQueue(Factory $queue)

No description

Parameters

Factory $queue

Return Value

Mailer

at line 64
static void macro(string $name, object|callable $macro)

No description

Parameters

string $name
object|callable $macro

Return Value

void

at line 64
static void mixin(object $mixin, bool $replace = true)

No description

Parameters

object $mixin
bool $replace

Return Value

void

at line 64
static bool hasMacro(string $name)

No description

Parameters

string $name

Return Value

bool

at line 64
static void flushMacros()

No description

Return Value

void

at line 64
static void assertSent(Closure $mailable, callable|array|string|int|null $callback = null)

No description

Parameters

Closure $mailable
callable|array|string|int|null $callback

Return Value

void

at line 64
static void assertNotOutgoing(Closure $mailable, callable|null $callback = null)

No description

Parameters

Closure $mailable
callable|null $callback

Return Value

void

at line 64
static void assertNotSent(Closure $mailable, callable|array|string|null $callback = null)

No description

Parameters

Closure $mailable
callable|array|string|null $callback

Return Value

void

at line 64
static void assertNothingOutgoing()

No description

Return Value

void

at line 64
static void assertNothingSent()

No description

Return Value

void

at line 64
static void assertQueued(Closure $mailable, callable|array|string|int|null $callback = null)

No description

Parameters

Closure $mailable
callable|array|string|int|null $callback

Return Value

void

at line 64
static void assertNotQueued(Closure $mailable, callable|array|string|null $callback = null)

No description

Parameters

Closure $mailable
callable|array|string|null $callback

Return Value

void

at line 64
static void assertNothingQueued()

No description

Return Value

void

at line 64
static void assertSentCount(int $count)

No description

Parameters

int $count

Return Value

void

at line 64
static void assertQueuedCount(int $count)

No description

Parameters

int $count

Return Value

void

at line 64
static void assertOutgoingCount(int $count)

No description

Parameters

int $count

Return Value

void

at line 64
static Collection sent(Closure $mailable, callable|null $callback = null)

No description

Parameters

Closure $mailable
callable|null $callback

Return Value

Collection

at line 64
static bool hasSent(string $mailable)

No description

Parameters

string $mailable

Return Value

bool

at line 64
static Collection queued(Closure $mailable, callable|null $callback = null)

No description

Parameters

Closure $mailable
callable|null $callback

Return Value

Collection

at line 64
static bool hasQueued(string $mailable)

No description

Parameters

string $mailable

Return Value

bool