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

October\Rain\Mail\Mailer

Source: ~/vendor/october/rain/src/Mail/Mailer.php

Extends:

  • Illuminate\Mail\Mailer

Implements:

  • Illuminate\Contracts\Mail\MailQueue
  • Illuminate\Contracts\Mail\Mailer

Mailer class for sending mail.

Protected properties

protected string $pretendingOriginal

Original driver before pretending.

protected array $emitterSingleEventCollection

Collection of registered events to be fired once only.

protected array $emitterEventCollection

Collection of registered events.

protected array $emitterEventSorted

Sorted collection of events.

Show inherited protected properties

Inherited protected properties

  • protected Illuminate\Contracts\View\Factory $views - defined in Illuminate\Mail\Mailer. The view factory instance.
  • protected Swift_Mailer $swift - defined in Illuminate\Mail\Mailer. The Swift Mailer instance.
  • protected Illuminate\Contracts\Events\Dispatcher|null $events - defined in Illuminate\Mail\Mailer. The event dispatcher instance.
  • protected array $from - defined in Illuminate\Mail\Mailer. The global from address and name.
  • protected array $replyTo - defined in Illuminate\Mail\Mailer. The global reply-to address and name.
  • protected array $to - defined in Illuminate\Mail\Mailer. The global to address and name.
  • protected Illuminate\Contracts\Queue\Queue $queue - defined in Illuminate\Mail\Mailer. The queue implementation.
  • protected array $failedRecipients - defined in Illuminate\Mail\Mailer. Array of failed recipients.
  • protected static array $macros - defined in Illuminate\Mail\Mailer. The registered string macros.

Public methods

public self bindEvent($event, $callback, $priority=0)

Create a new event binding.

Parameters
  • $event
  • $callback
  • $priority

public self bindEventOnce($event, $callback)

Create a new event binding that fires once only

Parameters
  • $event
  • $callback

public array fireEvent(string $event, array $params=array(), boolean $halt=false)

Fire an event and call the listeners.

Parameters
  • string $event - Event name
  • array $params - Event parameters
  • boolean $halt - Halt after first non-null result

public mixed later(int $delay, string|array $view, array $data=NULL, Closure|string $callback=NULL, string|null $queue=NULL)

Queue a new e-mail message for sending after (n) seconds.

Parameters
  • int $delay
  • string|array $view
  • array $data
  • Closure|string $callback
  • string|null $queue

public mixed laterOn(string $queue, int $delay, string|array $view, array $data=NULL, Closure|string $callback=NULL)

Queue a new e-mail message for sending after (n) seconds on the given queue.

Parameters
  • string $queue
  • int $delay
  • string|array $view
  • array $data
  • Closure|string $callback

public void pretend(bool $value=true)

Tell the mailer to not really send messages.

Parameters
  • bool $value

public mixed queue(string|array $view, array $data=NULL, Closure|string $callback=NULL, string|null $queue=NULL)

Queue a new e-mail message for sending.

Parameters
  • string|array $view
  • array $data
  • Closure|string $callback
  • string|null $queue

public mixed queueOn(string $queue, string|array $view, array $data=NULL, Closure|string $callback=NULL)

Queue a new e-mail message for sending on the given queue.

Parameters
  • string $queue
  • string|array $view
  • array $data
  • Closure|string $callback

public int raw(string $text, mixed $callback)

Send a new message when only a raw text part.

Parameters
  • string $text
  • mixed $callback

public int rawTo(array $recipients, string $view, mixed $callback=NULL, array $options=array())

Helper for raw() method, send a new message when only a raw text part.

Parameters
  • array $recipients
  • string $view
  • mixed $callback
  • array $options

public mixed send(string|array $view, array $data=array(), Closure|string $callback=NULL)

Send a new message using a view.

Parameters
  • string|array $view
  • array $data
  • Closure|string $callback

public void sendTo(array $recipients, string|array $view, array $data=array(), mixed $callback=NULL, array $options=array())

Helper for send() method, the first argument can take a single email or an array of recipients where the key is the address and the value is the name.

Parameters
  • array $recipients
  • string|array $view
  • array $data
  • mixed $callback
  • array $options

public self unbindEvent(string $event=NULL)

Destroys an event binding.

Parameters
  • string $event - Event to destroy

Show inherited public methods

Inherited public methods

  • public mixed __call(string $method, array $parameters) - defined in Illuminate\Mail\Mailer. Dynamically handle calls to the class.
  • public static mixed __callStatic(string $method, array $parameters) - defined in Illuminate\Mail\Mailer. Dynamically handle calls to the class.
  • public void __construct(Illuminate\Contracts\View\Factory $views, Swift_Mailer $swift, Illuminate\Contracts\Events\Dispatcher|null $events=NULL) - defined in Illuminate\Mail\Mailer. Create a new Mailer instance.
  • public void alwaysFrom(string $address, string|null $name=NULL) - defined in Illuminate\Mail\Mailer. Set the global from address and name.
  • public void alwaysReplyTo(string $address, string|null $name=NULL) - defined in Illuminate\Mail\Mailer. Set the global reply-to address and name.
  • public void alwaysTo(string $address, string|null $name=NULL) - defined in Illuminate\Mail\Mailer. Set the global to address and name.
  • public Illuminate\Mail\PendingMail bcc(mixed $users) - defined in Illuminate\Mail\Mailer. Begin the process of mailing a mailable class instance.
  • public array failures() - defined in Illuminate\Mail\Mailer. Get the array of failed recipients.
  • public Swift_Mailer getSwiftMailer() - defined in Illuminate\Mail\Mailer. Get the Swift Mailer instance.
  • public Illuminate\Contracts\View\Factory getViewFactory() - defined in Illuminate\Mail\Mailer. Get the view factory instance.
  • public static bool hasMacro(string $name) - defined in Illuminate\Mail\Mailer. Checks if macro is registered.
  • public static void macro(string $name, object|callable $macro) - defined in Illuminate\Mail\Mailer. Register a custom macro.
  • public static void mixin(object $mixin) - defined in Illuminate\Mail\Mailer. Mix another object into the class.
  • public mixed onQueue(string $queue, string|array $view) - defined in Illuminate\Mail\Mailer. Queue a new e-mail message for sending on the given queue.
  • public void plain(string $view, array $data, mixed $callback) - defined in Illuminate\Mail\Mailer. Send a new message when only a plain part.
  • public string render(string|array $view, array $data=array()) - defined in Illuminate\Mail\Mailer. Render the given message as a view.
  • public $this setQueue(Illuminate\Contracts\Queue\Factory $queue) - defined in Illuminate\Mail\Mailer. Set the queue manager instance.
  • public void setSwiftMailer(Swift_Mailer $swift) - defined in Illuminate\Mail\Mailer. Set the Swift Mailer instance.
  • public Illuminate\Mail\PendingMail to(mixed $users) - defined in Illuminate\Mail\Mailer. Begin the process of mailing a mailable class instance.

Protected methods

protected void addContent(Illuminate\Mail\Message $message, string $view, string $plain, string $raw, array $data)

Add the content to a given message.

Parameters
  • Illuminate\Mail\Message $message
  • string $view
  • string $plain
  • string $raw
  • array $data

protected void addContentRaw(Illuminate\Mail\Message $message, string $html, string $text)

Add the raw content to a given message.

Parameters
  • Illuminate\Mail\Message $message
  • string $html
  • string $text

protected mixed buildQueueMailable(mixed $callback, $data, $callback)

Build the mailable for a queued e-mail job.

Parameters
  • mixed $callback
  • $data
  • $callback

protected array emitterEventSortEvents(string $eventName)

Sort the listeners for a given event by priority.

Parameters
  • string $eventName

protected array processRecipients(mixed $recipients)

Process a recipients object, which can look like the following:

  • (string) admin@domain.tld
  • (object) ['email' => 'admin@domain.tld', 'name' => 'Adam Person']
  • (array) ['admin@domain.tld' => 'Adam Person', ...]
  • (array) [ (object|array) ['email' => 'admin@domain.tld', 'name' => 'Adam Person'], [...] ]
Parameters
  • mixed $recipients

Show inherited protected methods

Inherited protected methods

  • protected Illuminate\Mail\Message createMessage() - defined in Illuminate\Mail\Mailer. Create a new message instance.
  • protected void dispatchSentEvent(Illuminate\Mail\Message $message) - defined in Illuminate\Mail\Mailer. Dispatch the message sent event.
  • protected void forceReconnection() - defined in Illuminate\Mail\Mailer. Force the transport to re-connect.
  • protected array parseView(string|array $view) - defined in Illuminate\Mail\Mailer. Parse the given view name or array.
  • protected string renderView(string $view, array $data) - defined in Illuminate\Mail\Mailer. Render the given view.
  • protected mixed sendMailable(Illuminate\Contracts\Mail\Mailable $mailable) - defined in Illuminate\Mail\Mailer. Send the given mailable.
  • protected void sendSwiftMessage(Swift_Message $message) - defined in Illuminate\Mail\Mailer. Send a Swift Message instance.
  • protected void setGlobalTo(Illuminate\Mail\Message $message) - defined in Illuminate\Mail\Mailer. Set the global "to" address on the given message.
  • protected bool shouldSendMessage(Swift_Message $message) - defined in Illuminate\Mail\Mailer. Determines if the message can be sent.