Skip to main content

A Python package to interact with both on-premises and Office 365 Exchange Web Services

Project description

py-ews

Documentation Status

.______   ____    ____       ___________    __    ____   _______.
|   _  \  \   \  /   /      |   ____\   \  /  \  /   /  /       |
|  |_)  |  \   \/   / ______|  |__   \   \/    \/   /  |   (----`
|   ___/    \_    _/ |______|   __|   \            /    \   \    
|  |          |  |          |  |____   \    /\    / .----)   |   
| _|          |__|          |_______|   \__/  \__/  |_______/    

A Python package to interact with Exchange Web Services

py-ews is a cross platform python package to interact with both Exchange 2010 to 2019 on-premises and Exchange Online (Office 365). This package will wrap all Exchange Web Service endpoints, but currently is focused on providing eDiscovery endpoints.

py-ews has the following notable features in it's current release:

  • Autodiscover support
  • Delegation support
  • Impersonation support
  • Retrieve all mailboxes that can be searched based on credentials provided
  • Search a list of (or single) mailboxes in your Exchange environment using all supported search attributes
  • Delete email items from mailboxes in your Exchange environment
  • Retrieve mailbox inbox rules for a specific account

Currently this package supports the following ServiceEndpoints:

  • Autodiscover
  • DeleteItem
  • GetInboxRules
  • GetSearchableMailboxes
  • ResolveNames
  • SearchMailboxes

Installation

OS X & Linux:

pip install py-ews

Windows:

pip install py-ews

Usage example

The first step in using py-ews is that you need to create a UserConfiguration object. Think of this as all the connection information for Exchange Web Services. An example of creating a UserConfiguration object using Office 365 Autodiscover is:

from pyews import UserConfiguration

userconfig = UserConfiguration(
      'myaccount@company.com',
      'Password1234'
)

If you would like to use an alternative Autodiscover endpoint (or any alternative endpoint) then please provide one using the endpoint named parameter:

from pyews import UserConfiguration

userconfig = UserConfiguration(
   'myaccount@company.com',
   'Password1234',
   endpoint='https://outlook.office365.com/autodiscover/autodiscover.svc'
)

For more information about creating a UserConfiguration object, please see the full documentation on our ReadTheDocs page.

Now that you have a UserConfiguration object, we can now use a ServiceEndpoint. This example will demonstrate how you can identify which mailboxes you have access to by using the GetSearchableMailboxes EWS endpoint.

Once you have identified a list of mailbox reference ids, then you can begin searching all of those mailboxes by using the SearchMailboxes EWS endpoint.

The returned results will then be deleted (moved to Deleted Items folder) from Exchange using the DeleteItem EWS endpoint.

from pyews import UserConfiguration

userconfig = UserConfiguration(
      'myaccount@company.com',
      'Password1234'
)

# get searchable mailboxes based on your accounts permissions
referenceid_list = []
for mailbox in GetSearchableMailboxes(userconfig).response:
      referenceid_list.append(mailbox['ReferenceId'])

# let's search all the referenceid_list items
messages_found = []
for search in SearchMailboxes('subject:account', userconfig, referenceid_list).response:
      messages_found.append(search['MessageId'])
      # we can print the results first if we want
      print(search['Subject'])
      print(search['MessageId'])
      print(search['Sender'])
      print(search['ToRecipients'])
      print(search['CreatedTime'])
      print(search['ReceivedTime'])
      #etc.

# if we wanted to now delete a specific message then we would call the DeleteItem 
# class like this but we can also pass in the entire messages_found list
deleted_message_response = DeleteItem(messages_found[2], userconfig).response

print(deleted_message_response)

The following is an example of the output returned when calling the above code:

YOUR ACCOUNT IS ABOUT TO EXPIRE! UPGRADE NOW!!!
AAMkAGZjOTlkOWExLTM2MDEtNGI3MS0..............
Josh Rickard
Research
2019-02-28T18:28:36Z
2019-02-28T18:28:36Z
Upgrade Your Account!
AAMkADAyNTZhNmMyLWNmZTctNDIyZC0..............
Josh Rickard
Josh Rickard 
2019-01-24T18:41:11Z
2019-01-24T18:41:11Z
New or modified user account information
AAMkAGZjOTlkOWExLTM2MDEtNGI3MS04.............. 
Microsoft Online Services Team
Research
2019-01-24T18:38:06Z
2019-01-24T18:38:06Z
[{'MessageText': 'Succesfull'}]

For more examples and usage, please refer to the [Wiki][wiki].

Development setup

I have provided a Dockerfile with all the dependencies and it is currently calling bin\pyews_test.py. If you want to test new features, I recommend that you use this Dockerfile instead of a virtualenv. You can call the following to build a new container, but keep the dependencies unless they have changed in your requirements.txt or any other changes to the Dockerfile.

docker build --force-rm -t pyews .

To run the container, use the following:

docker run pyews

Release History

  • 1.0.0
    • Initial release of py-ews to PyPi
  • 1.0.1
    • Updating Documentation with new reference links

Meta

Josh Rickard – @MSAdministratorrickardja@live.com

Distributed under the MIT license. See LICENSE for more information.

Contributing

  1. Fork it (https://github.com/swimlane/pyews/fork)
  2. Create your feature branch (git checkout -b feature/fooBar)
  3. Commit your changes (git commit -am 'Add some fooBar')
  4. Push to the branch (git push origin feature/fooBar)
  5. Create a new Pull Request

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

py-ews-1.0.8.tar.gz (18.5 kB view details)

Uploaded Source

Built Distributions

py_ews-1.0.8-py3-none-any.whl (27.3 kB view details)

Uploaded Python 3

py_ews-1.0.8-py2-none-any.whl (27.3 kB view details)

Uploaded Python 2

File details

Details for the file py-ews-1.0.8.tar.gz.

File metadata

  • Download URL: py-ews-1.0.8.tar.gz
  • Upload date:
  • Size: 18.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.7

File hashes

Hashes for py-ews-1.0.8.tar.gz
Algorithm Hash digest
SHA256 1321c68ed178015957a1b6f279ec6b2747ae1db7007b5d02f075d7df07ab0c30
MD5 1ed4b402046b60853e2caede8a9c9e83
BLAKE2b-256 7d607c6c0a36aa8c1964cc21783ce0954ad129944a1ff3d51e427a16b7877cd8

See more details on using hashes here.

File details

Details for the file py_ews-1.0.8-py3-none-any.whl.

File metadata

  • Download URL: py_ews-1.0.8-py3-none-any.whl
  • Upload date:
  • Size: 27.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.7

File hashes

Hashes for py_ews-1.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 13da22e4216b3948d7bc8d2114d86bfc2972c62caa14bee58b78c9b480dcd0ed
MD5 ea390c609a4c2e3c4af119d9678b5ffa
BLAKE2b-256 30dcc6ee978f7143c8b7fde2cc9b5a90e8bbc3d0cbd691d5b652d792ef16e52e

See more details on using hashes here.

File details

Details for the file py_ews-1.0.8-py2-none-any.whl.

File metadata

  • Download URL: py_ews-1.0.8-py2-none-any.whl
  • Upload date:
  • Size: 27.3 kB
  • Tags: Python 2
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.7

File hashes

Hashes for py_ews-1.0.8-py2-none-any.whl
Algorithm Hash digest
SHA256 075025c74e7230c1746b616fa5ff40526ea48add592ba6751667e0ff52853fd7
MD5 20222b9029e96b9b051eb0ababe6055f
BLAKE2b-256 236df4554069550b1caf1a17bcf68de30fe606b257444fa34574e8f0396a1b1e

See more details on using hashes here.

Supported by

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