1. class
  2. Illuminate
  3. \
  4. Notifications
  5. \
  6. Messages
  7. \
  8. MailMessage

MailMessage

class MailMessage extends SimpleMessage implements Renderable (View source)

Traits

Conditionable

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

$this
success()

Indicate that the notification gives information about a successful operation.

from  SimpleMessage
$this
error()

Indicate that the notification gives information about an error.

from  SimpleMessage
$this
level(string $level)

Set the "level" of the notification (success, error, etc.).

from  SimpleMessage
$this
subject(string $subject)

Set the subject of the notification.

from  SimpleMessage
$this
greeting(string $greeting)

Set the greeting of the notification.

from  SimpleMessage
$this
salutation(string $salutation)

Set the salutation of the notification.

from  SimpleMessage
$this
line(mixed $line)

Add a line of text to the notification.

from  SimpleMessage
$this
lineIf(bool $boolean, mixed $line)

Add a line of text to the notification if the given condition is true.

from  SimpleMessage
$this
lines(iterable $lines)

Add lines of text to the notification.

from  SimpleMessage
$this
linesIf(bool $boolean, iterable $lines)

Add lines of text to the notification if the given condition is true.

from  SimpleMessage
$this
with(mixed $line)

Add a line of text to the notification.

from  SimpleMessage
Htmlable|string
formatLine(Htmlable|string|array|null $line)

Format the given line of text.

from  SimpleMessage
$this
action(string $text, string $url)

Configure the "call to action" button.

from  SimpleMessage
$this
mailer(string $mailer)

Set the name of the mailer that should send the notification.

from  SimpleMessage
array
toArray()

Get an array representation of the message.

from  SimpleMessage
$this|TWhenReturnType
when($value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) truthy.

from  Conditionable
$this|TUnlessReturnType
unless($value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) falsy.

from  Conditionable
$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.

array
data()

Get the data array for the mail message.

array
parseAddresses(array $value)

Parse the multi-address array into the necessary format.

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.

Details

in SimpleMessage at line 78
$this success()

Indicate that the notification gives information about a successful operation.

Return Value

$this

in SimpleMessage at line 90
$this error()

Indicate that the notification gives information about an error.

Return Value

$this

in SimpleMessage at line 103
$this level(string $level)

Set the "level" of the notification (success, error, etc.).

Parameters

string $level

Return Value

$this

in SimpleMessage at line 116
$this subject(string $subject)

Set the subject of the notification.

Parameters

string $subject

Return Value

$this

in SimpleMessage at line 129
$this greeting(string $greeting)

Set the greeting of the notification.

Parameters

string $greeting

Return Value

$this

in SimpleMessage at line 142
$this salutation(string $salutation)

Set the salutation of the notification.

Parameters

string $salutation

Return Value

$this

in SimpleMessage at line 155
$this line(mixed $line)

Add a line of text to the notification.

Parameters

mixed $line

Return Value

$this

in SimpleMessage at line 167
$this lineIf(bool $boolean, mixed $line)

Add a line of text to the notification if the given condition is true.

Parameters

bool $boolean
mixed $line

Return Value

$this

in SimpleMessage at line 182
$this lines(iterable $lines)

Add lines of text to the notification.

Parameters

iterable $lines

Return Value

$this

in SimpleMessage at line 198
$this linesIf(bool $boolean, iterable $lines)

Add lines of text to the notification if the given condition is true.

Parameters

bool $boolean
iterable $lines

Return Value

$this

in SimpleMessage at line 213
$this with(mixed $line)

Add a line of text to the notification.

Parameters

mixed $line

Return Value

$this

in SimpleMessage at line 232
protected Htmlable|string formatLine(Htmlable|string|array|null $line)

Format the given line of text.

Parameters

Htmlable|string|array|null $line

Return Value

Htmlable|string

in SimpleMessage at line 252
$this action(string $text, string $url)

Configure the "call to action" button.

Parameters

string $text
string $url

Return Value

$this

in SimpleMessage at line 266
$this mailer(string $mailer)

Set the name of the mailer that should send the notification.

Parameters

string $mailer

Return Value

$this

in SimpleMessage at line 278
array toArray()

Get an array representation of the message.

Return Value

array

in Conditionable at line 21
$this|TWhenReturnType when($value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) truthy.

Parameters

$value
callable|null $callback
callable|null $default

Return Value

$this|TWhenReturnType

in Conditionable at line 53
$this|TUnlessReturnType unless($value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) falsy.

Parameters

$value
callable|null $callback
callable|null $default

Return Value

$this|TUnlessReturnType

at line 123
$this view(array|string $view, array $data = [])

Set the view for the mail message.

Parameters

array|string $view
array $data

Return Value

$this

at line 140
$this text(string $textView, array $data = [])

Set the plain text view for the mail message.

Parameters

string $textView
array $data

Return Value

$this

at line 155
$this markdown(string $view, array $data = [])

Set the Markdown template for the notification.

Parameters

string $view
array $data

Return Value

$this

at line 171
$this template(string $template)

Set the default markdown template.

Parameters

string $template

Return Value

$this

at line 184
$this theme(string $theme)

Set the theme to use with the Markdown template.

Parameters

string $theme

Return Value

$this

at line 198
$this from(string $address, string|null $name = null)

Set the from address for the mail message.

Parameters

string $address
string|null $name

Return Value

$this

at line 212
$this replyTo(array|string $address, string|null $name = null)

Set the "reply to" address of the message.

Parameters

array|string $address
string|null $name

Return Value

$this

at line 230
$this cc(array|string $address, string|null $name = null)

Set the cc address for the mail message.

Parameters

array|string $address
string|null $name

Return Value

$this

at line 248
$this bcc(array|string $address, string|null $name = null)

Set the bcc address for the mail message.

Parameters

array|string $address
string|null $name

Return Value

$this

at line 266
$this attach(string|Attachable|Attachment $file, array $options = [])

Attach a file to the message.

Parameters

string|Attachable|Attachment $file
array $options

Return Value

$this

at line 287
$this attachMany((string|Attachable|Attachment|array)[] $files)

Attach multiple files to the message.

Parameters

(string|Attachable|Attachment|array)[] $files

Return Value

$this

at line 308
$this attachData(string $data, string $name, array $options = [])

Attach in-memory data as an attachment.

Parameters

string $data
string $name
array $options

Return Value

$this

at line 321
$this tag(string $value)

Add a tag header to the message when supported by the underlying transport.

Parameters

string $value

Return Value

$this

at line 335
$this metadata(string $key, string $value)

Add a metadata header to the message when supported by the underlying transport.

Parameters

string $key
string $value

Return Value

$this

at line 350
$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.

Parameters

int $level

Return Value

$this

at line 362
array data()

Get the data array for the mail message.

Return Value

array

at line 373
protected array parseAddresses(array $value)

Parse the multi-address array into the necessary format.

Parameters

array $value

Return Value

array

at line 387
protected bool arrayOfAddresses(mixed $address)

Determine if the given "address" is actually an array of addresses.

Parameters

mixed $address

Return Value

bool

at line 397
string render()

Render the mail notification message into an HTML string.

Return Value

string

at line 417
$this withSymfonyMessage(callable $callback)

Register a callback to be called with the Symfony message instance.

Parameters

callable $callback

Return Value

$this