List of registered domains and addresses

Get a list of mail domains and email addresses entered by the user in Post Office. For each domain or address, the current status of the registration process is shown.

Request syntax

https://postoffice.yandex.ru/api/1.0/reg-list
 ? oauth_token=<access token>
Query parameters
oauth_token *

OAuth access token. For more information about getting a token, see the section Application authorization using an OAuth token.

*  Required

Response format

Returns a list of mail domains and addresses that the user entered in Post Office for collecting statistics on mailings. For each domain or address, the Post Office registration status is shown (not verified/verified/entered description).

{
    "session":"seij3uoM",
    "list":[
      {
       "domain":"example.com",
       "status": 2
      },
      {
        "email":"noreply@company.ru",
        "status": 3
      },
      {
        "email":"someuser@somemail.com",
        "status": 1
      }
    ]   
}
session

ID of the session in which the API request was processed. Include this ID when contacting the Yandex support service about bugs or errors you encounter with the Post Office API.

list

A list of mail domains and addresses entered by the user in Post Office. The value is an array. Each mail domain or address is given as a hash item in the array. The order of domains and addresses in the list is not guaranteed.

domain

A mail domain entered by the user in Post Office as the source of mailings. The value is a string.

email

An email address entered by the user in Post Office as the source of mailings. The value is a string.

status

The current status of registering the mail domain or email address in Post Office. Acceptable values:

  • 1 — Not verified. The user added a domain or address in the Post Office interface but did not confirm ownership. Data is not being collected for mailings from this domain or address.
  • 2 — Verified. The user confirmed ownership of the domain or address in the Post Office interface. Data is being collected for mailings from this domain or address.
  • 3 — Description entered. The user confirmed ownership of the domain or address and entered a textual description for it. Data is being collected for mailings from this domain or address.