1. class
  2. Hypervel
  3. \
  4. Mail
  5. \
  6. Mailables
  7. \
  8. Envelope

Envelope

class Envelope

Traits

Conditionable

Properties

Address|string|null $from

The address sending the message.
array $to

The recipients of the message.
array $cc

The recipients receiving a copy of the message.
array $bcc

The recipients receiving a blind copy of the message.
array $replyTo

The recipients that should be replied to.
string|null $subject

The subject of the message.
array $tags

The message's tags.
array $metadata

The message's metadata.
array $using

The message's Symfony Message customization callbacks.

Methods

mixed
when(mixed $value = null, callable|null $callback = null, callable|null $default = null)

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

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

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

from  Conditionable
__construct(Address|string|null $from = null, Address|string> $to = [], Address|string> $cc = [], Address|string> $bcc = [], Address|string> $replyTo = [], string|null $subject = null, array $tags = [], array $metadata = [], array|Closure $using = [])

Create a new message envelope instance.

array
normalizeAddresses(array $addresses)

Normalize the given array of addresses.

Envelope
from(Address|string $address, string|null $name = null)

Specify who the message will be "from".

Envelope
to(Address|array|string $address, string|null $name = null)

Add a "to" recipient to the message envelope.

Envelope
cc(Address|array|string $address, string|null $name = null)

Add a "cc" recipient to the message envelope.

Envelope
bcc(Address|array|string $address, string|null $name = null)

Add a "bcc" recipient to the message envelope.

Envelope
replyTo(Address|array|string $address, string|null $name = null)

Add a "reply to" recipient to the message envelope.

Envelope
subject(string $subject)

Set the subject of the message.

Envelope
tags(array $tags)

Add "tags" to the message.

Envelope
tag(string $tag)

Add a "tag" to the message.

Envelope
metadata(string $key, int|string $value)

Add metadata to the message.

Envelope
using(Closure $callback)

Add a Symfony Message customization callback to the message.

bool
isFrom(string $address, string|null $name = null)

Determine if the message is from the given address.

bool
hasTo(string $address, string|null $name = null)

Determine if the message has the given address as a recipient.

bool
hasCc(string $address, string|null $name = null)

Determine if the message has the given address as a "cc" recipient.

bool
hasBcc(string $address, string|null $name = null)

Determine if the message has the given address as a "bcc" recipient.

bool
hasReplyTo(string $address, string|null $name = null)

Determine if the message has the given address as a "reply to" recipient.

bool
hasSubject(string $subject)

Determine if the message has the given subject.

bool
hasMetadata(string $key, int|string $value)

Determine if the message has the given metadata.

bool
hasRecipient(array $recipients, string $address, string|null $name = null)

Determine if the message has the given recipient.

Details

in Conditionable at line 23
mixed when(mixed $value = null, callable|null $callback = null, callable|null $default = null)

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

Parameters

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

Return Value

mixed

in Conditionable at line 56
mixed unless(mixed $value = null, callable|null $callback = null, callable|null $default = null)

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

Parameters

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

Return Value

mixed

at line 71
__construct(Address|string|null $from = null, Address|string> $to = [], Address|string> $cc = [], Address|string> $bcc = [], Address|string> $replyTo = [], string|null $subject = null, array $tags = [], array $metadata = [], array|Closure $using = [])

Create a new message envelope instance.

Parameters

Address|string|null $from
Address|string> $to
Address|string> $cc
Address|string> $bcc
Address|string> $replyTo
string|null $subject
array $tags
array $metadata
array|Closure $using

at line 90
protected array normalizeAddresses(array $addresses)

Normalize the given array of addresses.

Parameters

array $addresses

Return Value

array

at line 102
Envelope from(Address|string $address, string|null $name = null)

Specify who the message will be "from".

Parameters

Address|string $address
string|null $name

Return Value

Envelope

at line 114
Envelope to(Address|array|string $address, string|null $name = null)

Add a "to" recipient to the message envelope.

Parameters

Address|array|string $address
string|null $name

Return Value

Envelope

at line 128
Envelope cc(Address|array|string $address, string|null $name = null)

Add a "cc" recipient to the message envelope.

Parameters

Address|array|string $address
string|null $name

Return Value

Envelope

at line 142
Envelope bcc(Address|array|string $address, string|null $name = null)

Add a "bcc" recipient to the message envelope.

Parameters

Address|array|string $address
string|null $name

Return Value

Envelope

at line 156
Envelope replyTo(Address|array|string $address, string|null $name = null)

Add a "reply to" recipient to the message envelope.

Parameters

Address|array|string $address
string|null $name

Return Value

Envelope

at line 170
Envelope subject(string $subject)

Set the subject of the message.

Parameters

string $subject

Return Value

Envelope

at line 182
Envelope tags(array $tags)

Add "tags" to the message.

Parameters

array $tags

Return Value

Envelope

at line 194
Envelope tag(string $tag)

Add a "tag" to the message.

Parameters

string $tag

Return Value

Envelope

at line 206
Envelope metadata(string $key, int|string $value)

Add metadata to the message.

Parameters

string $key
int|string $value

Return Value

Envelope

at line 218
Envelope using(Closure $callback)

Add a Symfony Message customization callback to the message.

Parameters

Closure $callback

Return Value

Envelope

at line 228
bool isFrom(string $address, string|null $name = null)

Determine if the message is from the given address.

Parameters

string $address
string|null $name

Return Value

bool

at line 241
bool hasTo(string $address, string|null $name = null)

Determine if the message has the given address as a recipient.

Parameters

string $address
string|null $name

Return Value

bool

at line 249
bool hasCc(string $address, string|null $name = null)

Determine if the message has the given address as a "cc" recipient.

Parameters

string $address
string|null $name

Return Value

bool

at line 257
bool hasBcc(string $address, string|null $name = null)

Determine if the message has the given address as a "bcc" recipient.

Parameters

string $address
string|null $name

Return Value

bool

at line 265
bool hasReplyTo(string $address, string|null $name = null)

Determine if the message has the given address as a "reply to" recipient.

Parameters

string $address
string|null $name

Return Value

bool

at line 273
bool hasSubject(string $subject)

Determine if the message has the given subject.

Parameters

string $subject

Return Value

bool

at line 281
bool hasMetadata(string $key, int|string $value)

Determine if the message has the given metadata.

Parameters

string $key
int|string $value

Return Value

bool

at line 289
protected bool hasRecipient(array $recipients, string $address, string|null $name = null)

Determine if the message has the given recipient.

Parameters

array $recipients
string $address
string|null $name

Return Value

bool