diff --git a/README.md b/README.md index 75ac310..48597e6 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,36 @@ -# YaMD-API +# YaMD -Модуль доступа к API Яндекс.Почты для домена для Ansible +Клиент API Яндекс.Почты для домена -## Необходимые модули +## Зависимости -Скрипт написан на языке Perl и использует в работе следующие модули: +* Perl 5; +* [File::Basename](https://metacpan.org/pod/File::Basename); +* [YAML::XS](https://metacpan.org/pod/YAML::XS); +* [JSON::XS](https://metacpan.org/pod/JSON::XS); +* [LWP::UserAgent](https://metacpan.org/pod/LWP::UserAgent); +* [HTTP::Request](https://metacpan.org/pod/HTTP::Request). -* LWP::UserAgent; -* HTTP::Request; -* YAML::XS. +## Назначение + +Скрипт реализует доступ к функциям API Почты для домена от Яндекса. + +С помощью API Почты для домена можно: + +* подключать домены к Яндекс.Почте для домена и отключать их; +* управлять почтовыми ящиками; +* импортировать почту в Яндекс.Почту для домена; +* управлять заместителями администратора домена; +* работать с рассылками, логотипом домена; +* настраивать DNS-записи для домена; +* управлять DKIM для домена. + +Подробное описание можно найти в документации +https://tech.yandex.ru/pdd/doc/about-docpage/ ## Пример запуска ``` -yamd.pl example.yml +yamd example.yml ```