Secure your code as it's written. Use Snyk Code to scan source code in minutes - no build needed - and fix issues immediately.
def test_versioned_choice(self):
field = ChoiceField('foo', field_uri='bar', choices={
Choice('c1'), Choice('c2', supported_from=EXCHANGE_2010)
})
with self.assertRaises(ValueError):
field.clean('XXX') # Value must be a valid choice
field.clean('c2', version=None)
with self.assertRaises(ErrorInvalidServerVersion):
field.clean('c2', version=Version(EXCHANGE_2007))
field.clean('c2', version=Version(EXCHANGE_2010))
field.clean('c2', version=Version(EXCHANGE_2013))
for subfield in f.value_cls.supported_fields(version=self.account.version):
field_path = FieldPath(field=f, label=v.label, subfield=subfield)
path, subval = field_path.path, field_path.get_value(item)
if subval is None:
continue
filter_kwargs.extend([
{f.name: v}, {path: subval},
{'%s__in' % path: [subval]}, {'%s__contains' % path: [subval]}
])
else:
filter_kwargs = [{'%s__in' % f.name: val}, {'%s__contains' % f.name: val}]
else:
# Filter all others with =, __in and __contains. We could have more filters here, but these should
# always match.
filter_kwargs = [{f.name: val}, {'%s__in' % f.name: [val]}]
if isinstance(f, TextField) and not isinstance(f, (ChoiceField, BodyField)):
# Choice fields cannot be filtered using __contains. BodyField often works in practice but often
# fails with generated test data. Ugh.
filter_kwargs.append({'%s__contains' % f.name: val[2:10]})
for kw in filter_kwargs:
self.assertEqual(len(common_qs.filter(**kw)), 1, (f.name, val, kw))
self.bulk_delete(ids)
else:
if value in valid_choices:
return value
raise ValueError("Invalid choice '%s' for field '%s'. Valid choices are: %s" % (
value, self.name, ', '.join(valid_choices)
))
def supported_choices(self, version):
return list(c.value for c in self.choices if c.supports_version(version))
FREE_BUSY_CHOICES = [Choice('Free'), Choice('Tentative'), Choice('Busy'), Choice('OOF'), Choice('NoData'),
Choice('WorkingElsewhere', supported_from=EXCHANGE_2013)]
class FreeBusyStatusField(ChoiceField):
def __init__(self, *args, **kwargs):
kwargs['choices'] = set(FREE_BUSY_CHOICES)
super(FreeBusyStatusField, self).__init__(*args, **kwargs)
class BodyField(TextField):
def __init__(self, *args, **kwargs):
from .properties import Body
self.value_cls = Body
super(BodyField, self).__init__(*args, **kwargs)
def clean(self, value, version=None):
if value is not None and not isinstance(value, self.value_cls):
value = self.value_cls(value)
return super(BodyField, self).clean(value, version=version)
ELEMENT_NAME = 'Permission'
PERMISSION_ENUM = {Choice('None'), Choice('Owned'), Choice('All')}
FIELDS = [
ChoiceField('permission_level', field_uri='PermissionLevel', choices={
Choice('None'), Choice('Owner'), Choice('PublishingEditor'), Choice('Editor'), Choice('PublishingAuthor'),
Choice('Author'), Choice('NoneditingAuthor'), Choice('Reviewer'), Choice('Contributor'), Choice('Custom')
}, default='None'),
BooleanField('can_create_items', field_uri='CanCreateItems', default=False),
BooleanField('can_create_subfolders', field_uri='CanCreateSubfolders', default=False),
BooleanField('is_folder_owner', field_uri='IsFolderOwner', default=False),
BooleanField('is_folder_visible', field_uri='IsFolderVisible', default=False),
BooleanField('is_folder_contact', field_uri='IsFolderContact', default=False),
ChoiceField('edit_items', field_uri='EditItems', choices=PERMISSION_ENUM, default='None'),
ChoiceField('delete_items', field_uri='DeleteItems', choices=PERMISSION_ENUM, default='None'),
ChoiceField('read_items', field_uri='ReadItems', choices={
Choice('None'), Choice('FullDetails')
}, default='None'),
EWSElementField('user_id', field_uri='UserId', value_cls=UserId, is_required=True)
]
__slots__ = tuple(f.name for f in FIELDS)
class CalendarPermission(EWSElement):
"""MSDN: https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/calendarpermission"""
ELEMENT_NAME = 'Permission'
PERMISSION_ENUM = {Choice('None'), Choice('Owned'), Choice('All')}
FIELDS = [
ChoiceField('calendar_permission_level', field_uri='CalendarPermissionLevel', choices={
Choice('None'), Choice('Owner'), Choice('PublishingEditor'), Choice('Editor'), Choice('PublishingAuthor'),
choices={Choice('Unknown'), Choice('Organizer'), Choice('Tentative'),
Choice('Accept'), Choice('Decline'), Choice('NoResponseReceived')},
is_required=True, default='Unknown'),
]
FIELDS = Item.FIELDS + LOCAL_FIELDS
__slots__ = tuple(f.name for f in LOCAL_FIELDS)
class MeetingRequest(BaseMeetingItem, AcceptDeclineMixIn):
"""
MSDN: https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/meetingrequest
"""
ELEMENT_NAME = 'MeetingRequest'
LOCAL_FIELDS = [
ChoiceField('meeting_request_type', field_uri='meetingRequest:MeetingRequestType',
choices={Choice('FullUpdate'), Choice('InformationalUpdate'), Choice('NewMeetingRequest'),
Choice('None'), Choice('Outdated'), Choice('PrincipalWantsCopy'),
Choice('SilentUpdate')},
default='None'),
ChoiceField('intended_free_busy_status', field_uri='meetingRequest:IntendedFreeBusyStatus', choices={
Choice('Free'), Choice('Tentative'), Choice('Busy'), Choice('OOF'), Choice('NoData')},
is_required=True, default='Busy'),
] + [f for f in CalendarItem.LOCAL_FIELDS[1:] if f.name != 'is_response_requested']
# FIELDS on this element are shuffled compared to other elements
culture_idx = None
for i, field in enumerate(Item.FIELDS):
if field.name == 'culture':
culture_idx = i
break
FIELDS = Item.FIELDS[:culture_idx + 1] + BaseMeetingItem.LOCAL_FIELDS + LOCAL_FIELDS + Item.FIELDS[culture_idx + 1:]
LOCAL_FIELDS = [
MimeContentField('mime_content', field_uri='item:MimeContent', is_read_only_after_send=True),
EWSElementField('parent_folder_id', field_uri='item:ParentFolderId', value_cls=ParentFolderId,
is_read_only=True),
CharField('item_class', field_uri='item:ItemClass', is_read_only=True),
CharField('subject', field_uri='item:Subject'),
ChoiceField('sensitivity', field_uri='item:Sensitivity', choices={
Choice('Normal'), Choice('Personal'), Choice('Private'), Choice('Confidential')
}, is_required=True, default='Normal'),
TextField('text_body', field_uri='item:TextBody', is_read_only=True, supported_from=EXCHANGE_2013),
BodyField('body', field_uri='item:Body'), # Accepts and returns Body or HTMLBody instances
AttachmentField('attachments', field_uri='item:Attachments'), # ItemAttachment or FileAttachment
DateTimeField('datetime_received', field_uri='item:DateTimeReceived', is_read_only=True),
IntegerField('size', field_uri='item:Size', is_read_only=True), # Item size in bytes
CharListField('categories', field_uri='item:Categories'),
ChoiceField('importance', field_uri='item:Importance', choices={
Choice('Low'), Choice('Normal'), Choice('High')
}, is_required=True, default='Normal'),
TextField('in_reply_to', field_uri='item:InReplyTo'),
BooleanField('is_submitted', field_uri='item:IsSubmitted', is_read_only=True),
BooleanField('is_draft', field_uri='item:IsDraft', is_read_only=True),
BooleanField('is_from_me', field_uri='item:IsFromMe', is_read_only=True),
BooleanField('is_resend', field_uri='item:IsResend', is_read_only=True),
BooleanField('is_unmodified', field_uri='item:IsUnmodified', is_read_only=True),
MessageHeaderField('headers', field_uri='item:InternetMessageHeaders', is_read_only=True),
DateTimeField('datetime_sent', field_uri='item:DateTimeSent', is_read_only=True),
DateTimeField('datetime_created', field_uri='item:DateTimeCreated', is_read_only=True),
# Placeholder for ResponseObjects
DateTimeField('reminder_due_by', field_uri='item:ReminderDueBy', is_required_after_save=True,
is_searchable=False),
BooleanField('reminder_is_set', field_uri='item:ReminderIsSet', is_required=True, default=False),
IntegerField('reminder_minutes_before_start', field_uri='item:ReminderMinutesBeforeStart',
"""MSDN: https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/permission"""
ELEMENT_NAME = 'Permission'
PERMISSION_ENUM = {Choice('None'), Choice('Owned'), Choice('All')}
FIELDS = [
ChoiceField('permission_level', field_uri='PermissionLevel', choices={
Choice('None'), Choice('Owner'), Choice('PublishingEditor'), Choice('Editor'), Choice('PublishingAuthor'),
Choice('Author'), Choice('NoneditingAuthor'), Choice('Reviewer'), Choice('Contributor'), Choice('Custom')
}, default='None'),
BooleanField('can_create_items', field_uri='CanCreateItems', default=False),
BooleanField('can_create_subfolders', field_uri='CanCreateSubfolders', default=False),
BooleanField('is_folder_owner', field_uri='IsFolderOwner', default=False),
BooleanField('is_folder_visible', field_uri='IsFolderVisible', default=False),
BooleanField('is_folder_contact', field_uri='IsFolderContact', default=False),
ChoiceField('edit_items', field_uri='EditItems', choices=PERMISSION_ENUM, default='None'),
ChoiceField('delete_items', field_uri='DeleteItems', choices=PERMISSION_ENUM, default='None'),
ChoiceField('read_items', field_uri='ReadItems', choices={
Choice('None'), Choice('FullDetails')
}, default='None'),
EWSElementField('user_id', field_uri='UserId', value_cls=UserId, is_required=True)
]
__slots__ = tuple(f.name for f in FIELDS)
class CalendarPermission(EWSElement):
"""MSDN: https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/calendarpermission"""
ELEMENT_NAME = 'Permission'
PERMISSION_ENUM = {Choice('None'), Choice('Owned'), Choice('All')}
FIELDS = [
ChoiceField('calendar_permission_level', field_uri='CalendarPermissionLevel', choices={
class FolderId(ItemId):
"""MSDN: https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/folderid"""
ELEMENT_NAME = 'FolderId'
__slots__ = tuple()
class Mailbox(EWSElement):
"""MSDN: https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/mailbox"""
ELEMENT_NAME = 'Mailbox'
FIELDS = [
TextField('name', field_uri='Name'),
EmailAddressField('email_address', field_uri='EmailAddress'),
ChoiceField('routing_type', field_uri='RoutingType', choices={Choice('SMTP')}, default='SMTP'),
ChoiceField('mailbox_type', field_uri='MailboxType', choices={
Choice('Mailbox'), Choice('PublicDL'), Choice('PrivateDL'), Choice('Contact'), Choice('PublicFolder'),
Choice('Unknown'), Choice('OneOff'), Choice('GroupMailbox', supported_from=EXCHANGE_2013)
}, default='Mailbox'),
EWSElementField('item_id', value_cls=ItemId, is_read_only=True),
]
__slots__ = tuple(f.name for f in FIELDS)
def clean(self, version=None):
super(Mailbox, self).clean(version=version)
if not self.email_address and not self.item_id:
# See "Remarks" section of
# https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/mailbox
raise ValueError("Mailbox must have either 'email_address' or 'item_id' set")
def __hash__(self):
__slots__ = tuple(f.name for f in LOCAL_FIELDS)
class MeetingRequest(BaseMeetingItem, AcceptDeclineMixIn):
"""
MSDN: https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/meetingrequest
"""
ELEMENT_NAME = 'MeetingRequest'
LOCAL_FIELDS = [
ChoiceField('meeting_request_type', field_uri='meetingRequest:MeetingRequestType',
choices={Choice('FullUpdate'), Choice('InformationalUpdate'), Choice('NewMeetingRequest'),
Choice('None'), Choice('Outdated'), Choice('PrincipalWantsCopy'),
Choice('SilentUpdate')},
default='None'),
ChoiceField('intended_free_busy_status', field_uri='meetingRequest:IntendedFreeBusyStatus', choices={
Choice('Free'), Choice('Tentative'), Choice('Busy'), Choice('OOF'), Choice('NoData')},
is_required=True, default='Busy'),
] + [f for f in CalendarItem.LOCAL_FIELDS[1:] if f.name != 'is_response_requested']
# FIELDS on this element are shuffled compared to other elements
culture_idx = None
for i, field in enumerate(Item.FIELDS):
if field.name == 'culture':
culture_idx = i
break
FIELDS = Item.FIELDS[:culture_idx + 1] + BaseMeetingItem.LOCAL_FIELDS + LOCAL_FIELDS + Item.FIELDS[culture_idx + 1:]
__slots__ = tuple(f.name for f in LOCAL_FIELDS)
class MeetingMessage(BaseMeetingItem):
"""Like AvailabilityMailbox, but with a different tag name
MSDN: https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/email-emailaddresstype
"""
ELEMENT_NAME = 'Email'
__slots__ = tuple()
class MailboxData(EWSElement):
"""MSDN: https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/mailboxdata"""
ELEMENT_NAME = 'MailboxData'
ATTENDEE_TYPES = {'Optional', 'Organizer', 'Required', 'Resource', 'Room'}
FIELDS = [
EmailField('email'),
ChoiceField('attendee_type', field_uri='AttendeeType', choices={Choice(c) for c in ATTENDEE_TYPES}),
BooleanField('exclude_conflicts', field_uri='ExcludeConflicts'),
]
__slots__ = tuple(f.name for f in FIELDS)
def __hash__(self):
# Exchange may add 'name' on insert. We're satisfied if the email address matches.
return hash((self.email.email_address.lower(), self.attendee_type, self.exclude_conflicts))
class DistinguishedFolderId(ItemId):
"""MSDN: https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/distinguishedfolderid"""
ELEMENT_NAME = 'DistinguishedFolderId'
FIELDS = [
IdField('id', field_uri=ItemId.ID_ATTR, is_required=True),