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

Mail

class Mail extends Facade

Constants

protected STATE_CONTEXT_KEY

The context key for the coroutine-local facade roots.

Properties

static protected Container|null $app

The application instance being facaded.

 from  Facade
static protected array $resolvedInstance

The resolved object instances.

 from  Facade
static protected array<string, true> $scopedAccessors

Accessors whose resolved objects belong to a coroutine scope.

 from  Facade
static protected array<string, int> $coroutineAccessors

Accessors with coroutine-local roots, and their current generation.

 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|null
spy()

Convert the facade into a Mockery spy.

from  Facade
static MockInterface
partialMock()

Initiate a partial mock on the facade.

from  Facade
static CompositeExpectation|Expectation|HigherOrderMessage
shouldReceive()

Initiate a mock expectation on the facade.

from  Facade
static CompositeExpectation|Expectation|ExpectsHigherOrderMessage
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|null $name = null)

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 Container|null
getFacadeApplication()

Get the application instance behind the facade.

from  Facade
static void
setFacadeApplication(Container|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 MailManager
addPoolableDriver(string $driver)

No description

static Mailer
build(array $config)

No description

static TransportInterface
createSymfonyTransport(array $config)

No description

static Mailer
driver(UnitEnum|string|null $driver = 'null')

No description

static MailManager
extend(string $driver, Closure $callback, bool $poolable = 'false')

No description

static MailManager
forgetMailers()

No description

static Container
getApplication()

No description

static string
getDefaultDriver()

No description

static array
getPoolableDrivers()

No description

static Closure|null
getReleaseCallback(string $driver)

No description

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

No description

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

No description

static MailManager
removePoolableDriver(string $driver)

No description

static MailManager
setApplication(Container $app)

No description

static void
setDefaultDriver(UnitEnum|string $name)

No description

static MailManager
setPoolableDrivers(array $poolableDrivers)

No description

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

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, string|null $name = 'null')

No description

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

No description

static void
flushMacros()

No description

static void
flushState()

No description

static TransportInterface
getSymfonyTransport()

No description

static Factory
getViewFactory()

No description

static bool
hasMacro(string $name)

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

static Mailer
setQueue(Factory $queue)

No description

static void
setSymfonyTransport(TransportInterface $transport)

No description

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

No description

static void
assertNothingOutgoing()

No description

static void
assertNothingQueued()

No description

static void
assertNothingSent()

No description

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

No description

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

No description

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

No description

static void
assertOutgoingCount(int $count)

No description

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

No description

static void
assertQueuedCount(int $count)

No description

static void
assertQueuedOnce(string $mailable)

No description

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

No description

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

No description

static void
assertSentCount(int $count)

No description

static void
assertSentOnce(string $mailable)

No description

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

No description

static bool
hasQueued(string $mailable)

No description

static bool
hasSent(string $mailable)

No description

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

No description

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

No description

Details

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

Run a Closure when the facade has been resolved.

The callback is registered on the worker-global container and runs for every subsequent resolution of the facade accessor.

Parameters

Closure $callback

Return Value

void

in Facade at line 106
static MockInterface|null spy()

Convert the facade into a Mockery spy.

Swaps the resolved facade instance for the worker lifetime.

Return Value

MockInterface|null

in Facade at line 125
static MockInterface partialMock()

Initiate a partial mock on the facade.

Swaps the resolved facade instance for the worker lifetime.

Return Value

MockInterface

in Facade at line 142
static CompositeExpectation|Expectation|HigherOrderMessage shouldReceive()

Initiate a mock expectation on the facade.

Swaps the resolved facade instance for the worker lifetime.

Return Value

CompositeExpectation|Expectation|HigherOrderMessage

in Facade at line 159
static CompositeExpectation|Expectation|ExpectsHigherOrderMessage expects()

Initiate a mock expectation on the facade.

Swaps the resolved facade instance for the worker lifetime.

Return Value

CompositeExpectation|Expectation|ExpectsHigherOrderMessage

in Facade at line 176
static protected MockInterface createFreshMockInstance()

Create a fresh mock instance for the given class.

Swaps the resolved facade instance for the worker lifetime.

Return Value

MockInterface

in Facade at line 189
static protected MockInterface createMock()

Create a fresh mock instance for the given class.

Return Value

MockInterface

in Facade at line 199
static protected bool isMock()

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

Return Value

bool

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

Get the mockable class for the bound instance.

Return Value

string|null

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

Hotswap the underlying instance behind the facade.

Replaces the worker-wide resolved facade instance and container binding; runtime use races across coroutines and changes every subsequent facade call.

Parameters

mixed $instance

Return Value

void

in Facade at line 239
static bool isFake()

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

Return Value

bool

in Facade at line 250
static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

at line 100
static protected string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

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

Resolve the facade root instance from the container.

Parameters

string $name

Return Value

mixed

in Facade at line 312
static void clearResolvedInstance(string|null $name = null)

Clear a resolved facade instance.

Later facade calls everywhere resolve again; only references already held keep the previous instance.

Parameters

string|null $name

Return Value

void

in Facade at line 330
static void clearResolvedInstances()

Clear all of the resolved instances.

Later facade calls everywhere resolve again; only references already held keep the previous instances.

Return Value

void

in Facade at line 344
static Collection defaultAliases()

Get the application default aliases.

Return Value

Collection

in Facade at line 404
static Container|null getFacadeApplication()

Get the application instance behind the facade.

Return Value

Container|null

in Facade at line 415
static void setFacadeApplication(Container|null $app)

Set the application instance.

Replaces the worker-wide facade application reference; runtime use races across coroutines and breaks every facade lookup.

Parameters

Container|null $app

Return Value

void

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

Handle dynamic, static calls to the object.

Parameters

string $method
array $args

Return Value

mixed

Exceptions

RuntimeException
Throwable

at line 85
static MailFake fake()

Replace the bound instance with a fake.

Swaps the resolved facade instance for the worker lifetime.

Return Value

MailFake

at line 78
static MailManager addPoolableDriver(string $driver)

No description

Parameters

string $driver

Return Value

MailManager

at line 78
static Mailer build(array $config)

No description

Parameters

array $config

Return Value

Mailer

at line 78
static TransportInterface createSymfonyTransport(array $config)

No description

Parameters

array $config

Return Value

TransportInterface

at line 78
static Mailer driver(UnitEnum|string|null $driver = 'null')

No description

Parameters

UnitEnum|string|null $driver

Return Value

Mailer

at line 78
static MailManager extend(string $driver, Closure $callback, bool $poolable = 'false')

No description

Parameters

string $driver
Closure $callback
bool $poolable

Return Value

MailManager

at line 78
static MailManager forgetMailers()

No description

Return Value

MailManager

at line 78
static Container getApplication()

No description

Return Value

Container

at line 78
static string getDefaultDriver()

No description

Return Value

string

at line 78
static array getPoolableDrivers()

No description

Return Value

array

at line 78
static Closure|null getReleaseCallback(string $driver)

No description

Parameters

string $driver

Return Value

Closure|null

at line 78
static Mailer mailer(UnitEnum|string|null $name = 'null')

No description

Parameters

UnitEnum|string|null $name

Return Value

Mailer

at line 78
static void purge(UnitEnum|string|null $name = 'null')

No description

Parameters

UnitEnum|string|null $name

Return Value

void

at line 78
static MailManager removePoolableDriver(string $driver)

No description

Parameters

string $driver

Return Value

MailManager

at line 78
static MailManager setApplication(Container $app)

No description

Parameters

Container $app

Return Value

MailManager

at line 78
static void setDefaultDriver(UnitEnum|string $name)

No description

Parameters

UnitEnum|string $name

Return Value

void

at line 78
static MailManager setPoolableDrivers(array $poolableDrivers)

No description

Parameters

array $poolableDrivers

Return Value

MailManager

at line 78
static MailManager setReleaseCallback(string $driver, Closure $callback)

No description

Parameters

string $driver
Closure $callback

Return Value

MailManager

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

No description

Parameters

string $address
string|null $name

Return Value

void

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

No description

Parameters

string $address
string|null $name

Return Value

void

at line 78
static void alwaysReturnPath(string $address)

No description

Parameters

string $address

Return Value

void

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

No description

Parameters

string $address
string|null $name

Return Value

void

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

No description

Parameters

mixed $users
string|null $name

Return Value

PendingMail

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

No description

Parameters

mixed $users
string|null $name

Return Value

PendingMail

at line 78
static void flushMacros()

No description

Return Value

void

at line 78
static void flushState()

No description

Return Value

void

at line 78
static TransportInterface getSymfonyTransport()

No description

Return Value

TransportInterface

at line 78
static Factory getViewFactory()

No description

Return Value

Factory

at line 78
static bool hasMacro(string $name)

No description

Parameters

string $name

Return Value

bool

at line 78
static SentMessage|null html(string $html, Closure|string $callback)

No description

Parameters

string $html
Closure|string $callback

Return Value

SentMessage|null

at line 78
static mixed later(DateTimeInterface|int $delay, Mailable|array|string $view, UnitEnum|string|null $queue = 'null')

No description

Parameters

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

Return Value

mixed

at line 78
static mixed laterOn(UnitEnum|string $queue, DateTimeInterface|int $delay, Mailable $view)

No description

Parameters

UnitEnum|string $queue
DateTimeInterface|int $delay
Mailable $view

Return Value

mixed

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

No description

Parameters

string $name
callable|object $macro

Return Value

void

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

No description

Parameters

object $mixin
bool $replace

Return Value

void

at line 78
static mixed onQueue(UnitEnum|string|null $queue, Mailable $view)

No description

Parameters

UnitEnum|string|null $queue
Mailable $view

Return Value

mixed

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

No description

Parameters

string $view
array $data
Closure|string $callback

Return Value

SentMessage|null

at line 78
static mixed queue(Mailable|array|string $view, UnitEnum|string|null $queue = 'null')

No description

Parameters

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

Return Value

mixed

at line 78
static mixed queueOn(UnitEnum|string $queue, Mailable $view)

No description

Parameters

UnitEnum|string $queue
Mailable $view

Return Value

mixed

at line 78
static SentMessage|null raw(string $text, Closure|string $callback)

No description

Parameters

string $text
Closure|string $callback

Return Value

SentMessage|null

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

No description

Parameters

Closure|array|string $view
array $data

Return Value

string

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

No description

Parameters

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

Return Value

SentMessage|null

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

No description

Parameters

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

Return Value

SentMessage|null

at line 78
static Mailer setQueue(Factory $queue)

No description

Parameters

Factory $queue

Return Value

Mailer

at line 78
static void setSymfonyTransport(TransportInterface $transport)

No description

Parameters

TransportInterface $transport

Return Value

void

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

No description

Parameters

mixed $users
string|null $name

Return Value

PendingMail

at line 78
static void assertNothingOutgoing()

No description

Return Value

void

at line 78
static void assertNothingQueued()

No description

Return Value

void

at line 78
static void assertNothingSent()

No description

Return Value

void

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

No description

Parameters

Closure|string $mailable
callable|null $callback

Return Value

void

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

No description

Parameters

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

Return Value

void

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

No description

Parameters

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

Return Value

void

at line 78
static void assertOutgoingCount(int $count)

No description

Parameters

int $count

Return Value

void

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

No description

Parameters

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

Return Value

void

at line 78
static void assertQueuedCount(int $count)

No description

Parameters

int $count

Return Value

void

at line 78
static void assertQueuedOnce(string $mailable)

No description

Parameters

string $mailable

Return Value

void

at line 78
static void assertQueuedTimes(string $mailable, int $times = '1')

No description

Parameters

string $mailable
int $times

Return Value

void

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

No description

Parameters

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

Return Value

void

at line 78
static void assertSentCount(int $count)

No description

Parameters

int $count

Return Value

void

at line 78
static void assertSentOnce(string $mailable)

No description

Parameters

string $mailable

Return Value

void

at line 78
static void assertSentTimes(string $mailable, int $times = '1')

No description

Parameters

string $mailable
int $times

Return Value

void

at line 78
static bool hasQueued(string $mailable)

No description

Parameters

string $mailable

Return Value

bool

at line 78
static bool hasSent(string $mailable)

No description

Parameters

string $mailable

Return Value

bool

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

No description

Parameters

Closure|string $mailable
callable|null $callback

Return Value

Collection

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

No description

Parameters

Closure|string $mailable
callable|null $callback

Return Value

Collection