1. class
  2. Hypervel
  3. \
  4. Mail
  5. \
  6. Mailer

Mailer

class Mailer implements Mailer, MailQueue

Traits

Macroable

Properties

static protected array $macros

The registered string macros.

 from  Macroable
protected array $from

The global from address and name.
protected array $replyTo

The global reply-to address and name.
protected array $returnPath

The global return path address.
protected array $to

The global to address and name.
protected Factory|null $queue

The queue factory implementation.

Methods

static void
macro(string $name, callable|object $macro)

Register a custom macro.

from  Macroable
static void
mixin(object $mixin, bool $replace = true)

Mix another object into the class.

from  Macroable
static bool
hasMacro(string $name)

Check if macro is registered.

from  Macroable
static void
flushMacros()

Flush the existing macros.

from  Macroable
static mixed
__callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
mixed
__call(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
__construct(string $name, Factory $views, TransportInterface $transport, Dispatcher|null $events = null)

Create a new Mailer instance.

void
alwaysFrom(string $address, string|null $name = null)

Set the global from address and name.

void
alwaysReplyTo(string $address, string|null $name = null)

Set the global reply-to address and name.

void
alwaysReturnPath(string $address)

Set the global return path address.

void
alwaysTo(string $address, string|null $name = null)

Set the global to address and name.

PendingMail
to(mixed $users, string|null $name = null)

Begin the process of mailing a mailable class instance.

PendingMail
cc(mixed $users, string|null $name = null)

Begin the process of mailing a mailable class instance.

PendingMail
bcc(mixed $users, string|null $name = null)

Begin the process of mailing a mailable class instance.

SentMessage|null
html(string $html, Closure|string $callback)

Send a new message with only an HTML part.

SentMessage|null
raw(string $text, Closure|string $callback)

Send a new message with only a raw text part.

SentMessage|null
plain(string $view, array $data, Closure|string $callback)

Send a new message with only a plain part.

string
render(array|Closure|string $view, array $data = [])

Render the given message as a view.

string
replaceEmbeddedAttachments(string $renderedView, array $attachments)

Replace the embedded image attachments with raw, inline image data for browser rendering.

SentMessage|null
send(array|Mailable|string $view, array $data = [], Closure|string|null $callback = null)

Send a new message using a view.

SentMessage|null
sendMailable(Mailable $mailable)

Send the given mailable.

SentMessage|null
sendNow(array|Mailable|string $mailable, array $data = [], Closure|string|null $callback = null)

Send a new message synchronously using a view.

array
parseView(array|Closure|string $view)

Parse the given view name or array.

void
addContent(Message $message, Closure|Htmlable|string|null $view, Closure|Htmlable|string|null $plain, string|null $raw, array $data = [])

Add the content to a given message.

string
renderView(Closure|Htmlable|string $view, array $data)

Render the given view.

void
setGlobalToAndRemoveCcAndBcc(Message $message)

Set the global "to" address on the given message.

mixed
queue(array|Mailable|string $view, UnitEnum|string|null $queue = null)

Queue a new mail message for sending.

mixed
onQueue(UnitEnum|string|null $queue, Mailable $view)

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

mixed
queueOn(UnitEnum|string $queue, Mailable $view)

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

mixed
later(DateInterval|DateTimeInterface|int $delay, array|Mailable|string $view, UnitEnum|string|null $queue = null)

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

mixed
laterOn(UnitEnum|string $queue, DateInterval|DateTimeInterface|int $delay, Mailable $view)

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

Message
createMessage()

Create a new message instance.

SentMessage|null
sendSymfonyMessage(Email $message)

Send a Symfony Email instance.

bool
shouldSendMessage(Email $message, array $data = [])

Determines if the email can be sent.

void
dispatchSentEvent(SentMessage $message, array $data = [])

Dispatch the message sent event.

TransportInterface
getSymfonyTransport()

Get the Symfony Transport instance.

Factory
getViewFactory()

Get the view factory instance.

void
setSymfonyTransport(TransportInterface $transport)

Set the Symfony Transport instance.

Mailer
setQueue(Factory $queue)

Set the queue manager instance.

static void
flushState()

Flush all static state.

Details

in Macroable at line 30
static void macro(string $name, callable|object $macro)

Register a custom macro.

Macros persist in a static property for the worker lifetime and apply to every subsequent call on the macroable class.

Parameters

string $name
callable|object $macro

Return Value

void

in Macroable at line 44
static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

Delegates to macro() for each method; registered macros persist in a static property for the worker lifetime.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

in Macroable at line 61
static bool hasMacro(string $name)

Check if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 72
static void flushMacros()

Flush the existing macros.

Clears worker-wide macros; concurrent coroutines may resolve different methods depending on timing.

Return Value

void

in Macroable at line 83
static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in Macroable at line 108
mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

at line 71
__construct(string $name, Factory $views, TransportInterface $transport, Dispatcher|null $events = null)

Create a new Mailer instance.

Parameters

string $name

the name that is configured for the mailer
Factory $views

the view factory instance
TransportInterface $transport

the Symfony Transport instance
Dispatcher|null $events

the event dispatcher instance

at line 86
void alwaysFrom(string $address, string|null $name = null)

Set the global from address and name.

Mutates the shared Mailer's global from; per-request use races across coroutines and applies the change to every subsequent message.

Parameters

string $address
string|null $name

Return Value

void

at line 98
void alwaysReplyTo(string $address, string|null $name = null)

Set the global reply-to address and name.

Mutates the shared Mailer's global reply-to; per-request use races across coroutines and applies the change to every subsequent message.

Parameters

string $address
string|null $name

Return Value

void

at line 110
void alwaysReturnPath(string $address)

Set the global return path address.

Mutates the shared Mailer's global return path; per-request use races across coroutines and applies the change to every subsequent message.

Parameters

string $address

Return Value

void

at line 123
void alwaysTo(string $address, string|null $name = null)

Set the global to address and name.

Mutates the shared Mailer's global to; once set, Mailer::send() silently redirects every subsequent email across all coroutines to this address. Per-request use is never safe.

Parameters

string $address
string|null $name

Return Value

void

at line 132
PendingMail to(mixed $users, string|null $name = null)

Begin the process of mailing a mailable class instance.

Parameters

mixed $users
string|null $name

Return Value

PendingMail

at line 144
PendingMail cc(mixed $users, string|null $name = null)

Begin the process of mailing a mailable class instance.

Parameters

mixed $users
string|null $name

Return Value

PendingMail

at line 156
PendingMail bcc(mixed $users, string|null $name = null)

Begin the process of mailing a mailable class instance.

Parameters

mixed $users
string|null $name

Return Value

PendingMail

at line 168
SentMessage|null html(string $html, Closure|string $callback)

Send a new message with only an HTML part.

Parameters

string $html
Closure|string $callback

Return Value

SentMessage|null

at line 176
SentMessage|null raw(string $text, Closure|string $callback)

Send a new message with only a raw text part.

Parameters

string $text
Closure|string $callback

Return Value

SentMessage|null

at line 184
SentMessage|null plain(string $view, array $data, Closure|string $callback)

Send a new message with only a plain part.

Parameters

string $view
array $data
Closure|string $callback

Return Value

SentMessage|null

at line 192
string render(array|Closure|string $view, array $data = [])

Render the given message as a view.

Parameters

array|Closure|string $view
array $data

Return Value

string

at line 210
protected string replaceEmbeddedAttachments(string $renderedView, array $attachments)

Replace the embedded image attachments with raw, inline image data for browser rendering.

Parameters

string $renderedView
array $attachments

Return Value

string

at line 234
SentMessage|null send(array|Mailable|string $view, array $data = [], Closure|string|null $callback = null)

Send a new message using a view.

Parameters

array|Mailable|string $view
array $data
Closure|string|null $callback

Return Value

SentMessage|null

at line 285
protected SentMessage|null sendMailable(Mailable $mailable)

Send the given mailable.

Parameters

Mailable $mailable

Return Value

SentMessage|null

at line 300
SentMessage|null sendNow(array|Mailable|string $mailable, array $data = [], Closure|string|null $callback = null)

Send a new message synchronously using a view.

Parameters

array|Mailable|string $mailable
array $data
Closure|string|null $callback

Return Value

SentMessage|null

at line 312
protected array parseView(array|Closure|string $view)

Parse the given view name or array.

Parameters

array|Closure|string $view

Return Value

array

Exceptions

InvalidArgumentException

at line 338
protected void addContent(Message $message, Closure|Htmlable|string|null $view, Closure|Htmlable|string|null $plain, string|null $raw, array $data = [])

Add the content to a given message.

Parameters

Message $message
Closure|Htmlable|string|null $view
Closure|Htmlable|string|null $plain
string|null $raw
array $data

Return Value

void

at line 356
protected string renderView(Closure|Htmlable|string $view, array $data)

Render the given view.

Parameters

Closure|Htmlable|string $view
array $data

Return Value

string

at line 368
protected void setGlobalToAndRemoveCcAndBcc(Message $message)

Set the global "to" address on the given message.

Parameters

Message $message

Return Value

void

at line 383
mixed queue(array|Mailable|string $view, UnitEnum|string|null $queue = null)

Queue a new mail message for sending.

Parameters

array|Mailable|string $view
UnitEnum|string|null $queue

Return Value

mixed

Exceptions

InvalidArgumentException

at line 400
mixed onQueue(UnitEnum|string|null $queue, Mailable $view)

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

Parameters

UnitEnum|string|null $queue
Mailable $view

Return Value

mixed

at line 410
mixed queueOn(UnitEnum|string $queue, Mailable $view)

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

This method didn't match rest of framework's "onQueue" phrasing. Added "onQueue".

Parameters

UnitEnum|string $queue
Mailable $view

Return Value

mixed

at line 420
mixed later(DateInterval|DateTimeInterface|int $delay, array|Mailable|string $view, UnitEnum|string|null $queue = null)

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

Parameters

DateInterval|DateTimeInterface|int $delay
array|Mailable|string $view
UnitEnum|string|null $queue

Return Value

mixed

Exceptions

InvalidArgumentException

at line 437
mixed laterOn(UnitEnum|string $queue, DateInterval|DateTimeInterface|int $delay, Mailable $view)

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

Parameters

UnitEnum|string $queue
DateInterval|DateTimeInterface|int $delay
Mailable $view

Return Value

mixed

at line 445
protected Message createMessage()

Create a new message instance.

Return Value

Message

at line 473
protected SentMessage|null sendSymfonyMessage(Email $message)

Send a Symfony Email instance.

Parameters

Email $message

Return Value

SentMessage|null

at line 486
protected bool shouldSendMessage(Email $message, array $data = [])

Determines if the email can be sent.

Parameters

Email $message
array $data

Return Value

bool

at line 504
protected void dispatchSentEvent(SentMessage $message, array $data = [])

Dispatch the message sent event.

Parameters

SentMessage $message
array $data

Return Value

void

at line 516
TransportInterface getSymfonyTransport()

Get the Symfony Transport instance.

Return Value

TransportInterface

at line 524
Factory getViewFactory()

Get the view factory instance.

Return Value

Factory

at line 536
void setSymfonyTransport(TransportInterface $transport)

Set the Symfony Transport instance.

Replaces the transport on the shared Mailer; per-request use races across coroutines and routes every other coroutine's mail through the swapped transport.

Parameters

TransportInterface $transport

Return Value

void

at line 550
Mailer setQueue(Factory $queue)

Set the queue manager instance.

Replaces the queue factory on the shared Mailer; per-request use races across coroutines.

Parameters

Factory $queue

Return Value

Mailer

at line 561
static void flushState()

Flush all static state.

Return Value

void