platform/api/laravel/Mail/SendQueuedMailable.yaml
2024-09-02 10:44:11 -07:00

133 lines
3.3 KiB
YAML

name: SendQueuedMailable
class_comment: null
dependencies:
- name: Queueable
type: class
source: Illuminate\Bus\Queueable
- name: MailFactory
type: class
source: Illuminate\Contracts\Mail\Factory
- name: MailableContract
type: class
source: Illuminate\Contracts\Mail\Mailable
- name: ShouldBeEncrypted
type: class
source: Illuminate\Contracts\Queue\ShouldBeEncrypted
- name: ShouldQueueAfterCommit
type: class
source: Illuminate\Contracts\Queue\ShouldQueueAfterCommit
- name: InteractsWithQueue
type: class
source: Illuminate\Queue\InteractsWithQueue
properties:
- name: mailable
visibility: public
comment: '# * The mailable message instance.
# *
# * @var \Illuminate\Contracts\Mail\Mailable'
- name: tries
visibility: public
comment: '# * The number of times the job may be attempted.
# *
# * @var int'
- name: timeout
visibility: public
comment: '# * The number of seconds the job can run before timing out.
# *
# * @var int'
- name: maxExceptions
visibility: public
comment: '# * The maximum number of unhandled exceptions to allow before failing.
# *
# * @return int|null'
- name: shouldBeEncrypted
visibility: public
comment: '# * Indicates if the job should be encrypted.
# *
# * @var bool'
methods:
- name: __construct
visibility: public
parameters:
- name: mailable
comment: "# * The mailable message instance.\n# *\n# * @var \\Illuminate\\Contracts\\\
Mail\\Mailable\n# */\n# public $mailable;\n# \n# /**\n# * The number of times\
\ the job may be attempted.\n# *\n# * @var int\n# */\n# public $tries;\n# \n#\
\ /**\n# * The number of seconds the job can run before timing out.\n# *\n# *\
\ @var int\n# */\n# public $timeout;\n# \n# /**\n# * The maximum number of unhandled\
\ exceptions to allow before failing.\n# *\n# * @return int|null\n# */\n# public\
\ $maxExceptions;\n# \n# /**\n# * Indicates if the job should be encrypted.\n\
# *\n# * @var bool\n# */\n# public $shouldBeEncrypted = false;\n# \n# /**\n# *\
\ Create a new job instance.\n# *\n# * @param \\Illuminate\\Contracts\\Mail\\\
Mailable $mailable\n# * @return void"
- name: handle
visibility: public
parameters:
- name: factory
comment: '# * Handle the queued job.
# *
# * @param \Illuminate\Contracts\Mail\Factory $factory
# * @return void'
- name: backoff
visibility: public
parameters: []
comment: '# * Get the number of seconds before a released mailable will be available.
# *
# * @return mixed'
- name: retryUntil
visibility: public
parameters: []
comment: '# * Determine the time at which the job should timeout.
# *
# * @return \DateTime|null'
- name: failed
visibility: public
parameters:
- name: e
comment: '# * Call the failed method on the mailable instance.
# *
# * @param \Throwable $e
# * @return void'
- name: displayName
visibility: public
parameters: []
comment: '# * Get the display name for the queued job.
# *
# * @return string'
- name: __clone
visibility: public
parameters: []
comment: '# * Prepare the instance for cloning.
# *
# * @return void'
traits:
- Illuminate\Bus\Queueable
- Illuminate\Contracts\Queue\ShouldBeEncrypted
- Illuminate\Contracts\Queue\ShouldQueueAfterCommit
- Illuminate\Queue\InteractsWithQueue
- Queueable
interfaces: []