exchangelib.services.get_item API documentation

# Module `exchangelib.services.get_item`

Expand source code

    from .common import EWSAccountService, create_item_ids_element, create_shape_element
    from ..util import create_element, MNS

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

        SERVICE_NAME = 'GetItem'
        element_container_name = '{%s}Items' % MNS

        def call(self, items, additional_fields, shape):
            """Return all items in an account that correspond to a list of ID's, in stable order.

            :param items: a list of (id, changekey) tuples or Item objects
            :param additional_fields: the extra fields that should be returned with the item, as FieldPath objects
            :param shape: The shape of returned objects

            :return: XML elements for the items, in stable order
            """
            return self._elems_to_objs(self._chunked_get_elements(
                self.get_payload, items=items, additional_fields=additional_fields, shape=shape,
            ))

        def _elems_to_objs(self, elems):
            from ..folders.base import BaseFolder
            for elem in elems:
                if isinstance(elem, Exception):
                    yield elem
                    continue
                yield BaseFolder.item_model_from_tag(elem.tag).from_xml(elem=elem, account=self.account)

        def get_payload(self, items, additional_fields, shape):
            getitem = create_element('m:%s' % self.SERVICE_NAME)
            itemshape = create_shape_element(
                tag='m:ItemShape', shape=shape, additional_fields=additional_fields, version=self.account.version
            )
            getitem.append(itemshape)
            item_ids = create_item_ids_element(items=items, version=self.account.version)
            getitem.append(item_ids)
            return getitem

## Classes

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

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

  Expand source code

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

          SERVICE_NAME = 'GetItem'
          element_container_name = '{%s}Items' % MNS

          def call(self, items, additional_fields, shape):
              """Return all items in an account that correspond to a list of ID's, in stable order.

              :param items: a list of (id, changekey) tuples or Item objects
              :param additional_fields: the extra fields that should be returned with the item, as FieldPath objects
              :param shape: The shape of returned objects

              :return: XML elements for the items, in stable order
              """
              return self._elems_to_objs(self._chunked_get_elements(
                  self.get_payload, items=items, additional_fields=additional_fields, shape=shape,
              ))

          def _elems_to_objs(self, elems):
              from ..folders.base import BaseFolder
              for elem in elems:
                  if isinstance(elem, Exception):
                      yield elem
                      continue
                  yield BaseFolder.item_model_from_tag(elem.tag).from_xml(elem=elem, account=self.account)

          def get_payload(self, items, additional_fields, shape):
              getitem = create_element('m:%s' % self.SERVICE_NAME)
              itemshape = create_shape_element(
                  tag='m:ItemShape', shape=shape, additional_fields=additional_fields, version=self.account.version
              )
              getitem.append(itemshape)
              item_ids = create_item_ids_element(items=items, version=self.account.version)
              getitem.append(item_ids)
              return getitem

  ### Ancestors

  - EWSAccountService
  - EWSService

  ### Class variables

  `var SERVICE_NAME`
  `var element_container_name`

  ### Methods

  `def call(self, items, additional_fields, shape)`

    Return all items in an account that correspond to a list of ID's, in stable order.

    :param items: a list of (id, changekey) tuples or Item objects :param additional_fields: the extra fields that should be returned with the item, as FieldPath objects :param shape: The shape of returned objects

    :return: XML elements for the items, in stable order

    Expand source code

        def call(self, items, additional_fields, shape):
            """Return all items in an account that correspond to a list of ID's, in stable order.

            :param items: a list of (id, changekey) tuples or Item objects
            :param additional_fields: the extra fields that should be returned with the item, as FieldPath objects
            :param shape: The shape of returned objects

            :return: XML elements for the items, in stable order
            """
            return self._elems_to_objs(self._chunked_get_elements(
                self.get_payload, items=items, additional_fields=additional_fields, shape=shape,
            ))

  `def get_payload(self, items, additional_fields, shape)`
    Expand source code

        def get_payload(self, items, additional_fields, shape):
            getitem = create_element('m:%s' % self.SERVICE_NAME)
            itemshape = create_shape_element(
                tag='m:ItemShape', shape=shape, additional_fields=additional_fields, version=self.account.version
            )
            getitem.append(itemshape)
            item_ids = create_item_ids_element(items=items, version=self.account.version)
            getitem.append(item_ids)
            return getitem

  ### Inherited members

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