Spec-Zone.ru › Laravel 10

Конверт

класс Конверт (Просмотреть исходный код)

Трейты

Conditionable

Свойства

Адрес|строка|null $from

Адрес отправителя сообщения.

массив $to

Получатели сообщения.

массив $cc

Получатели, получившие копию сообщения.

массив $bcc

Получатели, получившие скрытую копию сообщения.

массив $replyTo

Получатели, которым следует ответить.

строка|null $subject

Тема сообщения.

массив $tags

Теги сообщения.

массив $metadata

Метаданные сообщения.

массив $using

Обратные вызовы кастомизации сообщения Symfony Message.

Методы

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

Применить обратный вызов, если заданное «значение» истинно.

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

Применить обратный вызов, если заданное «значение» ложно.

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

Создать новый экземпляр конверта сообщения.

Address> normalizeAddresses(Address|string> $addresses)

Нормализовать заданный массив адресов.

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

Указать, от кого будет отправлено сообщение.

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

Добавить получателя «к» конверту сообщения.

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

Добавить получателя «копия» в конверт сообщения.

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

Добавить получателя «слепая копия» в конверт сообщения.

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

Добавить получателя «ответ» в конверт сообщения.

$this subject(string $subject)

Установить тему сообщения.

$this tags(array $tags)

Добавить «теги» к сообщению.

$this tag(string $tag)

Добавить «тег» к сообщению.

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

Добавить метаданные к сообщению.

$this using(Closure $callback)

Добавить обратный вызов кастомизации сообщения Symfony Message к сообщению.

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

Определить, отправлено ли сообщение с указанного адреса.

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

Определить, содержит ли сообщение указанный адрес как получателя.

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

Определить, содержит ли сообщение указанный адрес как получателя «копия».

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

Определить, содержит ли сообщение указанный адрес как получателя «слепая копия».

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

Определить, содержит ли сообщение указанный адрес как получателя «ответ».

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

Определить, содержит ли сообщение указанного получателя.

bool hasSubject(string $subject)

Определить, содержит ли сообщение заданную тему.

bool hasMetadata(string $key, string $value)

Определить, содержит ли сообщение заданную метаданную.

Подробности

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

Применить обратный вызов, если заданное «значение» истинно.

Параметры

$value
обратный вызов $callback
обратный вызов $default

Возвращаемое значение

$this|TWhenReturnType

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

Применить обратный вызов, если заданное «значение» ложно.

Параметры

$value
обратный вызов $callback
обратный вызов $default

Возвращаемое значение

$this|TUnlessReturnType

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

Создать новый экземпляр конверта сообщения.

Параметры

Address|string $from
Address|string> $to
Address|string> $cc
Address|string> $bcc
Address|string> $replyTo
строка $subject
массив $tags
массив $metadata
Closure|массив $using

Возвращаемое значение

void

protected Address> normalizeAddresses(Address|string> $addresses)

Нормализовать заданный массив адресов.

Параметры

Address|string> $addresses

Возвращаемое значение

Address>

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

Указать, от кого будет отправлено сообщение.

Параметры

Address|string $address
строка|null $name

Возвращаемое значение

$this

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

Добавить получателя "ко" в конверт сообщения.

Параметры

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

Значение возврата

$this

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

Добавить получателя "копия" в конверт сообщения.

Параметры

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

Значение возврата

$this

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

Добавить получателя "скрытая копия" в конверт сообщения.

Параметры

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

Значение возврата

$this

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

Добавить получателя "ответ" в конверт сообщения.

Параметры

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

Значение возврата

$this

$this subject(string $subject)

Установить тему сообщения.

Параметры

string $subject

Значение возврата

$this

$this tags(array $tags)

Добавить "метки" к сообщению.

Параметры

array $tags

Значение возврата

$this

$this tag(string $tag)

Добавить "метку" к сообщению.

Параметры

string $tag

Значение возврата

$this

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

Добавить метаданные к сообщению.

Параметры

string $key
string|int $value

Значение возврата

$this

$this using(Closure $callback)

Добавить пользовательский callback для настройки сообщения Symfony.

Параметры

Closure $callback

Значение возврата

$this

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

Определить, отправлено ли сообщение с указанного адреса.

Параметры

string $address
string $name

Значение возврата

bool

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

Определить, содержит ли сообщение получателя с указанным адресом.

Параметры

string $address
string $name

Значение возврата

bool

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

Определить, содержит ли сообщение получателя "копия" с указанным адресом.

Параметры

string $address
string $name

Значение возврата

bool

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

Определить, содержит ли сообщение получателя "скрытая копия" с указанным адресом.

Параметры

string $address
string $name

Значение возврата

bool

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

Определить, содержит ли сообщение получателя "ответ" с указанным адресом.

Параметры

string $address
string $name

Значение возврата

bool

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

Определить, содержит ли сообщение указанного получателя.

Параметры

array $recipients
string $address
string|null $name

Значение возврата

bool

bool hasSubject(string $subject)

Определить, содержит ли сообщение указанную тему.

Параметры

string $subject

Значение возврата

bool

bool hasMetadata(string $key, string $value)

Определить, содержит ли сообщение указанные метаданные.

Параметры

string $key
string $value

Значение возврата

bool

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/10.x/Illuminate/Mail/Mailables/Envelope.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API