exchangelib.services.create_item API documentation

# Module `exchangelib.services.create_item`

## Classes

`class CreateItem (*args, **kwargs)`
  Expand source code

      class CreateItem(EWSAccountService):
          """Take a folder and a list of items. Return the result of creation as a list of tuples (success[True|False],
          errormessage), in the same order as the input list.

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

          SERVICE_NAME = "CreateItem"
          element_container_name = f"{{{MNS}}}Items"

          def call(self, items, folder, message_disposition, send_meeting_invitations):
              if message_disposition not in MESSAGE_DISPOSITION_CHOICES:
                  raise InvalidEnumValue("message_disposition", message_disposition, MESSAGE_DISPOSITION_CHOICES)
              if send_meeting_invitations not in SEND_MEETING_INVITATIONS_CHOICES:
                  raise InvalidEnumValue(
                      "send_meeting_invitations", send_meeting_invitations, SEND_MEETING_INVITATIONS_CHOICES
                  )
              if folder is not None:
                  if not isinstance(folder, (BaseFolder, FolderId)):
                      raise InvalidTypeError("folder", folder, (BaseFolder, FolderId))
                  if folder.account != self.account:
                      raise ValueError("Folder must belong to account")
              if message_disposition == SAVE_ONLY and folder is None:
                  raise AttributeError("Folder must be supplied when in save-only mode")
              if message_disposition == SEND_AND_SAVE_COPY and folder is None:
                  folder = self.account.sent  # 'Sent' is default EWS behaviour
              if message_disposition == SEND_ONLY and folder is not None:
                  raise AttributeError("Folder must be None in send-ony mode")
              return self._elems_to_objs(
                  self._chunked_get_elements(
                      self.get_payload,
                      items=items,
                      folder=folder,
                      message_disposition=message_disposition,
                      send_meeting_invitations=send_meeting_invitations,
                  )
              )

          def _elem_to_obj(self, elem):
              if isinstance(elem, bool):
                  return elem
              return BulkCreateResult.from_xml(elem=elem, account=self.account)

          @classmethod
          def _get_elements_in_container(cls, container):
              res = super()._get_elements_in_container(container)
              return res or [True]

          def get_payload(self, items, folder, message_disposition, send_meeting_invitations):
              """Take a list of Item objects (CalendarItem, Message etc.) and return the XML for a CreateItem request.
              convert items to XML Elements.

              MessageDisposition is only applicable to email messages, where it is required.

              SendMeetingInvitations is required for calendar items. It is also applicable to tasks, meeting request
              responses (see
              https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/createitem-operation-meeting-request
              ) and sharing
              invitation accepts (see
              https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/createitem-acceptsharinginvitation
              ). The last two are not supported yet.

              :param items:
              :param folder:
              :param message_disposition:
              :param send_meeting_invitations:
              """
              payload = create_element(
                  f"m:{self.SERVICE_NAME}",
                  attrs=dict(MessageDisposition=message_disposition, SendMeetingInvitations=send_meeting_invitations),
              )
              if folder:
                  payload.append(
                      folder_ids_element(folders=[folder], version=self.account.version, tag="m:SavedItemFolderId")
                  )
              item_elems = create_element("m:Items")
              for item in items:
                  if not item.account:
                      item.account = self.account
                  set_xml_value(item_elems, item, version=self.account.version)
              payload.append(item_elems)
              return payload

  Take a folder and a list of items. Return the result of creation as a list of tuples (success[True|False], errormessage), in the same order as the input list.

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

  ### Ancestors

  - EWSAccountService
  - EWSService
  - SupportedVersionClassMixIn

  ### Class variables

  `var SERVICE_NAME`
  `var element_container_name`

  ### Methods

  `def call(self, items, folder, message_disposition, send_meeting_invitations)`
    Expand source code

        def call(self, items, folder, message_disposition, send_meeting_invitations):
            if message_disposition not in MESSAGE_DISPOSITION_CHOICES:
                raise InvalidEnumValue("message_disposition", message_disposition, MESSAGE_DISPOSITION_CHOICES)
            if send_meeting_invitations not in SEND_MEETING_INVITATIONS_CHOICES:
                raise InvalidEnumValue(
                    "send_meeting_invitations", send_meeting_invitations, SEND_MEETING_INVITATIONS_CHOICES
                )
            if folder is not None:
                if not isinstance(folder, (BaseFolder, FolderId)):
                    raise InvalidTypeError("folder", folder, (BaseFolder, FolderId))
                if folder.account != self.account:
                    raise ValueError("Folder must belong to account")
            if message_disposition == SAVE_ONLY and folder is None:
                raise AttributeError("Folder must be supplied when in save-only mode")
            if message_disposition == SEND_AND_SAVE_COPY and folder is None:
                folder = self.account.sent  # 'Sent' is default EWS behaviour
            if message_disposition == SEND_ONLY and folder is not None:
                raise AttributeError("Folder must be None in send-ony mode")
            return self._elems_to_objs(
                self._chunked_get_elements(
                    self.get_payload,
                    items=items,
                    folder=folder,
                    message_disposition=message_disposition,
                    send_meeting_invitations=send_meeting_invitations,
                )
            )

  `def get_payload(self, items, folder, message_disposition, send_meeting_invitations)`
    Expand source code

        def get_payload(self, items, folder, message_disposition, send_meeting_invitations):
            """Take a list of Item objects (CalendarItem, Message etc.) and return the XML for a CreateItem request.
            convert items to XML Elements.

            MessageDisposition is only applicable to email messages, where it is required.

            SendMeetingInvitations is required for calendar items. It is also applicable to tasks, meeting request
            responses (see
            https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/createitem-operation-meeting-request
            ) and sharing
            invitation accepts (see
            https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/createitem-acceptsharinginvitation
            ). The last two are not supported yet.

            :param items:
            :param folder:
            :param message_disposition:
            :param send_meeting_invitations:
            """
            payload = create_element(
                f"m:{self.SERVICE_NAME}",
                attrs=dict(MessageDisposition=message_disposition, SendMeetingInvitations=send_meeting_invitations),
            )
            if folder:
                payload.append(
                    folder_ids_element(folders=[folder], version=self.account.version, tag="m:SavedItemFolderId")
                )
            item_elems = create_element("m:Items")
            for item in items:
                if not item.account:
                    item.account = self.account
                set_xml_value(item_elems, item, version=self.account.version)
            payload.append(item_elems)
            return payload

    Take a list of Item objects (CalendarItem, Message etc.) and return the XML for a CreateItem request. convert items to XML Elements.

    MessageDisposition is only applicable to email messages, where it is required.

    SendMeetingInvitations is required for calendar items. It is also applicable to tasks, meeting request responses (see https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/createitem-operation-meeting-request ) and sharing invitation accepts (see https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/createitem-acceptsharinginvitation ). The last two are not supported yet.

    :param items: :param folder: :param message_disposition: :param send_meeting_invitations:

  ### Inherited members

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