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 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466
|
import datetime
import logging
from ..ewsdatetime import EWSDate, EWSDateTime
from ..fields import (
AppointmentStateField,
AssociatedCalendarItemIdField,
AttachmentField,
AttendeesField,
BodyField,
BooleanField,
CharField,
Choice,
ChoiceField,
DateOrDateTimeField,
DateTimeField,
EnumAsIntField,
EWSElementListField,
FreeBusyStatusField,
IntegerField,
MailboxField,
MessageHeaderField,
OccurrenceField,
OccurrenceListField,
RecurrenceField,
ReferenceItemIdField,
TextField,
TimeZoneField,
URIField,
)
from ..properties import Attendee, EWSMeta, OccurrenceItemId, RecurringMasterItemId, ReferenceItemId
from ..recurrence import DeletedOccurrence, FirstOccurrence, LastOccurrence, Occurrence
from ..util import require_account, set_xml_value
from ..version import EXCHANGE_2010, EXCHANGE_2013
from .base import SEND_AND_SAVE_COPY, SEND_TO_NONE, BaseItem, BaseReplyItem
from .item import Item
from .message import Message
log = logging.getLogger(__name__)
# Conference Type values. See
# https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/conferencetype
CONFERENCE_TYPES = ("NetMeeting", "NetShow", "Chat")
# CalendarItemType enums
SINGLE = "Single"
OCCURRENCE = "Occurrence"
EXCEPTION = "Exception"
RECURRING_MASTER = "RecurringMaster"
CALENDAR_ITEM_CHOICES = (SINGLE, OCCURRENCE, EXCEPTION, RECURRING_MASTER)
class AcceptDeclineMixIn:
"""A mixin for items that can be declined or accepted."""
def accept(self, message_disposition=SEND_AND_SAVE_COPY, **kwargs):
return AcceptItem(
account=self.account, reference_item_id=ReferenceItemId(id=self.id, changekey=self.changekey), **kwargs
).send(message_disposition)
def decline(self, message_disposition=SEND_AND_SAVE_COPY, **kwargs):
return DeclineItem(
account=self.account, reference_item_id=ReferenceItemId(id=self.id, changekey=self.changekey), **kwargs
).send(message_disposition)
def tentatively_accept(self, message_disposition=SEND_AND_SAVE_COPY, **kwargs):
return TentativelyAcceptItem(
account=self.account, reference_item_id=ReferenceItemId(id=self.id, changekey=self.changekey), **kwargs
).send(message_disposition)
class CalendarItem(Item, AcceptDeclineMixIn):
"""MSDN: https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/calendaritem"""
ELEMENT_NAME = "CalendarItem"
uid = TextField(field_uri="calendar:UID", is_required_after_save=True, is_searchable=False)
recurrence_id = DateTimeField(field_uri="calendar:RecurrenceId", is_read_only=True)
start = DateOrDateTimeField(field_uri="calendar:Start", is_required=True)
end = DateOrDateTimeField(field_uri="calendar:End", is_required=True)
original_start = DateTimeField(field_uri="calendar:OriginalStart", is_read_only=True)
is_all_day = BooleanField(field_uri="calendar:IsAllDayEvent", is_required=True, default=False)
legacy_free_busy_status = FreeBusyStatusField(
field_uri="calendar:LegacyFreeBusyStatus", is_required=True, default="Busy"
)
location = TextField(field_uri="calendar:Location")
when = TextField(field_uri="calendar:When")
is_meeting = BooleanField(field_uri="calendar:IsMeeting", is_read_only=True)
is_cancelled = BooleanField(field_uri="calendar:IsCancelled", is_read_only=True)
is_recurring = BooleanField(field_uri="calendar:IsRecurring", is_read_only=True)
meeting_request_was_sent = BooleanField(field_uri="calendar:MeetingRequestWasSent", is_read_only=True)
is_response_requested = BooleanField(
field_uri="calendar:IsResponseRequested", default=None, is_required_after_save=True, is_searchable=False
)
type = ChoiceField(
field_uri="calendar:CalendarItemType", choices={Choice(c) for c in CALENDAR_ITEM_CHOICES}, is_read_only=True
)
my_response_type = ChoiceField(
field_uri="calendar:MyResponseType", choices={Choice(c) for c in Attendee.RESPONSE_TYPES}, is_read_only=True
)
organizer = MailboxField(field_uri="calendar:Organizer", is_read_only=True)
required_attendees = AttendeesField(field_uri="calendar:RequiredAttendees", is_searchable=False)
optional_attendees = AttendeesField(field_uri="calendar:OptionalAttendees", is_searchable=False)
resources = AttendeesField(field_uri="calendar:Resources", is_searchable=False)
conflicting_meeting_count = IntegerField(field_uri="calendar:ConflictingMeetingCount", is_read_only=True)
adjacent_meeting_count = IntegerField(field_uri="calendar:AdjacentMeetingCount", is_read_only=True)
conflicting_meetings = EWSElementListField(
field_uri="calendar:ConflictingMeetings", value_cls="CalendarItem", namespace=Item.NAMESPACE, is_read_only=True
)
adjacent_meetings = EWSElementListField(
field_uri="calendar:AdjacentMeetings", value_cls="CalendarItem", namespace=Item.NAMESPACE, is_read_only=True
)
duration = CharField(field_uri="calendar:Duration", is_read_only=True)
appointment_reply_time = DateTimeField(field_uri="calendar:AppointmentReplyTime", is_read_only=True)
appointment_sequence_number = IntegerField(field_uri="calendar:AppointmentSequenceNumber", is_read_only=True)
appointment_state = AppointmentStateField(field_uri="calendar:AppointmentState", is_read_only=True)
recurrence = RecurrenceField(field_uri="calendar:Recurrence", is_searchable=False)
first_occurrence = OccurrenceField(
field_uri="calendar:FirstOccurrence", value_cls=FirstOccurrence, is_read_only=True
)
last_occurrence = OccurrenceField(field_uri="calendar:LastOccurrence", value_cls=LastOccurrence, is_read_only=True)
modified_occurrences = OccurrenceListField(
field_uri="calendar:ModifiedOccurrences", value_cls=Occurrence, is_read_only=True
)
deleted_occurrences = OccurrenceListField(
field_uri="calendar:DeletedOccurrences", value_cls=DeletedOccurrence, is_read_only=True
)
_meeting_timezone = TimeZoneField(
field_uri="calendar:MeetingTimeZone", deprecated_from=EXCHANGE_2010, is_searchable=False
)
_start_timezone = TimeZoneField(
field_uri="calendar:StartTimeZone", supported_from=EXCHANGE_2010, is_searchable=False
)
_end_timezone = TimeZoneField(field_uri="calendar:EndTimeZone", supported_from=EXCHANGE_2010, is_searchable=False)
conference_type = EnumAsIntField(
field_uri="calendar:ConferenceType", enum=CONFERENCE_TYPES, min=0, default=None, is_required_after_save=True
)
allow_new_time_proposal = BooleanField(
field_uri="calendar:AllowNewTimeProposal", default=None, is_required_after_save=True, is_searchable=False
)
is_online_meeting = BooleanField(field_uri="calendar:IsOnlineMeeting", default=None, is_read_only=True)
meeting_workspace_url = URIField(field_uri="calendar:MeetingWorkspaceUrl")
net_show_url = URIField(field_uri="calendar:NetShowUrl")
def occurrence(self, index):
"""Get an occurrence of a recurring master by index. No query is sent to the server to actually fetch the item.
Call refresh() on the item to do so.
Only call this method on a recurring master.
:param index: The index, which is 1-based
:return The occurrence
"""
return self.__class__(
account=self.account,
folder=self.folder,
_id=OccurrenceItemId(id=self.id, changekey=self.changekey, instance_index=index),
)
def recurring_master(self):
"""Get the recurring master of an occurrence. No query is sent to the server to actually fetch the item.
Call refresh() on the item to do so.
Only call this method on an occurrence of a recurring master.
:return: The master occurrence
"""
return self.__class__(
account=self.account,
folder=self.folder,
_id=RecurringMasterItemId(id=self.id, changekey=self.changekey),
)
@classmethod
def timezone_fields(cls):
return tuple(f for f in cls.FIELDS if isinstance(f, TimeZoneField))
def clean_timezone_fields(self, version):
# Sets proper values on the timezone fields if they are not already set
if self.start is None:
start_tz = None
elif type(self.start) in (EWSDate, datetime.date):
start_tz = self.account.default_timezone
else:
start_tz = self.start.tzinfo
if self.end is None:
end_tz = None
elif type(self.end) in (EWSDate, datetime.date):
end_tz = self.account.default_timezone
else:
end_tz = self.end.tzinfo
if version.build < EXCHANGE_2010:
if self._meeting_timezone is None:
self._meeting_timezone = start_tz
self._start_timezone = None
self._end_timezone = None
else:
self._meeting_timezone = None
if self._start_timezone is None:
self._start_timezone = start_tz
if self._end_timezone is None:
self._end_timezone = end_tz
def clean(self, version=None):
super().clean(version=version)
if self.start and self.end and self.end < self.start:
raise ValueError(f"'end' must be greater than 'start' ({self.start} -> {self.end})")
if version:
self.clean_timezone_fields(version=version)
def cancel(self, **kwargs):
return CancelCalendarItem(
account=self.account, reference_item_id=ReferenceItemId(id=self.id, changekey=self.changekey), **kwargs
).send()
def _update_fieldnames(self):
update_fields = super()._update_fieldnames()
if self.type == OCCURRENCE:
# Some CalendarItem fields cannot be updated when the item is an occurrence. The values are empty when we
# receive them so would have been updated because they are set to None.
update_fields.remove("recurrence")
update_fields.remove("uid")
return update_fields
@classmethod
def from_xml(cls, elem, account):
item = super().from_xml(elem=elem, account=account)
# EWS returns the start and end values as a datetime regardless of the is_all_day status. Convert to date if
# applicable.
if not item.is_all_day:
return item
for field_name in ("start", "end"):
val = getattr(item, field_name)
if val is None:
continue
# Return just the date part of the value. Subtract 1 day from the date if this is the end field. This is
# the inverse of what we do in .to_xml(). Convert to the local timezone before getting the date.
if field_name == "end":
val -= datetime.timedelta(days=1)
tz = getattr(item, f"_{field_name}_timezone")
setattr(item, field_name, val.astimezone(tz).date())
return item
def tz_field_for_field_name(self, field_name):
meeting_tz_field, start_tz_field, end_tz_field = CalendarItem.timezone_fields()
if self.account.version.build < EXCHANGE_2010:
return meeting_tz_field
if field_name == "start":
return start_tz_field
if field_name == "end":
return end_tz_field
raise ValueError("Unsupported field_name")
def date_to_datetime(self, field_name):
# EWS always expects a datetime. If we have a date value, then convert it to datetime in the local
# timezone. Additionally, if this the end field, add 1 day to the date. We could add 12 hours to both
# start and end values and let EWS apply its logic, but that seems hacky.
value = getattr(self, field_name)
tz = getattr(self, self.tz_field_for_field_name(field_name).name)
value = EWSDateTime.combine(value, datetime.time(0, 0)).replace(tzinfo=tz)
if field_name == "end":
value += datetime.timedelta(days=1)
return value
def to_xml(self, version):
# EWS has some special logic related to all-day start and end values. Non-midnight start values are pushed to
# the previous midnight. Non-midnight end values are pushed to the following midnight. Midnight in this context
# refers to midnight in the local timezone. See
#
# https://docs.microsoft.com/en-us/exchange/client-developer/exchange-web-services/how-to-create-all-day-events-by-using-ews-in-exchange
#
elem = super().to_xml(version=version)
if not self.is_all_day:
return elem
for field_name in ("start", "end"):
value = getattr(self, field_name)
if value is None:
continue
if type(value) in (EWSDate, datetime.date):
# EWS always expects a datetime
value = self.date_to_datetime(field_name=field_name)
# We already generated an XML element for this field, but it contains a plain date at this point, which
# is invalid. Replace the value.
field = self.get_field_by_fieldname(field_name)
set_xml_value(elem.find(field.response_tag()), value)
return elem
class BaseMeetingItem(Item, metaclass=EWSMeta):
"""Base class for meeting requests that share the same fields (Message, Request, Response, Cancellation)
MSDN: https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/responsecode
Certain types are created as a side effect of doing something else. Meeting messages, for example, are created
when you send a calendar item to attendees; they are not explicitly created.
Therefore, BaseMeetingItem inherits from EWSElement has no save() or send() method
"""
associated_calendar_item_id = AssociatedCalendarItemIdField(field_uri="meeting:AssociatedCalendarItemId")
is_delegated = BooleanField(field_uri="meeting:IsDelegated", is_read_only=True, default=False)
is_out_of_date = BooleanField(field_uri="meeting:IsOutOfDate", is_read_only=True, default=False)
has_been_processed = BooleanField(field_uri="meeting:HasBeenProcessed", is_read_only=True, default=False)
response_type = ChoiceField(
field_uri="meeting:ResponseType",
choices={
Choice("Unknown"),
Choice("Organizer"),
Choice("Tentative"),
Choice("Accept"),
Choice("Decline"),
Choice("NoResponseReceived"),
},
is_required=True,
default="Unknown",
)
effective_rights_idx = Item.FIELDS.index_by_name("effective_rights")
sender_idx = Message.FIELDS.index_by_name("sender")
received_representing_idx = Message.FIELDS.index_by_name("received_representing")
FIELDS = (
Item.FIELDS[:effective_rights_idx]
+ Message.FIELDS[sender_idx : received_representing_idx + 1]
+ Item.FIELDS[effective_rights_idx:]
)
class MeetingRequest(BaseMeetingItem, AcceptDeclineMixIn):
"""MSDN: https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/meetingrequest"""
ELEMENT_NAME = "MeetingRequest"
meeting_request_type = ChoiceField(
field_uri="meetingRequest:MeetingRequestType",
choices={
Choice("FullUpdate"),
Choice("InformationalUpdate"),
Choice("NewMeetingRequest"),
Choice("None"),
Choice("Outdated"),
Choice("PrincipalWantsCopy"),
Choice("SilentUpdate"),
},
default="None",
)
intended_free_busy_status = ChoiceField(
field_uri="meetingRequest:IntendedFreeBusyStatus",
choices={Choice("Free"), Choice("Tentative"), Choice("Busy"), Choice("OOF"), Choice("NoData")},
is_required=True,
default="Busy",
)
# This element also has some fields from CalendarItem
start_idx = CalendarItem.FIELDS.index_by_name("start")
is_response_requested_idx = CalendarItem.FIELDS.index_by_name("is_response_requested")
FIELDS = (
BaseMeetingItem.FIELDS
+ CalendarItem.FIELDS[start_idx:is_response_requested_idx]
+ CalendarItem.FIELDS[is_response_requested_idx + 1 :]
)
class MeetingMessage(BaseMeetingItem):
"""MSDN: https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/meetingmessage"""
ELEMENT_NAME = "MeetingMessage"
class MeetingResponse(BaseMeetingItem):
"""MSDN: https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/meetingresponse"""
ELEMENT_NAME = "MeetingResponse"
proposed_start = DateTimeField(field_uri="meeting:ProposedStart", supported_from=EXCHANGE_2013)
proposed_end = DateTimeField(field_uri="meeting:ProposedEnd", supported_from=EXCHANGE_2013)
class MeetingCancellation(BaseMeetingItem):
"""MSDN: https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/meetingcancellation"""
ELEMENT_NAME = "MeetingCancellation"
class BaseMeetingReplyItem(BaseItem, metaclass=EWSMeta):
"""Base class for meeting request reply items that share the same fields (Accept, TentativelyAccept, Decline)."""
item_class = CharField(field_uri="item:ItemClass", is_read_only=True)
sensitivity = ChoiceField(
field_uri="item:Sensitivity",
choices={Choice("Normal"), Choice("Personal"), Choice("Private"), Choice("Confidential")},
is_required=True,
default="Normal",
)
body = BodyField(field_uri="item:Body") # Accepts and returns Body or HTMLBody instances
attachments = AttachmentField(field_uri="item:Attachments") # ItemAttachment or FileAttachment
headers = MessageHeaderField(field_uri="item:InternetMessageHeaders", is_read_only=True)
sender = Message.FIELDS["sender"]
to_recipients = Message.FIELDS["to_recipients"]
cc_recipients = Message.FIELDS["cc_recipients"]
bcc_recipients = Message.FIELDS["bcc_recipients"]
is_read_receipt_requested = Message.FIELDS["is_read_receipt_requested"]
is_delivery_receipt_requested = Message.FIELDS["is_delivery_receipt_requested"]
reference_item_id = ReferenceItemIdField(field_uri="item:ReferenceItemId")
received_by = MailboxField(field_uri="message:ReceivedBy", is_read_only=True)
received_representing = MailboxField(field_uri="message:ReceivedRepresenting", is_read_only=True)
proposed_start = DateTimeField(field_uri="meeting:ProposedStart", supported_from=EXCHANGE_2013)
proposed_end = DateTimeField(field_uri="meeting:ProposedEnd", supported_from=EXCHANGE_2013)
@require_account
def send(self, message_disposition=SEND_AND_SAVE_COPY):
from ..services import CreateItem
res = list(
CreateItem(account=self.account).call(
items=[self],
folder=self.folder,
message_disposition=message_disposition,
send_meeting_invitations=SEND_TO_NONE,
)
)
for r in res:
if isinstance(r, Exception):
raise r
# CreateItem may return multiple item IDs when given a meeting reply item. See issue#886. In lack of a better
# idea, return either the single ID or the list of IDs here.
if len(res) == 1:
return res[0]
return res
class AcceptItem(BaseMeetingReplyItem):
"""MSDN: https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/acceptitem"""
ELEMENT_NAME = "AcceptItem"
class TentativelyAcceptItem(BaseMeetingReplyItem):
"""MSDN: https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/tentativelyacceptitem"""
ELEMENT_NAME = "TentativelyAcceptItem"
class DeclineItem(BaseMeetingReplyItem):
"""MSDN: https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/declineitem"""
ELEMENT_NAME = "DeclineItem"
class CancelCalendarItem(BaseReplyItem):
"""MSDN: https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/cancelcalendaritem"""
ELEMENT_NAME = "CancelCalendarItem"
author_idx = BaseReplyItem.FIELDS.index_by_name("author")
FIELDS = BaseReplyItem.FIELDS[:author_idx] + BaseReplyItem.FIELDS[author_idx + 1 :]
class _Booking(Item):
"""Not mentioned anywhere in MSDN docs, but it's common enough that we want to at least not crash when we encounter
an item of this type in a folder. For more information, see https://github.com/ecederstrand/exchangelib/issues/877
Not supported in any way except to not crash on calendar folder reads
"""
ELEMENT_NAME = "Booking"
|