@backtomyfuture/exchange-cli-darwin-arm64 0.1.8 → 0.1.10

package/bin/_internal/exchangelib/items/__init__.py

@@ -0,0 +1,147 @@
+from .base import (
+    AFFECTED_TASK_OCCURRENCES_CHOICES,
+    ALL_OCCURRENCES,
+    ALL_PROPERTIES,
+    ALWAYS_OVERWRITE,
+    AUTO_RESOLVE,
+    CONFLICT_RESOLUTION_CHOICES,
+    DEFAULT,
+    DELETE_TYPE_CHOICES,
+    HARD_DELETE,
+    ID_ONLY,
+    MESSAGE_DISPOSITION_CHOICES,
+    MOVE_TO_DELETED_ITEMS,
+    NEVER_OVERWRITE,
+    SAVE_ONLY,
+    SEND_AND_SAVE_COPY,
+    SEND_MEETING_CANCELLATIONS_CHOICES,
+    SEND_MEETING_INVITATIONS_AND_CANCELLATIONS_CHOICES,
+    SEND_MEETING_INVITATIONS_CHOICES,
+    SEND_ONLY,
+    SEND_ONLY_TO_ALL,
+    SEND_ONLY_TO_CHANGED,
+    SEND_TO_ALL_AND_SAVE_COPY,
+    SEND_TO_CHANGED_AND_SAVE_COPY,
+    SEND_TO_NONE,
+    SHAPE_CHOICES,
+    SOFT_DELETE,
+    SPECIFIED_OCCURRENCE_ONLY,
+    BulkCreateResult,
+    RegisterMixIn,
+)
+from .calendar_item import (
+    CONFERENCE_TYPES,
+    AcceptItem,
+    CalendarItem,
+    CancelCalendarItem,
+    DeclineItem,
+    MeetingCancellation,
+    MeetingMessage,
+    MeetingRequest,
+    MeetingResponse,
+    TentativelyAcceptItem,
+    _Booking,
+)
+from .contact import Contact, DistributionList, Persona
+from .item import BaseItem, Item
+from .message import ForwardItem, Message, ReplyAllToItem, ReplyToItem
+from .post import PostItem, PostReplyItem
+from .task import Task
+
+# Traversal enums
+SHALLOW = "Shallow"
+SOFT_DELETED = "SoftDeleted"
+ASSOCIATED = "Associated"
+ITEM_TRAVERSAL_CHOICES = (SHALLOW, SOFT_DELETED, ASSOCIATED)
+
+# Contacts search (ResolveNames) scope enums
+ACTIVE_DIRECTORY = "ActiveDirectory"
+ACTIVE_DIRECTORY_CONTACTS = "ActiveDirectoryContacts"
+CONTACTS = "Contacts"
+CONTACTS_ACTIVE_DIRECTORY = "ContactsActiveDirectory"
+SEARCH_SCOPE_CHOICES = (ACTIVE_DIRECTORY, ACTIVE_DIRECTORY_CONTACTS, CONTACTS, CONTACTS_ACTIVE_DIRECTORY)
+
+
+ITEM_CLASSES = (
+    _Booking,
+    CalendarItem,
+    Contact,
+    DistributionList,
+    Item,
+    Message,
+    MeetingMessage,
+    MeetingRequest,
+    MeetingResponse,
+    MeetingCancellation,
+    PostItem,
+    Task,
+)
+TASK_ITEM_CLASSES = (Task,)
+CONTACT_ITEM_CLASSES = (Contact, DistributionList)
+MESSAGE_ITEM_CLASSES = (Message, MeetingRequest, MeetingResponse, MeetingCancellation)
+
+__all__ = [
+    "ACTIVE_DIRECTORY",
+    "ACTIVE_DIRECTORY_CONTACTS",
+    "AFFECTED_TASK_OCCURRENCES_CHOICES",
+    "ALL_OCCURRENCES",
+    "ALL_PROPERTIES",
+    "ALWAYS_OVERWRITE",
+    "ASSOCIATED",
+    "AUTO_RESOLVE",
+    "AcceptItem",
+    "BaseItem",
+    "BulkCreateResult",
+    "CONFERENCE_TYPES",
+    "CONFLICT_RESOLUTION_CHOICES",
+    "CONTACT_ITEM_CLASSES",
+    "CONTACTS",
+    "CONTACTS_ACTIVE_DIRECTORY",
+    "CalendarItem",
+    "CancelCalendarItem",
+    "Contact",
+    "DEFAULT",
+    "DELETE_TYPE_CHOICES",
+    "DeclineItem",
+    "DistributionList",
+    "ForwardItem",
+    "HARD_DELETE",
+    "ID_ONLY",
+    "ITEM_CLASSES",
+    "ITEM_TRAVERSAL_CHOICES",
+    "Item",
+    "MESSAGE_DISPOSITION_CHOICES",
+    "MESSAGE_ITEM_CLASSES",
+    "MOVE_TO_DELETED_ITEMS",
+    "TASK_ITEM_CLASSES",
+    "MeetingCancellation",
+    "MeetingRequest",
+    "MeetingResponse",
+    "Message",
+    "NEVER_OVERWRITE",
+    "Persona",
+    "PostItem",
+    "PostReplyItem",
+    "RegisterMixIn",
+    "ReplyAllToItem",
+    "ReplyToItem",
+    "SAVE_ONLY",
+    "SEARCH_SCOPE_CHOICES",
+    "SEND_AND_SAVE_COPY",
+    "SEND_MEETING_CANCELLATIONS_CHOICES",
+    "SEND_MEETING_INVITATIONS_AND_CANCELLATIONS_CHOICES",
+    "SEND_MEETING_INVITATIONS_CHOICES",
+    "SEND_ONLY",
+    "SEND_ONLY_TO_ALL",
+    "SEND_ONLY_TO_CHANGED",
+    "SEND_TO_ALL_AND_SAVE_COPY",
+    "SEND_TO_CHANGED_AND_SAVE_COPY",
+    "SEND_TO_NONE",
+    "SHALLOW",
+    "SHAPE_CHOICES",
+    "SOFT_DELETE",
+    "SOFT_DELETED",
+    "SPECIFIED_OCCURRENCE_ONLY",
+    "Task",
+    "TentativelyAcceptItem",
+]

package/bin/_internal/exchangelib/items/base.py

@@ -0,0 +1,241 @@
+import logging
+
+from ..errors import InvalidTypeError
+from ..extended_properties import ExtendedProperty
+from ..fields import (
+    AttachmentField,
+    BodyField,
+    BooleanField,
+    CharField,
+    EWSElementField,
+    ExtendedPropertyField,
+    ExtendedPropertyListField,
+    IdElementField,
+    MailboxField,
+    MailboxListField,
+)
+from ..properties import EWSElement, EWSMeta, IdChangeKeyMixIn, InvalidField, ItemId, ReferenceItemId
+from ..util import require_account
+from ..version import EXCHANGE_2007_SP1
+
+log = logging.getLogger(__name__)
+
+# Shape enums
+ID_ONLY = "IdOnly"
+DEFAULT = "Default"
+# AllProperties doesn't actually get all properties in FindItem, just the "first-class" ones. See
+# https://docs.microsoft.com/en-us/exchange/client-developer/exchange-web-services/email-properties-and-elements-in-ews-in-exchange
+ALL_PROPERTIES = "AllProperties"
+SHAPE_CHOICES = (ID_ONLY, DEFAULT, ALL_PROPERTIES)
+
+# MessageDisposition values. See
+# https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/createitem
+SAVE_ONLY = "SaveOnly"
+SEND_ONLY = "SendOnly"
+SEND_AND_SAVE_COPY = "SendAndSaveCopy"
+MESSAGE_DISPOSITION_CHOICES = (SAVE_ONLY, SEND_ONLY, SEND_AND_SAVE_COPY)
+
+# SendMeetingInvitations values. See
+# https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/createitem
+# SendMeetingInvitationsOrCancellations. See
+# https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/updateitem
+# SendMeetingCancellations values. See
+# https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/deleteitem
+SEND_TO_NONE = "SendToNone"
+SEND_ONLY_TO_ALL = "SendOnlyToAll"
+SEND_ONLY_TO_CHANGED = "SendOnlyToChanged"
+SEND_TO_ALL_AND_SAVE_COPY = "SendToAllAndSaveCopy"
+SEND_TO_CHANGED_AND_SAVE_COPY = "SendToChangedAndSaveCopy"
+SEND_MEETING_INVITATIONS_CHOICES = (SEND_TO_NONE, SEND_ONLY_TO_ALL, SEND_TO_ALL_AND_SAVE_COPY)
+SEND_MEETING_INVITATIONS_AND_CANCELLATIONS_CHOICES = (
+    SEND_TO_NONE,
+    SEND_ONLY_TO_ALL,
+    SEND_ONLY_TO_CHANGED,
+    SEND_TO_ALL_AND_SAVE_COPY,
+    SEND_TO_CHANGED_AND_SAVE_COPY,
+)
+SEND_MEETING_CANCELLATIONS_CHOICES = (SEND_TO_NONE, SEND_ONLY_TO_ALL, SEND_TO_ALL_AND_SAVE_COPY)
+
+# AffectedTaskOccurrences values. See
+# https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/deleteitem
+ALL_OCCURRENCES = "AllOccurrences"
+SPECIFIED_OCCURRENCE_ONLY = "SpecifiedOccurrenceOnly"
+AFFECTED_TASK_OCCURRENCES_CHOICES = (ALL_OCCURRENCES, SPECIFIED_OCCURRENCE_ONLY)
+
+# ConflictResolution values. See
+# https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/updateitem
+NEVER_OVERWRITE = "NeverOverwrite"
+AUTO_RESOLVE = "AutoResolve"
+ALWAYS_OVERWRITE = "AlwaysOverwrite"
+CONFLICT_RESOLUTION_CHOICES = (NEVER_OVERWRITE, AUTO_RESOLVE, ALWAYS_OVERWRITE)
+
+# DeleteType values. See
+# https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/deleteitem
+HARD_DELETE = "HardDelete"
+SOFT_DELETE = "SoftDelete"
+MOVE_TO_DELETED_ITEMS = "MoveToDeletedItems"
+DELETE_TYPE_CHOICES = (HARD_DELETE, SOFT_DELETE, MOVE_TO_DELETED_ITEMS)
+
+
+class RegisterMixIn(IdChangeKeyMixIn, metaclass=EWSMeta):
+    """Base class for classes that can change their list of supported fields dynamically."""
+
+    # This class implements dynamic fields on an element class, so we need to include __dict__ in __slots__
+    __slots__ = ("__dict__",)
+
+    INSERT_AFTER_FIELD = None
+
+    @classmethod
+    def register(cls, attr_name, attr_cls):
+        """Register a custom extended property in this item class so they can be accessed just like any other attribute
+
+        :param attr_name:
+        :param attr_cls:
+        :return:
+        """
+        if not cls.INSERT_AFTER_FIELD:
+            raise ValueError(f"Class {cls} is missing INSERT_AFTER_FIELD value")
+        try:
+            cls.get_field_by_fieldname(attr_name)
+        except InvalidField:
+            pass
+        else:
+            raise ValueError(f"'attr_name' {attr_name!r} is already registered")
+        if not issubclass(attr_cls, ExtendedProperty):
+            raise TypeError(f"'attr_cls' {attr_cls!r} must be a subclass of type {ExtendedProperty}")
+        # Check if class attributes are properly defined
+        attr_cls.validate_cls()
+        # ExtendedProperty is not a real field, but a placeholder in the fields list. See
+        #   https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/item
+        #
+        # Find the correct index for the new extended property, and insert.
+        if attr_cls.is_array_type():
+            field = ExtendedPropertyListField(attr_name, value_cls=attr_cls)
+        else:
+            field = ExtendedPropertyField(attr_name, value_cls=attr_cls)
+        cls.add_field(field, insert_after=cls.INSERT_AFTER_FIELD)
+
+    @classmethod
+    def deregister(cls, attr_name):
+        """De-register an extended property that has been registered with register().
+
+        :param attr_name:
+        :return:
+        """
+        try:
+            field = cls.get_field_by_fieldname(attr_name)
+        except InvalidField:
+            raise ValueError(f"{attr_name!r} is not registered")
+        if not isinstance(field, ExtendedPropertyField):
+            raise ValueError(f"{attr_name} is not registered as an ExtendedProperty")
+        cls.remove_field(field)
+
+
+class BaseItem(RegisterMixIn, metaclass=EWSMeta):
+    """Base class for all other classes that implement EWS items."""
+
+    ID_ELEMENT_CLS = ItemId
+    _id = IdElementField(field_uri="item:ItemId", value_cls=ID_ELEMENT_CLS)
+
+    __slots__ = "account", "folder"
+
+    def __init__(self, **kwargs):
+        """Pick out optional 'account' and 'folder' kwargs, and pass the rest to the parent class.
+
+        :param kwargs:
+            'account' is optional but allows calling 'send()' and 'delete()'
+            'folder' is optional but allows calling 'save()'. If 'folder' has an account, and 'account' is not set,
+                we use folder.account.
+        """
+        from ..account import Account
+        from ..folders import BaseFolder
+
+        self.account = kwargs.pop("account", None)
+        if self.account is not None and not isinstance(self.account, Account):
+            raise InvalidTypeError("account", self.account, Account)
+        self.folder = kwargs.pop("folder", None)
+        if self.folder is not None:
+            if not isinstance(self.folder, BaseFolder):
+                raise InvalidTypeError("folder", self.folder, BaseFolder)
+            if self.folder.account is not None:
+                if self.account is not None:
+                    # Make sure the account from kwargs matches the folder account
+                    if self.account != self.folder.account:
+                        raise ValueError("'account' does not match 'folder.account'")
+                self.account = self.folder.account
+        super().__init__(**kwargs)
+
+    @classmethod
+    def from_xml(cls, elem, account):
+        item = super().from_xml(elem=elem, account=account)
+        item.account = account
+        return item
+
+
+class BaseReplyItem(EWSElement, metaclass=EWSMeta):
+    """Base class for reply/forward elements that share the same fields."""
+
+    subject = CharField(field_uri="Subject")
+    body = BodyField(field_uri="Body")  # Accepts and returns Body or HTMLBody instances
+    to_recipients = MailboxListField(field_uri="ToRecipients")
+    cc_recipients = MailboxListField(field_uri="CcRecipients")
+    bcc_recipients = MailboxListField(field_uri="BccRecipients")
+    is_read_receipt_requested = BooleanField(field_uri="IsReadReceiptRequested")
+    is_delivery_receipt_requested = BooleanField(field_uri="IsDeliveryReceiptRequested")
+    author = MailboxField(field_uri="From")
+    reference_item_id = EWSElementField(value_cls=ReferenceItemId)
+    new_body = BodyField(field_uri="NewBodyContent")  # Accepts and returns Body or HTMLBody instances
+    received_by = MailboxField(field_uri="ReceivedBy", supported_from=EXCHANGE_2007_SP1)
+    received_representing = MailboxField(field_uri="ReceivedRepresenting", supported_from=EXCHANGE_2007_SP1)
+
+    __slots__ = ("account",)
+
+    def __init__(self, **kwargs):
+        # 'account' is optional but allows calling 'send()' and 'save()'
+        from ..account import Account
+
+        self.account = kwargs.pop("account", None)
+        if self.account is not None and not isinstance(self.account, Account):
+            raise InvalidTypeError("account", self.account, Account)
+        super().__init__(**kwargs)
+
+    @require_account
+    def send(self, save_copy=True, copy_to_folder=None):
+        from ..services import CreateItem
+
+        if copy_to_folder and not save_copy:
+            raise AttributeError("'save_copy' must be True when 'copy_to_folder' is set")
+        message_disposition = SEND_AND_SAVE_COPY if save_copy else SEND_ONLY
+        return CreateItem(account=self.account).get(
+            items=[self],
+            folder=copy_to_folder,
+            message_disposition=message_disposition,
+            send_meeting_invitations=SEND_TO_NONE,
+        )
+
+    @require_account
+    def save(self, folder):
+        """Save the item for later modification. You may want to use account.drafts as the folder.
+
+        :param folder:
+        :return:
+        """
+        from ..services import CreateItem
+
+        return CreateItem(account=self.account).get(
+            items=[self],
+            folder=folder,
+            message_disposition=SAVE_ONLY,
+            send_meeting_invitations=SEND_TO_NONE,
+        )
+
+
+class BulkCreateResult(BaseItem):
+    """A dummy class to store return values from a CreateItem service call."""
+
+    attachments = AttachmentField(field_uri="item:Attachments")  # ItemAttachment or FileAttachment
+
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+        if self.attachments is None:
+            self.attachments = []