Spec-Zone.ru › Laravel 10

MailManager

class MailManager implements Factory mixin Mailer (View source)

Свойства

protected Application $app

Экземпляр приложения.

protected array $mailers

Массив разрешённых почтовых клиентов.

protected array $customCreators

Зарегистрированные пользовательские создатели драйверов.

Методы

void __construct(Application $app)

Создать новый экземпляр менеджера почты.

Mailer mailer(string|null $name = null)

Получить экземпляр почтового клиента по имени.

Mailer driver(string|null $driver = null)

Получить экземпляр драйвера почтового клиента.

Mailer get(string $name)

Попытка получить почтового клиента из кэша.

Mailer resolve(string $name)

Разрешить указанного почтового клиента.

TransportInterface createSymfonyTransport(array $config)

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

EsmtpTransport createSmtpTransport(array $config)

Создать экземпляр драйвера Symfony SMTP Transport.

EsmtpTransport configureSmtpTransport(EsmtpTransport $transport, array $config)

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

SendmailTransport createSendmailTransport(array $config)

Создать экземпляр драйвера Symfony Sendmail Transport.

SesTransport createSesTransport(array $config)

Создать экземпляр драйвера Symfony Amazon SES Transport.

SesV2Transport createSesV2Transport(array $config)

Создать экземпляр драйвера Symfony Amazon SES V2 Transport.

array addSesCredentials(array $config)

Добавить учетные данные SES в массив конфигурации.

SendmailTransport createMailTransport()

Создать экземпляр драйвера Symfony Mail Transport.

TransportInterface createMailgunTransport(array $config)

Создать экземпляр драйвера Symfony Mailgun Transport.

PostmarkApiTransport createPostmarkTransport(array $config)

Создать экземпляр драйвера Symfony Postmark Transport.

FailoverTransport createFailoverTransport(array $config)

Создать экземпляр драйвера Symfony Failover Transport.

RoundRobinTransport createRoundrobinTransport(array $config)

Создать экземпляр драйвера Symfony Roundrobin Transport.

LogTransport createLogTransport(array $config)

Создать экземпляр драйвера Log Transport.

ArrayTransport createArrayTransport()

Создать экземпляр драйвера Array Transport.

HttpClientInterface|null getHttpClient(array $config)

Получить настроенный экземпляр Symfony HTTP client.

void setGlobalAddress(Mailer $mailer, array $config, string $type)

Установить глобальный адрес на почтовом клиенте по типу.

array getConfig(string $name)

Получить конфигурацию подключения к почте.

string getDefaultDriver()

Получить имя драйвера почты по умолчанию.

void setDefaultDriver(string $name)

Установить имя драйвера почты по умолчанию.

void purge(string|null $name = null)

Отключить указанного почтового клиента и удалить из локального кэша.

$this extend(string $driver, Closure $callback)

Зарегистрировать пользовательскую функцию-замыкание создания транспорта.

Application getApplication()

Получить экземпляр приложения, используемый менеджером.

$this setApplication(Application $app)

Установить экземпляр приложения, используемый менеджером.

$this forgetMailers()

Забыть все решенные экземпляры почтовых клиентов.

mixed __call(string $method, array $parameters)

Динамически вызвать экземпляр драйвера по умолчанию.

Подробное описание

void __construct(Application $app)

Создать новый экземпляр менеджера почты.

Параметры

Application $app

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

void

Mailer mailer(string|null $name = null)

Получить экземпляр почтового клиента по имени.

Параметры

string|null $name

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

Mailer

Mailer driver(string|null $driver = null)

Получить экземпляр драйвера почтового клиента.

Параметры

string|null $driver

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

Mailer

protected Mailer get(string $name)

Попытка получить почтового отправителя из локального кэша.

Parameters

string $name

Return Value

Mailer

protected Mailer resolve(string $name)

Разрешение заданного почтового отправителя.

Parameters

string $name

Return Value

Mailer

Exceptions

ИсключениеНеверногоАргумента

TransportInterface createSymfonyTransport(array $config)

Создание нового экземпляра транспорта.

Parameters

array $config

Return Value

TransportInterface

Exceptions

ИсключениеНеверногоАргумента

protected EsmtpTransport createSmtpTransport(array $config)

Создание экземпляра драйвера транспорта SMTP Symfony.

Parameters

array $config

Return Value

EsmtpTransport

protected EsmtpTransport configureSmtpTransport(EsmtpTransport $transport, array $config)

Настройка дополнительных параметров драйвера SMTP.

Parameters

EsmtpTransport $transport
array $config

Return Value

EsmtpTransport

protected SendmailTransport createSendmailTransport(array $config)

Создание экземпляра драйвера транспорта Sendmail Symfony.

Parameters

array $config

Return Value

SendmailTransport

protected SesTransport createSesTransport(array $config)

Создание экземпляра драйвера транспорта Amazon SES Symfony.

Parameters

array $config

Return Value

SesTransport

protected SesV2Transport createSesV2Transport(array $config)

Создание экземпляра драйвера транспорта Amazon SES V2 Symfony.

Parameters

array $config

Return Value

SesV2Transport

protected array addSesCredentials(array $config)

Добавление учетных данных SES в массив конфигурации.

Parameters

array $config

Return Value

array

protected SendmailTransport createMailTransport()

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

Return Value

SendmailTransport

protected TransportInterface createMailgunTransport(array $config)

Создание экземпляра драйвера транспорта Mailgun Symfony.

Parameters

array $config

Return Value

TransportInterface

protected PostmarkApiTransport createPostmarkTransport(array $config)

Создание экземпляра драйвера транспорта Postmark Symfony.

Parameters

array $config

Return Value

PostmarkApiTransport

protected FailoverTransport createFailoverTransport(array $config)

Создание экземпляра драйвера транспорта Failover Symfony.

Parameters

array $config

Return Value

FailoverTransport

protected RoundRobinTransport createRoundrobinTransport(array $config)

Создание экземпляра драйвера транспорта Roundrobin Symfony.

Parameters

array $config

Return Value

RoundRobinTransport

protected LogTransport createLogTransport(array $config)

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

Parameters

array $config

Return Value

LogTransport

protected ArrayTransport createArrayTransport()

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

Return Value

ArrayTransport

protected HttpClientInterface|null getHttpClient(array $config)

Получение сконфигурированного экземпляра Symfony HTTP клиента.

Parameters

array $config

Return Value

HttpClientInterface|null

protected void setGlobalAddress(Mailer $mailer, array $config, string $type)

Установка глобального адреса на почтового отправителя по типу.

Parameters

Mailer $mailer
array $config
string $type

Return Value

void

protected array getConfig(string $name)

Получение конфигурации подключения почты.

Parameters

string $name

Return Value

array

string getDefaultDriver()

Получить имя по умолчанию драйвера почты.

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

string

void setDefaultDriver(string $name)

Установить имя драйвера почты по умолчанию.

Параметры

string $name

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

void

void purge(string|null $name = null)

Отключить указанный почтовый отправитель и удалить из локального кэша.

Параметры

string|null $name

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

void

$this extend(string $driver, Closure $callback)

Зарегистрировать пользовательскую функцию-закрытие для создания транспортного средства.

Параметры

string $driver
Closure $callback

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

$this

Application getApplication()

Получить экземпляр приложения, используемый менеджером.

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

Application

$this setApplication(Application $app)

Установить экземпляр приложения, используемый менеджером.

Параметры

Application $app

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

$this

$this forgetMailers()

Забыть все решенные экземпляры отправителей почты.

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

$this

mixed __call(string $method, array $parameters)

Динамически вызвать экземпляр драйвера по умолчанию.

Параметры

string $method
array $parameters

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

mixed

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

Spec-Zone.ru

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