exchangelib.services.find_folder API documentation

# Module `exchangelib.services.find_folder`

Expand source code

    from collections import OrderedDict

    from .common import EWSAccountService, create_shape_element
    from ..util import create_element, set_xml_value, TNS, MNS
    from ..version import EXCHANGE_2010

    class FindFolder(EWSAccountService):
        """MSDN: https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/findfolder-operation"""

        SERVICE_NAME = 'FindFolder'
        element_container_name = '{%s}Folders' % TNS
        paging_container_name = '{%s}RootFolder' % MNS
        supports_paging = True

        def __init__(self, *args, **kwargs):
            super().__init__(*args, **kwargs)
            self.root = None  # A hack to communicate parsing args to _elems_to_objs()

        def call(self, folders, additional_fields, restriction, shape, depth, max_items, offset):
            """Find subfolders of a folder.

            :param folders: the folders to act on
            :param additional_fields: the extra fields that should be returned with the folder, as FieldPath objects
            :param restriction: Restriction object that defines the filters for the query
            :param shape: The set of attributes to return
            :param depth: How deep in the folder structure to search for folders
            :param max_items: The maximum number of items to return
            :param offset: the offset relative to the first item in the item collection. Usually 0.

            :return: XML elements for the matching folders
            """
            roots = {f.root for f in folders}
            if len(roots) != 1:
                raise ValueError('FindFolder must be called with folders in the same root hierarchy (%r)' % roots)
            self.root = roots.pop()
            return self._elems_to_objs(self._paged_call(
                    payload_func=self.get_payload,
                    max_items=max_items,
                    folders=folders,
                    **dict(
                        additional_fields=additional_fields,
                        restriction=restriction,
                        shape=shape,
                        depth=depth,
                        page_size=self.chunk_size,
                        offset=offset,
                    )
            ))

        def _elems_to_objs(self, elems):
            from ..folders import Folder
            for elem in elems:
                if isinstance(elem, Exception):
                    yield elem
                    continue
                yield Folder.from_xml_with_root(elem=elem, root=self.root)

        def get_payload(self, folders, additional_fields, restriction, shape, depth, page_size, offset=0):
            findfolder = create_element('m:%s' % self.SERVICE_NAME, attrs=dict(Traversal=depth))
            foldershape = create_shape_element(
                tag='m:FolderShape', shape=shape, additional_fields=additional_fields, version=self.account.version
            )
            findfolder.append(foldershape)
            if self.account.version.build >= EXCHANGE_2010:
                indexedpageviewitem = create_element(
                    'm:IndexedPageFolderView',
                    attrs=OrderedDict([
                        ('MaxEntriesReturned', str(page_size)),
                        ('Offset', str(offset)),
                        ('BasePoint', 'Beginning'),
                    ])
                )
                findfolder.append(indexedpageviewitem)
            else:
                if offset != 0:
                    raise ValueError('Offsets are only supported from Exchange 2010')
            if restriction:
                findfolder.append(restriction.to_xml(version=self.account.version))
            parentfolderids = create_element('m:ParentFolderIds')
            set_xml_value(parentfolderids, folders, version=self.account.version)
            findfolder.append(parentfolderids)
            return findfolder

## Classes

`class FindFolder (*args, **kwargs)`

  MSDN: https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/findfolder-operation

  Expand source code

      class FindFolder(EWSAccountService):
          """MSDN: https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/findfolder-operation"""

          SERVICE_NAME = 'FindFolder'
          element_container_name = '{%s}Folders' % TNS
          paging_container_name = '{%s}RootFolder' % MNS
          supports_paging = True

          def __init__(self, *args, **kwargs):
              super().__init__(*args, **kwargs)
              self.root = None  # A hack to communicate parsing args to _elems_to_objs()

          def call(self, folders, additional_fields, restriction, shape, depth, max_items, offset):
              """Find subfolders of a folder.

              :param folders: the folders to act on
              :param additional_fields: the extra fields that should be returned with the folder, as FieldPath objects
              :param restriction: Restriction object that defines the filters for the query
              :param shape: The set of attributes to return
              :param depth: How deep in the folder structure to search for folders
              :param max_items: The maximum number of items to return
              :param offset: the offset relative to the first item in the item collection. Usually 0.

              :return: XML elements for the matching folders
              """
              roots = {f.root for f in folders}
              if len(roots) != 1:
                  raise ValueError('FindFolder must be called with folders in the same root hierarchy (%r)' % roots)
              self.root = roots.pop()
              return self._elems_to_objs(self._paged_call(
                      payload_func=self.get_payload,
                      max_items=max_items,
                      folders=folders,
                      **dict(
                          additional_fields=additional_fields,
                          restriction=restriction,
                          shape=shape,
                          depth=depth,
                          page_size=self.chunk_size,
                          offset=offset,
                      )
              ))

          def _elems_to_objs(self, elems):
              from ..folders import Folder
              for elem in elems:
                  if isinstance(elem, Exception):
                      yield elem
                      continue
                  yield Folder.from_xml_with_root(elem=elem, root=self.root)

          def get_payload(self, folders, additional_fields, restriction, shape, depth, page_size, offset=0):
              findfolder = create_element('m:%s' % self.SERVICE_NAME, attrs=dict(Traversal=depth))
              foldershape = create_shape_element(
                  tag='m:FolderShape', shape=shape, additional_fields=additional_fields, version=self.account.version
              )
              findfolder.append(foldershape)
              if self.account.version.build >= EXCHANGE_2010:
                  indexedpageviewitem = create_element(
                      'm:IndexedPageFolderView',
                      attrs=OrderedDict([
                          ('MaxEntriesReturned', str(page_size)),
                          ('Offset', str(offset)),
                          ('BasePoint', 'Beginning'),
                      ])
                  )
                  findfolder.append(indexedpageviewitem)
              else:
                  if offset != 0:
                      raise ValueError('Offsets are only supported from Exchange 2010')
              if restriction:
                  findfolder.append(restriction.to_xml(version=self.account.version))
              parentfolderids = create_element('m:ParentFolderIds')
              set_xml_value(parentfolderids, folders, version=self.account.version)
              findfolder.append(parentfolderids)
              return findfolder

  ### Ancestors

  - EWSAccountService
  - EWSService

  ### Class variables

  `var SERVICE_NAME`
  `var element_container_name`
  `var paging_container_name`
  `var supports_paging`

  ### Methods

  `def call(self, folders, additional_fields, restriction, shape, depth, max_items, offset)`

    Find subfolders of a folder.

    :param folders: the folders to act on :param additional_fields: the extra fields that should be returned with the folder, as FieldPath objects :param restriction: Restriction object that defines the filters for the query :param shape: The set of attributes to return :param depth: How deep in the folder structure to search for folders :param max_items: The maximum number of items to return :param offset: the offset relative to the first item in the item collection. Usually 0.

    :return: XML elements for the matching folders

    Expand source code

        def call(self, folders, additional_fields, restriction, shape, depth, max_items, offset):
            """Find subfolders of a folder.

            :param folders: the folders to act on
            :param additional_fields: the extra fields that should be returned with the folder, as FieldPath objects
            :param restriction: Restriction object that defines the filters for the query
            :param shape: The set of attributes to return
            :param depth: How deep in the folder structure to search for folders
            :param max_items: The maximum number of items to return
            :param offset: the offset relative to the first item in the item collection. Usually 0.

            :return: XML elements for the matching folders
            """
            roots = {f.root for f in folders}
            if len(roots) != 1:
                raise ValueError('FindFolder must be called with folders in the same root hierarchy (%r)' % roots)
            self.root = roots.pop()
            return self._elems_to_objs(self._paged_call(
                    payload_func=self.get_payload,
                    max_items=max_items,
                    folders=folders,
                    **dict(
                        additional_fields=additional_fields,
                        restriction=restriction,
                        shape=shape,
                        depth=depth,
                        page_size=self.chunk_size,
                        offset=offset,
                    )
            ))

  `def get_payload(self, folders, additional_fields, restriction, shape, depth, page_size, offset=0)`
    Expand source code

        def get_payload(self, folders, additional_fields, restriction, shape, depth, page_size, offset=0):
            findfolder = create_element('m:%s' % self.SERVICE_NAME, attrs=dict(Traversal=depth))
            foldershape = create_shape_element(
                tag='m:FolderShape', shape=shape, additional_fields=additional_fields, version=self.account.version
            )
            findfolder.append(foldershape)
            if self.account.version.build >= EXCHANGE_2010:
                indexedpageviewitem = create_element(
                    'm:IndexedPageFolderView',
                    attrs=OrderedDict([
                        ('MaxEntriesReturned', str(page_size)),
                        ('Offset', str(offset)),
                        ('BasePoint', 'Beginning'),
                    ])
                )
                findfolder.append(indexedpageviewitem)
            else:
                if offset != 0:
                    raise ValueError('Offsets are only supported from Exchange 2010')
            if restriction:
                findfolder.append(restriction.to_xml(version=self.account.version))
            parentfolderids = create_element('m:ParentFolderIds')
            set_xml_value(parentfolderids, folders, version=self.account.version)
            findfolder.append(parentfolderids)
            return findfolder

  ### Inherited members

  - `EWSAccountService`:
    - `NO_VALID_SERVER_VERSIONS`
    - `WARNINGS_TO_CATCH_IN_RESPONSE`
    - `get`
    - `parse`