class SendQueuedMailable (View source)

Traits

Properties

string|null $connection

The name of the connection the job should be sent to.

from  Queueable
string|null $queue

The name of the queue the job should be sent to.

from  Queueable
string|null $chainConnection

The name of the connection the chain should be sent to.

from  Queueable
string|null $chainQueue

The name of the queue the chain should be sent to.

from  Queueable
array|null $chainCatchCallbacks

The callbacks to be executed on chain failure.

from  Queueable
DateTimeInterface|DateInterval|int|null $delay

The number of seconds before the job should be made available.

from  Queueable
bool|null $afterCommit

Indicates whether the job should be dispatched after all database transactions have committed.

from  Queueable
array $middleware

The middleware the job should be dispatched through.

from  Queueable
array $chained

The jobs that should run if this job is successful.

from  Queueable
Mailable $mailable

The mailable message instance.

int $tries

The number of times the job may be attempted.

int $timeout

The number of seconds the job can run before timing out.

bool $shouldBeEncrypted

Indicates if the job should be encrypted.

Methods

$this
onConnection(string|null $connection)

Set the desired connection for the job.

$this
onQueue(string|null $queue)

Set the desired queue for the job.

$this
allOnConnection(string|null $connection)

Set the desired connection for the chain.

$this
allOnQueue(string|null $queue)

Set the desired queue for the chain.

$this
delay(DateTimeInterface|DateInterval|int|null $delay)

Set the desired delay in seconds for the job.

$this
afterCommit()

Indicate that the job should be dispatched after all database transactions have committed.

$this
beforeCommit()

Indicate that the job should not wait until database transactions have been committed before dispatching.

$this
through(array|object $middleware)

Specify the middleware the job should be dispatched through.

$this
chain(array $chain)

Set the jobs that should run if this job is successful.

string
serializeJob(mixed $job)

Serialize a job for queuing.

void
dispatchNextJobInChain()

Dispatch the next job on the chain.

void
invokeChainCatchCallbacks(Throwable $e)

Invoke all of the chain's failed job callbacks.

void
__construct(Mailable $mailable)

Create a new job instance.

void
handle(Factory $factory)

Handle the queued job.

mixed
backoff()

Get the number of seconds before a released mailable will be available.

DateTime|null
retryUntil()

Determine the time at which the job should timeout.

void
failed(Throwable $e)

Call the failed method on the mailable instance.

string
displayName()

Get the display name for the queued job.

void
__clone()

Prepare the instance for cloning.

Details

$this onConnection(string|null $connection)

Set the desired connection for the job.

Parameters

string|null $connection

Return Value

$this

$this onQueue(string|null $queue)

Set the desired queue for the job.

Parameters

string|null $queue

Return Value

$this

$this allOnConnection(string|null $connection)

Set the desired connection for the chain.

Parameters

string|null $connection

Return Value

$this

$this allOnQueue(string|null $queue)

Set the desired queue for the chain.

Parameters

string|null $queue

Return Value

$this

$this delay(DateTimeInterface|DateInterval|int|null $delay)

Set the desired delay in seconds for the job.

Parameters

DateTimeInterface|DateInterval|int|null $delay

Return Value

$this

$this afterCommit()

Indicate that the job should be dispatched after all database transactions have committed.

Return Value

$this

$this beforeCommit()

Indicate that the job should not wait until database transactions have been committed before dispatching.

Return Value

$this

$this through(array|object $middleware)

Specify the middleware the job should be dispatched through.

Parameters

array|object $middleware

Return Value

$this

$this chain(array $chain)

Set the jobs that should run if this job is successful.

Parameters

array $chain

Return Value

$this

protected string serializeJob(mixed $job)

Serialize a job for queuing.

Parameters

mixed $job

Return Value

string

Exceptions

RuntimeException

void dispatchNextJobInChain()

Dispatch the next job on the chain.

Return Value

void

void invokeChainCatchCallbacks(Throwable $e)

Invoke all of the chain's failed job callbacks.

Parameters

Throwable $e

Return Value

void

void __construct(Mailable $mailable)

Create a new job instance.

Parameters

Mailable $mailable

Return Value

void

void handle(Factory $factory)

Handle the queued job.

Parameters

Factory $factory

Return Value

void

mixed backoff()

Get the number of seconds before a released mailable will be available.

Return Value

mixed

DateTime|null retryUntil()

Determine the time at which the job should timeout.

Return Value

DateTime|null

void failed(Throwable $e)

Call the failed method on the mailable instance.

Parameters

Throwable $e

Return Value

void

string displayName()

Get the display name for the queued job.

Return Value

string

void __clone()

Prepare the instance for cloning.

Return Value

void