1. class
  2. Illuminate
  3. \
  4. Mail
  5. \
  6. Mailables
  7. \
  8. Headers

Headers

class Headers (View source)

Traits

Conditionable

Properties

string|null $messageId

The message's message ID.
array $references

The message IDs that are referenced by the message.
array $text

The message's text headers.

Methods

$this|TWhenReturnType
when(TWhenParameter|TWhenParameter|null $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(TUnlessParameter|TUnlessParameter|null $value = null, callable|null $callback = null, callable|null $default = null)

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

from  Conditionable
void
__construct(string|null $messageId = null, array $references = [], array $text = [])

Create a new instance of headers for a message.

$this
messageId(string $messageId)

Set the message ID.

$this
references(array $references)

Set the message IDs referenced by this message.

$this
text(array $text)

Set the headers for this message.

string
referencesString()

Get the references header as a string.

Details

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

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

Parameters

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

Return Value

$this|TWhenReturnType

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

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

Parameters

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

Return Value

$this|TUnlessReturnType

at line 44
void __construct(string|null $messageId = null, array $references = [], array $text = [])

Create a new instance of headers for a message.

Parameters

string|null $messageId
array $references
array $text

Return Value

void

at line 57
$this messageId(string $messageId)

Set the message ID.

Parameters

string $messageId

Return Value

$this

at line 70
$this references(array $references)

Set the message IDs referenced by this message.

Parameters

array $references

Return Value

$this

at line 83
$this text(array $text)

Set the headers for this message.

Parameters

array $text

Return Value

$this

at line 95
string referencesString()

Get the references header as a string.

Return Value

string

Laravel Cloud is the best place to deploy Laravel, Nuxt, Express, Hono, Node.js, Bun, Go, Flask, Python, and more, with dedicated infrastructure available on AWS through Laravel Private Cloud.