1. Documentation
  2. API
  3. Library
  4. Mail
  5. Mailable

October\Rain\Mail\Mailable

Extends:

  • Illuminate\Mail\Mailable

Implements:

  • Illuminate\Contracts\Support\Renderable
  • Illuminate\Contracts\Mail\Mailable

Generic mailable class.

Public properties

public string|null $connection

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

public string|null $queue

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

public string|null $chainConnection

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

public string|null $chainQueue

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

public DateTimeInterface|\DateInterval|int|null $delay

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

public $middleware

The middleware the job should be dispatched through.

public array $chained

The jobs that should run if this job is successful.

Show inherited public properties

Inherited public properties

  • public string $locale - defined in Illuminate\Mail\Mailable. The locale of the message.
  • public array $from - defined in Illuminate\Mail\Mailable. The person the message is from.
  • public array $to - defined in Illuminate\Mail\Mailable. The "to" recipients of the message.
  • public array $cc - defined in Illuminate\Mail\Mailable. The "cc" recipients of the message.
  • public array $bcc - defined in Illuminate\Mail\Mailable. The "bcc" recipients of the message.
  • public array $replyTo - defined in Illuminate\Mail\Mailable. The "reply to" recipients of the message.
  • public string $subject - defined in Illuminate\Mail\Mailable. The subject of the message.
  • public string $view - defined in Illuminate\Mail\Mailable. The view to use for the message.
  • public string $textView - defined in Illuminate\Mail\Mailable. The plain text view to use for the message.
  • public array $viewData - defined in Illuminate\Mail\Mailable. The view data for the message.
  • public array $attachments - defined in Illuminate\Mail\Mailable. The attachments for the message.
  • public array $rawAttachments - defined in Illuminate\Mail\Mailable. The raw attachments for the message.
  • public array $diskAttachments - defined in Illuminate\Mail\Mailable. The attachments from a storage disk.
  • public array $callbacks - defined in Illuminate\Mail\Mailable. The callbacks for the message.
  • public static callable $viewDataCallback - defined in Illuminate\Mail\Mailable. The callback that should be invoked while building the view data.

Protected properties

There are no protected properties in the class.

Show inherited protected properties

Inherited protected properties

  • protected string $markdown - defined in Illuminate\Mail\Mailable. The Markdown template for the message (if applicable).
  • protected string $html - defined in Illuminate\Mail\Mailable. The HTML to use for the message.

Public methods

public array __serialize()

Prepare the instance values for serialization.

public array __sleep()

Prepare the instance for serialization.

public array __unserialize(array $values)

Restore the model after serialization.

Parameters
  • array $values

public void __wakeup()

Restore the model after serialization.

public $this allOnConnection(string|null $connection)

Set the desired connection for the chain.

Parameters
  • string|null $connection

public $this allOnQueue(string|null $queue)

Set the desired queue for the chain.

Parameters
  • string|null $queue

public $this build()

Build the message.

public array buildViewData()

Build the view data for the message.

public $this chain(array $chain)

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

Parameters
  • array $chain

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

Set the desired delay for the job.

Parameters
  • DateTimeInterface|\DateInterval|int|null $delay

public void dispatchNextJobInChain()

Dispatch the next job on the chain.

public array middleware()

Get the middleware the job should be dispatched through.

public $this onConnection(string|null $connection)

Set the desired connection for the job.

Parameters
  • string|null $connection

public $this onQueue(string|null $queue)

Set the desired queue for the job.

Parameters
  • string|null $queue

public Illuminate\Database\Eloquent\Model restoreModel(Illuminate\Contracts\Database\ModelIdentifier $value)

Restore the model from the model identifier instance.

Parameters
  • Illuminate\Contracts\Database\ModelIdentifier $value

public $this through(array|object $middleware)

Specify the middleware the job should be dispatched through.

Parameters
  • array|object $middleware

public $this withSerializedData(array $data)

Set serialized view data for the message.

Parameters
  • array $data

Show inherited public methods

Inherited public methods

  • public $this __call(string $method, array $parameters) - defined in Illuminate\Mail\Mailable. Dynamically bind parameters to the message.
  • public $this attach(string $file, array $options=array()) - defined in Illuminate\Mail\Mailable. Attach a file to the message.
  • public $this attachData(string $data, string $name, array $options=array()) - defined in Illuminate\Mail\Mailable. Attach in-memory data as an attachment.
  • public $this attachFromStorage(string $path, string|null $name=NULL, array $options=array()) - defined in Illuminate\Mail\Mailable. Attach a file to the message from storage.
  • public $this attachFromStorageDisk(string $disk, string $path, string|null $name=NULL, array $options=array()) - defined in Illuminate\Mail\Mailable. Attach a file to the message from storage.
  • public $this bcc(object|array|string $address, string|null $name=NULL) - defined in Illuminate\Mail\Mailable. Set the recipients of the message.
  • public static void buildViewDataUsing(callable $callback) - defined in Illuminate\Mail\Mailable. Register a callback to be called while building the view data.
  • public $this cc(object|array|string $address, string|null $name=NULL) - defined in Illuminate\Mail\Mailable. Set the recipients of the message.
  • public $this from(object|array|string $address, string|null $name=NULL) - defined in Illuminate\Mail\Mailable. Set the sender of the message.
  • public bool hasBcc(object|array|string $address, string|null $name=NULL) - defined in Illuminate\Mail\Mailable. Determine if the given recipient is set on the mailable.
  • public bool hasCc(object|array|string $address, string|null $name=NULL) - defined in Illuminate\Mail\Mailable. Determine if the given recipient is set on the mailable.
  • public bool hasFrom(object|array|string $address, string|null $name=NULL) - defined in Illuminate\Mail\Mailable. Determine if the given recipient is set on the mailable.
  • public bool hasReplyTo(object|array|string $address, string|null $name=NULL) - defined in Illuminate\Mail\Mailable. Determine if the given replyTo is set on the mailable.
  • public bool hasTo(object|array|string $address, string|null $name=NULL) - defined in Illuminate\Mail\Mailable. Determine if the given recipient is set on the mailable.
  • public $this html(string $html) - defined in Illuminate\Mail\Mailable. Set the rendered HTML content for the message.
  • public mixed later(DateTimeInterface|\DateInterval|int $delay, Illuminate\Contracts\Queue\Factory $queue) - defined in Illuminate\Mail\Mailable. Deliver the queued message after the given delay.
  • public $this locale(string $locale) - defined in Illuminate\Mail\Mailable. Set the locale of the message.
  • public $this markdown(string $view, array $data=array()) - defined in Illuminate\Mail\Mailable. Set the Markdown template for the message.
  • public $this priority(int $level=3) - defined in Illuminate\Mail\Mailable. Set the priority of this message.
  • public mixed queue(Illuminate\Contracts\Queue\Factory $queue) - defined in Illuminate\Mail\Mailable. Queue the message for sending.
  • public string render() - defined in Illuminate\Mail\Mailable. Render the mailable into a view.
  • public $this replyTo(object|array|string $address, string|null $name=NULL) - defined in Illuminate\Mail\Mailable. Set the "reply to" address of the message.
  • public void send(Illuminate\Contracts\Mail\Mailer $mailer) - defined in Illuminate\Mail\Mailable. Send the message using the given mailer.
  • public $this subject(string $subject) - defined in Illuminate\Mail\Mailable. Set the subject of the message.
  • public $this text(string $textView, array $data=array()) - defined in Illuminate\Mail\Mailable. Set the plain text view for the message.
  • public $this to(object|array|string $address, string|null $name=NULL) - defined in Illuminate\Mail\Mailable. Set the recipients of the message.
  • public $this view(string $view, array $data=array()) - defined in Illuminate\Mail\Mailable. Set the view and view data for the message.
  • public $this with(string|array $key, mixed $value=NULL) - defined in Illuminate\Mail\Mailable. Set the view data for the message.
  • public mixed withLocale(string $locale, Closure $callback) - defined in Illuminate\Mail\Mailable. Run the callback with the given locale.
  • public $this withSwiftMessage(callable $callback) - defined in Illuminate\Mail\Mailable. Register a callback to be called with the Swift message instance.

Protected methods

protected $this buildSubject(Illuminate\Mail\Message $message)

Set the subject for the message.

Parameters
  • Illuminate\Mail\Message $message

protected mixed getPropertyValue(ReflectionProperty $property)

Get the property value for the given property.

Parameters
  • ReflectionProperty $property

protected Illuminate\Database\Eloquent\Builder getQueryForModelRestoration(Illuminate\Database\Eloquent\Model $model, array|int $ids)

Get the query for model restoration.

Parameters
  • Illuminate\Database\Eloquent\Model $model
  • array|int $ids

protected mixed getRestoredPropertyValue(mixed $value)

Get the restored property value after deserialization.

Parameters
  • mixed $value

protected mixed getSerializedPropertyValue(mixed $value)

Get the property value prepared for serialization.

Parameters
  • mixed $value

protected Illuminate\Database\Eloquent\Collection restoreCollection(Illuminate\Contracts\Database\ModelIdentifier $value)

Restore a queueable collection instance.

Parameters
  • Illuminate\Contracts\Database\ModelIdentifier $value

Show inherited protected methods

Inherited protected methods

  • protected array addressesToArray(object|array|string $address, string|null $name) - defined in Illuminate\Mail\Mailable. Convert the given recipient arguments to an array.
  • protected $this buildAttachments(Illuminate\Mail\Message $message) - defined in Illuminate\Mail\Mailable. Add all of the attachments to the message.
  • protected void buildDiskAttachments(Illuminate\Mail\Message $message) - defined in Illuminate\Mail\Mailable. Add all of the disk attachments to the message.
  • protected $this buildFrom(Illuminate\Mail\Message $message) - defined in Illuminate\Mail\Mailable. Add the sender to the message.
  • protected string buildMarkdownText(Illuminate\Mail\Markdown $markdown, array $data) - defined in Illuminate\Mail\Mailable. Build the text view for a Markdown message.
  • protected array buildMarkdownView() - defined in Illuminate\Mail\Mailable. Build the Markdown view for the message.
  • protected $this buildRecipients(Illuminate\Mail\Message $message) - defined in Illuminate\Mail\Mailable. Add all of the recipients to the message.
  • protected array|string buildView() - defined in Illuminate\Mail\Mailable. Build the view for the message.
  • protected mixed forwardCallTo(mixed $object, string $method, array $parameters) - defined in Illuminate\Mail\Mailable. Forward a method call to the given object.
  • protected bool hasRecipient(object|array|string $address, string|null $name=NULL, string $property='to') - defined in Illuminate\Mail\Mailable. Determine if the given recipient is set on the mailable.
  • protected mixed newQueuedJob() - defined in Illuminate\Mail\Mailable. Make the queued mailable job instance.
  • protected object normalizeRecipient(mixed $recipient) - defined in Illuminate\Mail\Mailable. Convert the given recipient into an object.
  • protected $this runCallbacks(Illuminate\Mail\Message $message) - defined in Illuminate\Mail\Mailable. Run the callbacks for the message.
  • protected $this setAddress(object|array|string $address, string|null $name=NULL, string $property='to') - defined in Illuminate\Mail\Mailable. Set the recipients of the message.
  • protected static void throwBadMethodCallException(string $method) - defined in Illuminate\Mail\Mailable. Throw a bad method call exception for the given method.