exchangelib.services.archive_item API documentation

# Module `exchangelib.services.archive_item`

Expand source code

    from ..items import Item
    from ..util import MNS, create_element
    from ..version import EXCHANGE_2013
    from .common import EWSAccountService, folder_ids_element, item_ids_element

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

        SERVICE_NAME = "ArchiveItem"
        element_container_name = f"{{{MNS}}}Items"
        supported_from = EXCHANGE_2013

        def call(self, items, to_folder):
            """Move a list of items to a specific folder in the archive mailbox.

            :param items: a list of (id, changekey) tuples or Item objects
            :param to_folder:

            :return: None
            """
            return self._elems_to_objs(self._chunked_get_elements(self.get_payload, items=items, to_folder=to_folder))

        def _elem_to_obj(self, elem):
            return Item.id_from_xml(elem)

        def get_payload(self, items, to_folder):
            payload = create_element(f"m:{self.SERVICE_NAME}")
            payload.append(
                folder_ids_element(folders=[to_folder], version=self.account.version, tag="m:ArchiveSourceFolderId")
            )
            payload.append(item_ids_element(items=items, version=self.account.version))
            return payload

## Classes

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

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

  Expand source code

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

          SERVICE_NAME = "ArchiveItem"
          element_container_name = f"{{{MNS}}}Items"
          supported_from = EXCHANGE_2013

          def call(self, items, to_folder):
              """Move a list of items to a specific folder in the archive mailbox.

              :param items: a list of (id, changekey) tuples or Item objects
              :param to_folder:

              :return: None
              """
              return self._elems_to_objs(self._chunked_get_elements(self.get_payload, items=items, to_folder=to_folder))

          def _elem_to_obj(self, elem):
              return Item.id_from_xml(elem)

          def get_payload(self, items, to_folder):
              payload = create_element(f"m:{self.SERVICE_NAME}")
              payload.append(
                  folder_ids_element(folders=[to_folder], version=self.account.version, tag="m:ArchiveSourceFolderId")
              )
              payload.append(item_ids_element(items=items, version=self.account.version))
              return payload

  ### Ancestors

  - EWSAccountService
  - EWSService
  - SupportedVersionClassMixIn

  ### Class variables

  `var SERVICE_NAME`
  `var element_container_name`
  `var supported_from`

  ### Methods

  `def call(self, items, to_folder)`

    Move a list of items to a specific folder in the archive mailbox.

    :param items: a list of (id, changekey) tuples or Item objects :param to_folder:

    :return: None

    Expand source code

        def call(self, items, to_folder):
            """Move a list of items to a specific folder in the archive mailbox.

            :param items: a list of (id, changekey) tuples or Item objects
            :param to_folder:

            :return: None
            """
            return self._elems_to_objs(self._chunked_get_elements(self.get_payload, items=items, to_folder=to_folder))

  `def get_payload(self, items, to_folder)`
    Expand source code

        def get_payload(self, items, to_folder):
            payload = create_element(f"m:{self.SERVICE_NAME}")
            payload.append(
                folder_ids_element(folders=[to_folder], version=self.account.version, tag="m:ArchiveSourceFolderId")
            )
            payload.append(item_ids_element(items=items, version=self.account.version))
            return payload

  ### Inherited members

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