INinfomaniak
Mailboxes > Aliases

List mailbox aliases

Changed on

Returns list of aliases for the mailbox specified

get/2/mail_hostings/{service_mail}/mailboxes/{mailbox}/aliases

Request

  • Base URL
    https://api.infomaniak.com
  • URL
    https://api.infomaniak.com/2/mail_hostings/{service_mail}/mailboxes/{mailbox}/aliases
  • Auth
    HTTP bearer

Path parameters

service_mailinteger required

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

mailboxstring required

The username (that is the part before the @) of the email address you want to request.

Query parameters

searchstring
return'total'

Optional : If you pass this parameter with the value total, then the response will be the number of items in the collection, instead of the items themselves.<br /> Part of the total capacity

pageinteger

Optional parameter that define the page number<br /> Part of the pagination capacity

per_pageinteger

Optional parameter that define the number of items per page<br /> Part of the pagination capacity

string
OR
string[]

Optional parameter that define the field used for sorting<br /> Part of the sort capacity

order'asc' | 'desc'

Optional parameter that define the default sort order<br /> Part of the sort capacity

order_forobject

Optional parameter that define the sorting order for a field<br /> By default order is used<br /> Part of the sort capacity

Response

OK

result'success' | 'error' | 'asynchronous' required

Result of the HTTP request

totalinteger

Total number of items Added when using query parameter page

pageinteger

Number of the current page Added when using query parameter page

pagesinteger

Total number of pages Added when using query parameter page

items_per_pageinteger

Number of items per page Added when using query parameter page

Example response

{
  "result": "success",
  "data": [
    {
      "status": "disabled"
    }
  ],
  "total": 221,
  "page": 2,
  "pages": 15,
  "items_per_page": 15
}

Changes