Get a list of subscribers

This request is used for getting a list of mailboxes included in a mailing list.

The mailing list can be specified using the email address or the mailbox ID. You can get the ID in the response to the Get domain mailing lists request.

  1. Request syntax
  2. Request example
  3. Response structure

Request syntax

The request should be sent over the HTTPS protocol using the GET method.

GET /api2/admin/email/ml/subscribers?
domain=<domain name>
&(maillist=<email address or username of mailing list>|maillist_uid=<mailing list ID>)

Host: pddimp.yandex.ru
PddToken: <PDD token>

Headers:

Name Description
PddToken

PDD token.
Name Description
PddToken

PDD token.

Parameters:

Parameter Type Value
Mandatory
domain String

Name of the domain.
maillist String

The email address of the mailing list, in the format “username@domain.ru” or “username”.

The request should only pass one of the parameters: maillist or maillist_uid.
maillist_uid Integer

ID of the mailing list.

You can get the ID value in the response to the Get domain mailing lists request.

The request should only pass one of the parameters: maillist or maillist_uid.
Parameter Type Value
Mandatory
domain String

Name of the domain.
maillist String

The email address of the mailing list, in the format “username@domain.ru” or “username”.

The request should only pass one of the parameters: maillist or maillist_uid.
maillist_uid Integer

ID of the mailing list.

You can get the ID value in the response to the Get domain mailing lists request.

The request should only pass one of the parameters: maillist or maillist_uid.

Request example

GET /api2/admin/email/ml/subscribers?domain=domain.com&maillist_uid=123456789 HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
cURL
curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' 'https://pddimp.yandex.ru/api2/admin/email/ml/subscribers?domain=domain.com&maillist_uid=123456789'

Response structure

{
  "domain": "{domain name}",
  "maillist": "{email address of the mailing list}",
  "uid": "{mailing list ID}",
  "subscribers":
    [
      "{subscriber's email address}",
      ...
    ],
  "success": "{status of request execution}"
}
Name Type of value Description
domain String

Name of the domain.
maillist String

Email address of the mailing list.
uid Integer

ID of the mailing list.
success String

Status of request execution.

Possible values:
  • ok — Request executed successfully.
  • error — Request executed with error.
subscribers Array

List of subscribers' email addresses.
error String

Error code.

Included in the response if the request resulted in an error.

Possible values:
  • unknown — A temporary failure or API error occurred (repeat the request again later).
  • no_token (no_domain, no_ip ) — A mandatory parameter was omitted.
  • bad_domain — The domain name was not specified or does not conform to the RFC.
  • prohibited — A forbidden domain name.
  • bad_token (bad_login, bad_passwd) — An invalid PDD token (or username/password) was passed.
  • no_auth — The PddToken header was omitted.
  • not_allowed — This operation is not allowed for this user (the user is not the domain administrator).
  • blocked — Blocked domain (for example, due to spam and so on).
  • occupied — The domain name is in use by another user.
  • domain_limit_reached — Exceeded the acceptable number of connected domains (50).
  • no_reply — Yandex.Mail for Domain cannot connect to the server source for the import.
Name Type of value Description
domain String

Name of the domain.
maillist String

Email address of the mailing list.
uid Integer

ID of the mailing list.
success String

Status of request execution.

Possible values:
  • ok — Request executed successfully.
  • error — Request executed with error.
subscribers Array

List of subscribers' email addresses.
error String

Error code.

Included in the response if the request resulted in an error.

Possible values:
  • unknown — A temporary failure or API error occurred (repeat the request again later).
  • no_token (no_domain, no_ip ) — A mandatory parameter was omitted.
  • bad_domain — The domain name was not specified or does not conform to the RFC.
  • prohibited — A forbidden domain name.
  • bad_token (bad_login, bad_passwd) — An invalid PDD token (or username/password) was passed.
  • no_auth — The PddToken header was omitted.
  • not_allowed — This operation is not allowed for this user (the user is not the domain administrator).
  • blocked — Blocked domain (for example, due to spam and so on).
  • occupied — The domain name is in use by another user.
  • domain_limit_reached — Exceeded the acceptable number of connected domains (50).
  • no_reply — Yandex.Mail for Domain cannot connect to the server source for the import.