class Mailer (View source)

Properties

protected Factory $views The view factory instance.
protected Swift_Mailer $swift The Swift Mailer instance.
protected Dispatcher $events The event dispatcher instance.
protected array $from The global from address and name.
protected Writer $logger The log writer instance.
protected Container $container The IoC container instance.
protected $queue
protected bool $pretending Indicates if the actual sending is disabled.
protected array $failedRecipients Array of failed recipients.
protected array $parsedViews Array of parsed views containing html and text view name.

Methods

void
__construct(Factory $views, Swift_Mailer $swift, Dispatcher $events = null)

Create a new Mailer instance.

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

Set the global from address and name.

int
plain(string $view, array $data, mixed $callback)

Send a new message when only a plain part.

void
send(string|array $view, array $data, Closure|string $callback)

Send a new message using a view.

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

Queue a new e-mail message for sending.

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

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

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

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

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

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

mixed
buildQueueCallable(mixed $callback)

Build the callable for a queued e-mail job.

void
handleQueuedMessage(Job $job, array $data)

Handle a queued e-mail message job.

mixed
getQueuedCallable(array $data)

Get the true callable for a queued e-mail message.

void
addContent(Message $message, string $view, string $plain, array $data)

Add the content to a given message.

array
parseView(string|array $view)

Parse the given view name or array.

void
sendSwiftMessage(Swift_Message $message)

Send a Swift Message instance.

void
logMessage(Swift_Message $message)

Log that a message was sent.

mixed
callMessageBuilder(Closure|string $callback, Message $message)

Call the provided message builder.

createMessage()

Create a new message instance.

getView(string $view, array $data)

Render the given view.

void
pretend(bool $value = true)

Tell the mailer to not really send messages.

bool
isPretending()

Check if the mailer is pretending to send messages.

getViewFactory()

Get the view factory instance.

Swift_Mailer
getSwiftMailer()

Get the Swift Mailer instance.

array
failures()

Get the array of failed recipients.

void
setSwiftMailer(Swift_Mailer $swift)

Set the Swift Mailer instance.

$this
setLogger(Writer $logger)

Set the log writer instance.

$this
setQueue(QueueManager $queue)

Set the queue manager instance.

void
setContainer(Container $container)

Set the IoC container instance.

Details

void __construct(Factory $views, Swift_Mailer $swift, Dispatcher $events = null)

Create a new Mailer instance.

Parameters

Factory $views
Swift_Mailer $swift
Dispatcher $events

Return Value

void

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

Set the global from address and name.

Parameters

string $address
string $name

Return Value

void

int plain(string $view, array $data, mixed $callback)

Send a new message when only a plain part.

Parameters

string $view
array $data
mixed $callback

Return Value

int

void send(string|array $view, array $data, Closure|string $callback)

Send a new message using a view.

Parameters

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

Return Value

void

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

Queue a new e-mail message for sending.

Parameters

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

Return Value

mixed

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

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

Parameters

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

Return Value

mixed

mixed later(int $delay, string|array $view, array $data, Closure|string $callback, string $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 $queue

Return Value

mixed

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

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

Return Value

mixed

protected mixed buildQueueCallable(mixed $callback)

Build the callable for a queued e-mail job.

Parameters

mixed $callback

Return Value

mixed

void handleQueuedMessage(Job $job, array $data)

Handle a queued e-mail message job.

Parameters

Job $job
array $data

Return Value

void

protected mixed getQueuedCallable(array $data)

Get the true callable for a queued e-mail message.

Parameters

array $data

Return Value

mixed

protected void addContent(Message $message, string $view, string $plain, array $data)

Add the content to a given message.

Parameters

Message $message
string $view
string $plain
array $data

Return Value

void

protected array parseView(string|array $view)

Parse the given view name or array.

Parameters

string|array $view

Return Value

array

Exceptions

InvalidArgumentException

protected void sendSwiftMessage(Swift_Message $message)

Send a Swift Message instance.

Parameters

Swift_Message $message

Return Value

void

protected void logMessage(Swift_Message $message)

Log that a message was sent.

Parameters

Swift_Message $message

Return Value

void

protected mixed callMessageBuilder(Closure|string $callback, Message $message)

Call the provided message builder.

Parameters

Closure|string $callback
Message $message

Return Value

mixed

Exceptions

InvalidArgumentException

protected Message createMessage()

Create a new message instance.

Return Value

Message

protected View getView(string $view, array $data)

Render the given view.

Parameters

string $view
array $data

Return Value

View

void pretend(bool $value = true)

Tell the mailer to not really send messages.

Parameters

bool $value

Return Value

void

bool isPretending()

Check if the mailer is pretending to send messages.

Return Value

bool

Factory getViewFactory()

Get the view factory instance.

Return Value

Factory

Swift_Mailer getSwiftMailer()

Get the Swift Mailer instance.

Return Value

Swift_Mailer

array failures()

Get the array of failed recipients.

Return Value

array

void setSwiftMailer(Swift_Mailer $swift)

Set the Swift Mailer instance.

Parameters

Swift_Mailer $swift

Return Value

void

$this setLogger(Writer $logger)

Set the log writer instance.

Parameters

Writer $logger

Return Value

$this

$this setQueue(QueueManager $queue)

Set the queue manager instance.

Parameters

QueueManager $queue

Return Value

$this

void setContainer(Container $container)

Set the IoC container instance.

Parameters

Container $container

Return Value

void