GetMailboxDetailsCommand

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { WorkMailClient, GetMailboxDetailsCommand } from "@aws-sdk/client-workmail"; // ES Modules import
// const { WorkMailClient, GetMailboxDetailsCommand } = require("@aws-sdk/client-workmail"); // CommonJS import
const client = new WorkMailClient(config);
const input = { // GetMailboxDetailsRequest
  OrganizationId: "STRING_VALUE", // required
  UserId: "STRING_VALUE", // required
};
const command = new GetMailboxDetailsCommand(input);
const response = await client.send(command);
// { // GetMailboxDetailsResponse
//   MailboxQuota: Number("int"),
//   MailboxSize: Number("double"),
// };

GetMailboxDetailsCommand Input

See GetMailboxDetailsCommandInput for more details

Parameter
Type
Description
OrganizationId
Required
string | undefined

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

UserId
Required
string | undefined

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: userdomain.tld

  • User name: user

GetMailboxDetailsCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
MailboxQuota
number | undefined

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

MailboxSize
number | undefined

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

Throws

Name
Fault
Details
EntityNotFoundException
client

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

InvalidParameterException
client

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

OrganizationNotFoundException
client

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

OrganizationStateException
client

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

WorkMailServiceException
Base exception class for all service exceptions from WorkMail service.