Module exchangelib.account
Classes
+-
+
+class Account +(primary_smtp_address,
fullname=None,
access_type=None,
autodiscover=False,
credentials=None,
config=None,
locale=None,
default_timezone=None) +
+-
-
Expand source code
-from locale import getlocale -from logging import getLogger - -from cached_property import threaded_cached_property - -from .autodiscover import discover -from .configuration import Configuration -from .credentials import DELEGATE, IMPERSONATION, ACCESS_TYPES -from .errors import UnknownTimeZone -from .ewsdatetime import EWSTimeZone, UTC -from .fields import FieldPath -from .folders import Folder, AdminAuditLogs, ArchiveDeletedItems, ArchiveInbox, ArchiveMsgFolderRoot, \ - ArchiveRecoverableItemsDeletions, ArchiveRecoverableItemsPurges, ArchiveRecoverableItemsRoot, \ - ArchiveRecoverableItemsVersions, ArchiveRoot, Calendar, Conflicts, Contacts, ConversationHistory, DeletedItems, \ - Directory, Drafts, Favorites, IMContactList, Inbox, Journal, JunkEmail, LocalFailures, MsgFolderRoot, MyContacts, \ - Notes, Outbox, PeopleConnect, PublicFoldersRoot, QuickContacts, RecipientCache, RecoverableItemsDeletions, \ - RecoverableItemsPurges, RecoverableItemsRoot, RecoverableItemsVersions, Root, SearchFolders, SentItems, \ - ServerFailures, SyncIssues, Tasks, ToDoSearch, VoiceMail -from .items import HARD_DELETE, AUTO_RESOLVE, SEND_TO_NONE, SAVE_ONLY, ALL_OCCURRENCIES, ID_ONLY -from .properties import Mailbox, SendingAs -from .protocol import Protocol -from .queryset import QuerySet -from .services import ExportItems, UploadItems, GetItem, CreateItem, UpdateItem, DeleteItem, MoveItem, SendItem, \ - CopyItem, GetUserOofSettings, SetUserOofSettings, GetMailTips, ArchiveItem, GetDelegate, MarkAsJunk, GetPersona -from .util import get_domain, peek - -log = getLogger(__name__) - - -class Identity: - """Contains information that uniquely identifies an account. Currently only used for SOAP impersonation headers.""" - - def __init__(self, primary_smtp_address=None, smtp_address=None, upn=None, sid=None): - """ - - :param primary_smtp_address: The primary email address associated with the account (Default value = None) - :param smtp_address: The (non-)primary email address associated with the account (Default value = None) - :param upn: (Default value = None) - :param sid: (Default value = None) - :return: - """ - self.primary_smtp_address = primary_smtp_address - self.smtp_address = smtp_address - self.upn = upn - self.sid = sid - - def __eq__(self, other): - for k in self.__dict__: - if getattr(self, k) != getattr(other, k): - return False - return True - - def __hash__(self): - return hash(repr(self)) - - def __repr__(self): - return self.__class__.__name__ + repr((self.primary_smtp_address, self.smtp_address, self.upn, self.sid)) - - -class Account: +
+ return f"{self.primary_smtp_address} ({self.fullname})" + return self.primary_smtp_addressclass Account: """Models an Exchange server user account.""" - def __init__(self, primary_smtp_address, fullname=None, access_type=None, autodiscover=False, credentials=None, - config=None, locale=None, default_timezone=None): + def __init__( + self, + primary_smtp_address, + fullname=None, + access_type=None, + autodiscover=False, + credentials=None, + config=None, + locale=None, + default_timezone=None, + ): """ :param primary_smtp_address: The primary email address associated with the account on the Exchange server @@ -106,65 +85,98 @@Module
assume values to be in the provided timezone. Defaults to the timezone of the host. :return: """ - if '@' not in primary_smtp_address: - raise ValueError("primary_smtp_address %r is not an email address" % primary_smtp_address) + if "@" not in primary_smtp_address: + raise ValueError(f"primary_smtp_address {primary_smtp_address!r} is not an email address") self.fullname = fullname # Assume delegate access if individual credentials are provided. Else, assume service user with impersonation self.access_type = access_type or (DELEGATE if credentials else IMPERSONATION) if self.access_type not in ACCESS_TYPES: - raise ValueError("'access_type' %r must be one of %s" % (self.access_type, ACCESS_TYPES)) + raise InvalidEnumValue("access_type", self.access_type, ACCESS_TYPES) try: - self.locale = locale or getlocale()[0] or None # get_locale() might not be able to determine the locale + # get_locale() might not be able to determine the locale + self.locale = locale or stdlib_locale.getlocale()[0] or None except ValueError as e: # getlocale() may throw ValueError if it fails to parse the system locale - log.warning('Failed to get locale (%s)', e) + log.warning("Failed to get locale (%s)", e) self.locale = None if not isinstance(self.locale, (type(None), str)): - raise ValueError("Expected 'locale' to be a string, got %r" % self.locale) + raise InvalidTypeError("locale", self.locale, str) if default_timezone: try: self.default_timezone = EWSTimeZone.from_timezone(default_timezone) except TypeError: - raise ValueError("Expected 'default_timezone' to be an EWSTimeZone, got %r" % default_timezone) + raise InvalidTypeError("default_timezone", default_timezone, EWSTimeZone) else: try: self.default_timezone = EWSTimeZone.localzone() except (ValueError, UnknownTimeZone) as e: # There is no translation from local timezone name to Windows timezone name, or e failed to find the # local timezone. - log.warning('%s. Fallback to UTC', e.args[0]) + log.warning("%s. Fallback to UTC", e.args[0]) self.default_timezone = UTC if not isinstance(config, (Configuration, type(None))): - raise ValueError("Expected 'config' to be a Configuration, got %r" % config) + raise InvalidTypeError("config", config, Configuration) if autodiscover: if config: - retry_policy, auth_type = config.retry_policy, config.auth_type + auth_type, retry_policy, version, max_connections = ( + config.auth_type, + config.retry_policy, + config.version, + config.max_connections, + ) if not credentials: credentials = config.credentials else: - retry_policy, auth_type = None, None - self.ad_response, self.protocol = discover( - email=primary_smtp_address, credentials=credentials, auth_type=auth_type, retry_policy=retry_policy - ) + auth_type, retry_policy, version, max_connections = None, None, None, None + self.ad_response, self.protocol = Autodiscovery( + email=primary_smtp_address, credentials=credentials + ).discover() + # Let's not use the auth_package hint from the AD response. It could be incorrect and we can just guess. + self.protocol.config.auth_type = auth_type + if retry_policy: + self.protocol.config.retry_policy = retry_policy + if version: + self.protocol.config.version = version + self.protocol.max_connections = max_connections primary_smtp_address = self.ad_response.autodiscover_smtp_address else: if not config: - raise AttributeError('non-autodiscover requires a config') + raise AttributeError("non-autodiscover requires a config") self.ad_response = None self.protocol = Protocol(config=config) # Other ways of identifying the account can be added later self.identity = Identity(primary_smtp_address=primary_smtp_address) - # We may need to override the default server version on a per-account basis because Microsoft may report one - # server version up-front but delegate account requests to an older backend server. - self.version = self.protocol.version - log.debug('Added account: %s', self) + # For maintaining affinity in e.g. subscriptions + self.affinity_cookie = None + + self._version = None + self._version_lock = Lock() + log.debug("Added account: %s", self) @property def primary_smtp_address(self): return self.identity.primary_smtp_address + @property + def version(self): + # We may need to override the default server version on a per-account basis because Microsoft may report one + # server version up-front but delegate account requests to an older backend server. Create a new instance to + # avoid changing the protocol version instance. + if self._version: + return self._version + with self._version_lock: + if self._version: + return self._version + self._version = self.protocol.version.copy() + return self._version + + @version.setter + def version(self, value): + with self._version_lock: + self._version = value + @threaded_cached_property def admin_audit_logs(self): return self.root.get_default_folder(AdminAuditLogs) @@ -367,7 +379,7 @@exchangelib.accountModule
# We accept generators, so it's not always convenient for caller to know up-front if 'ids' is empty. Allow # empty 'ids' and return early. return - kwargs['items'] = items + kwargs["items"] = items yield from service_cls(account=self, chunk_size=chunk_size).call(**kwargs) def export(self, items, chunk_size=None): @@ -378,9 +390,7 @@exchangelib.accountModule
:return: A list of strings, the exported representation of the object """ - return list( - self._consume_item_service(service_cls=ExportItems, items=items, chunk_size=chunk_size, kwargs={}) - ) + return list(self._consume_item_service(service_cls=ExportItems, items=items, chunk_size=chunk_size, kwargs={})) def upload(self, data, chunk_size=None): """Upload objects retrieved from an export to the given folders. @@ -402,12 +412,11 @@exchangelib.accountModule
-> [("idA", "changekey"), ("idB", "changekey"), ("idC", "changekey")] """ items = ((f, (None, False, d) if isinstance(d, str) else d) for f, d in data) - return list( - self._consume_item_service(service_cls=UploadItems, items=items, chunk_size=chunk_size, kwargs={}) - ) + return list(self._consume_item_service(service_cls=UploadItems, items=items, chunk_size=chunk_size, kwargs={})) - def bulk_create(self, folder, items, message_disposition=SAVE_ONLY, send_meeting_invitations=SEND_TO_NONE, - chunk_size=None): + def bulk_create( + self, folder, items, message_disposition=SAVE_ONLY, send_meeting_invitations=SEND_TO_NONE, chunk_size=None + ): """Create new items in 'folder'. :param folder: the folder to create the items in @@ -424,23 +433,36 @@exchangelib.accountModule
""" if isinstance(items, QuerySet): # bulk_create() on a queryset does not make sense because it returns items that have already been created - raise ValueError('Cannot bulk create items from a QuerySet') + raise ValueError("Cannot bulk create items from a QuerySet") log.debug( - 'Adding items for %s (folder %s, message_disposition: %s, send_meeting_invitations: %s)', + "Adding items for %s (folder %s, message_disposition: %s, send_meeting_invitations: %s)", self, folder, message_disposition, send_meeting_invitations, ) - return list(self._consume_item_service(service_cls=CreateItem, items=items, chunk_size=chunk_size, kwargs=dict( - folder=folder, - message_disposition=message_disposition, - send_meeting_invitations=send_meeting_invitations, - ))) - - def bulk_update(self, items, conflict_resolution=AUTO_RESOLVE, message_disposition=SAVE_ONLY, - send_meeting_invitations_or_cancellations=SEND_TO_NONE, suppress_read_receipts=True, - chunk_size=None): + return list( + self._consume_item_service( + service_cls=CreateItem, + items=items, + chunk_size=chunk_size, + kwargs=dict( + folder=folder, + message_disposition=message_disposition, + send_meeting_invitations=send_meeting_invitations, + ), + ) + ) + + def bulk_update( + self, + items, + conflict_resolution=AUTO_RESOLVE, + message_disposition=SAVE_ONLY, + send_meeting_invitations_or_cancellations=SEND_TO_NONE, + suppress_read_receipts=True, + chunk_size=None, + ): """Bulk update existing items. :param items: a list of (Item, fieldnames) tuples, where 'Item' is an Item object, and 'fieldnames' is a list @@ -460,23 +482,37 @@exchangelib.accountModule
# fact, it could be dangerous if the queryset contains an '.only()'. This would wipe out certain fields # entirely. if isinstance(items, QuerySet): - raise ValueError('Cannot bulk update on a queryset') + raise ValueError("Cannot bulk update on a queryset") log.debug( - 'Updating items for %s (conflict_resolution %s, message_disposition: %s, send_meeting_invitations: %s)', + "Updating items for %s (conflict_resolution %s, message_disposition: %s, send_meeting_invitations: %s)", self, conflict_resolution, message_disposition, send_meeting_invitations_or_cancellations, ) - return list(self._consume_item_service(service_cls=UpdateItem, items=items, chunk_size=chunk_size, kwargs=dict( - conflict_resolution=conflict_resolution, - message_disposition=message_disposition, - send_meeting_invitations_or_cancellations=send_meeting_invitations_or_cancellations, - suppress_read_receipts=suppress_read_receipts, - ))) - - def bulk_delete(self, ids, delete_type=HARD_DELETE, send_meeting_cancellations=SEND_TO_NONE, - affected_task_occurrences=ALL_OCCURRENCIES, suppress_read_receipts=True, chunk_size=None): + return list( + self._consume_item_service( + service_cls=UpdateItem, + items=items, + chunk_size=chunk_size, + kwargs=dict( + conflict_resolution=conflict_resolution, + message_disposition=message_disposition, + send_meeting_invitations_or_cancellations=send_meeting_invitations_or_cancellations, + suppress_read_receipts=suppress_read_receipts, + ), + ) + ) + + def bulk_delete( + self, + ids, + delete_type=HARD_DELETE, + send_meeting_cancellations=SEND_TO_NONE, + affected_task_occurrences=ALL_OCCURRENCES, + suppress_read_receipts=True, + chunk_size=None, + ): """Bulk delete items. :param ids: an iterable of either (id, changekey) tuples or Item objects. @@ -485,26 +521,31 @@exchangelib.accountModule
:param send_meeting_cancellations: only applicable to CalendarItem. Possible values are specified in SEND_MEETING_CANCELLATIONS_CHOICES. (Default value = SEND_TO_NONE) :param affected_task_occurrences: only applicable for recurring Task items. Possible values are specified in - AFFECTED_TASK_OCCURRENCES_CHOICES. (Default value = ALL_OCCURRENCIES) + AFFECTED_TASK_OCCURRENCES_CHOICES. (Default value = ALL_OCCURRENCES) :param suppress_read_receipts: only supported from Exchange 2013. True or False. (Default value = True) :param chunk_size: The number of items to send to the server in a single request (Default value = None) :return: a list of either True or exception instances, in the same order as the input """ log.debug( - 'Deleting items for %s (delete_type: %s, send_meeting_invitations: %s, affected_task_occurences: %s)', + "Deleting items for %s (delete_type: %s, send_meeting_invitations: %s, affected_task_occurrences: %s)", self, delete_type, send_meeting_cancellations, affected_task_occurrences, ) return list( - self._consume_item_service(service_cls=DeleteItem, items=ids, chunk_size=chunk_size, kwargs=dict( - delete_type=delete_type, - send_meeting_cancellations=send_meeting_cancellations, - affected_task_occurrences=affected_task_occurrences, - suppress_read_receipts=suppress_read_receipts, - )) + self._consume_item_service( + service_cls=DeleteItem, + items=ids, + chunk_size=chunk_size, + kwargs=dict( + delete_type=delete_type, + send_meeting_cancellations=send_meeting_cancellations, + affected_task_occurrences=affected_task_occurrences, + suppress_read_receipts=suppress_read_receipts, + ), + ) ) def bulk_send(self, ids, save_copy=True, copy_to_folder=None, chunk_size=None): @@ -522,9 +563,14 @@exchangelib.accountModule
if save_copy and not copy_to_folder: copy_to_folder = self.sent # 'Sent' is default EWS behaviour return list( - self._consume_item_service(service_cls=SendItem, items=ids, chunk_size=chunk_size, kwargs=dict( - saved_item_folder=copy_to_folder, - )) + self._consume_item_service( + service_cls=SendItem, + items=ids, + chunk_size=chunk_size, + kwargs=dict( + saved_item_folder=copy_to_folder, + ), + ) ) def bulk_copy(self, ids, to_folder, chunk_size=None): @@ -536,9 +582,16 @@exchangelib.accountModule
:return: Status for each send operation, in the same order as the input """ - return list(self._consume_item_service(service_cls=CopyItem, items=ids, chunk_size=chunk_size, kwargs=dict( - to_folder=to_folder, - ))) + return list( + self._consume_item_service( + service_cls=CopyItem, + items=ids, + chunk_size=chunk_size, + kwargs=dict( + to_folder=to_folder, + ), + ) + ) def bulk_move(self, ids, to_folder, chunk_size=None): """Move items to another folder. @@ -550,9 +603,16 @@exchangelib.accountModule
:return: The new IDs of the moved items, in the same order as the input. If 'to_folder' is a public folder or a folder in a different mailbox, an empty list is returned. """ - return list(self._consume_item_service(service_cls=MoveItem, items=ids, chunk_size=chunk_size, kwargs=dict( - to_folder=to_folder, - ))) + return list( + self._consume_item_service( + service_cls=MoveItem, + items=ids, + chunk_size=chunk_size, + kwargs=dict( + to_folder=to_folder, + ), + ) + ) def bulk_archive(self, ids, to_folder, chunk_size=None): """Archive items to a folder in the archive mailbox. An archive mailbox must be enabled in order for this @@ -564,9 +624,15 @@exchangelib.accountModule
:return: A list containing True or an exception instance in stable order of the requested items """ - return list(self._consume_item_service(service_cls=ArchiveItem, items=ids, chunk_size=chunk_size, kwargs=dict( - to_folder=to_folder, - )) + return list( + self._consume_item_service( + service_cls=ArchiveItem, + items=ids, + chunk_size=chunk_size, + kwargs=dict( + to_folder=to_folder, + ), + ) ) def bulk_mark_as_junk(self, ids, is_junk, move_item, chunk_size=None): @@ -580,10 +646,17 @@exchangelib.accountModule
:return: A list containing the new IDs of the moved items, if items were moved, or True, or an exception instance, in stable order of the requested items. """ - return list(self._consume_item_service(service_cls=MarkAsJunk, items=ids, chunk_size=chunk_size, kwargs=dict( - is_junk=is_junk, - move_item=move_item, - ))) + return list( + self._consume_item_service( + service_cls=MarkAsJunk, + items=ids, + chunk_size=chunk_size, + kwargs=dict( + is_junk=is_junk, + move_item=move_item, + ), + ) + ) def fetch(self, ids, folder=None, only_fields=None, chunk_size=None): """Fetch items by ID. @@ -608,13 +681,19 @@exchangelib.accountModule
for field in only_fields: validation_folder.validate_item_field(field=field, version=self.version) # Remove ItemId and ChangeKey. We get them unconditionally - additional_fields = {f for f in validation_folder.normalize_fields(fields=only_fields) - if not f.field.is_attribute} + additional_fields = { + f for f in validation_folder.normalize_fields(fields=only_fields) if not f.field.is_attribute + } # Always use IdOnly here, because AllProperties doesn't actually get *all* properties - yield from self._consume_item_service(service_cls=GetItem, items=ids, chunk_size=chunk_size, kwargs=dict( + yield from self._consume_item_service( + service_cls=GetItem, + items=ids, + chunk_size=chunk_size, + kwargs=dict( additional_fields=additional_fields, shape=ID_ONLY, - )) + ), + ) def fetch_personas(self, ids): """Fetch personas by ID. @@ -630,52 +709,143 @@exchangelib.accountModule
# We accept generators, so it's not always convenient for caller to know up-front if 'ids' is empty. Allow # empty 'ids' and return early. return - # GetPersona only accepts one persona ID per request. Crazy. - svc = GetPersona(account=self) - for i in ids: - yield svc.call(persona=i) + yield from GetPersona(account=self).call(personas=ids) @property def mail_tips(self): """See self.oof_settings about caching considerations.""" - # mail_tips_requested must be one of properties.MAIL_TIPS_TYPES return GetMailTips(protocol=self.protocol).get( sending_as=SendingAs(email_address=self.primary_smtp_address), recipients=[Mailbox(email_address=self.primary_smtp_address)], - mail_tips_requested='All', + mail_tips_requested="All", ) @property def delegates(self): """Return a list of DelegateUser objects representing the delegates that are set on this account.""" - delegates = [] - for d in GetDelegate(account=self).call(user_ids=None, include_permissions=True): - if isinstance(d, Exception): - raise d - delegates.append(d) - return delegates + return list(GetDelegate(account=self).call(user_ids=None, include_permissions=True)) + + @property + def rules(self): + """Return a list of Rule objects representing the rules that are set on this account.""" + return list(GetInboxRules(account=self).call()) + + def create_rule(self, rule: Rule): + """Create an Inbox rule. + + :param rule: The rule to create. Must have at least 'display_name' set. + :return: None if success, else raises an error. + """ + CreateInboxRule(account=self).get(rule=rule, remove_outlook_rule_blob=True) + # After creating the rule, query all rules, + # find the rule that was just created, and return its ID. + try: + rule.id = {i.display_name: i for i in GetInboxRules(account=self).call()}[rule.display_name].id + except KeyError: + raise ResponseMessageError(f"Failed to create rule ({rule.display_name})!") + + def set_rule(self, rule: Rule): + """Modify an Inbox rule. + + :param rule: The rule to set. Must have an ID. + :return: None if success, else raises an error. + """ + SetInboxRule(account=self).get(rule=rule) + + def delete_rule(self, rule: Rule): + """Delete an Inbox rule. + + :param rule: The rule to delete. Must have an ID. + :return: None if success, else raises an error. + """ + if not rule.id: + raise ValueError("Rule must have an ID") + DeleteInboxRule(account=self).get(rule=rule) + rule.id = None + + def subscribe_to_pull(self, event_types=None, watermark=None, timeout=60): + """Create a pull subscription. + + :param event_types: List of event types to subscribe to. Possible values defined in SubscribeToPull.EVENT_TYPES + :param watermark: An event bookmark as returned by some sync services + :param timeout: Timeout of the subscription, in minutes. Timeout is reset when the server receives a + GetEvents request for this subscription. + :return: The subscription ID and a watermark + """ + if event_types is None: + event_types = SubscribeToPull.EVENT_TYPES + return SubscribeToPull(account=self).get( + folders=None, + event_types=event_types, + watermark=watermark, + timeout=timeout, + ) + + def subscribe_to_push(self, callback_url, event_types=None, watermark=None, status_frequency=1): + """Create a push subscription. + + :param callback_url: A client-defined URL that the server will call + :param event_types: List of event types to subscribe to. Possible values defined in SubscribeToPush.EVENT_TYPES + :param watermark: An event bookmark as returned by some sync services + :param status_frequency: The frequency, in minutes, that the callback URL will be called with. + :return: The subscription ID and a watermark + """ + if event_types is None: + event_types = SubscribeToPush.EVENT_TYPES + return SubscribeToPush(account=self).get( + folders=None, + event_types=event_types, + watermark=watermark, + status_frequency=status_frequency, + url=callback_url, + ) + + def subscribe_to_streaming(self, event_types=None): + """Create a streaming subscription. + + :param event_types: List of event types to subscribe to. Possible values defined in SubscribeToPush.EVENT_TYPES + :return: The subscription ID + """ + if event_types is None: + event_types = SubscribeToStreaming.EVENT_TYPES + return SubscribeToStreaming(account=self).get(folders=None, event_types=event_types) + + def pull_subscription(self, **kwargs): + return PullSubscription(target=self, **kwargs) + + def push_subscription(self, **kwargs): + return PushSubscription(target=self, **kwargs) + + def streaming_subscription(self, **kwargs): + return StreamingSubscription(target=self, **kwargs) + + def unsubscribe(self, subscription_id): + """Unsubscribe. Only applies to pull and streaming notifications. + + :param subscription_id: A subscription ID as acquired by .subscribe_to_[pull|streaming]() + :return: True + + This method doesn't need the current collection instance, but it makes sense to keep the method along the other + sync methods. + """ + return Unsubscribe(account=self).get(subscription_id=subscription_id) + + def __getstate__(self): + # The lock cannot be pickled + state = self.__dict__.copy() + del state["_version_lock"] + return state + + def __setstate__(self, state): + # Restore the lock + self.__dict__.update(state) + self._version_lock = Lock() def __str__(self): - txt = '%s' % self.primary_smtp_address if self.fullname: - txt += ' (%s)' % self.fullname - return txtexchangelib.account
Classes
--
-
-class Account -(primary_smtp_address, fullname=None, access_type=None, autodiscover=False, credentials=None, config=None, locale=None, default_timezone=None) -
--
+
Models an Exchange server user account.
:param primary_smtp_address: The primary email address associated with the account on the Exchange server :param fullname: The full name of the account. Optional. (Default value = None) @@ -690,644 +860,86 @@
Classes
:param default_timezone: EWS may return some datetime values without timezone information. In this case, we will assume values to be in the provided timezone. Defaults to the timezone of the host. :return:Instance variables
+-
+
var admin_audit_logs
+-
+ +
Expand source code
-class Account: - """Models an Exchange server user account.""" - - def __init__(self, primary_smtp_address, fullname=None, access_type=None, autodiscover=False, credentials=None, - config=None, locale=None, default_timezone=None): - """ +
+def __get__(self, obj, cls): + if obj is None: + return self - :param primary_smtp_address: The primary email address associated with the account on the Exchange server - :param fullname: The full name of the account. Optional. (Default value = None) - :param access_type: The access type granted to 'credentials' for this account. Valid options are 'delegate' - and 'impersonation'. 'delegate' is default if 'credentials' is set. Otherwise, 'impersonation' is default. - :param autodiscover: Whether to look up the EWS endpoint automatically using the autodiscover protocol. - (Default value = False) - :param credentials: A Credentials object containing valid credentials for this account. (Default value = None) - :param config: A Configuration object containing EWS endpoint information. Required if autodiscover is disabled - (Default value = None) - :param locale: The locale of the user, e.g. 'en_US'. Defaults to the locale of the host, if available. - :param default_timezone: EWS may return some datetime values without timezone information. In this case, we will - assume values to be in the provided timezone. Defaults to the timezone of the host. - :return: - """ - if '@' not in primary_smtp_address: - raise ValueError("primary_smtp_address %r is not an email address" % primary_smtp_address) - self.fullname = fullname - # Assume delegate access if individual credentials are provided. Else, assume service user with impersonation - self.access_type = access_type or (DELEGATE if credentials else IMPERSONATION) - if self.access_type not in ACCESS_TYPES: - raise ValueError("'access_type' %r must be one of %s" % (self.access_type, ACCESS_TYPES)) + obj_dict = obj.__dict__ + name = self.func.__name__ + with self.lock: try: - self.locale = locale or getlocale()[0] or None # get_locale() might not be able to determine the locale - except ValueError as e: - # getlocale() may throw ValueError if it fails to parse the system locale - log.warning('Failed to get locale (%s)', e) - self.locale = None - if not isinstance(self.locale, (type(None), str)): - raise ValueError("Expected 'locale' to be a string, got %r" % self.locale) - if default_timezone: - try: - self.default_timezone = EWSTimeZone.from_timezone(default_timezone) - except TypeError: - raise ValueError("Expected 'default_timezone' to be an EWSTimeZone, got %r" % default_timezone) - else: - try: - self.default_timezone = EWSTimeZone.localzone() - except (ValueError, UnknownTimeZone) as e: - # There is no translation from local timezone name to Windows timezone name, or e failed to find the - # local timezone. - log.warning('%s. Fallback to UTC', e.args[0]) - self.default_timezone = UTC - if not isinstance(config, (Configuration, type(None))): - raise ValueError("Expected 'config' to be a Configuration, got %r" % config) - if autodiscover: - if config: - retry_policy, auth_type = config.retry_policy, config.auth_type - if not credentials: - credentials = config.credentials - else: - retry_policy, auth_type = None, None - self.ad_response, self.protocol = discover( - email=primary_smtp_address, credentials=credentials, auth_type=auth_type, retry_policy=retry_policy - ) - primary_smtp_address = self.ad_response.autodiscover_smtp_address - else: - if not config: - raise AttributeError('non-autodiscover requires a config') - self.ad_response = None - self.protocol = Protocol(config=config) - - # Other ways of identifying the account can be added later - self.identity = Identity(primary_smtp_address=primary_smtp_address) + # check if the value was computed before the lock was acquired + return obj_dict[name] - # We may need to override the default server version on a per-account basis because Microsoft may report one - # server version up-front but delegate account requests to an older backend server. - self.version = self.protocol.version - log.debug('Added account: %s', self) + except KeyError: + # if not, do the calculation and release the lock + return obj_dict.setdefault(name, self.func(obj))
+ var archive_deleted_items
+-
+++ +
+Expand source code +
+
+def __get__(self, obj, cls): + if obj is None: + return self - @property - def primary_smtp_address(self): - return self.identity.primary_smtp_address + obj_dict = obj.__dict__ + name = self.func.__name__ + with self.lock: + try: + # check if the value was computed before the lock was acquired + return obj_dict[name] - @threaded_cached_property - def admin_audit_logs(self): - return self.root.get_default_folder(AdminAuditLogs) + except KeyError: + # if not, do the calculation and release the lock + return obj_dict.setdefault(name, self.func(obj))
+ var archive_inbox
+-
++-
+Expand source code +
+
-def __get__(self, obj, cls): + if obj is None: + return self - @threaded_cached_property - def archive_deleted_items(self): - return self.archive_root.get_default_folder(ArchiveDeletedItems) + obj_dict = obj.__dict__ + name = self.func.__name__ + with self.lock: + try: + # check if the value was computed before the lock was acquired + return obj_dict[name] - @threaded_cached_property - def archive_inbox(self): - return self.archive_root.get_default_folder(ArchiveInbox) - - @threaded_cached_property - def archive_msg_folder_root(self): - return self.archive_root.get_default_folder(ArchiveMsgFolderRoot) - - @threaded_cached_property - def archive_recoverable_items_deletions(self): - return self.archive_root.get_default_folder(ArchiveRecoverableItemsDeletions) - - @threaded_cached_property - def archive_recoverable_items_purges(self): - return self.archive_root.get_default_folder(ArchiveRecoverableItemsPurges) - - @threaded_cached_property - def archive_recoverable_items_root(self): - return self.archive_root.get_default_folder(ArchiveRecoverableItemsRoot) - - @threaded_cached_property - def archive_recoverable_items_versions(self): - return self.archive_root.get_default_folder(ArchiveRecoverableItemsVersions) - - @threaded_cached_property - def archive_root(self): - return ArchiveRoot.get_distinguished(account=self) - - @threaded_cached_property - def calendar(self): - # If the account contains a shared calendar from a different user, that calendar will be in the folder list. - # Attempt not to return one of those. An account may not always have a calendar called "Calendar", but a - # Calendar folder with a localized name instead. Return that, if it's available, but always prefer any - # distinguished folder returned by the server. - return self.root.get_default_folder(Calendar) - - @threaded_cached_property - def conflicts(self): - return self.root.get_default_folder(Conflicts) - - @threaded_cached_property - def contacts(self): - return self.root.get_default_folder(Contacts) - - @threaded_cached_property - def conversation_history(self): - return self.root.get_default_folder(ConversationHistory) - - @threaded_cached_property - def directory(self): - return self.root.get_default_folder(Directory) - - @threaded_cached_property - def drafts(self): - return self.root.get_default_folder(Drafts) - - @threaded_cached_property - def favorites(self): - return self.root.get_default_folder(Favorites) - - @threaded_cached_property - def im_contact_list(self): - return self.root.get_default_folder(IMContactList) - - @threaded_cached_property - def inbox(self): - return self.root.get_default_folder(Inbox) - - @threaded_cached_property - def journal(self): - return self.root.get_default_folder(Journal) - - @threaded_cached_property - def junk(self): - return self.root.get_default_folder(JunkEmail) - - @threaded_cached_property - def local_failures(self): - return self.root.get_default_folder(LocalFailures) - - @threaded_cached_property - def msg_folder_root(self): - return self.root.get_default_folder(MsgFolderRoot) - - @threaded_cached_property - def my_contacts(self): - return self.root.get_default_folder(MyContacts) - - @threaded_cached_property - def notes(self): - return self.root.get_default_folder(Notes) - - @threaded_cached_property - def outbox(self): - return self.root.get_default_folder(Outbox) - - @threaded_cached_property - def people_connect(self): - return self.root.get_default_folder(PeopleConnect) - - @threaded_cached_property - def public_folders_root(self): - return PublicFoldersRoot.get_distinguished(account=self) - - @threaded_cached_property - def quick_contacts(self): - return self.root.get_default_folder(QuickContacts) - - @threaded_cached_property - def recipient_cache(self): - return self.root.get_default_folder(RecipientCache) - - @threaded_cached_property - def recoverable_items_deletions(self): - return self.root.get_default_folder(RecoverableItemsDeletions) - - @threaded_cached_property - def recoverable_items_purges(self): - return self.root.get_default_folder(RecoverableItemsPurges) - - @threaded_cached_property - def recoverable_items_root(self): - return self.root.get_default_folder(RecoverableItemsRoot) - - @threaded_cached_property - def recoverable_items_versions(self): - return self.root.get_default_folder(RecoverableItemsVersions) - - @threaded_cached_property - def root(self): - return Root.get_distinguished(account=self) - - @threaded_cached_property - def search_folders(self): - return self.root.get_default_folder(SearchFolders) - - @threaded_cached_property - def sent(self): - return self.root.get_default_folder(SentItems) - - @threaded_cached_property - def server_failures(self): - return self.root.get_default_folder(ServerFailures) - - @threaded_cached_property - def sync_issues(self): - return self.root.get_default_folder(SyncIssues) - - @threaded_cached_property - def tasks(self): - return self.root.get_default_folder(Tasks) - - @threaded_cached_property - def todo_search(self): - return self.root.get_default_folder(ToDoSearch) - - @threaded_cached_property - def trash(self): - return self.root.get_default_folder(DeletedItems) - - @threaded_cached_property - def voice_mail(self): - return self.root.get_default_folder(VoiceMail) - - @property - def domain(self): - return get_domain(self.primary_smtp_address) - - @property - def oof_settings(self): - # We don't want to cache this property because then we can't easily get updates. 'threaded_cached_property' - # supports the 'del self.oof_settings' syntax to invalidate the cache, but does not support custom setter - # methods. Having a non-cached service call here goes against the assumption that properties are cheap, but the - # alternative is to create get_oof_settings() and set_oof_settings(), and that's just too Java-ish for my taste. - return GetUserOofSettings(account=self).get( - mailbox=Mailbox(email_address=self.primary_smtp_address), - ) - - @oof_settings.setter - def oof_settings(self, value): - SetUserOofSettings(account=self).get( - oof_settings=value, - mailbox=Mailbox(email_address=self.primary_smtp_address), - ) - - def _consume_item_service(self, service_cls, items, chunk_size, kwargs): - if isinstance(items, QuerySet): - # We just want an iterator over the results - items = iter(items) - is_empty, items = peek(items) - if is_empty: - # We accept generators, so it's not always convenient for caller to know up-front if 'ids' is empty. Allow - # empty 'ids' and return early. - return - kwargs['items'] = items - yield from service_cls(account=self, chunk_size=chunk_size).call(**kwargs) - - def export(self, items, chunk_size=None): - """Return export strings of the given items. - - :param items: An iterable containing the Items we want to export - :param chunk_size: The number of items to send to the server in a single request (Default value = None) - - :return: A list of strings, the exported representation of the object - """ - return list( - self._consume_item_service(service_cls=ExportItems, items=items, chunk_size=chunk_size, kwargs={}) - ) - - def upload(self, data, chunk_size=None): - """Upload objects retrieved from an export to the given folders. - - :param data: An iterable of tuples containing the folder we want to upload the data to and the string outputs of - exports. If you want to update items instead of create, the data must be a tuple of - (ItemId, is_associated, data) values. - :param chunk_size: The number of items to send to the server in a single request (Default value = None) - - :return: A list of tuples with the new ids and changekeys - - Example: - account.upload([ - (account.inbox, "AABBCC..."), - (account.inbox, (ItemId('AA', 'BB'), False, "XXYYZZ...")), - (account.inbox, (('CC', 'DD'), None, "XXYYZZ...")), - (account.calendar, "ABCXYZ..."), - ]) - -> [("idA", "changekey"), ("idB", "changekey"), ("idC", "changekey")] - """ - items = ((f, (None, False, d) if isinstance(d, str) else d) for f, d in data) - return list( - self._consume_item_service(service_cls=UploadItems, items=items, chunk_size=chunk_size, kwargs={}) - ) - - def bulk_create(self, folder, items, message_disposition=SAVE_ONLY, send_meeting_invitations=SEND_TO_NONE, - chunk_size=None): - """Create new items in 'folder'. - - :param folder: the folder to create the items in - :param items: an iterable of Item objects - :param message_disposition: only applicable to Message items. Possible values are specified in - MESSAGE_DISPOSITION_CHOICES (Default value = SAVE_ONLY) - :param send_meeting_invitations: only applicable to CalendarItem items. Possible values are specified in - SEND_MEETING_INVITATIONS_CHOICES (Default value = SEND_TO_NONE) - :param chunk_size: The number of items to send to the server in a single request (Default value = None) - - :return: a list of either BulkCreateResult or exception instances in the same order as the input. The returned - BulkCreateResult objects are normal Item objects except they only contain the 'id' and 'changekey' - of the created item, and the 'id' of any attachments that were also created. - """ - if isinstance(items, QuerySet): - # bulk_create() on a queryset does not make sense because it returns items that have already been created - raise ValueError('Cannot bulk create items from a QuerySet') - log.debug( - 'Adding items for %s (folder %s, message_disposition: %s, send_meeting_invitations: %s)', - self, - folder, - message_disposition, - send_meeting_invitations, - ) - return list(self._consume_item_service(service_cls=CreateItem, items=items, chunk_size=chunk_size, kwargs=dict( - folder=folder, - message_disposition=message_disposition, - send_meeting_invitations=send_meeting_invitations, - ))) - - def bulk_update(self, items, conflict_resolution=AUTO_RESOLVE, message_disposition=SAVE_ONLY, - send_meeting_invitations_or_cancellations=SEND_TO_NONE, suppress_read_receipts=True, - chunk_size=None): - """Bulk update existing items. - - :param items: a list of (Item, fieldnames) tuples, where 'Item' is an Item object, and 'fieldnames' is a list - containing the attributes on this Item object that we want to be updated. - :param conflict_resolution: Possible values are specified in CONFLICT_RESOLUTION_CHOICES - (Default value = AUTO_RESOLVE) - :param message_disposition: only applicable to Message items. Possible values are specified in - MESSAGE_DISPOSITION_CHOICES (Default value = SAVE_ONLY) - :param send_meeting_invitations_or_cancellations: only applicable to CalendarItem items. Possible values are - specified in SEND_MEETING_INVITATIONS_AND_CANCELLATIONS_CHOICES (Default value = SEND_TO_NONE) - :param suppress_read_receipts: nly supported from Exchange 2013. True or False (Default value = True) - :param chunk_size: The number of items to send to the server in a single request (Default value = None) - - :return: a list of either (id, changekey) tuples or exception instances, in the same order as the input - """ - # bulk_update() on a queryset does not make sense because there would be no opportunity to alter the items. In - # fact, it could be dangerous if the queryset contains an '.only()'. This would wipe out certain fields - # entirely. - if isinstance(items, QuerySet): - raise ValueError('Cannot bulk update on a queryset') - log.debug( - 'Updating items for %s (conflict_resolution %s, message_disposition: %s, send_meeting_invitations: %s)', - self, - conflict_resolution, - message_disposition, - send_meeting_invitations_or_cancellations, - ) - return list(self._consume_item_service(service_cls=UpdateItem, items=items, chunk_size=chunk_size, kwargs=dict( - conflict_resolution=conflict_resolution, - message_disposition=message_disposition, - send_meeting_invitations_or_cancellations=send_meeting_invitations_or_cancellations, - suppress_read_receipts=suppress_read_receipts, - ))) - - def bulk_delete(self, ids, delete_type=HARD_DELETE, send_meeting_cancellations=SEND_TO_NONE, - affected_task_occurrences=ALL_OCCURRENCIES, suppress_read_receipts=True, chunk_size=None): - """Bulk delete items. - - :param ids: an iterable of either (id, changekey) tuples or Item objects. - :param delete_type: the type of delete to perform. Possible values are specified in DELETE_TYPE_CHOICES - (Default value = HARD_DELETE) - :param send_meeting_cancellations: only applicable to CalendarItem. Possible values are specified in - SEND_MEETING_CANCELLATIONS_CHOICES. (Default value = SEND_TO_NONE) - :param affected_task_occurrences: only applicable for recurring Task items. Possible values are specified in - AFFECTED_TASK_OCCURRENCES_CHOICES. (Default value = ALL_OCCURRENCIES) - :param suppress_read_receipts: only supported from Exchange 2013. True or False. (Default value = True) - :param chunk_size: The number of items to send to the server in a single request (Default value = None) - - :return: a list of either True or exception instances, in the same order as the input - """ - log.debug( - 'Deleting items for %s (delete_type: %s, send_meeting_invitations: %s, affected_task_occurences: %s)', - self, - delete_type, - send_meeting_cancellations, - affected_task_occurrences, - ) - return list( - self._consume_item_service(service_cls=DeleteItem, items=ids, chunk_size=chunk_size, kwargs=dict( - delete_type=delete_type, - send_meeting_cancellations=send_meeting_cancellations, - affected_task_occurrences=affected_task_occurrences, - suppress_read_receipts=suppress_read_receipts, - )) - ) - - def bulk_send(self, ids, save_copy=True, copy_to_folder=None, chunk_size=None): - """Send existing draft messages. If requested, save a copy in 'copy_to_folder'. - - :param ids: an iterable of either (id, changekey) tuples or Item objects. - :param save_copy: If true, saves a copy of the message (Default value = True) - :param copy_to_folder: If requested, save a copy of the message in this folder. Default is the Sent folder - :param chunk_size: The number of items to send to the server in a single request (Default value = None) - - :return: Status for each send operation, in the same order as the input - """ - if copy_to_folder and not save_copy: - raise AttributeError("'save_copy' must be True when 'copy_to_folder' is set") - if save_copy and not copy_to_folder: - copy_to_folder = self.sent # 'Sent' is default EWS behaviour - return list( - self._consume_item_service(service_cls=SendItem, items=ids, chunk_size=chunk_size, kwargs=dict( - saved_item_folder=copy_to_folder, - )) - ) - - def bulk_copy(self, ids, to_folder, chunk_size=None): - """Copy items to another folder. - - :param ids: an iterable of either (id, changekey) tuples or Item objects. - :param to_folder: The destination folder of the copy operation - :param chunk_size: The number of items to send to the server in a single request (Default value = None) - - :return: Status for each send operation, in the same order as the input - """ - return list(self._consume_item_service(service_cls=CopyItem, items=ids, chunk_size=chunk_size, kwargs=dict( - to_folder=to_folder, - ))) - - def bulk_move(self, ids, to_folder, chunk_size=None): - """Move items to another folder. - - :param ids: an iterable of either (id, changekey) tuples or Item objects. - :param to_folder: The destination folder of the copy operation - :param chunk_size: The number of items to send to the server in a single request (Default value = None) - - :return: The new IDs of the moved items, in the same order as the input. If 'to_folder' is a public folder or a - folder in a different mailbox, an empty list is returned. - """ - return list(self._consume_item_service(service_cls=MoveItem, items=ids, chunk_size=chunk_size, kwargs=dict( - to_folder=to_folder, - ))) - - def bulk_archive(self, ids, to_folder, chunk_size=None): - """Archive items to a folder in the archive mailbox. An archive mailbox must be enabled in order for this - to work. - - :param ids: an iterable of either (id, changekey) tuples or Item objects. - :param to_folder: The destination folder of the archive operation - :param chunk_size: The number of items to send to the server in a single request (Default value = None) - - :return: A list containing True or an exception instance in stable order of the requested items - """ - return list(self._consume_item_service(service_cls=ArchiveItem, items=ids, chunk_size=chunk_size, kwargs=dict( - to_folder=to_folder, - )) - ) - - def bulk_mark_as_junk(self, ids, is_junk, move_item, chunk_size=None): - """Mark or un-mark message items as junk email and add or remove the sender from the blocked sender list. - - :param ids: an iterable of either (id, changekey) tuples or Item objects. - :param is_junk: Whether the messages are junk or not - :param move_item: Whether to move the messages to the junk folder or not - :param chunk_size: The number of items to send to the server in a single request (Default value = None) - - :return: A list containing the new IDs of the moved items, if items were moved, or True, or an exception - instance, in stable order of the requested items. - """ - return list(self._consume_item_service(service_cls=MarkAsJunk, items=ids, chunk_size=chunk_size, kwargs=dict( - is_junk=is_junk, - move_item=move_item, - ))) - - def fetch(self, ids, folder=None, only_fields=None, chunk_size=None): - """Fetch items by ID. - - :param ids: an iterable of either (id, changekey) tuples or Item objects. - :param folder: used for validating 'only_fields' (Default value = None) - :param only_fields: A list of string or FieldPath items specifying the fields to fetch. Default to all fields - :param chunk_size: The number of items to send to the server in a single request (Default value = None) - - :return: A generator of Item objects, in the same order as the input - """ - validation_folder = folder or Folder(root=self.root) # Default to a folder type that supports all item types - # 'ids' could be an unevaluated QuerySet, e.g. if we ended up here via `fetch(ids=some_folder.filter(...))`. In - # that case, we want to use its iterator. Otherwise, peek() will start a count() which is wasteful because we - # need the item IDs immediately afterwards. iterator() will only do the bare minimum. - if only_fields is None: - # We didn't restrict list of field paths. Get all fields from the server, including extended properties. - additional_fields = { - FieldPath(field=f) for f in validation_folder.allowed_item_fields(version=self.version) - } - else: - for field in only_fields: - validation_folder.validate_item_field(field=field, version=self.version) - # Remove ItemId and ChangeKey. We get them unconditionally - additional_fields = {f for f in validation_folder.normalize_fields(fields=only_fields) - if not f.field.is_attribute} - # Always use IdOnly here, because AllProperties doesn't actually get *all* properties - yield from self._consume_item_service(service_cls=GetItem, items=ids, chunk_size=chunk_size, kwargs=dict( - additional_fields=additional_fields, - shape=ID_ONLY, - )) - - def fetch_personas(self, ids): - """Fetch personas by ID. - - :param ids: an iterable of either (id, changekey) tuples or Persona objects. - :return: A generator of Persona objects, in the same order as the input - """ - if isinstance(ids, QuerySet): - # We just want an iterator over the results - ids = iter(ids) - is_empty, ids = peek(ids) - if is_empty: - # We accept generators, so it's not always convenient for caller to know up-front if 'ids' is empty. Allow - # empty 'ids' and return early. - return - # GetPersona only accepts one persona ID per request. Crazy. - svc = GetPersona(account=self) - for i in ids: - yield svc.call(persona=i) - - @property - def mail_tips(self): - """See self.oof_settings about caching considerations.""" - # mail_tips_requested must be one of properties.MAIL_TIPS_TYPES - return GetMailTips(protocol=self.protocol).get( - sending_as=SendingAs(email_address=self.primary_smtp_address), - recipients=[Mailbox(email_address=self.primary_smtp_address)], - mail_tips_requested='All', - ) - - @property - def delegates(self): - """Return a list of DelegateUser objects representing the delegates that are set on this account.""" - delegates = [] - for d in GetDelegate(account=self).call(user_ids=None, include_permissions=True): - if isinstance(d, Exception): - raise d - delegates.append(d) - return delegates - - def __str__(self): - txt = '%s' % self.primary_smtp_address - if self.fullname: - txt += ' (%s)' % self.fullname - return txtInstance variables
--
-
var admin_audit_logs
--
-
---
-Expand source code -
-
-def __get__(self, obj, cls): - if obj is None: - return self - - obj_dict = obj.__dict__ - name = self.func.__name__ - with self.lock: - try: - # check if the value was computed before the lock was acquired - return obj_dict[name] - - except KeyError: - # if not, do the calculation and release the lock - return obj_dict.setdefault(name, self.func(obj))
- var archive_deleted_items
--
-
---
-Expand source code -
-
-def __get__(self, obj, cls): - if obj is None: - return self - - obj_dict = obj.__dict__ - name = self.func.__name__ - with self.lock: - try: - # check if the value was computed before the lock was acquired - return obj_dict[name] - - except KeyError: - # if not, do the calculation and release the lock - return obj_dict.setdefault(name, self.func(obj))
- var archive_inbox
--
-
--+ +
-Expand source code -
-
+def __get__(self, obj, cls): - if obj is None: - return self + except KeyError: + # if not, do the calculation and release the lock + return obj_dict.setdefault(name, self.func(obj))
+ var archive_msg_folder_root
+-
++-
+Expand source code +
+def __get__(self, obj, cls): + if obj is None: + return self obj_dict = obj.__dict__ name = self.func.__name__ @@ -1340,33 +952,10 @@Instance variables
# if not, do the calculation and release the lock return obj_dict.setdefault(name, self.func(obj))
- var archive_msg_folder_root
--
--
-Expand source code -
-
-def __get__(self, obj, cls): - if obj is None: - return self - - obj_dict = obj.__dict__ - name = self.func.__name__ - with self.lock: - try: - # check if the value was computed before the lock was acquired - return obj_dict[name] - - except KeyError: - # if not, do the calculation and release the lock - return obj_dict.setdefault(name, self.func(obj)) var archive_recoverable_items_deletions-
-
+
Expand source code @@ -1386,10 +975,10 @@
Instance variables
# if not, do the calculation and release the lock return obj_dict.setdefault(name, self.func(obj)) var archive_recoverable_items_purges-
-
+
Expand source code @@ -1409,10 +998,10 @@
Instance variables
# if not, do the calculation and release the lock return obj_dict.setdefault(name, self.func(obj)) var archive_recoverable_items_root-
-
+
Expand source code @@ -1432,10 +1021,10 @@
Instance variables
# if not, do the calculation and release the lock return obj_dict.setdefault(name, self.func(obj)) var archive_recoverable_items_versions-
-
+
Expand source code @@ -1455,10 +1044,10 @@
Instance variables
# if not, do the calculation and release the lock return obj_dict.setdefault(name, self.func(obj)) var archive_root-
-
+
Expand source code @@ -1478,10 +1067,10 @@
Instance variables
# if not, do the calculation and release the lock return obj_dict.setdefault(name, self.func(obj)) var calendar-
-
+
Expand source code @@ -1501,10 +1090,10 @@
Instance variables
# if not, do the calculation and release the lock return obj_dict.setdefault(name, self.func(obj)) var conflicts-
-
+
Expand source code @@ -1524,10 +1113,10 @@
Instance variables
# if not, do the calculation and release the lock return obj_dict.setdefault(name, self.func(obj)) var contacts-
-
+
Expand source code @@ -1547,10 +1136,10 @@
Instance variables
# if not, do the calculation and release the lock return obj_dict.setdefault(name, self.func(obj)) var conversation_history-
-
+
Expand source code @@ -1570,10 +1159,10 @@
Instance variables
# if not, do the calculation and release the lock return obj_dict.setdefault(name, self.func(obj))
- var delegates
+prop delegates-
-
Return a list of DelegateUser objects representing the delegates that are set on this account.
+Expand source code @@ -1581,17 +1170,12 @@
Instance variables
+ return list(GetDelegate(account=self).call(user_ids=None, include_permissions=True))@property def delegates(self): """Return a list of DelegateUser objects representing the delegates that are set on this account.""" - delegates = [] - for d in GetDelegate(account=self).call(user_ids=None, include_permissions=True): - if isinstance(d, Exception): - raise d - delegates.append(d) - return delegatesReturn a list of DelegateUser objects representing the delegates that are set on this account.
var directory-
-
+
Expand source code @@ -1611,10 +1195,10 @@
Instance variables
# if not, do the calculation and release the lock return obj_dict.setdefault(name, self.func(obj))
- var domain
+prop domain-
-
+
Expand source code @@ -1623,10 +1207,10 @@
Instance variables
def domain(self): return get_domain(self.primary_smtp_address) var drafts-
-
+
Expand source code @@ -1646,10 +1230,10 @@
Instance variables
# if not, do the calculation and release the lock return obj_dict.setdefault(name, self.func(obj)) var favorites-
-
+
Expand source code @@ -1669,10 +1253,10 @@
Instance variables
# if not, do the calculation and release the lock return obj_dict.setdefault(name, self.func(obj)) var im_contact_list-
-
+
Expand source code @@ -1692,10 +1276,10 @@
Instance variables
# if not, do the calculation and release the lock return obj_dict.setdefault(name, self.func(obj)) var inbox-
-
+
Expand source code @@ -1715,10 +1299,10 @@
Instance variables
# if not, do the calculation and release the lock return obj_dict.setdefault(name, self.func(obj)) var journal-
-
+
Expand source code @@ -1738,10 +1322,10 @@
Instance variables
# if not, do the calculation and release the lock return obj_dict.setdefault(name, self.func(obj)) var junk-
-
+
Expand source code @@ -1761,10 +1345,10 @@
Instance variables
# if not, do the calculation and release the lock return obj_dict.setdefault(name, self.func(obj)) var local_failures-
-
+
Expand source code @@ -1784,10 +1368,10 @@
Instance variables
# if not, do the calculation and release the lock return obj_dict.setdefault(name, self.func(obj))
- var mail_tips
+prop mail_tips-
-
See self.oof_settings about caching considerations.
+Expand source code @@ -1795,17 +1379,16 @@
Instance variables
@property def mail_tips(self): """See self.oof_settings about caching considerations.""" - # mail_tips_requested must be one of properties.MAIL_TIPS_TYPES return GetMailTips(protocol=self.protocol).get( sending_as=SendingAs(email_address=self.primary_smtp_address), recipients=[Mailbox(email_address=self.primary_smtp_address)], - mail_tips_requested='All', + mail_tips_requested="All", )See self.oof_settings about caching considerations.
var msg_folder_root-
-
+
Expand source code @@ -1825,10 +1408,10 @@
Instance variables
# if not, do the calculation and release the lock return obj_dict.setdefault(name, self.func(obj)) var my_contacts-
-
+
Expand source code @@ -1848,10 +1431,10 @@
Instance variables
# if not, do the calculation and release the lock return obj_dict.setdefault(name, self.func(obj)) var notes-
-
+
Expand source code @@ -1871,10 +1454,10 @@
Instance variables
# if not, do the calculation and release the lock return obj_dict.setdefault(name, self.func(obj))
- var oof_settings
+prop oof_settings-
-
+
Expand source code @@ -1889,10 +1472,10 @@
Instance variables
mailbox=Mailbox(email_address=self.primary_smtp_address), ) var outbox-
-
+
Expand source code @@ -1912,10 +1495,10 @@
Instance variables
# if not, do the calculation and release the lock return obj_dict.setdefault(name, self.func(obj)) var people_connect-
-
+
Expand source code @@ -1935,10 +1518,10 @@
Instance variables
# if not, do the calculation and release the lock return obj_dict.setdefault(name, self.func(obj))
- var primary_smtp_address
+prop primary_smtp_address-
-
+
Expand source code @@ -1947,10 +1530,10 @@
Instance variables
def primary_smtp_address(self): return self.identity.primary_smtp_address var public_folders_root-
-
+
Expand source code @@ -1970,10 +1553,10 @@
Instance variables
# if not, do the calculation and release the lock return obj_dict.setdefault(name, self.func(obj)) var quick_contacts-
-
+
Expand source code @@ -1993,10 +1576,10 @@
Instance variables
# if not, do the calculation and release the lock return obj_dict.setdefault(name, self.func(obj)) var recipient_cache-
-
+
Expand source code @@ -2016,10 +1599,10 @@
Instance variables
# if not, do the calculation and release the lock return obj_dict.setdefault(name, self.func(obj)) var recoverable_items_deletions-
-
+
Expand source code @@ -2039,10 +1622,10 @@
Instance variables
# if not, do the calculation and release the lock return obj_dict.setdefault(name, self.func(obj)) var recoverable_items_purges-
-
+
Expand source code @@ -2062,10 +1645,10 @@
Instance variables
# if not, do the calculation and release the lock return obj_dict.setdefault(name, self.func(obj)) var recoverable_items_root-
-
+
Expand source code @@ -2085,10 +1668,10 @@
Instance variables
# if not, do the calculation and release the lock return obj_dict.setdefault(name, self.func(obj)) var recoverable_items_versions-
-
+
Expand source code @@ -2108,10 +1691,10 @@
Instance variables
# if not, do the calculation and release the lock return obj_dict.setdefault(name, self.func(obj)) var root-
-
+ +
Expand source code @@ -2131,10 +1714,23 @@
Instance variables
# if not, do the calculation and release the lock return obj_dict.setdefault(name, self.func(obj))
+ prop rules
+-
+++
+Expand source code +
+
+@property +def rules(self): + """Return a list of Rule objects representing the rules that are set on this account.""" + return list(GetInboxRules(account=self).call())Return a list of Rule objects representing the rules that are set on this account.
var search_folders-
-
+
Expand source code @@ -2154,10 +1750,10 @@
Instance variables
# if not, do the calculation and release the lock return obj_dict.setdefault(name, self.func(obj)) var sent-
-
+
Expand source code @@ -2177,10 +1773,10 @@
Instance variables
# if not, do the calculation and release the lock return obj_dict.setdefault(name, self.func(obj)) var server_failures-
-
+
Expand source code @@ -2200,10 +1796,10 @@
Instance variables
# if not, do the calculation and release the lock return obj_dict.setdefault(name, self.func(obj)) var sync_issues-
-
+
Expand source code @@ -2223,10 +1819,10 @@
Instance variables
# if not, do the calculation and release the lock return obj_dict.setdefault(name, self.func(obj)) var tasks-
-
+
Expand source code @@ -2246,10 +1842,10 @@
Instance variables
# if not, do the calculation and release the lock return obj_dict.setdefault(name, self.func(obj)) var todo_search-
-
+
Expand source code @@ -2269,10 +1865,10 @@
Instance variables
# if not, do the calculation and release the lock return obj_dict.setdefault(name, self.func(obj)) var trash-
-
+
Expand source code @@ -2292,10 +1888,31 @@
Instance variables
# if not, do the calculation and release the lock return obj_dict.setdefault(name, self.func(obj))
- var voice_mail
+prop version-
+++
+Expand source code +
+
+@property +def version(self): + # We may need to override the default server version on a per-account basis because Microsoft may report one + # server version up-front but delegate account requests to an older backend server. Create a new instance to + # avoid changing the protocol version instance. + if self._version: + return self._version + with self._version_lock: + if self._version: + return self._version + self._version = self.protocol.version.copy() + return self._version
+ var voice_mail
+-
+
Expand source code @@ -2315,6 +1932,7 @@
Instance variables
# if not, do the calculation and release the lock return obj_dict.setdefault(name, self.func(obj))
Methods
@@ -2323,12 +1941,6 @@Methods
def bulk_archive(self, ids, to_folder, chunk_size=None)- -
Archive items to a folder in the archive mailbox. An archive mailbox must be enabled in order for this -to work.
-:param ids: an iterable of either (id, changekey) tuples or Item objects. -:param to_folder: The destination folder of the archive operation -:param chunk_size: The number of items to send to the server in a single request (Default value = None)
-:return: A list containing True or an exception instance in stable order of the requested items
+Expand source code @@ -2343,21 +1955,28 @@
Methods
:return: A list containing True or an exception instance in stable order of the requested items """ - return list(self._consume_item_service(service_cls=ArchiveItem, items=ids, chunk_size=chunk_size, kwargs=dict( - to_folder=to_folder, - )) + return list( + self._consume_item_service( + service_cls=ArchiveItem, + items=ids, + chunk_size=chunk_size, + kwargs=dict( + to_folder=to_folder, + ), + ) )Archive items to a folder in the archive mailbox. An archive mailbox must be enabled in order for this +to work.
+:param ids: an iterable of either (id, changekey) tuples or Item objects. +:param to_folder: The destination folder of the archive operation +:param chunk_size: The number of items to send to the server in a single request (Default value = None)
+:return: A list containing True or an exception instance in stable order of the requested items
def bulk_copy(self, ids, to_folder, chunk_size=None)-
-
Copy items to another folder.
-:param ids: an iterable of either (id, changekey) tuples or Item objects. -:param to_folder: The destination folder of the copy operation -:param chunk_size: The number of items to send to the server in a single request (Default value = None)
-:return: Status for each send operation, in the same order as the input
+Expand source code @@ -2371,32 +1990,34 @@
Methods
:return: Status for each send operation, in the same order as the input """ - return list(self._consume_item_service(service_cls=CopyItem, items=ids, chunk_size=chunk_size, kwargs=dict( - to_folder=to_folder, - ))) + return list( + self._consume_item_service( + service_cls=CopyItem, + items=ids, + chunk_size=chunk_size, + kwargs=dict( + to_folder=to_folder, + ), + ) + )Copy items to another folder.
+:param ids: an iterable of either (id, changekey) tuples or Item objects. +:param to_folder: The destination folder of the copy operation +:param chunk_size: The number of items to send to the server in a single request (Default value = None)
+:return: Status for each send operation, in the same order as the input
-def bulk_create(self, folder, items, message_disposition='SaveOnly', send_meeting_invitations='SendToNone', chunk_size=None) +def bulk_create(self,
folder,
items,
message_disposition='SaveOnly',
send_meeting_invitations='SendToNone',
chunk_size=None)-
-
Create new items in 'folder'.
-:param folder: the folder to create the items in -:param items: an iterable of Item objects -:param message_disposition: only applicable to Message items. Possible values are specified in -MESSAGE_DISPOSITION_CHOICES (Default value = SAVE_ONLY) -:param send_meeting_invitations: only applicable to CalendarItem items. Possible values are specified in -SEND_MEETING_INVITATIONS_CHOICES (Default value = SEND_TO_NONE) -:param chunk_size: The number of items to send to the server in a single request (Default value = None)
-:return: a list of either BulkCreateResult or exception instances in the same order as the input. The returned -BulkCreateResult objects are normal Item objects except they only contain the 'id' and 'changekey' -of the created item, and the 'id' of any attachments that were also created.
+Expand source code
-def bulk_create(self, folder, items, message_disposition=SAVE_ONLY, send_meeting_invitations=SEND_TO_NONE, - chunk_size=None): +
+ return list( + self._consume_item_service( + service_cls=CreateItem, + items=items, + chunk_size=chunk_size, + kwargs=dict( + folder=folder, + message_disposition=message_disposition, + send_meeting_invitations=send_meeting_invitations, + ), + ) + )def bulk_create( + self, folder, items, message_disposition=SAVE_ONLY, send_meeting_invitations=SEND_TO_NONE, chunk_size=None +): """Create new items in 'folder'. :param folder: the folder to create the items in @@ -2413,42 +2034,56 @@Methods
""" if isinstance(items, QuerySet): # bulk_create() on a queryset does not make sense because it returns items that have already been created - raise ValueError('Cannot bulk create items from a QuerySet') + raise ValueError("Cannot bulk create items from a QuerySet") log.debug( - 'Adding items for %s (folder %s, message_disposition: %s, send_meeting_invitations: %s)', + "Adding items for %s (folder %s, message_disposition: %s, send_meeting_invitations: %s)", self, folder, message_disposition, send_meeting_invitations, ) - return list(self._consume_item_service(service_cls=CreateItem, items=items, chunk_size=chunk_size, kwargs=dict( - folder=folder, - message_disposition=message_disposition, - send_meeting_invitations=send_meeting_invitations, - )))Create new items in 'folder'.
+:param folder: the folder to create the items in +:param items: an iterable of Item objects +:param message_disposition: only applicable to Message items. Possible values are specified in +MESSAGE_DISPOSITION_CHOICES (Default value = SAVE_ONLY) +:param send_meeting_invitations: only applicable to CalendarItem items. Possible values are specified in +SEND_MEETING_INVITATIONS_CHOICES (Default value = SEND_TO_NONE) +:param chunk_size: The number of items to send to the server in a single request (Default value = None)
+:return: a list of either BulkCreateResult or exception instances in the same order as the input. The returned +BulkCreateResult objects are normal Item objects except they only contain the 'id' and 'changekey' +of the created item, and the 'id' of any attachments that were also created.
-def bulk_delete(self, ids, delete_type='HardDelete', send_meeting_cancellations='SendToNone', affected_task_occurrences='AllOccurrences', suppress_read_receipts=True, chunk_size=None) +def bulk_delete(self,
ids,
delete_type='HardDelete',
send_meeting_cancellations='SendToNone',
affected_task_occurrences='AllOccurrences',
suppress_read_receipts=True,
chunk_size=None)-
-
Bulk delete items.
-:param ids: an iterable of either (id, changekey) tuples or Item objects. -:param delete_type: the type of delete to perform. Possible values are specified in DELETE_TYPE_CHOICES -(Default value = HARD_DELETE) -:param send_meeting_cancellations: only applicable to CalendarItem. Possible values are specified in -SEND_MEETING_CANCELLATIONS_CHOICES. (Default value = SEND_TO_NONE) -:param affected_task_occurrences: only applicable for recurring Task items. Possible values are specified in -AFFECTED_TASK_OCCURRENCES_CHOICES. (Default value = ALL_OCCURRENCIES) -:param suppress_read_receipts: only supported from Exchange 2013. True or False. (Default value = True) -:param chunk_size: The number of items to send to the server in a single request (Default value = None)
-:return: a list of either True or exception instances, in the same order as the input
+Expand source code
-def bulk_delete(self, ids, delete_type=HARD_DELETE, send_meeting_cancellations=SEND_TO_NONE, - affected_task_occurrences=ALL_OCCURRENCIES, suppress_read_receipts=True, chunk_size=None): +def bulk_delete( + self, + ids, + delete_type=HARD_DELETE, + send_meeting_cancellations=SEND_TO_NONE, + affected_task_occurrences=ALL_OCCURRENCES, + suppress_read_receipts=True, + chunk_size=None, +): """Bulk delete items. :param ids: an iterable of either (id, changekey) tuples or Item objects. @@ -2457,40 +2092,49 @@Methods
:param send_meeting_cancellations: only applicable to CalendarItem. Possible values are specified in SEND_MEETING_CANCELLATIONS_CHOICES. (Default value = SEND_TO_NONE) :param affected_task_occurrences: only applicable for recurring Task items. Possible values are specified in - AFFECTED_TASK_OCCURRENCES_CHOICES. (Default value = ALL_OCCURRENCIES) + AFFECTED_TASK_OCCURRENCES_CHOICES. (Default value = ALL_OCCURRENCES) :param suppress_read_receipts: only supported from Exchange 2013. True or False. (Default value = True) :param chunk_size: The number of items to send to the server in a single request (Default value = None) :return: a list of either True or exception instances, in the same order as the input """ log.debug( - 'Deleting items for %s (delete_type: %s, send_meeting_invitations: %s, affected_task_occurences: %s)', + "Deleting items for %s (delete_type: %s, send_meeting_invitations: %s, affected_task_occurrences: %s)", self, delete_type, send_meeting_cancellations, affected_task_occurrences, ) return list( - self._consume_item_service(service_cls=DeleteItem, items=ids, chunk_size=chunk_size, kwargs=dict( - delete_type=delete_type, - send_meeting_cancellations=send_meeting_cancellations, - affected_task_occurrences=affected_task_occurrences, - suppress_read_receipts=suppress_read_receipts, - )) + self._consume_item_service( + service_cls=DeleteItem, + items=ids, + chunk_size=chunk_size, + kwargs=dict( + delete_type=delete_type, + send_meeting_cancellations=send_meeting_cancellations, + affected_task_occurrences=affected_task_occurrences, + suppress_read_receipts=suppress_read_receipts, + ), + ) )Bulk delete items.
+:param ids: an iterable of either (id, changekey) tuples or Item objects. +:param delete_type: the type of delete to perform. Possible values are specified in DELETE_TYPE_CHOICES +(Default value = HARD_DELETE) +:param send_meeting_cancellations: only applicable to CalendarItem. Possible values are specified in +SEND_MEETING_CANCELLATIONS_CHOICES. (Default value = SEND_TO_NONE) +:param affected_task_occurrences: only applicable for recurring Task items. Possible values are specified in +AFFECTED_TASK_OCCURRENCES_CHOICES. (Default value = ALL_OCCURRENCES) +:param suppress_read_receipts: only supported from Exchange 2013. True or False. (Default value = True) +:param chunk_size: The number of items to send to the server in a single request (Default value = None)
+:return: a list of either True or exception instances, in the same order as the input
def bulk_mark_as_junk(self, ids, is_junk, move_item, chunk_size=None)-
-
Mark or un-mark message items as junk email and add or remove the sender from the blocked sender list.
-:param ids: an iterable of either (id, changekey) tuples or Item objects. -:param is_junk: Whether the messages are junk or not -:param move_item: Whether to move the messages to the junk folder or not -:param chunk_size: The number of items to send to the server in a single request (Default value = None)
-:return: A list containing the new IDs of the moved items, if items were moved, or True, or an exception -instance, in stable order of the requested items.
+Expand source code @@ -2506,22 +2150,30 @@
Methods
:return: A list containing the new IDs of the moved items, if items were moved, or True, or an exception instance, in stable order of the requested items. """ - return list(self._consume_item_service(service_cls=MarkAsJunk, items=ids, chunk_size=chunk_size, kwargs=dict( - is_junk=is_junk, - move_item=move_item, - ))) + return list( + self._consume_item_service( + service_cls=MarkAsJunk, + items=ids, + chunk_size=chunk_size, + kwargs=dict( + is_junk=is_junk, + move_item=move_item, + ), + ) + )Mark or un-mark message items as junk email and add or remove the sender from the blocked sender list.
+:param ids: an iterable of either (id, changekey) tuples or Item objects. +:param is_junk: Whether the messages are junk or not +:param move_item: Whether to move the messages to the junk folder or not +:param chunk_size: The number of items to send to the server in a single request (Default value = None)
+:return: A list containing the new IDs of the moved items, if items were moved, or True, or an exception +instance, in stable order of the requested items.
def bulk_move(self, ids, to_folder, chunk_size=None)-
-
Move items to another folder.
-:param ids: an iterable of either (id, changekey) tuples or Item objects. -:param to_folder: The destination folder of the copy operation -:param chunk_size: The number of items to send to the server in a single request (Default value = None)
-:return: The new IDs of the moved items, in the same order as the input. If 'to_folder' is a public folder or a -folder in a different mailbox, an empty list is returned.
+Expand source code @@ -2536,21 +2188,28 @@
Methods
:return: The new IDs of the moved items, in the same order as the input. If 'to_folder' is a public folder or a folder in a different mailbox, an empty list is returned. """ - return list(self._consume_item_service(service_cls=MoveItem, items=ids, chunk_size=chunk_size, kwargs=dict( - to_folder=to_folder, - ))) + return list( + self._consume_item_service( + service_cls=MoveItem, + items=ids, + chunk_size=chunk_size, + kwargs=dict( + to_folder=to_folder, + ), + ) + )Move items to another folder.
+:param ids: an iterable of either (id, changekey) tuples or Item objects. +:param to_folder: The destination folder of the copy operation +:param chunk_size: The number of items to send to the server in a single request (Default value = None)
+:return: The new IDs of the moved items, in the same order as the input. If 'to_folder' is a public folder or a +folder in a different mailbox, an empty list is returned.
def bulk_send(self, ids, save_copy=True, copy_to_folder=None, chunk_size=None)-
-
Send existing draft messages. If requested, save a copy in 'copy_to_folder'.
-:param ids: an iterable of either (id, changekey) tuples or Item objects. -:param save_copy: If true, saves a copy of the message (Default value = True) -:param copy_to_folder: If requested, save a copy of the message in this folder. Default is the Sent folder -:param chunk_size: The number of items to send to the server in a single request (Default value = None)
-:return: Status for each send operation, in the same order as the input
+Expand source code @@ -2570,35 +2229,40 @@
Methods
if save_copy and not copy_to_folder: copy_to_folder = self.sent # 'Sent' is default EWS behaviour return list( - self._consume_item_service(service_cls=SendItem, items=ids, chunk_size=chunk_size, kwargs=dict( - saved_item_folder=copy_to_folder, - )) + self._consume_item_service( + service_cls=SendItem, + items=ids, + chunk_size=chunk_size, + kwargs=dict( + saved_item_folder=copy_to_folder, + ), + ) )Send existing draft messages. If requested, save a copy in 'copy_to_folder'.
+:param ids: an iterable of either (id, changekey) tuples or Item objects. +:param save_copy: If true, saves a copy of the message (Default value = True) +:param copy_to_folder: If requested, save a copy of the message in this folder. Default is the Sent folder +:param chunk_size: The number of items to send to the server in a single request (Default value = None)
+:return: Status for each send operation, in the same order as the input
-def bulk_update(self, items, conflict_resolution='AutoResolve', message_disposition='SaveOnly', send_meeting_invitations_or_cancellations='SendToNone', suppress_read_receipts=True, chunk_size=None) +def bulk_update(self,
items,
conflict_resolution='AutoResolve',
message_disposition='SaveOnly',
send_meeting_invitations_or_cancellations='SendToNone',
suppress_read_receipts=True,
chunk_size=None)-
-
Bulk update existing items.
-:param items: a list of (Item, fieldnames) tuples, where 'Item' is an Item object, and 'fieldnames' is a list -containing the attributes on this Item object that we want to be updated. -:param conflict_resolution: Possible values are specified in CONFLICT_RESOLUTION_CHOICES -(Default value = AUTO_RESOLVE) -:param message_disposition: only applicable to Message items. Possible values are specified in -MESSAGE_DISPOSITION_CHOICES (Default value = SAVE_ONLY) -:param send_meeting_invitations_or_cancellations: only applicable to CalendarItem items. Possible values are -specified in SEND_MEETING_INVITATIONS_AND_CANCELLATIONS_CHOICES (Default value = SEND_TO_NONE) -:param suppress_read_receipts: nly supported from Exchange 2013. True or False (Default value = True) -:param chunk_size: The number of items to send to the server in a single request (Default value = None)
-:return: a list of either (id, changekey) tuples or exception instances, in the same order as the input
+Expand source code
-
+def bulk_update(self, items, conflict_resolution=AUTO_RESOLVE, message_disposition=SAVE_ONLY, - send_meeting_invitations_or_cancellations=SEND_TO_NONE, suppress_read_receipts=True, - chunk_size=None): +
+ return list( + self._consume_item_service( + service_cls=UpdateItem, + items=items, + chunk_size=chunk_size, + kwargs=dict( + conflict_resolution=conflict_resolution, + message_disposition=message_disposition, + send_meeting_invitations_or_cancellations=send_meeting_invitations_or_cancellations, + suppress_read_receipts=suppress_read_receipts, + ), + ) + )def bulk_update( + self, + items, + conflict_resolution=AUTO_RESOLVE, + message_disposition=SAVE_ONLY, + send_meeting_invitations_or_cancellations=SEND_TO_NONE, + suppress_read_receipts=True, + chunk_size=None, +): """Bulk update existing items. :param items: a list of (Item, fieldnames) tuples, where 'Item' is an Item object, and 'fieldnames' is a list @@ -2618,30 +2282,94 @@Methods
# fact, it could be dangerous if the queryset contains an '.only()'. This would wipe out certain fields # entirely. if isinstance(items, QuerySet): - raise ValueError('Cannot bulk update on a queryset') + raise ValueError("Cannot bulk update on a queryset") log.debug( - 'Updating items for %s (conflict_resolution %s, message_disposition: %s, send_meeting_invitations: %s)', + "Updating items for %s (conflict_resolution %s, message_disposition: %s, send_meeting_invitations: %s)", self, conflict_resolution, message_disposition, send_meeting_invitations_or_cancellations, ) - return list(self._consume_item_service(service_cls=UpdateItem, items=items, chunk_size=chunk_size, kwargs=dict( - conflict_resolution=conflict_resolution, - message_disposition=message_disposition, - send_meeting_invitations_or_cancellations=send_meeting_invitations_or_cancellations, - suppress_read_receipts=suppress_read_receipts, - )))+Bulk update existing items.
+:param items: a list of (Item, fieldnames) tuples, where 'Item' is an Item object, and 'fieldnames' is a list +containing the attributes on this Item object that we want to be updated. +:param conflict_resolution: Possible values are specified in CONFLICT_RESOLUTION_CHOICES +(Default value = AUTO_RESOLVE) +:param message_disposition: only applicable to Message items. Possible values are specified in +MESSAGE_DISPOSITION_CHOICES (Default value = SAVE_ONLY) +:param send_meeting_invitations_or_cancellations: only applicable to CalendarItem items. Possible values are +specified in SEND_MEETING_INVITATIONS_AND_CANCELLATIONS_CHOICES (Default value = SEND_TO_NONE) +:param suppress_read_receipts: nly supported from Exchange 2013. True or False (Default value = True) +:param chunk_size: The number of items to send to the server in a single request (Default value = None)
+:return: a list of either (id, changekey) tuples or exception instances, in the same order as the input
+ +def create_rule(self,
rule: Rule) +
+-
+++
+Expand source code +
+
+def create_rule(self, rule: Rule): + """Create an Inbox rule. + + :param rule: The rule to create. Must have at least 'display_name' set. + :return: None if success, else raises an error. + """ + CreateInboxRule(account=self).get(rule=rule, remove_outlook_rule_blob=True) + # After creating the rule, query all rules, + # find the rule that was just created, and return its ID. + try: + rule.id = {i.display_name: i for i in GetInboxRules(account=self).call()}[rule.display_name].id + except KeyError: + raise ResponseMessageError(f"Failed to create rule ({rule.display_name})!")+Create an Inbox rule.
+:param rule: The rule to create. Must have at least 'display_name' set. +:return: None if success, else raises an error.
+ +def delete_rule(self,
rule: Rule) +
+-
+++
+Expand source code +
+def delete_rule(self, rule: Rule): + """Delete an Inbox rule. + + :param rule: The rule to delete. Must have an ID. + :return: None if success, else raises an error. + """ + if not rule.id: + raise ValueError("Rule must have an ID") + DeleteInboxRule(account=self).get(rule=rule) + rule.id = NoneDelete an Inbox rule.
+:param rule: The rule to delete. Must have an ID. +:return: None if success, else raises an error.
def export(self, items, chunk_size=None)-
-
Return export strings of the given items.
-:param items: An iterable containing the Items we want to export -:param chunk_size: The number of items to send to the server in a single request (Default value = None)
-:return: A list of strings, the exported representation of the object
+Expand source code @@ -2654,21 +2382,17 @@
Methods
:return: A list of strings, the exported representation of the object """ - return list( - self._consume_item_service(service_cls=ExportItems, items=items, chunk_size=chunk_size, kwargs={}) - ) + return list(self._consume_item_service(service_cls=ExportItems, items=items, chunk_size=chunk_size, kwargs={}))Return export strings of the given items.
+:param items: An iterable containing the Items we want to export +:param chunk_size: The number of items to send to the server in a single request (Default value = None)
+:return: A list of strings, the exported representation of the object
def fetch(self, ids, folder=None, only_fields=None, chunk_size=None)-
-
Fetch items by ID.
-:param ids: an iterable of either (id, changekey) tuples or Item objects. -:param folder: used for validating 'only_fields' (Default value = None) -:param only_fields: A list of string or FieldPath items specifying the fields to fetch. Default to all fields -:param chunk_size: The number of items to send to the server in a single request (Default value = None)
-:return: A generator of Item objects, in the same order as the input
+Expand source code @@ -2696,22 +2420,31 @@
Methods
for field in only_fields: validation_folder.validate_item_field(field=field, version=self.version) # Remove ItemId and ChangeKey. We get them unconditionally - additional_fields = {f for f in validation_folder.normalize_fields(fields=only_fields) - if not f.field.is_attribute} + additional_fields = { + f for f in validation_folder.normalize_fields(fields=only_fields) if not f.field.is_attribute + } # Always use IdOnly here, because AllProperties doesn't actually get *all* properties - yield from self._consume_item_service(service_cls=GetItem, items=ids, chunk_size=chunk_size, kwargs=dict( + yield from self._consume_item_service( + service_cls=GetItem, + items=ids, + chunk_size=chunk_size, + kwargs=dict( additional_fields=additional_fields, shape=ID_ONLY, - )) + ), + )Fetch items by ID.
+:param ids: an iterable of either (id, changekey) tuples or Item objects. +:param folder: used for validating 'only_fields' (Default value = None) +:param only_fields: A list of string or FieldPath items specifying the fields to fetch. Default to all fields +:param chunk_size: The number of items to send to the server in a single request (Default value = None)
+:return: A generator of Item objects, in the same order as the input
def fetch_personas(self, ids)-
-
Fetch personas by ID.
-:param ids: an iterable of either (id, changekey) tuples or Persona objects. -:return: A generator of Persona objects, in the same order as the input
+Expand source code @@ -2730,30 +2463,189 @@
Methods
# We accept generators, so it's not always convenient for caller to know up-front if 'ids' is empty. Allow # empty 'ids' and return early. return - # GetPersona only accepts one persona ID per request. Crazy. - svc = GetPersona(account=self) - for i in ids: - yield svc.call(persona=i) + yield from GetPersona(account=self).call(personas=ids) ++Fetch personas by ID.
+:param ids: an iterable of either (id, changekey) tuples or Persona objects. +:return: A generator of Persona objects, in the same order as the input
+ +def pull_subscription(self, **kwargs) +
+-
+++ +
+Expand source code +
+
+def pull_subscription(self, **kwargs): + return PullSubscription(target=self, **kwargs)
+ +def push_subscription(self, **kwargs) +
+-
+++ +
+Expand source code +
+
+def push_subscription(self, **kwargs): + return PushSubscription(target=self, **kwargs)
+ +def set_rule(self,
rule: Rule) +
+-
+++
+Expand source code +
+
+def set_rule(self, rule: Rule): + """Modify an Inbox rule. + + :param rule: The rule to set. Must have an ID. + :return: None if success, else raises an error. + """ + SetInboxRule(account=self).get(rule=rule)+Modify an Inbox rule.
+:param rule: The rule to set. Must have an ID. +:return: None if success, else raises an error.
+ +def streaming_subscription(self, **kwargs) +
+-
+++ +
+Expand source code +
+
+def streaming_subscription(self, **kwargs): + return StreamingSubscription(target=self, **kwargs)
+ +def subscribe_to_pull(self, event_types=None, watermark=None, timeout=60) +
+-
+++
+Expand source code +
+
+def subscribe_to_pull(self, event_types=None, watermark=None, timeout=60): + """Create a pull subscription. + + :param event_types: List of event types to subscribe to. Possible values defined in SubscribeToPull.EVENT_TYPES + :param watermark: An event bookmark as returned by some sync services + :param timeout: Timeout of the subscription, in minutes. Timeout is reset when the server receives a + GetEvents request for this subscription. + :return: The subscription ID and a watermark + """ + if event_types is None: + event_types = SubscribeToPull.EVENT_TYPES + return SubscribeToPull(account=self).get( + folders=None, + event_types=event_types, + watermark=watermark, + timeout=timeout, + )+Create a pull subscription.
+:param event_types: List of event types to subscribe to. Possible values defined in SubscribeToPull.EVENT_TYPES +:param watermark: An event bookmark as returned by some sync services +:param timeout: Timeout of the subscription, in minutes. Timeout is reset when the server receives a +GetEvents request for this subscription. +:return: The subscription ID and a watermark
+ +def subscribe_to_push(self, callback_url, event_types=None, watermark=None, status_frequency=1) +
+-
+++
+Expand source code +
+
+def subscribe_to_push(self, callback_url, event_types=None, watermark=None, status_frequency=1): + """Create a push subscription. + + :param callback_url: A client-defined URL that the server will call + :param event_types: List of event types to subscribe to. Possible values defined in SubscribeToPush.EVENT_TYPES + :param watermark: An event bookmark as returned by some sync services + :param status_frequency: The frequency, in minutes, that the callback URL will be called with. + :return: The subscription ID and a watermark + """ + if event_types is None: + event_types = SubscribeToPush.EVENT_TYPES + return SubscribeToPush(account=self).get( + folders=None, + event_types=event_types, + watermark=watermark, + status_frequency=status_frequency, + url=callback_url, + )+Create a push subscription.
+:param callback_url: A client-defined URL that the server will call +:param event_types: List of event types to subscribe to. Possible values defined in SubscribeToPush.EVENT_TYPES +:param watermark: An event bookmark as returned by some sync services +:param status_frequency: The frequency, in minutes, that the callback URL will be called with. +:return: The subscription ID and a watermark
+ +def subscribe_to_streaming(self, event_types=None) +
+-
+++
+Expand source code +
+
+def subscribe_to_streaming(self, event_types=None): + """Create a streaming subscription. + + :param event_types: List of event types to subscribe to. Possible values defined in SubscribeToPush.EVENT_TYPES + :return: The subscription ID + """ + if event_types is None: + event_types = SubscribeToStreaming.EVENT_TYPES + return SubscribeToStreaming(account=self).get(folders=None, event_types=event_types)+Create a streaming subscription.
+:param event_types: List of event types to subscribe to. Possible values defined in SubscribeToPush.EVENT_TYPES +:return: The subscription ID
+ +def unsubscribe(self, subscription_id) +
+-
+++
+Expand source code +
+def unsubscribe(self, subscription_id): + """Unsubscribe. Only applies to pull and streaming notifications. + + :param subscription_id: A subscription ID as acquired by .subscribe_to_[pull|streaming]() + :return: True + + This method doesn't need the current collection instance, but it makes sense to keep the method along the other + sync methods. + """ + return Unsubscribe(account=self).get(subscription_id=subscription_id)Unsubscribe. Only applies to pull and streaming notifications.
+:param subscription_id: A subscription ID as acquired by .subscribe_to_pull|streaming +:return: True
+This method doesn't need the current collection instance, but it makes sense to keep the method along the other +sync methods.
def upload(self, data, chunk_size=None)-
-
Upload objects retrieved from an export to the given folders.
-:param data: An iterable of tuples containing the folder we want to upload the data to and the string outputs of -exports. If you want to update items instead of create, the data must be a tuple of -(ItemId, is_associated, data) values. -:param chunk_size: The number of items to send to the server in a single request (Default value = None)
-:return: A list of tuples with the new ids and changekeys
-Example: -account.upload([ -(account.inbox, "AABBCC…"), -(account.inbox, (ItemId('AA', 'BB'), False, "XXYYZZ…")), -(account.inbox, (('CC', 'DD'), None, "XXYYZZ…")), -(account.calendar, "ABCXYZ…"), -]) --> [("idA", "changekey"), ("idB", "changekey"), ("idC", "changekey")]
+Expand source code @@ -2778,63 +2670,97 @@
Methods
-> [("idA", "changekey"), ("idB", "changekey"), ("idC", "changekey")] """ items = ((f, (None, False, d) if isinstance(d, str) else d) for f, d in data) - return list( - self._consume_item_service(service_cls=UploadItems, items=items, chunk_size=chunk_size, kwargs={}) - ) + return list(self._consume_item_service(service_cls=UploadItems, items=items, chunk_size=chunk_size, kwargs={}))Upload objects retrieved from an export to the given folders.
+:param data: An iterable of tuples containing the folder we want to upload the data to and the string outputs of +exports. If you want to update items instead of create, the data must be a tuple of +(ItemId, is_associated, data) values. +:param chunk_size: The number of items to send to the server in a single request (Default value = None)
+:return: A list of tuples with the new ids and changekeys
+Example: +account.upload([ +(account.inbox, "AABBCC…"), +(account.inbox, (ItemId('AA', 'BB'), False, "XXYYZZ…")), +(account.inbox, (('CC', 'DD'), None, "XXYYZZ…")), +(account.calendar, "ABCXYZ…"), +]) +-> [("idA", "changekey"), ("idB", "changekey"), ("idC", "changekey")]
class Identity -(primary_smtp_address=None, smtp_address=None, upn=None, sid=None) +(**kwargs)-
-
Contains information that uniquely identifies an account. Currently only used for SOAP impersonation headers.
-:param primary_smtp_address: The primary email address associated with the account (Default value = None) -:param smtp_address: The (non-)primary email address associated with the account (Default value = None) -:param upn: (Default value = None) -:param sid: (Default value = None) -:return:
+Expand source code
-class Identity: +
+ # We have multiple options for uniquely identifying the user. Here's a prioritized list in accordance with + # https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/connectingsid + sid = TextField(field_uri="SID") + upn = TextField(field_uri="PrincipalName") + smtp_address = TextField(field_uri="SmtpAddress") # The (non-)primary email address for the account + primary_smtp_address = TextField(field_uri="PrimarySmtpAddress") # The primary email address for the accountclass Identity(EWSElement): """Contains information that uniquely identifies an account. Currently only used for SOAP impersonation headers.""" - def __init__(self, primary_smtp_address=None, smtp_address=None, upn=None, sid=None): - """ - - :param primary_smtp_address: The primary email address associated with the account (Default value = None) - :param smtp_address: The (non-)primary email address associated with the account (Default value = None) - :param upn: (Default value = None) - :param sid: (Default value = None) - :return: - """ - self.primary_smtp_address = primary_smtp_address - self.smtp_address = smtp_address - self.upn = upn - self.sid = sid - - def __eq__(self, other): - for k in self.__dict__: - if getattr(self, k) != getattr(other, k): - return False - return True + ELEMENT_NAME = "ConnectingSID" - def __hash__(self): - return hash(repr(self)) - - def __repr__(self): - return self.__class__.__name__ + repr((self.primary_smtp_address, self.smtp_address, self.upn, self.sid))+Contains information that uniquely identifies an account. Currently only used for SOAP impersonation headers.
Ancestors
+-
+
- EWSElement +
Class variables
+-
+
var ELEMENT_NAME
+- + + +
var FIELDS
+- + + +
Instance variables
+-
+
var primary_smtp_address
+- + + +
var sid
+- + + +
var smtp_address
+- + + +
var upn
+- + + +
Inherited members
+-
+
EWSElement: + +
+