mailbox-org-api 2.4

A library to access the mailbox Business API.

mailbox-org-api

A library to access the mailbox Business API.

Motivation and purpose

The goal is to provide a comprehensive, easy to use library to integrate the business features of mailbox.
Primarily, the library should mirror all calls and features of the mailbox API.
As a secondary goal, the library should implement helper functions for common tasks.

Installation

Using pip:

pip install mailbox-org-api

Directly from source:

pip install git+https://github.com/heshsum/mailbox-org-api

Usage and documentation

Basic usage is fairly straightforward. The naming scheme of the functions is similar to the naming at mailbox.org, but instead of points, it uses underscores (e.g. instead of mail.add it's mail_add).

Therefore, the functions mirror the functions as provided and documented at mailbox: api.mailbox.org

Additionally, some helper functions for common or more complicated tasks are included to make life a bit easier, e.g. for changing plans, password and to retrieving invoices.

from mailbox_org_api import APIClient

username = 'foo'
password = 'bar'

# Initializing
api = APIClient.APIClient()

# Testing with hello.world
api.hello_world()

# Creating a new API session
api.auth(username, password)

# Testing the session with hello.innerworld
api.hello_innerworld()

# Changing account settings
api.account_set('foo', payment_type='invoice')

# Creating an inbox
api.mail_add('[e-mail]', 's3cr3tp4ssw0rd', 'standard', 'First Name', 'Last Name')

# Here are some examples for helper functions provided by this package

# Changing an inbox password
api.mail_set_password('[e-mail]', 'an0th3rS3cr3t')

# Changing an inbox plan
api.mail_set_plan('[e-mail]', 'premium')

# Deactivating an inbox
api.mail_set_state('[e-mail]', False)

# Changing alias addresses
api.mail_set_aliases('[e-mail]', ['[e-mail]', '[e-mail]'])

# Changing forward addresses
api.mail_set_forwards('[e-mail]', ['[e-mail]', '[e-mail]'])

# Closing the session
api.deauth()

More information can be found in the Wiki

Common tasks

mailbox_org_api includes a number of helper functions to make common tasks simpler. These include:

mail_set_password

This is a function to send a mail.setcommand and set a user's password.

Usage:

api.mail_set_password('[e-mail]', 'theNewPassword')

mail_set_password_require_reset

This function sends a mail.set command to set a user's password and require the user to change it upon the next login.

Usage:

api.mail_set_password('[e-mail]', 'theNewPassword')

The function will automatically set 'require_reset':True when sending the request.

mail_set_plan

This function sets the plan for an inbox.

Usage:

api.mail_set_plan('[e-mail]', 'standard')

mail_set_forwards

This function sets the forwards of an inbox.

Usage:

api.mail_set_forwards('[e-mail]', ['[e-mail]', '[e-mail]'])

mail_set_aliases

This function sets the aliases of an inbox.

Usage:

api.mail_set_forwards('[e-mail]', ['[e-mail]', '[e-mail]'])

mail_set_state

With this function an inbox can be (de-)activated. It sends a mail.set command with the active parameter.

Usage:

# Deactivates an inbox
api.mail_set_state('[e-mail]', 'False')

# Activates an inbox
api.mail_set_state('[e-mail]', 'True')

account_invoice_get_list

This function makes retrieving a list of all invoices easier.
It returns a list of all invoice id's for a given account.

Usage:

api.account_invoice_get_list('account_name')

account_invoice_get_token

In order to retrieve an invoice, a token is needed. Tokens change periodically.
This function helps to get the token for a given invoice ID.

Usage:

api.account_invoice_get_token('BMBO-1234-24')

account_invoice_get_file

Invoices are provided as Based64 encoded gz Strings. This function

1. takes the invoice ID
2. retrieves the token for the invoice
3. gets the binary data
4. decodes the Base64
5. decompresses it
6. returns the bytes of the actual invoice file

Usage

invoice_id = 'BMBO-1234-24'
account_name = 'foo'
with open(invoice_id + '.pdf', 'w') as file:
    file.write(api.account_invoice_get_file(account_name, invoice_id, 'PDF'))

Here be dragons

1. I'm not a programmer. I'm not very good at this. Be aware of my incompetence.
2. Implementation is not complete. Not all functions of the API have been implemented
3. Type hinting is available for most functions, but not all of them.
   E.g. mail_set() accepts kwargs due to the number of available attributes. In that case type errors will be returned if wrong types are provided.

API documentation

mailbox.org provides API documentation here: https://api.mailbox.org