INinfomaniak
Mailbox management

Display a mailbox

Changed on

Returns a variety of information about a single a Mailbox specified by the requested unique identifier.

get/1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}

Request

  • Base URL
    https://api.infomaniak.com
  • URL
    https://api.infomaniak.com/1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}
  • Auth
    HTTP bearer

Path parameters

mail_hosting_idinteger required

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

mailbox_namestring required

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

Query parameters

withstring

Optional : Allows loading additional data about a resource, which may include related resources.

unit'B' | 'MB' | 'kB'

Specifies the storage unit for the mailbox.<note><strong>b</strong>: Return the unit size in Bytes.</note><note><strong>mb</strong>: Return the unit size in Megabytes.</note><note><strong>kb</strong>: Return the unit size in Kilobytes.</note>

Example:B

Response

OK

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

Result of the HTTP request

Example response

{
  "result": "success",
  "data": {
    "users": [
      {
        "id": 123456
      }
    ],
    "teams": [
      {
        "id": 123456,
        "created_by": {
          "id": 123456
        },
        "owned_by": {
          "id": 123456
        }
      }
    ],
    "account_user": {
      "id": 123456
    }
  }
}

Changes

  • 876c540ed2aeRevision changes
    • breaking

      the response property // became optional for the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property ///// to the response with the status