List mailboxes

v1
mail
get
/1/mail_hostings/{mail_hosting_id}/mailboxes

This endpoint allows you to retrieve all the mailboxes for a given mail hosting.

Path parameters

mail_hosting_id
requiredinteger

The unique identifier (ID) of the mail hosting to request.

Examples:44321

Response Body

application/json
resultrequiredstring
Possible values:successerrorasynchronous

Result of the HTTP request

Examples:success
dataarrayofMailbox
totalinteger

Total number of items Added when using query parameter page

Examples:221
pageinteger

Number of the current page Added when using query parameter page

Examples:2
pagesinteger

Total number of pages Added when using query parameter page

Examples:15
items_per_pageinteger

Number of items per page Added when using query parameter page

Examples:15

Example request

                <?php
use GuzzleHttp\Client;

$client = new Client();
$headers = [
	'Authorization' => 'Bearer YOUR-TOKEN-HERE',
	'Content-Type' => 'application/json'
];

$request = new Request('GET', 'https://api.infomaniak.com/1/mail_hostings/{mail_hosting_id}/mailboxes', $headers, $body);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();
            

Example response

application/json
                
                    
{
"result":"success",
"data":[
{
"mailbox_name":"user",
"mailbox":"user@xn--xample-hva.com",
"mailbox_idn":"user@êxample.com",
"is_limited":false,
"is_free_mail":false
}
],
"total":221,
"page":2,
"pages":15,
"items_per_page":15
}