Функции модуля (__call)

НАЧАЛО >> Оглавление >> Сервер приложений ИРБИС 64/128 >> Описание модулей системы >> I128FMail - Отправка писем от имени системы >> Функции модуля (__call)📄 Скачать в DOCX

Функции могут быть вызваны как UseModule("I128FMail")->function(parameter1,parameter2,...);

Имя функцииОписаниеПараметры
ComputeInboundFingerprintРасчет fingerprint входящего письма
Подробнее... 
Строит стабильный fingerprint входящего письма для идемпотентности по Message-ID, отправителю, теме, body hash и ключевым threading headers.
ТипПараметрПо умолчаниюОписание
array$messagearray ( )Нормализованное или исходное описание письма
ExplainInboundDeliveryПроверка доставки входящего письма
Подробнее... 
Выполняет dry-run проверки входящего письма по mailbox profile и возвращает объяснимое решение: можно ли доставлять envelope owner-модулю, какие ограничения сработали и какой handler должен получить данные.
ТипПараметрПо умолчаниюОписание
array$profilearray ( )Mailbox profile входящего канала
array$envelopearray ( )Нормализованный inbound envelope
array$optionsarray ( )Дополнительные параметры проверки
GMailОтправка через основной ящик
Подробнее... 
Находит основной почтовый ящик системы и отправляет письмо через `Mail`.
ТипПараметрПо умолчаниюОписание
string$tonameОбязательныйИмя получателя.
string$emailОбязательныйАдрес электронной почты получателя.
string$subjectОбязательныйТема письма.
string$bodyОбязательныйHTML-тело письма.
bool$inbackgroundОбязательныйЕсли true, отправка ставится в очередь.
array$attachesОбязательныйСписок вложений.
GetInboundContractDefinitionsЧтение контракта входящей почты
Подробнее... 
Читает системный JSON-контракт входящего почтового канала I128FMail и возвращает справочники политик, статусов и нормализованные системные mailbox profiles.
ТипПараметрПо умолчаниюОписание
bool$includeRawfalseВернуть исходный JSON-текст и разобранные данные без нормализации
GetMailboxПолучение почтового ящика
Подробнее... 
Возвращает почтовый ящик, связанный с указанной административной переменной модуля, либо основной ящик системы.
ТипПараметрПо умолчаниюОписание
string$modulenameОбязательныйИмя модуля, у которого нужно искать связанную запись ящика.
string$variablenameОбязательныйИмя административной переменной со связью на ящик.
HealthCheckInboundDefinitionДиагностика контракта входящей почты
Подробнее... 
Проверяет системный контракт входящей почты I128FMail: JSON, справочники политик, уникальность mailbox profiles, наличие обработчика, secret reference, event type, queue handler и безопасные настройки вложений.
ТипПараметрПо умолчаниюОписание
array$optionsarray ( )Параметры диагностики
MailОтправка письма
Подробнее... 
Отправляет письмо по настройкам записи `I128FMail`: через SMTP, HTTP-шлюз или очередь фоновой отправки.
ТипПараметрПо умолчаниюОписание
ObjectData$rОбязательныйЗапись настроек почтового ящика.
string$tonameОбязательныйИмя получателя.
string$emailОбязательныйАдрес электронной почты получателя.
string$subjectОбязательныйТема письма.
string$bodyОбязательныйHTML-тело письма.
bool$inbackgroundОбязательныйЕсли true, отправка выполняется через очередь `Queue`.
array$attachesОбязательныйСписок вложений.
MailHTTPОтправка письма через HTTP
Подробнее... 
Передает письмо во внешний HTTP-шлюз, используя параметры URL и имен полей из записи почтового ящика.
ТипПараметрПо умолчаниюОписание
ObjectData$rОбязательныйЗапись настроек почтового ящика.
string$tonameОбязательныйИмя получателя.
string$emailОбязательныйАдрес электронной почты получателя.
string$subjectОбязательныйТема письма.
string$bodyОбязательныйHTML-тело письма.
array$attachesОбязательныйСписок вложений.
MailSMTPОтправка письма через SMTP
Подробнее... 
Отправляет HTML-письмо через PHPMailer по SMTP-настройкам записи почтового ящика.
ТипПараметрПо умолчаниюОписание
ObjectData$rОбязательныйЗапись настроек почтового ящика.
string$tonameОбязательныйИмя получателя.
string$emailОбязательныйАдрес электронной почты получателя.
string$subjectОбязательныйТема письма.
string$bodyОбязательныйHTML-тело письма.
array$attachesОбязательныйСписок вложений.
NormalizeInboundEnvelopeНормализация входящего письма
Подробнее... 
Преобразует исходные данные входящего письма в безопасный inbound envelope для передачи owner-модулю: message id, отправитель, тема, тело, headers, вложения, identity hint, trace id и idempotency key.
ТипПараметрПо умолчаниюОписание
array$messagearray ( )Исходные данные письма после transport/parser слоя
NormalizeMailboxProfileНормализация профиля входящего ящика
Подробнее... 
Приводит mailbox profile входящей почты к единому виду: ключ, адресные правила, политики отправителей, вложений, threading, идемпотентность, обработчик owner-модуля и безопасные ссылки на секреты.
ТипПараметрПо умолчаниюОписание
array$profilearray ( )Исходное описание mailbox profile из JSON или настроек