1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
|
import logging
import warnings
from ..errors import ErrorNameResolutionMultipleResults, ErrorNameResolutionNoResults, InvalidEnumValue
from ..items import SEARCH_SCOPE_CHOICES, SHAPE_CHOICES, Contact
from ..properties import Mailbox
from ..util import MNS, add_xml_child, create_element
from ..version import EXCHANGE_2010_SP2
from .common import EWSService, folder_ids_element
log = logging.getLogger(__name__)
class ResolveNames(EWSService):
"""MSDN: https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/resolvenames-operation"""
SERVICE_NAME = "ResolveNames"
element_container_name = f"{{{MNS}}}ResolutionSet"
ERRORS_TO_CATCH_IN_RESPONSE = ErrorNameResolutionNoResults
WARNINGS_TO_IGNORE_IN_RESPONSE = ErrorNameResolutionMultipleResults
# According to the 'Remarks' section of the MSDN documentation referenced above, at most 100 candidates are
# returned for a lookup.
# Note: paging information is returned as attrs on the 'ResolutionSet' element, but this service does not
# support the 'IndexedPageItemView' element, so it's not really a paging service.
candidates_limit = 100
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.return_full_contact_data = False # A hack to communicate parsing args to _elems_to_objs()
def call(
self,
unresolved_entries,
parent_folders=None,
return_full_contact_data=False,
search_scope=None,
contact_data_shape=None,
):
if self.chunk_size > 100:
raise ValueError(
f"Chunk size {self.chunk_size} is too high. {self.SERVICE_NAME} supports returning at most 100 "
f"candidates for a lookup",
)
if search_scope and search_scope not in SEARCH_SCOPE_CHOICES:
raise InvalidEnumValue("search_scope", search_scope, SEARCH_SCOPE_CHOICES)
if contact_data_shape and contact_data_shape not in SHAPE_CHOICES:
raise InvalidEnumValue("contact_data_shape", contact_data_shape, SHAPE_CHOICES)
self.return_full_contact_data = return_full_contact_data
return self._elems_to_objs(
self._chunked_get_elements(
self.get_payload,
items=unresolved_entries,
parent_folders=parent_folders,
return_full_contact_data=return_full_contact_data,
search_scope=search_scope,
contact_data_shape=contact_data_shape,
)
)
def _get_element_container(self, message, name=None):
container_or_exc = super()._get_element_container(message=message, name=name)
if isinstance(container_or_exc, Exception):
return container_or_exc
is_last_page = container_or_exc.get("IncludesLastItemInRange").lower() in ("true", "0")
log.debug("Includes last item in range: %s", is_last_page)
if not is_last_page:
warnings.warn(
f"The {self.__class__.__name__} service returns at most {self.candidates_limit} candidates and does "
f"not support paging. You have reached this limit and have not received the exhaustive list of "
f"candidates."
)
return container_or_exc
def _elem_to_obj(self, elem):
if self.return_full_contact_data:
mailbox_elem = elem.find(Mailbox.response_tag())
contact_elem = elem.find(Contact.response_tag())
return (
None if mailbox_elem is None else Mailbox.from_xml(elem=mailbox_elem, account=None),
None if contact_elem is None else Contact.from_xml(elem=contact_elem, account=None),
)
return Mailbox.from_xml(elem=elem.find(Mailbox.response_tag()), account=None)
def get_payload(
self, unresolved_entries, parent_folders, return_full_contact_data, search_scope, contact_data_shape
):
attrs = dict(ReturnFullContactData=return_full_contact_data)
if search_scope:
attrs["SearchScope"] = search_scope
if contact_data_shape:
if self.protocol.version.build < EXCHANGE_2010_SP2:
raise NotImplementedError(
"'contact_data_shape' is only supported for Exchange 2010 SP2 servers and later"
)
attrs["ContactDataShape"] = contact_data_shape
payload = create_element(f"m:{self.SERVICE_NAME}", attrs=attrs)
if parent_folders:
payload.append(
folder_ids_element(folders=parent_folders, version=self.protocol.version, tag="m:ParentFolderIds")
)
for entry in unresolved_entries:
add_xml_child(payload, "m:UnresolvedEntry", entry)
return payload
|
