:doc:`WorkMail <../../workmail>` / Paginator / ListMailboxPermissions

**********************
ListMailboxPermissions
**********************



.. py:class:: WorkMail.Paginator.ListMailboxPermissions

  ::

    
    paginator = client.get_paginator('list_mailbox_permissions')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`WorkMail.Client.list_mailbox_permissions`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          OrganizationId='string',
          EntityId='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :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 PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

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

      
      ::

        {
            'Permissions': [
                {
                    'GranteeId': 'string',
                    'GranteeType': 'GROUP'|'USER',
                    'PermissionValues': [
                        'FULL_ACCESS'|'SEND_AS'|'SEND_ON_BEHALF',
                    ]
                },
            ],
            
        }
        
      **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) --* 
          
        
      
    