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

************************
list_mailbox_permissions
************************



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

  

  Lists the mailbox permissions associated with a user, group, or resource mailbox.

  

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


  **Request Syntax**
  ::

    response = client.list_mailbox_permissions(
        OrganizationId='string',
        EntityId='string',
        NextToken='string',
        MaxResults=123
    )
    
  :type OrganizationId: string
  :param OrganizationId: **[REQUIRED]** 

    The identifier of the organization under which the user, group, or resource exists.

    

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

    The identifier of the user, or resource for which to list mailbox permissions.

     

    The entity ID can accept *UserId or ResourceId*, *Username or Resourcename*, or *email*.

     

    
    * Entity ID: 12345678-1234-1234-1234-123456789012, or r-0123456789a0123456789b0123456789
     
    * Email address: entity@domain.tld
     
    * Entity name: entity
    

    

  
  :type NextToken: string
  :param NextToken: 

    The token to use to retrieve the next page of results. The first call does not contain any tokens.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results to return in a single call.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'Permissions': [
              {
                  'GranteeId': 'string',
                  'GranteeType': 'GROUP'|'USER',
                  'PermissionValues': [
                      'FULL_ACCESS'|'SEND_AS'|'SEND_ON_BEHALF',
                  ]
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Permissions** *(list) --* 

        One page of the user, group, or resource mailbox permissions.

        
        

        - *(dict) --* 

          Permission granted to a user, group, or resource to access a certain aspect of another user, group, or resource mailbox.

          
          

          - **GranteeId** *(string) --* 

            The identifier of the user, group, or resource to which the permissions are granted.

            
          

          - **GranteeType** *(string) --* 

            The type of user, group, or resource referred to in GranteeId.

            
          

          - **PermissionValues** *(list) --* 

            The permissions granted to the grantee. SEND_AS allows the grantee to send email as the owner of the mailbox (the grantee is not mentioned on these emails). SEND_ON_BEHALF allows the grantee to send email on behalf of the owner of the mailbox (the grantee is not mentioned as the physical sender of these emails). FULL_ACCESS allows the grantee full access to the mailbox, irrespective of other folder-level permissions set on the mailbox.

            
            

            - *(string) --* 
        
      
    
      

      - **NextToken** *(string) --* 

        The token to use to retrieve the next page of results. The value is "null" when there are no more results to return.

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

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

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

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

  