iRedMail   //  Document Index

iRedAdmin-Pro RESTful API (interact with Python)

Summary

iRedAdmin-Pro RESTful API will return message in JSON format.

• If operation succeed, it returns JSON {'success': true}.
• If operation failed, it returns JSON {'success': false, 'msg': '<error_reason>'}.

Requirements

• At least iRedAdmin-Pro-SQL-2.4.0 or iRedAdmin-Pro-LDAP-2.6.0. Earlier releases didn't offer RESTful API.
• Our sample Python code requires Python module requests. For more details, please read its official documentation.

Sample code

Login (/login, POST)

import sys
import requests

# Base URL to iRedAdmin-Pro API interface
url = 'https://<server>/iredadmin/api'

# Admin username (email) and password.
admin = 'my_admin@domain.com'
pw = 'my_password'

#
# Login
#
r = requests.post(url + '/login', data={'username': admin, 'password': pw})

# Get returned JSON data (Python dict)
data = r.json()
if not data['success']:
    sys.exit('Login failed')

# Get cookies
cookies = r.cookies

Domain (/domain/<domain>)

Create domain (POST)

Create domain test.com.

requests.post(url + '/domain/test.com',
              cookies=cookies,
              data={'defaultQuota': '1024'})

Optional POST data:

• cn: the short description of this domain name. e.g. company name.
• quota: a integer number for mailbox quota (for whole domain)
• preferredLanguage: default preferred language for new user. e.g. en_US for English, de_DE for Deutsch.
• defaultQuota: default mailbox quota for new user.
• maxUserQuota: Max mailbox quota of a single mail user
• numberOfUsers: Max number of mail user accounts
• numberOfAliases: Max number of mail alias accounts

Delete domain (DELETE)

requests.delete(url + '/domain/test.com', cookies=cookies)

Mail User (/user/<mail>)

Create mail user (POST)

Create mail user zhb@test.com.

requests.post(url + '/user/zhb@test.com',
              cookies=cookies,
              data={'cn': 'Zhang Huangbin',
                    'password': 'password_for_zhb',
                    'preferredLanguage': 'en_US',
                    'mailQuota': 2048})

Required POST data:

• password: password for this user

Optional POST data:

• cn: display name
• preferredLanguage: default preferred language for new user. e.g. en_US for English, de_DE for Deutsch.
• mailQuota: mailbox quota for this user (in MB). Defaults to per-domain quota setting or unlimited.

Delete mail user (DELETE)

requests.delete(url + '/user/zhb@test.com', cookies=cookies)

Update mail user profiles (PUT)

requests.put(url + '/user/zhb@test.com',
             cookies=cookies,
             data={'password': '<a_strong_password>'})

Optional PUT data:

• name: display name.
• accountStatus: enable or disable user. possible value is: active, disabled.
• password: set new password for user
• quota: set mailbox quota (in MB)
• language: set preferred language of web UI
• transport: set per-user transport

Mail Alias (/alias/<mail>)

Create mail alias (POST)

Create mail alias account alias@test.com.

requests.post(url + '/alias/alias@test.com',
              cookies=cookies,
              data={'cn': 'My Alias'})

Optional POST data:

• cn: display name

Delete mail alias (DELETE)

requests.delete(url + '/alias/alias@test.com', cookies=cookies)

Mailing List (/maillist/<mail>, OpenLDAP backend only)

Create mailing list (POST)

requests.post(url + '/maillist/list@test.com',
              cookies=cookies,
              data={'cn': 'My Mailing List'})

Optional POST data:

• cn: display name

Delete mail alias (DELETE)

requests.delete(url + '/maillist/list@test.com', cookies=cookies)

See Also

• iRedAdmin-Pro RESTful API (interact with curl)

All documents are available in BitBucket repository, and published under Creative Commons license. If you found something wrong, please do contact us to fix it.