Skip to main content

A high-level library to access programaticaly Zimbra SOAP API features

Project description

ZimSOAP : a programmatic python interface to zimbra

[![Build Status](](

ZimSOAP allows to access the [SOAP Zimbra API] through a programmatic,
data-type-aware interface high-level. It also handle authentification,
sessions, pre-authentication and delegated authentication.

Not all methods are covered, but you're welcome to wrap the ones you need and
pull-request !

If you are looking at a lower-level lib, you better look to [python-zimbra]

Allows accessing zimbraAdmin and zimbraAccount SOAP APIs

- handle authentification
- handle pre-authentification admin->admin and admin->Account
- presents the request results as nice Python objects
- all requests are tested with 8.0.4 and 8.0.5

[SOAP Zimbra API]:



pip install zimsoap

Or if you fetch it from git:

./ install


API is accessible through the ZimbraAdminClient() method. Example :

zc = ZimbraAdminClient('myserver.example.tld')
zc.login('username@domain.tld', 'mypassword')

print("Domains on that zimbra instance :")
for domain in zc.get_all_domains():
# Each domain is a zobject.Domain instance
print(' - %s' %

You can also access raw SOAP methods:

zc = ZimbraAdminClient()
zc.login('username@domain.tld', 'mypassword')
xml_response = self.zc.GetAllDomainsRequest()

If you want up-to-date code example, look at unit tests...


Most of tests are integration tests, they require a live zimbra server to be

The tests will assume some base data (provisioning scsripts included),
create/update some, and cleanup after themselves. They may leave garbage data in
case they crash.



Use a dedicated test server, unable to send emails over network and consider
all Zimbra accounts/domains/settings are disposable for automated tests


### Setting your environment for tests ###

Most of tests are Integration tests are to be run either :

- against a pre-configured VM, using vagrant
- using any zimbra server you provide, after reading the above warning.

#### Using the vagrant VM ####

There is a VM ready for you with vagrant, just make sure you have vagrant installed and then :

$ vagrant up 8.0.5
$ vagrant provision 8.0.5

You have several zimbra versions available as VMs for testing (see vagrant

*Warning*: the test VM requires 2GB RAM to function properly and may put heavy
load on your machine.

#### Using your own zimbra server ####

Be sure to have a server:
- running zimbra 8.x,
- ports 7071 and 443 reachables
- with an unix user having password-less sudo rights

First delete all accounts/domains/calendar resources from your test server and run :

cat tests/provision-01-test-data.zmprov | ssh user@mytestserver -- sudo su - zimbra -c | zmprov

(considering *mytestserver* is your server hostname and *user* is a unix user with admin sudo rights)

It will provision an admin account, but disabled. You have to set a password and enable the account

ssh user@mytestserver -- sudo su - zimbra -c 'zmprov sp mypassword'
ssh user@mytestserver -- sudo su - zimbra -c 'zmprov ma zimbraAccountStatus active'

Then create a *test_config.ini* in tests/ directory. Example content:

host = mytestserver
server_name =
admin_port = 7071
admin_login =
admin_password = mypassword

*note: server_name is the internal server name from your zimbra server list (generally matches the hostname)*

If you damaged the data with failed tests, you can just delete everything except
the admin account and then run :

cat tests/provision-01-test-data.zmprov | ssh user@mytestserver -- sudo su - zimbra -c | zmprov

### Testing ###

After you are all set, you can run tests
[the standard python way](

$ python -m unittest discover

… Or using [py.test](

$ py.test

For contributing code, you may also want to run the *flake8* linter:

$ pip install -r test-requirements.txt
$ make lint

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

zimsoap-0.4.2.tar.gz (19.8 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page