Mailer
Mailer
class Mailer implements Mailer, MailQueue (View source)
Traits
Macroable |
Methods
static void | macro(string $name, callable $macro) Register a custom macro. | from Macroable |
static bool | hasMacro(string $name) Checks if macro is registered. | 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 |
void | __construct(Factory $views, Swift_Mailer $swift, Dispatcher $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 | alwaysTo(string $address, string|null $name = null) Set the global to address and name. | |
PendingMail | to(mixed $users) Begin the process of mailing a mailable class instance. | |
PendingMail | bcc(mixed $users) Begin the process of mailing a mailable class instance. | |
int | raw(string $text, Closure|string $callback) Send a new message when only a raw text part. | |
void | plain(string $view, array $data, mixed $callback) Send a new message when only a plain part. | |
void | send(string|array $view, array $data = array(), Closure|string $callback = null) Send a new message using a view. | |
mixed | queue(string|array $view, array $data = array(), Closure|string $callback = null, string $queue = null) Queue a new e-mail message for sending. | |
mixed | onQueue(string $queue, string|array $view, array $data, Closure|string $callback) Queue a new e-mail message for sending on the given queue. | |
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 = array(), Closure|string $callback = null, 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. | |
Factory | 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 | setQueue(Factory $queue) Set the queue manager instance. |
Details
static void macro(string $name, callable $macro)
Register a custom macro.
static bool hasMacro(string $name)
Checks if macro is registered.
static mixed __callStatic(string $method, array $parameters)
Dynamically handle calls to the class.
mixed __call(string $method, array $parameters)
Dynamically handle calls to the class.
void __construct(Factory $views, Swift_Mailer $swift, Dispatcher $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 alwaysTo(string $address, string|null $name = null)
Set the global to address and name.
PendingMail to(mixed $users)
Begin the process of mailing a mailable class instance.
PendingMail bcc(mixed $users)
Begin the process of mailing a mailable class instance.
int raw(string $text, Closure|string $callback)
Send a new message when only a raw text part.
void plain(string $view, array $data, mixed $callback)
Send a new message when only a plain part.
void send(string|array $view, array $data = array(), Closure|string $callback = null)
Send a new message using a view.
mixed queue(string|array $view, array $data = array(), Closure|string $callback = null, string $queue = null)
Queue a new e-mail message for sending.
mixed onQueue(string $queue, string|array $view, array $data, Closure|string $callback)
Queue a new e-mail message for sending on the given queue.
mixed queueOn(string $queue, string|array $view, array $data, Closure|string $callback)
Queue a new e-mail message for sending on the given queue.
This method didn't match rest of framework's "onQueue" phrasing. Added "onQueue".
mixed later(int $delay, string|array $view, array $data = array(), Closure|string $callback = null, 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.
Factory 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 setQueue(Factory $queue)
Set the queue manager instance.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.4/Illuminate/Mail/Mailer.html