:doc:`WorkMail <../../workmail>` / Client / get_mailbox_details

*******************
get_mailbox_details
*******************



.. py:method:: WorkMail.Client.get_mailbox_details(**kwargs)

  

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

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/GetMailboxDetails>`_  


  **Request Syntax**
  ::

    response = client.get_mailbox_details(
        OrganizationId='string',
        UserId='string'
    )
    
  :type OrganizationId: string
  :param OrganizationId: **[REQUIRED]** 

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

    

  
  :type UserId: string
  :param UserId: **[REQUIRED]** 

    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
    

    

  
  
  :rtype: 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**
  
  *   :py:class:`WorkMail.Client.exceptions.InvalidParameterException`

  
  *   :py:class:`WorkMail.Client.exceptions.OrganizationNotFoundException`

  
  *   :py:class:`WorkMail.Client.exceptions.OrganizationStateException`

  
  *   :py:class:`WorkMail.Client.exceptions.EntityNotFoundException`

  