Get the list of mailboxes
This request is used for getting a list of the domain's mailboxes.
The response is paginated, and its parameters can be set in the request.
Request syntax
The request should be sent over the HTTPS protocol using the GET method.
GET /api2/admin/email/list?
domain=<domain name>
[&page=<page number in the response>]
[&on_page=<number of mailboxes per response page>]
Host: pddimp.yandex.ru
PddToken: <PDD token>
Headers:
Parameters:
Parameter | Type | Value |
---|---|---|
Mandatory | ||
domain | String | Name of the domain. |
Optional | ||
page | Integer | Page number in the response. The default value is 1. |
on_page | Integer | Number of mailboxes on each response page. The default value is 30. |
Parameter | Type | Value |
---|---|---|
Mandatory | ||
domain | String | Name of the domain. |
Optional | ||
page | Integer | Page number in the response. The default value is 1. |
on_page | Integer | Number of mailboxes on each response page. The default value is 30. |
GET /api2/registrar/email/list?
domain=<domain name>
[&page=<page number in the response>]
[&on_page=<number of mailboxes per response page>]
Host: pddimp.yandex.ru
PddToken: <PDD token>
Authorization: OAuth <OAuth token>
Headers:
Name | Description |
---|---|
PddToken | |
Authorization |
Name | Description |
---|---|
PddToken | |
Authorization |
Parameters:
Parameter | Type | Value |
---|---|---|
Mandatory | ||
domain | String | Name of the domain. |
Optional | ||
page | Integer | Page number in the response. The default value is 1. |
on_page | Integer | Number of mailboxes on each response page. The default value is 30. |
Parameter | Type | Value |
---|---|---|
Mandatory | ||
domain | String | Name of the domain. |
Optional | ||
page | Integer | Page number in the response. The default value is 1. |
on_page | Integer | Number of mailboxes on each response page. The default value is 30. |
Request example
GET /api2/admin/email/list?domain=domain.com&page=1&on_page=5 HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' 'https://pddimp.yandex.ru/api2/admin/email/list?domain=domain.com&page=1&on_page=5'
GET /api2/admin/email/list?domain=domain.com&page=1&on_page=5 HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
Authorization: OAuth 00123456789ABCDEF00000000000000000000000000000000000
curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' -H 'Authorization: OAuth 00123456789ABCDEF00000000000000000000000000000000000' 'https://pddimp.yandex.ru/api2/admin/email/list?domain=domain.com&page=1&on_page=5'
Response structure
{
"domain": "{domain name",
"page": "{page number in the response}",
"pages": "{total number of pages in the response}",
"on_page": "{number of mailboxes per page in the response}",
"total": "{total number of mailboxes on the domain}",
"found": "{number of mailboxes on the current response page}",
"accounts":
[
{
"login": "{email address of a mailbox}",
"uid": "{mailbox ID}",
"enabled": "{mailbox status}",
"fio": "{user's full name}",
"fname": "{user's last name}",
"iname": "{user's first name}",
"birth_date": "{user's date of birth}",
"sex": "{user's gender}",
"hintq": "{secret question}",
"ready": "{whether the mailbox is ready}",
"aliases":
[
"{alias name}",
...
],
"maillist": "{mailing list flag}"
},
...
],
"success": "{status of request execution}"
}
Name | Type of value | Description |
---|---|---|
domain | String | Name of the domain. |
page | Integer | Page number in the response. Value of the page parameter set in the request. If the parameter value is omitted, the default value is used. |
pages | Integer | Total number of pages in the response. |
on_page | Integer | Number of mailboxes on each response page. Value of the on_page parameter set in the request. |
total | Integer | Total number of mailboxes on the domain. |
found | Integer | The number of mailboxes on the current response page (may be less than the on_page value for the last page). |
accounts | Array | Properties of mailboxes. Each object in the array corresponds to a single mailbox. |
success | String | Status of request execution. Possible values:
|
error | String | Error code. Included in the response if the request resulted in an error. Possible values:
|
Keys for objects in the accounts array | ||
login | String | Email address of the mailbox. |
uid | Integer | Mailbox ID. |
enabled | String | Whether the mailbox is enabled. Possible values:
|
fio | String | User's full name. |
aliases | Array | List of . |
fname | String | User's last name. |
iname | String | User's first name. |
birth_date | String | User's date of birth in the format YYYY-MM-DD. |
sex | Integer | User's gender. Possible values:
|
hintq | String | Secret question. |
ready | String | Mailbox readiness. Possible values:
|
maillist | String | Whether this is a mailing list. Possible values:
|
Name | Type of value | Description |
---|---|---|
domain | String | Name of the domain. |
page | Integer | Page number in the response. Value of the page parameter set in the request. If the parameter value is omitted, the default value is used. |
pages | Integer | Total number of pages in the response. |
on_page | Integer | Number of mailboxes on each response page. Value of the on_page parameter set in the request. |
total | Integer | Total number of mailboxes on the domain. |
found | Integer | The number of mailboxes on the current response page (may be less than the on_page value for the last page). |
accounts | Array | Properties of mailboxes. Each object in the array corresponds to a single mailbox. |
success | String | Status of request execution. Possible values:
|
error | String | Error code. Included in the response if the request resulted in an error. Possible values:
|
Keys for objects in the accounts array | ||
login | String | Email address of the mailbox. |
uid | Integer | Mailbox ID. |
enabled | String | Whether the mailbox is enabled. Possible values:
|
fio | String | User's full name. |
aliases | Array | List of . |
fname | String | User's last name. |
iname | String | User's first name. |
birth_date | String | User's date of birth in the format YYYY-MM-DD. |
sex | Integer | User's gender. Possible values:
|
hintq | String | Secret question. |
ready | String | Mailbox readiness. Possible values:
|
maillist | String | Whether this is a mailing list. Possible values:
|