mailService

mailService

• mailService
  • GetTable(request) ⇒ Promise.<ApiResult>
  • GetById(id) ⇒ Promise.<ApiResult>
  • UpdateStatus(params) ⇒ Promise.<ApiResult>
  • Create(formData) ⇒ Promise.<ApiResult>

GetTable(request) ⇒ Promise.<ApiResult>

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

Все фильтры кроме pagination опциональны: не передан — условие не применяется. Счётчики по статусам считаются с учётом остальных фильтров, то есть описывают текущий срез, а не всю таблицу.

У каждого письма есть адресат (externalType + externalId + externalFullName — имя на момент отправки) и отправитель (senderUserId + senderFullName — пользователь, чьё действие породило письмо; у писем от фоновых процессов пусто).

Принимаемые параметры

Param	Type	Description
request	GetMailsRequestDto	Фильтры и пагинация. См. GetMailsRequestDto

Возвращаемые данные

Returns: Promise.<ApiResult> - Письма под полем pagination (файлы письма — в files), счётчики статусов под statusFilters

WARNING

Раньше метод принимал готовую query-строку. Теперь принимает DTO и собирает строку сам.

Пример

await mailService.GetTable({
  pagination: { page: 1, rowsPerPage: 25, sortBy: 'CreateDateTime', descending: true },
  statusFilter: { available: [1, 2, 3, 4], selected: [] },
  externalTypes: [4],
  externalFullName: 'Muster',
  createdAt: { from: '2026-01-01' },
})

---

GetById(id) ⇒ Promise.<ApiResult>

Получает почтовое отправление по идентификатору

Принимаемые параметры

Param	Type	Description
id	number	ID почтового отправления

Возвращаемые данные

Returns: Promise.<ApiResult> - Данные почтового отправления; файлы — списком в files (раньше был один fileUrl), адресат — в externalFullName, отправитель — в senderFullName

---

UpdateStatus(params) ⇒ Promise.<ApiResult>

Обновляет статус почтового отправления

Принимаемые параметры

Param	Type	Description
params	UpdateMailStatusRequestDto	Тело запроса. См. UpdateMailStatusRequestDto

Возвращаемые данные

Returns: Promise.<ApiResult> - Подтверждение операции

---

Create(formData) ⇒ Promise.<ApiResult>

Создаёт исходящее бумажное письмо

Принимаемые параметры

Param	Type	Description
formData	FormData	Multipart-форма с полями письма и файлами

Возвращаемые данные

Returns: Promise.<ApiResult> - Созданное письмо

WARNING

Эндпоинт принимает multipart/form-data, поэтому здесь FormData, а не объект: в форме лежат поля письма и вложения.

---