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

SimpleMessage

class SimpleMessage (View source)

Properties

string $level

The "level" of the notification (info, success, error).
string $subject

The subject of the notification.
string $greeting

The notification's greeting.
string $salutation

The notification's salutation.
array $introLines

The "intro" lines of the notification.
array $outroLines

The "outro" lines of the notification.
string $actionText

The text / label for the action.
string $actionUrl

The action URL.
string $mailer

The name of the mailer that should send the notification.

Methods

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

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

Format the given line of text.

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

Details

at line 78
$this success()

Indicate that the notification gives information about a successful operation.

Return Value

$this

at line 90
$this error()

Indicate that the notification gives information about an error.

Return Value

$this

at line 103
$this level(string $level)

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

Parameters

string $level

Return Value

$this

at line 116
$this subject(string $subject)

Set the subject of the notification.

Parameters

string $subject

Return Value

$this

at line 129
$this greeting(string $greeting)

Set the greeting of the notification.

Parameters

string $greeting

Return Value

$this

at line 142
$this salutation(string $salutation)

Set the salutation of the notification.

Parameters

string $salutation

Return Value

$this

at line 155
$this line(mixed $line)

Add a line of text to the notification.

Parameters

mixed $line

Return Value

$this

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

at line 182
$this lines(iterable $lines)

Add lines of text to the notification.

Parameters

iterable $lines

Return Value

$this

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

at line 213
$this with(mixed $line)

Add a line of text to the notification.

Parameters

mixed $line

Return Value

$this

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

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

Configure the "call to action" button.

Parameters

string $text
string $url

Return Value

$this

at line 266
$this mailer(string $mailer)

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

Parameters

string $mailer

Return Value

$this

at line 278
array toArray()

Get an array representation of the message.

Return Value

array