GetMailboxDetails

Requests a user's mailbox details for a specified organization and user.

Request Syntax


{
   "OrganizationId": "string",
   "UserId": "string"
}

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

The identifier for the organization that contains the user whose mailbox details are being requested.

Type: String

Length Constraints: Fixed length of 34.

Pattern: ^m-[0-9a-f]{32}$

Required: Yes

The identifier for the user whose mailbox details are being requested.

The identifier can be the UserId, Username, or email. The following identity formats are available:

User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234
Email address: user@domain.tld
User name: user

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [a-zA-Z0-9._%+@-]+

Required: Yes


{
   "MailboxQuota": number,
   "MailboxSize": number
}

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

The maximum allowed mailbox size, in MB, for the specified user.

Type: Integer

Valid Range: Minimum value of 1.

The current mailbox size, in MB, for the specified user.

Type: Double

Valid Range: Minimum value of 0.

For information about the errors that are common to all actions, see Common Errors.

EntityNotFoundException

The identifier supplied for the user, group, or resource does not exist in your organization.

HTTP Status Code: 400

InvalidParameterException

One or more of the input parameters don't match the service's restrictions.

HTTP Status Code: 400

OrganizationNotFoundException

An operation received a valid organization identifier that either doesn't belong or exist in the system.

HTTP Status Code: 400

OrganizationStateException

The organization must have a valid state to perform certain operations on the organization or its members.

HTTP Status Code: 400