Display a mailbox
v1
mail
get
/1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}
Returns a variety of information about a single a Mailbox specified by the requested unique identifier.
mail_hosting_id
requiredinteger
The unique identifier (ID) of the mail hosting to request.
Examples:82660
mailbox_name
requiredstring
The username (that is the part before the @) of the email address you want to request.
Examples:example
Query parameters
withstring
Possible values:full_nameauthorized_sendersblocked_sendershas_auto_responderredirectionhas_move_spamaliaseslast_loginpassword_last_changed_atcreated_atuserssmtpbanhas_dkim_signatureis_removableauthpermissionshas_operation_in_progressfull_aliasesmailbox_idhas_mail_filteringmail_filtering_folder_commercialsmail_filtering_folder_social_networkssizesize_refreshworkspace_securitycount_signatures
Examples:auth
Response Body
application/json
resultrequiredstring
Possible values:successerrorasynchronous
Result of the HTTP request
Examples:success
dataMailbox
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/{mailbox_name}', $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}}