Mailgun

Mailgun — сервис доставки почты: транзакционные письма, списки рассылки и журнал событий (доставлено, открыто, клик).

С Mailgun в Pailot вы можете:

Отправлять письмо (текст и HTML, копия, скрытая копия, теги)
Читать сохранённое сообщение по ключу хранилища
Смотреть события отправки
Создавать списки рассылки и добавлять участников
Смотреть домены аккаунта

Нужен ключ API (Application Programming Interface — программный интерфейс) Mailgun и отправляющий домен (например mg.example.com).

Блок ставят на холст как отдельный шаг или прикрепляют к агенту. Ключ — в переменных окружения рабочего пространства.

Инструменты

`mailgun_send_message`

Отправить письмо через API Mailgun.

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailgun
`domain`	string	Да	Домен Mailgun (например mg.example.com)
`from`	string	Да	Адрес отправителя
`to`	string	Да	Адрес получателя (несколько — через запятую)
`subject`	string	Да	Тема письма
`text`	string	Нет	Тело письма обычным текстом
`html`	string	Нет	Тело письма в HTML
`cc`	string	Нет	Копия (несколько — через запятую)
`bcc`	string	Нет	Скрытая копия (несколько — через запятую)
`tags`	string	Нет	Теги письма (через запятую)

Выход

Параметр	Тип	Описание
`success`	boolean	Удалось ли отправить письмо
`id`	string	ID сообщения
`message`	string	Сообщение ответа Mailgun

`mailgun_get_message`

Прочитать сохранённое сообщение по ключу.

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailgun
`domain`	string	Да	Домен Mailgun
`messageKey`	string	Да	Ключ сообщения в хранилище

Выход

Параметр	Тип	Описание
`success`	boolean	Успешность запроса
`recipients`	string	Получатели
`from`	string	Адрес отправителя
`subject`	string	Тема
`bodyPlain`	string	Тело обычным текстом
`strippedText`	string	Текст без служебных частей
`strippedSignature`	string	Отделённая подпись
`bodyHtml`	string	Тело в HTML
`strippedHtml`	string	HTML без служебных частей
`attachmentCount`	number	Число вложений
`timestamp`	number	Время сообщения
`messageHeaders`	json	Заголовки письма
`contentIdMap`	json	Карта Content-ID

`mailgun_list_messages`

Список событий (журнал) писем, отправленных через Mailgun.

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailgun
`domain`	string	Да	Домен Mailgun
`event`	string	Нет	Тип события (accepted, delivered, failed, opened, clicked и др.)
`limit`	number	Нет	Максимум событий (по умолчанию 100)

Выход

Параметр	Тип	Описание
`success`	boolean	Успешность запроса
`items`	json	Массив событий
`paging`	json	Данные постраничного вывода

`mailgun_create_mailing_list`

Создать список рассылки.

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailgun
`address`	string	Да	Адрес списка (например list@example.com)
`name`	string	Нет	Название списка
`description`	string	Нет	Описание списка
`accessLevel`	string	Нет	Уровень доступа: readonly, members или everyone

Выход

Параметр	Тип	Описание
`success`	boolean	Удалось ли создать список
`message`	string	Сообщение ответа
`list`	json	Данные созданного списка

`mailgun_get_mailing_list`

Данные списка рассылки.

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailgun
`address`	string	Да	Адрес списка

Выход

Параметр	Тип	Описание
`success`	boolean	Успешность запроса
`list`	json	Данные списка

`mailgun_add_list_member`

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

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailgun
`listAddress`	string	Да	Адрес списка
`address`	string	Да	Email участника
`name`	string	Нет	Имя участника
`vars`	string	Нет	Пользовательские переменные — JSON-строка
`subscribed`	boolean	Нет	Подписан ли участник

Выход

Параметр	Тип	Описание
`success`	boolean	Удалось ли добавить участника
`message`	string	Сообщение ответа
`member`	json	Данные добавленного участника

`mailgun_list_domains`

Список доменов аккаунта Mailgun.

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailgun

Выход

Параметр	Тип	Описание
`success`	boolean	Успешность запроса
`totalCount`	number	Всего доменов
`items`	json	Массив объектов доменов

`mailgun_get_domain`

Данные конкретного домена.

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailgun
`domain`	string	Да	Имя домена

Выход

Параметр	Тип	Описание
`success`	boolean	Успешность запроса
`domain`	json	Данные домена

Mailgun

На этой странице