Skip to content

Latest commit

 

History

History
68 lines (46 loc) · 2.18 KB

README.md

File metadata and controls

68 lines (46 loc) · 2.18 KB

Gem Version Build Status Code Climate Test Coverage

YandexDomains

Ruby client for Yandex Domains API.

Installation

Add this line to your application's Gemfile:

gem 'yandex_domains'

And then execute:

$ bundle

Or install it yourself as:

$ gem install yandex_domains

Documentation

http://www.rubydoc.info/github/beydogan/yandex_domains/

Usage

This client works with only Administrator access. More details about Administrator user is here. In order to use the client and API features, the PDD token is required. You can get a PDD token on the token management page by entering a domain name that has already been verified.

Initialize a client

client = YandexDomains::Client.new(pdd_token)

Usage Examples

After configuring a client, you can do the followings.

Signing up a domain

client.connect_domain('google.com')

Adding a mailbox for a domain

client.add_mailbox('google.com', 'hi', 'strongpassword')

Deleting a mailbox on a domain

client.delete_mailbox('google.com', 'hi')

More examples here

Any ideas?

Use Gitcussion to send your ideas on here

Contributing

  1. Fork it ( https://github.com/beydogan/yandex_domains/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request