SendQueuedMailable

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\|array\|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
Job\|null	$job	The underlying queue job instance.	from InteractsWithQueue
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.
$maxExceptions	The maximum number of unhandled exceptions to allow before failing.
bool	$shouldBeEncrypted	Indicates if the job should be encrypted.

Methods

$this

onConnection(string|null $connection)

Set the desired connection for the job.

from Queueable

$this

onQueue(string|null $queue)

Set the desired queue for the job.

from Queueable

$this

allOnConnection(string|null $connection)

Set the desired connection for the chain.

from Queueable

$this

allOnQueue(string|null $queue)

Set the desired queue for the chain.

from Queueable

$this

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

Set the desired delay in seconds for the job.

from Queueable

$this

afterCommit()

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

from Queueable

$this

beforeCommit()

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

from Queueable

$this

through(array|object $middleware)

Specify the middleware the job should be dispatched through.

from Queueable

$this

chain(array $chain)

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

from Queueable

$this

prependToChain(mixed $job)

Prepend a job to the current chain so that it is run after the currently running job.

from Queueable

$this

appendToChain(mixed $job)

Append a job to the end of the current chain.

from Queueable

string

serializeJob(mixed $job)

Serialize a job for queuing.

from Queueable

void

dispatchNextJobInChain()

Dispatch the next job on the chain.

from Queueable

void

invokeChainCatchCallbacks(Throwable $e)

Invoke all of the chain's failed job callbacks.

from Queueable

int

secondsUntil(DateTimeInterface|DateInterval|int $delay)

Get the number of seconds until the given DateTime.

from InteractsWithTime

int

availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Get the "available at" UNIX timestamp.

from InteractsWithTime

DateTimeInterface|int

parseDateInterval(DateTimeInterface|DateInterval|int $delay)

If the given value is an interval, convert it to a DateTime instance.

from InteractsWithTime

int

currentTime()

Get the current system time as a UNIX timestamp.

from InteractsWithTime

int

attempts()

Get the number of times the job has been attempted.

from InteractsWithQueue

void

delete()

Delete the job from the queue.

from InteractsWithQueue

void

fail(Throwable|string|null $exception = null)

Fail the job from the queue.

from InteractsWithQueue

void

release(DateTimeInterface|DateInterval|int $delay = 0)

Release the job back into the queue after (n) seconds.

from InteractsWithQueue

$this

setJob(Job $job)

Set the base queue job instance.

from InteractsWithQueue

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|array|int|null $delay)

Set the desired delay in seconds for the job.

Parameters

DateTimeInterface|DateInterval|array|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

$this prependToChain(mixed $job)

Prepend a job to the current chain so that it is run after the currently running job.

Parameters

mixed

$job

Return Value

$this

$this appendToChain(mixed $job)

Append a job to the end of the current chain.

Parameters

mixed

$job

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

Return Value

void

protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)

Get the number of seconds until the given DateTime.

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

int

protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Get the "available at" UNIX timestamp.

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

int

protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

If the given value is an interval, convert it to a DateTime instance.

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

DateTimeInterface|int

protected int currentTime()

Get the current system time as a UNIX timestamp.

Return Value

int

int attempts()

Get the number of times the job has been attempted.

Return Value

int

void delete()

Delete the job from the queue.

Return Value

void

void fail(Throwable|string|null $exception = null)

Fail the job from the queue.

Parameters

Throwable|string|null

$exception

Return Value

void

void release(DateTimeInterface|DateInterval|int $delay = 0)

Release the job back into the queue after (n) seconds.

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

void

$this setJob(Job $job)

Set the base queue job instance.

Parameters

Job

$job

Return Value

$this

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

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

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