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
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

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 Mailer

driver(string|null $driver = null)

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 mixed

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

No description

static mixed

onQueue(string $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|int|null $callback = null)

No description

static void

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

No description

static void

assertNotSent(Closure $mailable, callable|null $callback = null)

No description

static void

assertNothingOutgoing()

No description

static void

assertNothingSent()

No description

static void

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

No description

static void

assertNotQueued(Closure $mailable, callable|null $callback = null)

No description

static void

assertNothingQueued()

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

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

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

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

Return Value

bool

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(string $name)

Resolve the facade root instance from the container.

Parameters

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

Get the application default aliases.

Return Value

Collection

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 Mailer driver(string|null $driver = null)

No description

Parameters

string|null

$driver

Return Value

Mailer

static TransportInterface createSymfonyTransport(array $config)

No description

Parameters

array

$config

Return Value

TransportInterface

static string getDefaultDriver()

No description

Return Value

string

static void setDefaultDriver(string $name)

No description

Parameters

string

$name

Return Value

void

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

No description

Parameters

string|null

$name

Return Value

void

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

No description

Parameters

string	$driver
Closure	$callback

Return Value

MailManager

static Application getApplication()

No description

Return Value

Application

static MailManager setApplication(Application $app)

No description

Parameters

Application

$app

Return Value

MailManager

static MailManager forgetMailers()

No description

Return Value

MailManager

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

No description

Parameters

mixed	$users
string\|null	$name

Return Value

PendingMail

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

No description

Parameters

mixed	$users
string\|null	$name

Return Value

PendingMail

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

No description

Parameters

mixed	$users
string\|null	$name

Return Value

PendingMail

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

No description

Parameters

string	$html
mixed	$callback

Return Value

SentMessage|null

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

No description

Parameters

string	$text
mixed	$callback

Return Value

SentMessage|null

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

No description

Parameters

string	$view
array	$data
mixed	$callback

Return Value

SentMessage|null

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

No description

Parameters

string\|array	$view
array	$data

Return Value

string

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

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

No description

Parameters

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

Return Value

mixed

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

No description

Parameters

string	$queue
Mailable	$view

Return Value

mixed

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

No description

Parameters

string	$queue
Mailable	$view

Return Value

mixed

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

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

No description

Parameters

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

Return Value

mixed

static TransportInterface getSymfonyTransport()

No description

Return Value

TransportInterface

static Factory getViewFactory()

No description

Return Value

Factory

static void setSymfonyTransport(TransportInterface $transport)

No description

Parameters

TransportInterface

$transport

Return Value

void

static Mailer setQueue(Factory $queue)

No description

Parameters

Factory

$queue

Return Value

Mailer

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

No description

Parameters

string	$name
object\|callable	$macro

Return Value

void

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

No description

Parameters

object	$mixin
bool	$replace

Return Value

void

static bool hasMacro(string $name)

No description

Parameters

string

$name

Return Value

bool

static void flushMacros()

No description

Return Value

void

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

No description

Parameters

Closure	$mailable
callable\|int\|null	$callback

Return Value

void

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

No description

Parameters

Closure	$mailable
callable\|null	$callback

Return Value

void

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

No description

Parameters

Closure	$mailable
callable\|null	$callback

Return Value

void

static void assertNothingOutgoing()

No description

Return Value

void

static void assertNothingSent()

No description

Return Value

void

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

No description

Parameters

Closure	$mailable
callable\|int\|null	$callback

Return Value

void

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

No description

Parameters

Closure	$mailable
callable\|null	$callback

Return Value

void

static void assertNothingQueued()

No description

Return Value

void

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

No description

Parameters

Closure	$mailable
callable\|null	$callback

Return Value

Collection

static bool hasSent(string $mailable)

No description

Parameters

string

$mailable

Return Value

bool

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

No description

Parameters

Closure	$mailable
callable\|null	$callback

Return Value

Collection

static bool hasQueued(string $mailable)

No description

Parameters

string

$mailable

Return Value

bool

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