Secure your code as it's written. Use Snyk Code to scan source code in minutes - no build needed - and fix issues immediately.
TextField('company_name', field_uri='contacts:CompanyName'),
EmailAddressesField('email_addresses', field_uri='contacts:EmailAddress'),
PhysicalAddressField('physical_addresses', field_uri='contacts:PhysicalAddress'),
PhoneNumberField('phone_numbers', field_uri='contacts:PhoneNumber'),
TextField('assistant_name', field_uri='contacts:AssistantName'),
DateTimeField('birthday', field_uri='contacts:Birthday'),
URIField('business_homepage', field_uri='contacts:BusinessHomePage'),
TextListField('children', field_uri='contacts:Children'),
TextListField('companies', field_uri='contacts:Companies', is_searchable=False),
ChoiceField('contact_source', field_uri='contacts:ContactSource', choices={
Choice('Store'), Choice('ActiveDirectory')
}, is_read_only=True),
TextField('department', field_uri='contacts:Department'),
TextField('generation', field_uri='contacts:Generation'),
CharField('im_addresses', field_uri='contacts:ImAddresses', is_read_only=True),
TextField('job_title', field_uri='contacts:JobTitle'),
TextField('manager', field_uri='contacts:Manager'),
TextField('mileage', field_uri='contacts:Mileage'),
TextField('office', field_uri='contacts:OfficeLocation'),
ChoiceField('postal_address_index', field_uri='contacts:PostalAddressIndex', choices={
Choice('Business'), Choice('Home'), Choice('Other'), Choice('None')
}, default='None', is_required_after_save=True),
TextField('profession', field_uri='contacts:Profession'),
TextField('spouse_name', field_uri='contacts:SpouseName'),
CharField('surname', field_uri='contacts:Surname'),
DateTimeField('wedding_anniversary', field_uri='contacts:WeddingAnniversary'),
BooleanField('has_picture', field_uri='contacts:HasPicture', supported_from=EXCHANGE_2010, is_read_only=True),
TextField('phonetic_full_name', field_uri='contacts:PhoneticFullName', supported_from=EXCHANGE_2013,
is_read_only=True),
TextField('phonetic_first_name', field_uri='contacts:PhoneticFirstName', supported_from=EXCHANGE_2013,
is_read_only=True),
TextField('phonetic_last_name', field_uri='contacts:PhoneticLastName', supported_from=EXCHANGE_2013,
TextField('nickname', field_uri='contacts:Nickname'),
# Placeholder for CompleteName
TextField('company_name', field_uri='contacts:CompanyName'),
EmailAddressesField('email_addresses', field_uri='contacts:EmailAddress'),
PhysicalAddressField('physical_addresses', field_uri='contacts:PhysicalAddress'),
PhoneNumberField('phone_numbers', field_uri='contacts:PhoneNumber'),
TextField('assistant_name', field_uri='contacts:AssistantName'),
DateTimeField('birthday', field_uri='contacts:Birthday'),
URIField('business_homepage', field_uri='contacts:BusinessHomePage'),
TextListField('children', field_uri='contacts:Children'),
TextListField('companies', field_uri='contacts:Companies', is_searchable=False),
ChoiceField('contact_source', field_uri='contacts:ContactSource', choices={
Choice('Store'), Choice('ActiveDirectory')
}, is_read_only=True),
TextField('department', field_uri='contacts:Department'),
TextField('generation', field_uri='contacts:Generation'),
CharField('im_addresses', field_uri='contacts:ImAddresses', is_read_only=True),
TextField('job_title', field_uri='contacts:JobTitle'),
TextField('manager', field_uri='contacts:Manager'),
TextField('mileage', field_uri='contacts:Mileage'),
TextField('office', field_uri='contacts:OfficeLocation'),
ChoiceField('postal_address_index', field_uri='contacts:PostalAddressIndex', choices={
Choice('Business'), Choice('Home'), Choice('Other'), Choice('None')
}, default='None', is_required_after_save=True),
TextField('profession', field_uri='contacts:Profession'),
TextField('spouse_name', field_uri='contacts:SpouseName'),
CharField('surname', field_uri='contacts:Surname'),
DateTimeField('wedding_anniversary', field_uri='contacts:WeddingAnniversary'),
BooleanField('has_picture', field_uri='contacts:HasPicture', supported_from=EXCHANGE_2010, is_read_only=True),
TextField('phonetic_full_name', field_uri='contacts:PhoneticFullName', supported_from=EXCHANGE_2013,
is_read_only=True),
TextField('phonetic_first_name', field_uri='contacts:PhoneticFirstName', supported_from=EXCHANGE_2013,
if val is not None:
return val
return self.default
class TextListField(TextField):
is_list = True
def from_xml(self, elem, account):
iter_elem = elem.find(self.response_tag())
if iter_elem is not None:
return get_xml_attrs(iter_elem, '{%s}String' % TNS)
return self.default
class MessageField(TextField):
INNER_ELEMENT_NAME = 'Message'
def from_xml(self, elem, account):
reply = elem.find(self.response_tag())
if reply is None:
return None
message = reply.find('{%s}%s' % (TNS, self.INNER_ELEMENT_NAME))
if message is None:
return None
return message.text
def to_xml(self, value, version):
field_elem = create_element(self.request_tag())
message = create_element('t:%s' % self.INNER_ELEMENT_NAME)
message.text = value
return set_xml_value(field_elem, message, version=version)
def reply_all(self, subject, body):
self.create_reply_all(subject, body).send()
class Task(Item):
"""
MSDN: https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/task
"""
ELEMENT_NAME = 'Task'
NOT_STARTED = 'NotStarted'
COMPLETED = 'Completed'
LOCAL_FIELDS = [
IntegerField('actual_work', field_uri='task:ActualWork', min=0),
DateTimeField('assigned_time', field_uri='task:AssignedTime', is_read_only=True),
TextField('billing_information', field_uri='task:BillingInformation'),
IntegerField('change_count', field_uri='task:ChangeCount', is_read_only=True, min=0),
TextListField('companies', field_uri='task:Companies'),
# 'complete_date' can be set, but is ignored by the server, which sets it to now()
DateTimeField('complete_date', field_uri='task:CompleteDate', is_read_only=True),
TextListField('contacts', field_uri='task:Contacts'),
ChoiceField('delegation_state', field_uri='task:DelegationState', choices={
Choice('NoMatch'), Choice('OwnNew'), Choice('Owned'), Choice('Accepted'), Choice('Declined'), Choice('Max')
}, is_read_only=True),
CharField('delegator', field_uri='task:Delegator', is_read_only=True),
DateTimeField('due_date', field_uri='task:DueDate'),
BooleanField('is_editable', field_uri='task:IsAssignmentEditable', is_read_only=True),
BooleanField('is_complete', field_uri='task:IsComplete', is_read_only=True),
BooleanField('is_recurring', field_uri='task:IsRecurring', is_read_only=True),
BooleanField('is_team_task', field_uri='task:IsTeamTask', is_read_only=True),
TextField('mileage', field_uri='task:Mileage'),
CharField('owner', field_uri='task:Owner', is_read_only=True),
PhoneNumberField('phone_numbers', field_uri='contacts:PhoneNumber'),
TextField('assistant_name', field_uri='contacts:AssistantName'),
DateTimeField('birthday', field_uri='contacts:Birthday'),
URIField('business_homepage', field_uri='contacts:BusinessHomePage'),
TextListField('children', field_uri='contacts:Children'),
TextListField('companies', field_uri='contacts:Companies', is_searchable=False),
ChoiceField('contact_source', field_uri='contacts:ContactSource', choices={
Choice('Store'), Choice('ActiveDirectory')
}, is_read_only=True),
TextField('department', field_uri='contacts:Department'),
TextField('generation', field_uri='contacts:Generation'),
CharField('im_addresses', field_uri='contacts:ImAddresses', is_read_only=True),
TextField('job_title', field_uri='contacts:JobTitle'),
TextField('manager', field_uri='contacts:Manager'),
TextField('mileage', field_uri='contacts:Mileage'),
TextField('office', field_uri='contacts:OfficeLocation'),
ChoiceField('postal_address_index', field_uri='contacts:PostalAddressIndex', choices={
Choice('Business'), Choice('Home'), Choice('Other'), Choice('None')
}, default='None', is_required_after_save=True),
TextField('profession', field_uri='contacts:Profession'),
TextField('spouse_name', field_uri='contacts:SpouseName'),
CharField('surname', field_uri='contacts:Surname'),
DateTimeField('wedding_anniversary', field_uri='contacts:WeddingAnniversary'),
BooleanField('has_picture', field_uri='contacts:HasPicture', supported_from=EXCHANGE_2010, is_read_only=True),
TextField('phonetic_full_name', field_uri='contacts:PhoneticFullName', supported_from=EXCHANGE_2013,
is_read_only=True),
TextField('phonetic_first_name', field_uri='contacts:PhoneticFirstName', supported_from=EXCHANGE_2013,
is_read_only=True),
TextField('phonetic_last_name', field_uri='contacts:PhoneticLastName', supported_from=EXCHANGE_2013,
is_read_only=True),
EmailAddressField('email_alias', field_uri='contacts:Alias', is_read_only=True),
# 'notes' is documented in MSDN but apparently unused. Writing to it raises ErrorInvalidPropertyRequest. OWA
kwargs.update(cls.duration_to_start_end(elem=elem, account=account))
cls._clear(elem)
return cls(**kwargs)
class MailTips(EWSElement):
"""MSDN: https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/mailtips"""
ELEMENT_NAME = 'MailTips'
NAMESPACE = MNS
FIELDS = [
RecipientAddressField('recipient_address'),
ChoiceField('pending_mail_tips', field_uri='PendingMailTips', choices={Choice(c) for c in MAIL_TIPS_TYPES}),
EWSElementField('out_of_office', field_uri='OutOfOffice', value_cls=OutOfOffice),
BooleanField('mailbox_full', field_uri='MailboxFull'),
TextField('custom_mail_tip', field_uri='CustomMailTip'),
IntegerField('total_member_count', field_uri='TotalMemberCount'),
IntegerField('external_member_count', field_uri='ExternalMemberCount'),
IntegerField('max_message_size', field_uri='MaxMessageSize'),
BooleanField('delivery_restricted', field_uri='DeliveryRestricted'),
BooleanField('is_moderated', field_uri='IsModerated'),
BooleanField('invalid_recipient', field_uri='InvalidRecipient'),
]
__slots__ = tuple(f.name for f in FIELDS)
ENTRY_ID = 'EntryId' # The base64-encoded PR_ENTRYID property
EWS_ID = 'EwsId' # The EWS format used in Exchange 2007 SP1 and later
EWS_LEGACY_ID = 'EwsLegacyId' # The EWS format used in Exchange 2007 before SP1
HEX_ENTRY_ID = 'HexEntryId' # The hexadecimal representation of the PR_ENTRYID property
OWA_ID = 'OwaId' # The OWA format for Exchange 2007 and 2010
class Item(BaseItem):
"""
MSDN: https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/item
"""
ELEMENT_NAME = 'Item'
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),
IdField('id', field_uri=ID_ATTR, is_required=True),
IdField('root_id', field_uri=ROOT_ID_ATTR),
IdField('root_changekey', field_uri=ROOT_CHANGEKEY_ATTR),
]
__slots__ = tuple(f.name for f in FIELDS)
class Attachment(EWSElement):
"""Base class for FileAttachment and ItemAttachment
"""
FIELDS = [
EWSElementField('attachment_id', value_cls=AttachmentId),
TextField('name', field_uri='Name'),
TextField('content_type', field_uri='ContentType'),
TextField('content_id', field_uri='ContentId'),
URIField('content_location', field_uri='ContentLocation'),
IntegerField('size', field_uri='Size', is_read_only=True), # Attachment size in bytes
DateTimeField('last_modified_time', field_uri='LastModifiedTime'),
BooleanField('is_inline', field_uri='IsInline'),
]
__slots__ = tuple(f.name for f in FIELDS) + ('parent_item',)
def __init__(self, **kwargs):
self.parent_item = kwargs.pop('parent_item', None)
super(Attachment, self).__init__(**kwargs)
def clean(self, version=None):
from .items import Item
if self.parent_item is not None and not isinstance(self.parent_item, Item):
raise ValueError("'parent_item' value %r must be an Item instance" % self.parent_item)
__slots__ = tuple()
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
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)
def from_xml(self, elem, account):
from .properties import Body, HTMLBody
field_elem = elem.find(self.response_tag())
val = None if field_elem is None else field_elem.text or None
if val is not None:
body_type = field_elem.get('BodyType')