1. class
  2. Illuminate
  3. \
  4. Mail
  5. \
  6. PendingMail

PendingMail

class PendingMail (View source)

Traits

Conditionable

Properties

protected Mailer $mailer

The mailer instance.
protected string $locale

The locale of the message.
protected array $to

The "to" recipients of the message.
protected array $cc

The "cc" recipients of the message.
protected array $bcc

The "bcc" recipients of the message.

Methods

$this|TWhenReturnType
when($value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) truthy.

from  Conditionable
$this|TUnlessReturnType
unless($value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) falsy.

from  Conditionable
__construct(Mailer $mailer)

Create a new mailable mailer instance.

$this
locale(string $locale)

Set the locale of the message.

$this
to(mixed $users)

Set the recipients of the message.

$this
cc(mixed $users)

Set the recipients of the message.

$this
bcc(mixed $users)

Set the recipients of the message.

SentMessage|null
send(Mailable $mailable)

Send a new mailable message instance.

SentMessage|null
sendNow(Mailable $mailable)

Send a new mailable message instance synchronously.

mixed
queue(Mailable $mailable)

Push the given mailable onto the queue.

mixed
later(DateTimeInterface|DateInterval|int $delay, Mailable $mailable)

Deliver the queued message after (n) seconds.

Mailable
fill(Mailable $mailable)

Populate the mailable with the addresses.

Details

in Conditionable at line 21
$this|TWhenReturnType when($value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) truthy.

Parameters

$value
callable|null $callback
callable|null $default

Return Value

$this|TWhenReturnType

in Conditionable at line 53
$this|TUnlessReturnType unless($value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) falsy.

Parameters

$value
callable|null $callback
callable|null $default

Return Value

$this|TUnlessReturnType

at line 54
__construct(Mailer $mailer)

Create a new mailable mailer instance.

Parameters

Mailer $mailer

at line 65
$this locale(string $locale)

Set the locale of the message.

Parameters

string $locale

Return Value

$this

at line 78
$this to(mixed $users)

Set the recipients of the message.

Parameters

mixed $users

Return Value

$this

at line 95
$this cc(mixed $users)

Set the recipients of the message.

Parameters

mixed $users

Return Value

$this

at line 108
$this bcc(mixed $users)

Set the recipients of the message.

Parameters

mixed $users

Return Value

$this

at line 121
SentMessage|null send(Mailable $mailable)

Send a new mailable message instance.

Parameters

Mailable $mailable

Return Value

SentMessage|null

at line 132
SentMessage|null sendNow(Mailable $mailable)

Send a new mailable message instance synchronously.

Parameters

Mailable $mailable

Return Value

SentMessage|null

at line 143
mixed queue(Mailable $mailable)

Push the given mailable onto the queue.

Parameters

Mailable $mailable

Return Value

mixed

at line 155
mixed later(DateTimeInterface|DateInterval|int $delay, Mailable $mailable)

Deliver the queued message after (n) seconds.

Parameters

DateTimeInterface|DateInterval|int $delay
Mailable $mailable

Return Value

mixed

at line 166
protected Mailable fill(Mailable $mailable)

Populate the mailable with the addresses.

Parameters

Mailable $mailable

Return Value

Mailable