get_mailbox_details

get_mailbox_details(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_mailbox_details(
    OrganizationId='string',
    UserId='string'
)
Parameters
  • OrganizationId (string) --

    [REQUIRED]

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

  • UserId (string) --

    [REQUIRED]

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

Return type

dict

Returns

Response Syntax

{
    'MailboxQuota': 123,
    'MailboxSize': 123.0
}

Response Structure

  • (dict) --

    • MailboxQuota (integer) --

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

    • MailboxSize (float) --

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

Exceptions

  • WorkMail.Client.exceptions.OrganizationNotFoundException
  • WorkMail.Client.exceptions.OrganizationStateException
  • WorkMail.Client.exceptions.EntityNotFoundException