exchangelib.services.upload_items API documentation

# Module `exchangelib.services.upload_items`

Expand source code

    from .common import EWSAccountService, to_item_id
    from ..properties import ItemId, ParentFolderId
    from ..util import create_element, set_xml_value, add_xml_child, MNS

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

        SERVICE_NAME = 'UploadItems'
        element_container_name = '{%s}ItemId' % MNS

        def call(self, items):
            # _pool_requests expects 'items', not 'data'
            return self._elems_to_objs(self._chunked_get_elements(self.get_payload, items=items))

        def get_payload(self, items):
            """Upload given items to given account.

            'items' is an iterable of tuples where the first element is a Folder instance representing the ParentFolder
            that the item will be placed in and the second element is a tuple containing an optional ItemId, an optional
            Item.is_associated boolean, and a Data string returned from an ExportItems.
            call.

            :param items:
            """
            uploaditems = create_element('m:%s' % self.SERVICE_NAME)
            itemselement = create_element('m:Items')
            uploaditems.append(itemselement)
            for parent_folder, (item_id, is_associated, data_str) in items:
                # TODO: The full spec also allows the "UpdateOrCreate" create action.
                item = create_element('t:Item', attrs=dict(CreateAction='Update' if item_id else 'CreateNew'))
                if is_associated is not None:
                    item.set('IsAssociated', 'true' if is_associated else 'false')
                parentfolderid = ParentFolderId(parent_folder.id, parent_folder.changekey)
                set_xml_value(item, parentfolderid, version=self.account.version)
                if item_id:
                    itemid = to_item_id(item_id, ItemId, version=self.account.version)
                    set_xml_value(item, itemid, version=self.account.version)
                add_xml_child(item, 't:Data', data_str)
                itemselement.append(item)
            return uploaditems

        def _elems_to_objs(self, elems):
            for elem in elems:
                if isinstance(elem, Exception):
                    yield elem
                    continue
                yield elem.get(ItemId.ID_ATTR), elem.get(ItemId.CHANGEKEY_ATTR)

        @classmethod
        def _get_elements_in_container(cls, container):
            return [container]

## Classes

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

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

  Expand source code

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

          SERVICE_NAME = 'UploadItems'
          element_container_name = '{%s}ItemId' % MNS

          def call(self, items):
              # _pool_requests expects 'items', not 'data'
              return self._elems_to_objs(self._chunked_get_elements(self.get_payload, items=items))

          def get_payload(self, items):
              """Upload given items to given account.

              'items' is an iterable of tuples where the first element is a Folder instance representing the ParentFolder
              that the item will be placed in and the second element is a tuple containing an optional ItemId, an optional
              Item.is_associated boolean, and a Data string returned from an ExportItems.
              call.

              :param items:
              """
              uploaditems = create_element('m:%s' % self.SERVICE_NAME)
              itemselement = create_element('m:Items')
              uploaditems.append(itemselement)
              for parent_folder, (item_id, is_associated, data_str) in items:
                  # TODO: The full spec also allows the "UpdateOrCreate" create action.
                  item = create_element('t:Item', attrs=dict(CreateAction='Update' if item_id else 'CreateNew'))
                  if is_associated is not None:
                      item.set('IsAssociated', 'true' if is_associated else 'false')
                  parentfolderid = ParentFolderId(parent_folder.id, parent_folder.changekey)
                  set_xml_value(item, parentfolderid, version=self.account.version)
                  if item_id:
                      itemid = to_item_id(item_id, ItemId, version=self.account.version)
                      set_xml_value(item, itemid, version=self.account.version)
                  add_xml_child(item, 't:Data', data_str)
                  itemselement.append(item)
              return uploaditems

          def _elems_to_objs(self, elems):
              for elem in elems:
                  if isinstance(elem, Exception):
                      yield elem
                      continue
                  yield elem.get(ItemId.ID_ATTR), elem.get(ItemId.CHANGEKEY_ATTR)

          @classmethod
          def _get_elements_in_container(cls, container):
              return [container]

  ### Ancestors

  - EWSAccountService
  - EWSService

  ### Class variables

  `var SERVICE_NAME`
  `var element_container_name`

  ### Methods

  `def call(self, items)`
    Expand source code

        def call(self, items):
            # _pool_requests expects 'items', not 'data'
            return self._elems_to_objs(self._chunked_get_elements(self.get_payload, items=items))

  `def get_payload(self, items)`

    Upload given items to given account.

    'items' is an iterable of tuples where the first element is a Folder instance representing the ParentFolder that the item will be placed in and the second element is a tuple containing an optional ItemId, an optional Item.is_associated boolean, and a Data string returned from an ExportItems. call.

    :param items:

    Expand source code

        def get_payload(self, items):
            """Upload given items to given account.

            'items' is an iterable of tuples where the first element is a Folder instance representing the ParentFolder
            that the item will be placed in and the second element is a tuple containing an optional ItemId, an optional
            Item.is_associated boolean, and a Data string returned from an ExportItems.
            call.

            :param items:
            """
            uploaditems = create_element('m:%s' % self.SERVICE_NAME)
            itemselement = create_element('m:Items')
            uploaditems.append(itemselement)
            for parent_folder, (item_id, is_associated, data_str) in items:
                # TODO: The full spec also allows the "UpdateOrCreate" create action.
                item = create_element('t:Item', attrs=dict(CreateAction='Update' if item_id else 'CreateNew'))
                if is_associated is not None:
                    item.set('IsAssociated', 'true' if is_associated else 'false')
                parentfolderid = ParentFolderId(parent_folder.id, parent_folder.changekey)
                set_xml_value(item, parentfolderid, version=self.account.version)
                if item_id:
                    itemid = to_item_id(item_id, ItemId, version=self.account.version)
                    set_xml_value(item, itemid, version=self.account.version)
                add_xml_child(item, 't:Data', data_str)
                itemselement.append(item)
            return uploaditems

  ### Inherited members

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