Exchange Web Services client library

This module provides an well-performing, well-behaving, platform-independent and simple interface for communicating with a Microsoft Exchange 2007-2016 Server or Office365 using Exchange Web Services (EWS). It currently implements autodiscover, and functions for searching, creating, updating and deleting calendar, mailbox, task and contact items.

Usage

Here is a simple example that inserts, retrieves and deletes calendar items in an Exchange calendar:

from exchangelib import DELEGATE, IMPERSONATION, IdOnly, Account, Credentials, \
    EWSDateTime, EWSTimeZone, Configuration, NTLM, Restriction, Q
from exchangelib.folders import Calendar, CalendarItem

year, month, day = 2016, 3, 20
tz = EWSTimeZone.timezone('Europe/Copenhagen')

# Build a list of calendar items
calendar_items = []
for hour in range(7, 17):
    calendar_items.append(CalendarItem(
        start=tz.localize(EWSDateTime(year, month, day, hour, 30)),
        end=tz.localize(EWSDateTime(year, month, day, hour + 1, 15)),
        subject='Test item',
        body='Hello from Python',
        location='devnull',
        categories=['foo', 'bar'],
    ))

# Username in WINDOMAIN\username format. Office365 wants usernames in PrimarySMTPAddress
# ('myusername@example.com') format. UPN format is also supported.
#
# By default, fault-tolerant error handling is used. This means that calls may block for a long time if the server
# is unavailable. If you need immediate failures, add 'is_service_account=False' to Credentials.
credentials = Credentials(username='MYWINDOMAIN\\myusername', password='topsecret')

# If your credentials have been given impersonation access to the target account, use
# access_type=IMPERSONATION
account = Account(primary_smtp_address='john@example.com', credentials=credentials,
                  autodiscover=True, access_type=DELEGATE)

# If the server doesn't support autodiscover, use a Configuration object to set the
# server location:
# config = Configuration(server='mail.example.com',
#                        credentials=Credentials(username='MYWINDOMAIN\\myusername', password='topsecret'),
#                        auth_type=NTLM)
# account = Account(primary_smtp_address='john@example.com', config=config,
#                   access_type=DELEGATE)


# Create the calendar items in the user's standard calendar.  If you want to access a
# non-standard calendar, choose a different one from account.folders[Calendar]
res = account.calendar.bulk_create(calendar_items)
print(res)

# Get Exchange ID and changekey of the calendar items we just created. We filter by
# categories so we only get the items created by us. The syntax for filter() is
# modeled after Django QuerySet filters.
#
# If you need more complex filtering, filter() also accepts a Python-like search expression:
#
# ids = account.calendar.filter(
#       "start < '2016-01-02T03:04:05T' and end > '2016-01-01T03:04:05T' and categories in ('foo', 'bar')",
#       shape=IdOnly
# )
#
# filter() also support Q objects that are modeled after Django Q objects
#
# q = (Q(subject__iexact='foo') | Q(subject__contains='bar')) & ~Q(subject__startswith='baz')
# ids = account.calendar.filter(q, shape=IdOnly)
#
ids = account.calendar.filter(
    start__lt=tz.localize(EWSDateTime(year, month, day + 1)),
    end__gt=tz.localize(EWSDateTime(year, month, day)),
    categories__contains=['foo', 'bar'],
    shape=IdOnly,
)
print(ids)

# Get the rest of the attributes on the calendar items we just created. Most attributes from EWS are supported.
items = account.get_items(ids)
for item in items:
    print(item.start, item.end, item.subject, items.body, item.location)

# Delete the calendar items again
res = account.calendar.bulk_delete(ids)
print(res)