Клиент API Яндекс.Почты для домена
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

36 lines
1.9 KiB

# Описание запроса к API Яндекс.Почты для домена
# Раздел обязательно начинается с 'yamd:'.
# Обязательные поля:
# 'domain' - Имя домена
# 'token' - ПДД-токен
# 'service' - Имя сервиса, доступного через API. Возможные значения:
# * 'deputy'
# * 'dkim'
# * 'dns'
# * 'domain'
# * 'email'
# * 'import'
# 'query' - Команда управления - т.е. что делать будем.
#
# 'sub_service' - Дополнительный сервис в рамках основного. Необязательный,
# т.к. присутствует не вовсех основных сервисах. Например,
# 'ml' - списки рассылок в рамках почтового сервиса
# ('email').
#
# 'options' - Список параметров запроса. Может быть пустым, т.к. в некоторых
# запросах отсутствуют какие-либо параметры, кроме обязательного
# для всех имени домена ('domain'). Для других же запросов могут
# быть дополнительные обязательные параметры.
# Описание всех параметров см. в документации по адресу:
# https://tech.yandex.ru/pdd/doc/about-docpage/
---
yamd:
# Получить список почтовых ящиков для домена example.ru
domain: 'example.ru'
token: '123456789ABCDEF0000000000000000000000000000000000000'
service: 'email'
query: 'list'
options:
page: 1
on_page: 50