Spec-Zone.ru › CakePHP 3.3

Класс Email

Класс CakePHP Email.

Этот класс используется для отправки сообщений в формате Internet Message Format, основанном на стандарте, описанном в http://www.rfc-editor.org/rfc/rfc2822.txt

Конфигурация

Конфигурация для Email управляется методами Email::config() и Email::configTransport(). Email::config() можно использовать для добавления или чтения профиля конфигурации для экземпляров Email. После создания профили конфигурации можно использовать повторно для разных электронных сообщений, которые отправляет ваше приложение.

Cake\Mailer\Email реализует JsonSerializable, Serializable использует Cake\Core\StaticConfigTrait , Cake\View\ViewVarsTrait
Пространство имён: Cake\Mailer
Расположение: Mailer/Email.php

Краткое описание констант

  • string

    EMAIL_PATTERN
    '/^((?:[\p{L}0-9.!#$%&\'*+\/=?^_`{|}~-]+)*@[\p{L}0-9-.]+)$/ui'
  • integer

    LINE_LENGTH_MUST
    998
  • integer

    LINE_LENGTH_SHOULD
    78
  • string

    MESSAGE_HTML
    'html'
  • string

    MESSAGE_TEXT
    'text'

Краткое описание свойств

  • $_appCharset protected
    string
    Кодировка символов на уровне приложения, используемая для кодирования заголовков и тела
  • $_attachments protected
    array
    Список файлов, которые должны быть прикреплены к электронному письму.
  • $_bcc protected
    array
    Скрытая копия
  • $_boundary protected
    string
    Если установлено, разделитель для многочастных MIME-сообщений
  • $_cc protected
    array
    Копия
  • $_charset8bit protected
    array
    8-битные наборы символов
  • $_contentTypeCharset protected
    array
    Определение имени набора символов Content-Type
  • $_domain protected
    string

    Домен для генерации messageId. Необходимо вручную установить для отправки из командной строки, так как env('HTTP_HOST') пуст

  • $_dsnClassMap protected static
    array
    Массив, сопоставляющий схемы URL с полными именами классов транспорта
  • $_emailFormat protected
    string
    В каком формате должно быть отправлено электронное письмо
  • $_emailFormatAvailable protected
    array
    Доступные форматы для отправки.
  • $_emailPattern protected
    string
    Регулярное выражение для проверки адреса электронной почты
  • $_from protected
    array
    Адрес электронной почты, с которого отправляется сообщение
  • $_headers protected
    array

    Ассоциативный массив пользовательских заголовков. Ключи будут иметь префикс «X-» в соответствии с RFC2822 Раздел 4.7.5

  • $_htmlMessage protected
    string
    HTML-сообщение
  • $_message protected
    array
    Конечное сообщение для отправки
  • $_messageId protected
    boolean|string
    Идентификатор сообщения
  • $_profile protected
    array

    Копия профиля конфигурации для этого экземпляра. Эту копию можно изменить с помощью Email::profile().

  • $_readReceipt protected
    array
    Электронное письмо для подтверждения прочтения
  • $_replyTo protected
    array
    Адрес электронной почты, на который должен отвечать получатель
  • $_returnPath protected
    array

    Адрес электронной почты, который будет использоваться в случае возникновения ошибок, таких как - Отдалённый почтовый сервер недоступен - Отдалённый пользователь превысил свой лимит - Неизвестный пользователь

  • $_sender protected
    array
    Отправитель
  • $_subject protected
    string
    Тема письма
  • $_textMessage protected
    string
    Текстовое сообщение
  • $_to protected
    array
    Получатель электронного письма
  • $_transport protected
    Cake\Mailer\AbstractTransport
    Экземпляр транспорта, который будет использоваться для отправки почты.
  • $_transportConfig protected static
    array
    Профили конфигурации для транспортов.
  • $charset public
    string
    Кодировка символов тела электронного письма
  • $headerCharset public
    string

    Кодировка символов заголовка электронного письма. Если null, будет использоваться свойство $charset по умолчанию

Унаследованные свойства

  • _config _viewBuilder, viewClass, viewVars

Краткое описание методов

  • __clone() public
    Клонирование экземпляра ViewBuilder при клонировании объекта электронной почты.
  • __construct() public
    Конструктор
  • _addEmail() protected
    Добавить электронную почту
  • _applyConfig() protected
    Применение конфигурации к экземпляру
  • _attachFiles() protected
    Прикрепить файлы, не встроенные в сообщение, добавив содержимое файла внутри границ.
  • _attachInlineFiles() protected
    Прикрепить встроенные/вложенные файлы к сообщению.
  • _checkViewVars() protected
    Итерирует по хэшу для очистки и нормализации.
  • _constructTransport() protected
    Создание экземпляра транспорта из данных конфигурации.
  • _createBoundary() protected
    Создание уникального идентификатора границы
  • _decode() protected
    Декодирование указанной строки
  • _encode() protected
    Кодирование указанной строки с использованием текущей кодировки
  • _encodeString() protected

    Перевод строки из одной кодировки в другую, если значение App.encoding отличается и функция mb_convert_encoding существует

  • _formatAddress() protected
    Форматирование адресов
  • _getContentTransferEncoding() protected
    Возвращение значения Content-Transfer Encoding на основе установленной кодировки
  • _getContentTypeCharset() protected
    Возвращение значения кодировки для Content-Type.
  • _getTypes() protected
    Получение типов текстовых тел, присутствующих в этом сообщении электронной почты
  • _logDelivery() protected
    Регистрация доставки сообщения электронной почты.
  • _readFile() protected
    Чтение содержимого файла и возвращение его base64-версии.
  • _render() protected
    Отображение тела электронного письма.
  • _renderTemplates() protected

    Создание и установка всех свойств представления, необходимых для отображения шаблонизированных электронных писем. Если шаблон не задан, возвращается $content в виде хэша типов текстового содержимого для электронного письма.

  • _setEmail() protected
    Установить электронную почту
  • _setEmailSingle() protected
    Установить только 1 электронное письмо
  • _validateEmail() protected
    Проверка адреса электронной почты
  • _wrap() protected
    Упаковка сообщения в соответствии с RFC 2822 - 2.1.1
  • addAttachments() public
    Добавление вложений
  • addBcc() public
    Добавление BCC
  • addCc() public
    Добавление Cc
  • addHeaders() public
    Добавление заголовков к сообщению
  • addTo() public
    Добавление получателей
  • attachments() public
    Добавление вложений к сообщению электронной почты
  • bcc() public
    BCC
  • cc() public
    Cc
  • charset() public
    Установка/получение кодировки
  • configTransport() public static
    Добавление или чтение конфигурации транспорта.
  • configuredTransport() public static
    Возвращает массив, содержащий конфигурации транспортных средств с именами
  • createFromArray() public
    Настройка объекта email из сериализованной конфигурации.
  • deliver() public static
    Статический метод для быстрого создания экземпляра \Cake\Mailer\Email
  • domain() public
    Домен как верхний уровень (часть после @)
  • dropTransport() public static
    Удаление конфигурации транспорта.
  • emailFormat() public
    Формат электронной почты
  • emailPattern() public
    Установка/получение emailPattern
  • from() public
    Отправитель
  • getHeaders() public
    Получить список заголовков
  • getOriginalSubject() public
    Получить исходный предмет без кодирования
  • headerCharset() public
    Установка/получение кодировки заголовков
  • helpers() public
    Помощники, которые будут использованы при отображении
  • jsonSerialize() public

    Сериализация объекта email в значение, которое можно напрямую сериализовать и использовать для клонирования этого экземпляра email.

  • message() public
    Получить сгенерированное сообщение (используется классами транспорта)
  • messageId() public
    Идентификатор сообщения
  • profile() public
    Получить/установить профиль конфигурации для использования этим экземпляром.
  • readReceipt() public
    Получение уведомления о подтверждении прочтения (заголовок Disposition-Notification-To)
  • replyTo() public
    Ответ
  • reset() public
    Сбросить все внутренние переменные, чтобы отправить новое электронное письмо.
  • returnPath() public
    Адрес возврата
  • send() public
    Отправка электронного письма с использованием указанного содержимого, шаблона и макета
  • sender() public
    Отправитель
  • serialize() public
    Сериализация объекта Email.
  • setHeaders() public
    Установка заголовков для сообщения
  • subject() public
    Установка/получение темы.
  • template() public
    Шаблон и макет
  • theme() public
    Тема для использования при отображении
  • to() public
    Получатели
  • transport() public
    Получение/установка транспорта.
  • unserialize() public
    Десериализация объекта Email.
  • viewRender() public
    Класс представления для рендеринга
  • viewVars() public
    Переменные для установки при отображении

Подробное описание методов

__clone()source public

__clone( )

Клонировать экземпляр ViewBuilder при клонировании объекта электронной почты.

__construct()source public

__construct( array|string|null $config null )

Конструктор

Параметры

array|string|null $config необязательный null
Массив конфигураций или строка для загрузки конфигураций из email.php

_addEmail()source protected

_addEmail( string $varName , string|array $email , string $name )

Добавить электронную почту

Параметры

string $varName
Имя свойства
string|array $email

Строка с электронной почтой, Массив с электронной почтой в качестве ключа, именем в качестве значения или электронной почтой в качестве значения (без имени)

string $name
Имя

Возвращает


$this

Исключения

InvalidArgumentException

_applyConfig()source protected

_applyConfig( string|array $config )

Применить конфигурацию к экземпляру

Параметры

string|array $config
Параметры конфигурации.

Исключения

InvalidArgumentException
При использовании несуществующей конфигурации.

_attachFiles()source protected

_attachFiles( string|null $boundary null )

Прикрепить файлы, не встроенные в сообщение, добавив содержимое файла внутри границ.

Параметры

string|null $boundary необязательный null
Граница для использования. Если null, будет использоваться по умолчанию $this->_boundary

Возвращает

array
Массив строк для добавления в сообщение

_attachInlineFiles()source protected

_attachInlineFiles( string|null $boundary null )

Прикрепить встроенные файлы к сообщению.

Параметры

string|null $boundary необязательный null
Граница для использования. Если null, будет использоваться по умолчанию $this->_boundary

Возвращает

array
Массив строк для добавления в сообщение

_checkViewVars()source protected

_checkViewVars( mixed $item , string $key )

Итерация по хэшу для очистки и нормализации.

Параметры

mixed $item
Ссылка на значение переменной представления.
string $key
Ключ переменной представления.

_constructTransport()source protected

_constructTransport( string $name )

Создать экземпляр транспорта из данных конфигурации.

Параметры

string $name
Имя конфигурации транспорта для создания.

Возвращает

Cake\Mailer\AbstractTransport

Исключения

InvalidArgumentException
При отсутствии или некорректной конфигурации транспорта.

_createBoundary()source protected

_createBoundary( )

Создать уникальный идентификатор границы

_decode()source protected

_decode( string $text )

Декодировать указанную строку

Параметры

string $text
Строка для декодирования

Возвращает

string
Декодированная строка

_encode()source protected

_encode( string $text )

Кодировать указанную строку с помощью текущего набора символов

Параметры

string $text
Строка для кодирования

Возвращает

string
Закодированная строка

_encodeString()source protected

_encodeString( string $text , string $charset )

Преобразует строку в другой набор символов, если значение App.encoding отличается, и функция mb_convert_encoding существует

Параметры

string $text
Текст, подлежащий преобразованию
string $charset
Кодировка назначения

Возвращает

string

_formatAddress()source protected

_formatAddress( array $address )

Форматировать адреса

Если адрес содержит не буквенно-цифровые/пробельные символы, он будет заключен в кавычки, так как символы, такие как : и ,, известны тем, что вызывают проблемы в заголовках адресов.

Параметры

array $address
Адреса для форматирования.

Возвращает

array

_getContentTransferEncoding()source protected

_getContentTransferEncoding( )

Возвращает значение Content-Transfer Encoding, основанное на установленной кодировке символов

Возвращает

string

_getContentTypeCharset()source protected

_getContentTypeCharset( )

Возвращает значение кодировки символов для Content-Type.

Проверяет типы обратной совместимости/обработки, которые включают обходные пути для устаревших японских наборов символов.

Возвращает

string

_getTypes()source protected

_getTypes( )

Получить типы текстового тела, которые содержатся в этом сообщении электронной почты

Возвращает

array
Массив типов. Действительные типы — 'text' и 'html'

_logDelivery()source protected

_logDelivery( array $contents )

Записать доставку сообщения электронной почты.

Параметры

array $contents
Содержимое с ключами 'headers' и 'message'.

_readFile()source protected

_readFile( string $path )

Прочитать содержимое файла и вернуть базовый 64-версию содержимого файла.

Параметры

string $path
Абсолютный путь к файлу для чтения.

Возвращает

string
Содержимое файла в кодировке base64

_render()source protected

_render( array $content )

Отобразить тело электронной почты.

Параметры

array $content
Содержимое для отображения

Возвращает

array
Тело электронной почты, готовое к отправке

_renderTemplates()source protected

_renderTemplates( string $content )

Создать и установить все свойства представления, необходимые для рендеринга шаблонов электронных писем. Если шаблон не задан, $content будет возвращен в хэше типов текстового содержимого для электронной почты.

Параметры

string $content
Содержимое, переданное из send() в большинстве случаев.

Возвращает

array
Отображенное содержимое с ключами html и text.

_setEmail()source protected

_setEmail( string $varName , string|array $email , string $name )

Установить электронную почту

Параметры

string $varName
Имя свойства
string|array $email

Строка с электронной почтой, Массив с электронной почтой в качестве ключа, именем в качестве значения или электронной почтой в качестве значения (без имени)

string $name
Имя

Возвращает


$this

Исключения

InvalidArgumentException
END_OF_DOCUMENT_MARKER

_setEmailSingle()source protected

_setEmailSingle( string $varName , string|array $email , string $name , string $throwMessage )

Установить только 1 адрес электронной почты

Параметры

string $varName
Имя свойства
string|array $email

Строка с адресом электронной почты, Массив с адресом электронной почты в качестве ключа, имя в качестве значения или адрес электронной почты в качестве значения (без имени)

string $name
Имя
string $throwMessage
Сообщение об ошибке

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


$this

Исключения

InvalidArgumentException

_validateEmail()source protected

_validateEmail( string $email )

Проверить адрес электронной почты

Параметры

string $email
Адрес электронной почты для проверки

Исключения

InvalidArgumentException
Если адрес электронной почты не проходит проверку

_wrap()source protected

_wrap( string $message , integer $wrapLength Email::LINE_LENGTH_MUST )

Упаковать сообщение в соответствии с RFC 2822 - 2.1.1

Параметры

string $message
Сообщение для упаковки
integer $wrapLength необязательно Email::LINE_LENGTH_MUST
Длина строки

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

array
Упакованное сообщение

addAttachments()source public

addAttachments( string|array $attachments )

Добавить вложения

Параметры

string|array $attachments
Имя файла или массив имён файлов

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


$this

Исключения

InvalidArgumentException

См. также

\Cake\Mailer\Email::attachments()

addBcc()source public

addBcc( string|array $email , string|null $name null )

Добавить Bcc

Параметры

string|array $email

Null для получения, Строка с адресом электронной почты, Массив с адресом электронной почты в качестве ключа, имя в качестве значения или адрес электронной почты в качестве значения (без имени)

string|null $name необязательно null
Имя

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


$this

addCc()source public

addCc( string|array $email , string|null $name null )

Добавить Cc

Параметры

string|array $email

Null для получения, Строка с адресом электронной почты, Массив с адресом электронной почты в качестве ключа, имя в качестве значения или адрес электронной почты в качестве значения (без имени)

string|null $name необязательно null
Имя

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


$this

addHeaders()source public

addHeaders( array $headers )

Добавить заголовок к сообщению

Параметры

array $headers
Заголовки для установки.

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


$this

addTo()source public

addTo( string|array $email , string|null $name null )

Добавить получателя

Параметры

string|array $email

Null для получения, Строка с адресом электронной почты, Массив с адресом электронной почты в качестве ключа, имя в качестве значения или адрес электронной почты в качестве значения (без имени)

string|null $name необязательно null
Имя

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


$this

attachments()source public

attachments( string|array|null $attachments null )

Добавить вложения к сообщению электронной почты

Вложения можно определить несколькими способами, в зависимости от требуемого уровня управления:

Прикрепить один файл:

$email->attachments('path/to/file');

Прикрепить файл с другим именем файла:

$email->attachments(['custom_name.txt' => 'path/to/file.txt']);

Прикрепить файл и указать дополнительные свойства:

$email->attachments(['custom_name.png' => [
     'file' => 'path/to/file',
     'mimetype' => 'image/png',
     'contentId' => 'abc123',
     'contentDisposition' => false
   ]
]);

Прикрепить файл из строки и указать дополнительные свойства:

$email->attachments(['custom_name.png' => [
     'data' => file_get_contents('path/to/file'),
     'mimetype' => 'image/png'
   ]
]);

Ключ contentId позволяет указать встроенное вложение. В тексте вашего сообщения электронной почты вы можете использовать <img src="cid:abc123" /> для отображения изображения встроеным.

Ключ contentDisposition позволяет отключить заголовок Content-Disposition, что может улучшить совместимость вложений с клиентами электронной почты Outlook.

Параметры

string|array|null $attachments необязательно null
Строка с именем файла или массив имён файлов

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

array|Cake\Mailer\Email
$this Массив вложений при получении или $this при установке.

Исключения

InvalidArgumentException

bcc()source public

bcc( string|array|null $email null , string|null $name null )

Bcc

Параметры

string|array|null $email необязательно null

Null для получения, Строка с адресом электронной почты, Массив с адресом электронной почты в качестве ключа, имя в качестве значения или адрес электронной почты в качестве значения (без имени)

string|null $name необязательно null
Имя

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

array|Cake\Mailer\Email
$this

cc()source public

cc( string|array|null $email null , string|null $name null )

Cc

Параметры

string|array|null $email необязательно null

Null для получения, Строка с адресом электронной почты, Массив с адресом электронной почты в качестве ключа, имя в качестве значения или адрес электронной почты в качестве значения (без имени)

string|null $name необязательно null
Имя

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

array|Cake\Mailer\Email
$this

charset()source public

charset( string|null $charset null )

Установка/получение кодировки символов

Параметры

string|null $charset необязательно null
Кодировка символов.

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

string
this->charset

configTransport()source public static

configTransport( string|array $key , array|Cake\Mailer\AbstractTransport|null $config null )

Добавление или чтение конфигурации транспорта.

Используйте этот метод для определения транспортов, которые будут использоваться в профилях доставки. После определения конфигурации изменить её нельзя, и нужно использовать Email::dropTransport() для её очистки.

При использовании массива данных конфигурации для каждого отправляемого сообщения будет создан новый транспорт. При использовании замыкания, замыкание будет вычисляться для каждого сообщения.

Ключ className используется для определения класса, используемого для транспорта. Это может быть короткое имя или полное имя класса.

Параметры

string|array $key

Имя конфигурации для чтения/записи. Или массив из нескольких транспортов для установки.

array|Cake\Mailer\AbstractTransport|null $config необязательно null

Массив данных конфигурации или экземпляр транспорта.

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

array|null
null при установке или массив данных при чтении.

Исключения

BadMethodCallException
При изменении существующей конфигурации.

configuredTransport()source public static

configuredTransport( )

Возвращает массив, содержащий конфигурации транспортов с указанными именами

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

array
Массив конфигураций.

createFromArray()source public

createFromArray( array $config )

Настройка экземпляра объекта электронной почты из сериализованной конфигурации.

Параметры

array $config
Массив конфигурации электронной почты.

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


$this Настроенный экземпляр объекта электронной почты.
END_OF_DOCUMENT_MARKER

deliver()source public static

deliver( string|array|null $to null , string|null $subject null , string|array|null $message null , string|array $transportConfig 'default' , boolean $send true )

Статический метод для быстрого создания экземпляра \Cake\Mailer\Email

Параметры

string|array|null $to необязательно null
Адрес для отправки (см. Cake\Mailer\Email::to()). Если null, будет попытка использовать 'to' из конфигурации транспорта
string|null $subject необязательно null
Строка темы или null для использования 'subject' из конфигурации транспорта
string|array|null $message необязательно null
Строка с сообщением или массив с переменными для использования в рендеринге
string|array $transportConfig необязательно 'default'
Строка для использования конфигурации из EmailConfig или массив с конфигурациями
boolean $send необязательно true
Отправить электронное письмо или просто вернуть экземпляр с предварительной настройкой

Возвращает

Cake\Mailer\Email
Экземпляр Cake\Mailer\Email

Исключения

InvalidArgumentException

domain()source public

domain( string|null $domain null )

Домен как верхний уровень (часть после @)

Параметры

string|null $domain необязательно null
Вручную установить домен для рассылки из командной строки

Возвращает

string|Cake\Mailer\Email
$this

dropTransport()source public static

dropTransport( string $key )

Удалить конфигурацию транспорта.

Параметры

string $key
Имя транспорта для удаления.

emailFormat()source public

emailFormat( string|null $format null )

Формат электронного письма

Параметры

string|null $format необязательно null
Форматирующая строка.

Возвращает

string|Cake\Mailer\Email
$this

Исключения

InvalidArgumentException

emailPattern()source public

emailPattern( string|boolean|null $regex false )

Установка/получение шаблона электронного письма

Параметры

string|boolean|null $regex необязательно false

Шаблон для проверки адреса электронной почты, null для отмены шаблона и использования filter_var(), false или ничего для возвращения текущего значения

Возвращает

string|Cake\Mailer\Email
$this

from()source public

from( string|array|null $email null , string|null $name null )

Отправитель

Параметры

string|array|null $email необязательно null

Null для получения, строка с адресом электронной почты, массив с адресом электронной почты в качестве ключа, именем в качестве значения или адресом электронной почты в качестве значения (без имени)

string|null $name необязательно null
Имя

Возвращает

array|Cake\Mailer\Email
$this

Исключения

InvalidArgumentException

getHeaders()source public

getHeaders( array $include [] )

Получить список заголовков

Включает:

  • from
  • replyTo
  • readReceipt
  • returnPath
  • to
  • cc
  • bcc
  • subject

Параметры

array $include необязательно []
Список заголовков.

Возвращает

array

getOriginalSubject()source public

getOriginalSubject( )

Получить исходную тему без кодирования

Возвращает

string
Исходная тема

headerCharset()source public

headerCharset( string|null $charset null )

Установка/получение кодировки символов заголовка

Параметры

string|null $charset необязательно null
Кодировка символов.

Возвращает

string
this->charset

helpers()source public

helpers( array|null $helpers null )

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

Параметры

array|null $helpers необязательно null
Список вспомогательных функций.

Возвращает

array|Cake\Mailer\Email
$this

jsonSerialize()source public

jsonSerialize( )

Сериализует объект электронного письма в значение, которое можно напрямую сериализовать и повторно использовать для клонирования этого экземпляра электронного письма.

Есть определенные ограничения для viewVars, которые стоит знать:

  • ORM\Query, выполняемые и хранящиеся в качестве набора результатов
  • SimpleXmlElements, хранящиеся в качестве ассоциативного массива
  • Исключения, хранящиеся в виде строк
  • Ресурсы, \Closure и \PDO не поддерживаются.

Возвращает

array
Сериализуемый массив свойств конфигурации.

Исключения

Exception
Когда объект view var не может быть должным образом сериализован.

Реализация

JsonSerializable::jsonSerialize()

message()source public

message( string|null $type null )

Получить сгенерированное сообщение (используется классами транспорта)

Параметры

string|null $type необязательно null
Использовать константы MESSAGE_* или null для возвращения полного сообщения в виде массива

Возвращает

string|array
Строка, если тип есть, массив, если тип null

messageId()source public

messageId( boolean|string|null $message null )

Идентификатор сообщения

Параметры

boolean|string|null $message необязательно null
True для генерации нового Message-ID, False для игнорирования (не отправлять в email), Строка для установки в качестве Message-ID

Возвращает

boolean|string|Cake\Mailer\Email
$this

Исключения

InvalidArgumentException

profile()source public

profile( null|string|array $config null )

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

Параметры

null|string|array $config необязательно null

Строка с именем конфигурации или массив с конфигурацией или null для возвращения текущей конфигурации.

Возвращает

string|array|Cake\Mailer\Email
$this

readReceipt()source public

readReceipt( string|array|null $email null , string|null $name null )

Получение/установка подтверждения о прочтении (заголовок Disposition-Notification-To)

Параметры

string|array|null $email необязательно null

Null для получения, строка с адресом электронной почты, массив с адресом электронной почты в качестве ключа, именем в качестве значения или адресом электронной почты в качестве значения (без имени)

string|null $name необязательно null
Имя

Возвращает

array|Cake\Mailer\Email
$this

Исключения

InvalidArgumentException

replyTo()source public

replyTo( string|array|null $email null , string|null $name null )

Ответ

Параметры

string|array|null $email необязательно null

Null для получения, строка с адресом электронной почты, массив с адресом электронной почты в качестве ключа, именем в качестве значения или адресом электронной почты в качестве значения (без имени)

string|null $name необязательно null
Имя

Возвращает

array|Cake\Mailer\Email
$this

Исключения

InvalidArgumentException
END_OF_DOCUMENT_MARKER

reset()source public

reset( )

Сбросьте все внутренние переменные, чтобы отправить новое письмо.

Возвращает


$this

returnPath()source public

returnPath( string|array|null $email null , string|null $name null )

Возвращаемый адрес

Параметры

string|array|null $email необязательно null

Null для получения, Строка с адресом электронной почты, Массив с адресом электронной почты в качестве ключа, именем в качестве значения или адресом электронной почты в качестве значения (без имени)

string|null $name необязательно null
Имя

Возвращает

array|Cake\Mailer\Email
$this

Исключения

InvalidArgumentException

send()source public

send( string|array|null $content null )

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

Параметры

string|array|null $content необязательно null
Строка с сообщением или массив с сообщениями

Возвращает

array

Исключения

BadMethodCallException

sender()source public

sender( string|array|null $email null , string|null $name null )

Отправитель

Параметры

string|array|null $email необязательно null

Null для получения, Строка с адресом электронной почты, Массив с адресом электронной почты в качестве ключа, именем в качестве значения или адресом электронной почты в качестве значения (без имени)

string|null $name необязательно null
Имя

Возвращает

array|Cake\Mailer\Email
$this

Исключения

InvalidArgumentException

serialize()source public

serialize( )

Сериализует объект Email.

Возвращает

string

Реализация

Serializable::serialize()

setHeaders()source public

setHeaders( array $headers )

Устанавливает заголовки для сообщения

Параметры

array $headers
Ассоциативный массив, содержащий устанавливаемые заголовки.

Возвращает


$this

subject()source public

subject( string|null $subject null )

Получение/установка темы.

Параметры

string|null $subject необязательно null
Строка темы.

Возвращает

string|Cake\Mailer\Email
$this

template()source public

template( boolean|string $template false , boolean|string $layout false )

Шаблон и макет

Параметры

boolean|string $template необязательно false
Имя шаблона или null, чтобы не использовать
boolean|string $layout необязательно false
Имя макета или null, чтобы не использовать

Возвращает

array|Cake\Mailer\Email
$this

theme()source public

theme( string|null $theme null )

Тема для использования при рендеринге

Параметры

string|null $theme необязательно null
Имя темы.

Возвращает

string|Cake\Mailer\Email
$this

to()source public

to( string|array|null $email null , string|null $name null )

Кому

Параметры

string|array|null $email необязательно null

Null для получения, Строка с адресом электронной почты, Массив с адресом электронной почты в качестве ключа, именем в качестве значения или адресом электронной почты в качестве значения (без имени)

string|null $name необязательно null
Имя

Возвращает

array|Cake\Mailer\Email
$this

transport()source public

transport( string|Cake\Mailer\AbstractTransport|null $name null )

Получение/установка транспорта.

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

Параметры

string|Cake\Mailer\AbstractTransport|null $name необязательно null

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

Возвращает

Cake\Mailer\AbstractTransport|Cake\Mailer\Email
$this

Исключения

LogicException
Когда выбранный транспорт не имеет метода отправки.
InvalidArgumentException
Когда $name не является строкой или объектом.

unserialize()source public

unserialize( string $data )

Десериализует объект Email.

Параметры

string $data
Сериализованная строка.

Возвращает

Cake\Mailer\Email
Настроенный экземпляр электронной почты.

Реализация

Serializable::unserialize()

viewRender()source public

viewRender( string|null $viewClass null )

Класс представления для рендеринга

Параметры

string|null $viewClass необязательно null
Имя класса представления.

Возвращает

string|Cake\Mailer\Email
$this

viewVars()source public

viewVars( array|null $viewVars null )

Переменные, которые должны быть установлены при рендеринге

Параметры

array|null $viewVars необязательно null
Переменные для установки для представления.

Возвращает

array|Cake\Mailer\Email
$this

Методы, используемые из Cake\Core\StaticConfigTrait

config()source public static

config( string|array $key , array|null $config null )

Этот метод можно использовать для определения адаптеров конфигурации для приложения или чтения существующей конфигурации.

Чтобы изменить конфигурацию адаптера во время выполнения, сначала удалите адаптер, а затем переконфигурируйте его.

Адаптеры не будут созданы до тех пор, пока не будет выполнено первое действие.

Использование

Предполагая, что имя класса Cache поддерживаются следующие сценарии:

Чтение данных конфигурации обратно:

Cache::config('default');

Настройка движка кэша.

Cache::config('default', $settings);

Ввод созданного адаптера:

Cache::config('default', $instance);

Одновременная настройка нескольких адаптеров:

Cache::config($arrayOfConfig);

Параметры

string|array $key
Имя конфигурации или массив нескольких конфигураций.
array|null $config необязательно null
Массив пар имя => данные конфигурации для адаптера.

Возвращает

array|null
Null при добавлении конфигурации или массив данных конфигурации при чтении.

Исключения

BadMethodCallException
При попытке изменить существующую конфигурацию.

configured()source public static

configured( )

Возвращает массив, содержащий настроенные конфигурации

Возвращает

array
Массив конфигураций.

drop()source public static

drop( string $config )

Удаляет созданный адаптер.

Если вы хотите изменить существующую конфигурацию, необходимо удалить её, изменить конфигурацию и затем добавить её заново.

Если реализующие объекты поддерживают объект $_registry , настроенная конфигурация также будет выгружена из реестра.

Параметры

string $config
Существующая конфигурация, которую вы хотите удалить.

Возвращает

boolean
Результат удаления, возвращает false, если конфигурация не существует.
END_OF_DOCUMENT_MARKER

dsnClassMap()source public static

dsnClassMap( array $map null )

Возвращает или обновляет карту классов DSN для данного класса

Параметры

массив $map необязательно null
Добавления/изменения в карту классов для применения

Возвращает

массив

parseDsn()source public static

parseDsn( string $dsn )

Парсит DSN в корректную конфигурацию подключения

Этот метод позволяет задать DSN, используя формат, аналогичный используемому в PEAR::DB. Ниже приведен пример его использования:

$dsn = 'mysql://user:pass@localhost/database?';
$config = ConnectionManager::parseDsn($dsn);

$dsn = 'Cake\Log\Engine\FileLog://?types=notice,info,debug&file=debug&path=LOGS';
$config = Log::parseDsn($dsn);

$dsn = 'smtp://user:secret@localhost:25?timeout=30&client=null&tls=null';
$config = Email::parseDsn($dsn);

$dsn = 'file:///?className=\My\Cache\Engine\FileEngine';
$config = Cache::parseDsn($dsn);

$dsn = 'File://?prefix=myapp_cake_core_&serialize=true&duration=+2 minutes&path=/tmp/persistent/';
$config = Cache::parseDsn($dsn);

Для всех классов значение scheme устанавливается как значение обоих className, если не указано иное.

Обратите внимание, что аргументы строки запроса также анализируются и устанавливаются как значения в возвращаемой конфигурации.

Параметры

строка $dsn
Строка DSN для преобразования в массив конфигурации

Возвращает

массив
Массив конфигурации для хранения после анализа DSN

Исключения

InvalidArgumentException
Если передано не строка

Методы, используемые из Cake\View\ViewVarsTrait

createView()source public

createView( string|null $viewClass null )

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

Параметры

строка|null $viewClass необязательно null
Необязательное полное имя класса представления для создания экземпляра.

Возвращает

Cake\View\View

Исключения

Cake\View\Exception\MissingViewException
Если класс представления не найден.

set()source public

set( string|array $name , mixed $value null )

Сохраняет переменную или ассоциативный массив переменных для использования внутри шаблона.

Параметры

строка|массив $name
Строка или массив данных.
смешанный $value необязательно null

Значение, если $name является строкой (в этом случае работает как ключ). Не используется, если $name является ассоциативным массивом, в противном случае служит значениями для ключей $name.

Возвращает


$this

viewBuilder()source public

viewBuilder( )

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

Возвращает

Cake\View\ViewBuilder

viewOptions()source public

viewOptions( string|array|null $options null , boolean $merge true )

Получить/установить допустимые параметры представления в свойстве объекта _validViewOptions. Свойство создается как пустой массив, если оно не установлено. Если вызывается без параметров, возвращает текущий список допустимых параметров представления. См. createView().

Параметры

строка|массив|null $options необязательно null
Строка или массив строк для добавления в _validViewOptions.
boolean $merge необязательно true

Флаг слияния с существующими допустимыми параметрами представления или их перезаписи. По умолчанию true.

Возвращает

массив
Обновленные параметры представления в виде массива.

Подробности свойств

$_appCharsetsource

protected строка

Кодировка символов приложения, используемая для кодирования заголовков и тела

null

$_attachmentssource

protected массив

Список файлов, которые должны быть прикреплены к электронному сообщению.

Только абсолютные пути

[]

$_bccsource

protected массив

Скрытая копия

Список адресов электронной почты, которые должны получить копию сообщения. Получатель НЕ увидит этот список

[]

$_boundarysource

protected строка

Если установлено, разделитель для многочастотных MIME-сообщений

null

$_ccsource

protected массив

Копия

Список адресов электронной почты, которые должны получить копию сообщения. Получатель УВИДИТ этот список

[]

$_charset8bitsource

protected массив

Кодировки символов 8-бит

['UTF-8', 'SHIFT_JIS']

$_contentTypeCharsetsource

protected массив

Определение имени кодировки символов Content-Type

[
    'ISO-2022-JP-MS' => 'ISO-2022-JP'
]

$_domainsource

protected строка

Домен для генерации messageId. Необходимо установить вручную для рассылки из командной строки, так как env('HTTP_HOST') пуст

null

$_dsnClassMapsource

protected static массив

Массив, сопоставляющий схемы URL с полными именами классов транспорта

[
    'debug' => 'Cake\Mailer\Transport\DebugTransport',
    'mail' => 'Cake\Mailer\Transport\MailTransport',
    'smtp' => 'Cake\Mailer\Transport\SmtpTransport',
]

$_emailFormatsource

protected строка

В каком формате должно быть отправлено сообщение электронной почты

'text'

$_emailFormatAvailablesource

protected массив

Доступные форматы для отправки.

['text', 'html', 'both']

$_emailPatternsource

protected строка

Регулярное выражение для проверки адреса электронной почты

Если null, будет использоваться filter_var(). Используйте метод emailPattern() для установки пользовательского шаблона.

self::EMAIL_PATTERN

$_fromsource

protected массив

Адрес электронной почты отправителя

[]

$_headerssource

protected массив

Ассоциативный массив пользовательских заголовков. Ключи будут префикс 'X-' согласно RFC2822 Раздел 4.7.5

[]

$_htmlMessagesource

protected строка

HTML сообщение

''

$_messagesource

protected массив

Окончательное сообщение для отправки

[]
END_OF_DOCUMENT_MARKER

$_messageIdsource

protected boolean|string

Идентификатор сообщения

true

$_profilesource

protected array

Копия профиля конфигурации для этого экземпляра. Эту копию можно изменить с помощью Email::profile().

[]

$_readReceiptsource

protected array

Электронная почта подтверждения прочтения

[]

$_replyTosource

protected array

Электронная почта, на которую будет отвечать получатель

[]

$_returnPathsource

protected array

Адрес электронной почты, который будет использоваться в случае ошибок, таких как: — удаленный почтовый сервер недоступен — удаленный пользователь превысил свой лимит — неизвестный пользователь

[]

$_sendersource

protected array

Электронная почта отправителя

[]

$_subjectsource

protected string

Тема письма

''

$_textMessagesource

protected string

Текст сообщения

''

$_tosource

protected array

Получатель письма

[]

$_transportsource

protected Cake\Mailer\AbstractTransport

Экземпляр транспорта для отправки почты.

null

$_transportConfigsource

protected static array

Профили конфигурации для транспортов.

[]

$charsetsource

public string

Кодировка, в которой отправляется тело письма

'utf-8'

$headerCharsetsource

public string

Кодировка заголовков письма. Если null, используется свойство $charset

null

© 2005–2017 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.3/class-Cake.Mailer.Email.html

Spec-Zone.ru

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