MailMessage
class MailMessage extends SimpleMessage implements Renderable (View source)
Traits
Properties
| string | $level | The "level" of the notification (info, success, error). |
from SimpleMessage |
| string | $subject | The subject of the notification. |
from SimpleMessage |
| string | $greeting | The notification's greeting. |
from SimpleMessage |
| string | $salutation | The notification's salutation. |
from SimpleMessage |
| array | $introLines | The "intro" lines of the notification. |
from SimpleMessage |
| array | $outroLines | The "outro" lines of the notification. |
from SimpleMessage |
| string | $actionText | The text / label for the action. |
from SimpleMessage |
| string | $actionUrl | The action URL. |
from SimpleMessage |
| string | $mailer | The name of the mailer that should send the notification. |
from SimpleMessage |
| array|string | $view | The view to be rendered. |
|
| array | $viewData | The view data for the message. |
|
| string|null | $markdown | The Markdown template to render (if applicable). |
|
| string|null | $theme | The current theme being used when generating emails. |
|
| array | $from | The "from" information for the message. |
|
| array | $replyTo | The "reply to" information for the message. |
|
| array | $cc | The "cc" information for the message. |
|
| array | $bcc | The "bcc" information for the message. |
|
| array | $attachments | The attachments for the message. |
|
| array | $rawAttachments | The raw attachments for the message. |
|
| array | $tags | The tags for the message. |
|
| array | $metadata | The metadata for the message. |
|
| int | $priority | Priority level of the message. |
|
| array | $callbacks | The callbacks for the message. |
Methods
Indicate that the notification gives information about a successful operation.
Set the "level" of the notification (success, error, etc.).
Add a line of text to the notification if the given condition is true.
Add lines of text to the notification if the given condition is true.
Set the name of the mailer that should send the notification.
Apply the callback if the given "value" is (or resolves to) truthy.
Apply the callback if the given "value" is (or resolves to) falsy.
Set the view for the mail message.
Set the plain text view for the mail message.
Set the Markdown template for the notification.
Set the default markdown template.
Set the theme to use with the Markdown template.
Set the from address for the mail message.
Set the "reply to" address of the message.
Set the cc address for the mail message.
Set the bcc address for the mail message.
Attach in-memory data as an attachment.
Add a tag header to the message when supported by the underlying transport.
Add a metadata header to the message when supported by the underlying transport.
Set the priority of this message.
Get the data array for the mail message.
Parse the multi-address array into the necessary format.
Determine if the given "address" is actually an array of addresses.
Render the mail notification message into an HTML string.
Register a callback to be called with the Symfony message instance.
Details
$this
success()
Indicate that the notification gives information about a successful operation.
$this
error()
Indicate that the notification gives information about an error.
$this
level(string $level)
Set the "level" of the notification (success, error, etc.).
$this
subject(string $subject)
Set the subject of the notification.
$this
greeting(string $greeting)
Set the greeting of the notification.
$this
salutation(string $salutation)
Set the salutation of the notification.
$this
line(mixed $line)
Add a line of text to the notification.
$this
lineIf(bool $boolean, mixed $line)
Add a line of text to the notification if the given condition is true.
$this
lines(iterable $lines)
Add lines of text to the notification.
$this
linesIf(bool $boolean, iterable $lines)
Add lines of text to the notification if the given condition is true.
$this
with(mixed $line)
Add a line of text to the notification.
$this
action(string $text, string $url)
Configure the "call to action" button.
$this
mailer(string $mailer)
Set the name of the mailer that should send the notification.
array
toArray()
Get an array representation of the message.
$this|TWhenReturnType
when($value = null, callable $callback = null, callable $default = null)
Apply the callback if the given "value" is (or resolves to) truthy.
$this|TUnlessReturnType
unless($value = null, callable $callback = null, callable $default = null)
Apply the callback if the given "value" is (or resolves to) falsy.
$this
view(array|string $view, array $data = [])
Set the view for the mail message.
$this
text(string $textView, array $data = [])
Set the plain text view for the mail message.
$this
markdown(string $view, array $data = [])
Set the Markdown template for the notification.
$this
template(string $template)
Set the default markdown template.
$this
theme(string $theme)
Set the theme to use with the Markdown template.
$this
from(string $address, string|null $name = null)
Set the from address for the mail message.
$this
replyTo(array|string $address, string|null $name = null)
Set the "reply to" address of the message.
$this
cc(array|string $address, string|null $name = null)
Set the cc address for the mail message.
$this
bcc(array|string $address, string|null $name = null)
Set the bcc address for the mail message.
$this
attach(string|Attachable|Attachment $file, array $options = [])
Attach a file to the message.
$this
attachMany((string|Attachable|Attachment|array)[] $files)
Attach multiple files to the message.
$this
attachData(string $data, string $name, array $options = [])
Attach in-memory data as an attachment.
$this
tag(string $value)
Add a tag header to the message when supported by the underlying transport.
$this
metadata(string $key, string $value)
Add a metadata header to the message when supported by the underlying transport.
$this
priority(int $level)
Set the priority of this message.
The value is an integer where 1 is the highest priority and 5 is the lowest.
array
data()
Get the data array for the mail message.
protected array
parseAddresses(array $value)
Parse the multi-address array into the necessary format.
protected bool
arrayOfAddresses(mixed $address)
Determine if the given "address" is actually an array of addresses.
string
render()
Render the mail notification message into an HTML string.
$this
withSymfonyMessage(callable $callback)
Register a callback to be called with the Symfony message instance.