Use SQLAlchemy ORMs to Access Microsoft Exchange Data in Python

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Exchange Python Connector

Python Connector Libraries for Microsoft Exchange Data Connectivity. Integrate Microsoft Exchange with popular Python tools like Pandas, SQLAlchemy, Dash & petl.



The CData Python Connector for Microsoft Exchange enables you to create Python applications and scripts that use SQLAlchemy Object-Relational Mappings of Microsoft Exchange data.

The rich ecosystem of Python modules lets you get to work quickly and integrate your systems effectively. With the CData Python Connector for Microsoft Exchange and the SQLAlchemy toolkit, you can build Microsoft Exchange-connected Python applications and scripts. This article shows how to use SQLAlchemy to connect to Microsoft Exchange data to query, update, delete, and insert Microsoft Exchange data.

With built-in optimized data processing, the CData Python Connector offers unmatched performance for interacting with live Microsoft Exchange data in Python. When you issue complex SQL queries from Microsoft Exchange, the CData Connector pushes supported SQL operations, like filters and aggregations, directly to Microsoft Exchange and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).

Connecting to Microsoft Exchange Data

Connecting to Microsoft Exchange data looks just like connecting to any relational data source. Create a connection string using the required connection properties. For this article, you will pass the connection string as a parameter to the create_engine function.

Specify the User and Password to connect to Exchange. Additionally, specify the address of the Exchange server you are connecting to and the Platform associated with the server.

Follow the procedure below to install SQLAlchemy and start accessing Microsoft Exchange through Python objects.

Install Required Modules

Use the pip utility to install the SQLAlchemy toolkit:

pip install sqlalchemy

Be sure to import the module with the following:

import sqlalchemy

Model Microsoft Exchange Data in Python

You can now connect with a connection string. Use the create_engine function to create an Engine for working with Microsoft Exchange data.

engine = create_engine("exchange:///?User='myUser@mydomain.onmicrosoft.com'&Password='myPassword'&Server='https://outlook.office365.com/EWS/Exchange.asmx'&Platform='Exchange_Online'")

Declare a Mapping Class for Microsoft Exchange Data

After establishing the connection, declare a mapping class for the table you wish to model in the ORM (in this article, we will model the Contacts table). Use the sqlalchemy.ext.declarative.declarative_base function and create a new class with some or all of the fields (columns) defined.

base = declarative_base()
class Contacts(base):
	__tablename__ = "Contacts"
	GivenName = Column(String,primary_key=True)
	Size = Column(String)
	...

Query Microsoft Exchange Data

With the mapping class prepared, you can use a session object to query the data source. After binding the Engine to the session, provide the mapping class to the session query method.

Using the query Method

engine = create_engine("exchange:///?User='myUser@mydomain.onmicrosoft.com'&Password='myPassword'&Server='https://outlook.office365.com/EWS/Exchange.asmx'&Platform='Exchange_Online'")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Contacts).filter_by(BusinnessAddress_City="Raleigh"):
	print("GivenName: ", instance.GivenName)
	print("Size: ", instance.Size)
	print("---------")

Alternatively, you can use the execute method with the appropriate table object. The code below works with an active session.

Using the execute Method

Contacts_table = Contacts.metadata.tables["Contacts"]
for instance in session.execute(Contacts_table.select().where(Contacts_table.c.BusinnessAddress_City == "Raleigh")):
	print("GivenName: ", instance.GivenName)
	print("Size: ", instance.Size)
	print("---------")

For examples of more complex querying, including JOINs, aggregations, limits, and more, refer to the Help documentation for the extension.

Insert Microsoft Exchange Data

To insert Microsoft Exchange data, define an instance of the mapped class and add it to the active session. Call the commit function on the session to push all added instances to Microsoft Exchange.

new_rec = Contacts(GivenName="placeholder", BusinnessAddress_City="Raleigh")
session.add(new_rec)
session.commit()

Update Microsoft Exchange Data

To update Microsoft Exchange data, fetch the desired record(s) with a filter query. Then, modify the values of the fields and call the commit function on the session to push the modified record to Microsoft Exchange.

updated_rec = session.query(Contacts).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.BusinnessAddress_City = "Raleigh"
session.commit()

Delete Microsoft Exchange Data

To delete Microsoft Exchange data, fetch the desired record(s) with a filter query. Then delete the record with the active session and call the commit function on the session to perform the delete operation on the provided records (rows).

deleted_rec = session.query(Contacts).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
session.delete(deleted_rec)
session.commit()

Free Trial & More Information

Download a free, 30-day trial of the Microsoft Exchange Python Connector to start building Python apps and scripts with connectivity to Microsoft Exchange data. Reach out to our Support Team if you have any questions.