From 7d297c52ec4044eed8b65f622d830aecbab24297 Mon Sep 17 00:00:00 2001
From: Sergey Kiselev <root@digital-freak.ru>
Date: Fri, 15 Jun 2018 13:08:54 +0500
Subject: [PATCH] =?UTF-8?q?example.yml=20-=20=D0=9F=D1=80=D0=B8=D0=BC?=
 =?UTF-8?q?=D0=B5=D1=80=20=D0=B7=D0=B0=D0=BF=D1=80=D0=BE=D1=81=D0=B0=20?=
 =?UTF-8?q?=D1=81=D0=BF=D0=B8=D1=81=D0=BA=D0=B0=20=D0=BF=D0=BE=D1=87=D1=82?=
 =?UTF-8?q?=D0=BE=D0=B2=D1=8B=D1=85=20=D1=8F=D1=89=D0=B8=D0=BA=D0=BE=D0=B2?=
 =?UTF-8?q?=20=D0=BD=D0=B0=20=D0=B4=D0=BE=D0=BC=D0=B5=D0=BD=D0=B5.?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 example.yml | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)
 create mode 100644 example.yml

diff --git a/example.yml b/example.yml
new file mode 100644
index 0000000..c312f61
--- /dev/null
+++ b/example.yml
@@ -0,0 +1,36 @@
+# Описание запроса к 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
+