Skip to main content

Client for Microsoft Exchange Web Services (EWS)

Project description

This module provides an well-performing 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, IdOnly, Account, Credentials, EWSDateTime, EWSTimeZone
from exchangelib.folders import 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'],
    ))

credentials = Credentials(username='MYWINDOMAIN\myusername', password='topsecret')
account = Account(primary_smtp_address='john@example.com', credentials=credentials, autodiscover=True, access_type=DELEGATE)

# Create the calendar items in the user's calendar
res = account.calendar.add_items(calendar_items)
print(res)

# Get Exchange ID and changekey of the calendar items we just created
ids = account.calendar.find_items(
    start=tz.localize(EWSDateTime(year, month, day)),
    end=tz.localize(EWSDateTime(year, month, day+1)),
    categories=['foo', 'bar'],
    shape=IdOnly,
)
print(ids)

# Get the rest of the attributes on the calendar items we just created
items = account.calendar.get_items(ids)
print(items)

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

Project details


Release history Release notifications | RSS feed

This version

1.5.1

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page