mailinabox-api

Python client SDK for the Mail-in-a-Box API.

• API version: 0.51.0
• Package version: 0.51.1

https://pypi.org/project/mailinabox-api

NOTE: This package is auto-generated from the Mail-In-A-Box OpenAPI spec.

Requirements

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/badsyntax/mailinabox-api-py.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/badsyntax/mailinabox-api-py.git)

Then import the package:

import mailinabox_api

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import mailinabox_api

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function

import time
import mailinabox_api
from mailinabox_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://box.example.com/admin
# See configuration.py for a list of all supported configuration parameters.
configuration = mailinabox_api.Configuration(
    host = "https://box.example.com/admin"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = mailinabox_api.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)


# Enter a context with an instance of the API client
with mailinabox_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mailinabox_api.DNSApi(api_client)
    qname = 'qname_example' # str | DNS query name.
    body = 1.2.3.4 # str | 

    try:
        # Add DNS custom A record
        api_response = api_instance.add_dns_custom_a_record(qname, body)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DNSApi->add_dns_custom_a_record: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://box.example.com/admin

Documentation For Models

• DNSCustomRecord
• DNSCustomRecordsResponse
• DNSDumpDomainRecord
• DNSDumpDomainRecords
• DNSDumpDomains
• DNSDumpResponse
• DNSRecordType
• DNSSecondaryNameserverAddRequest
• DNSSecondaryNameserverResponse
• DNSUpdateRequest
• DNSZonesResponse
• MailAlias
• MailAliasByDomain
• MailAliasRemoveRequest
• MailAliasUpsertRequest
• MailAliasesResponseFormat
• MailUser
• MailUserAddPrivilegeRequest
• MailUserAddRequest
• MailUserByDomain
• MailUserPrivilege
• MailUserRemovePrivilegeRequest
• MailUserRemoveRequest
• MailUserSetPasswordRequest
• MailUserStatus
• MailUsersResponse
• MailUsersResponseFormat
• MeAuthStatus
• MeResponse
• MfaDisableRequest
• MfaEnableRequest
• MfaStatusResponse
• MfaStatusResponseEnabledMfa
• MfaStatusResponseNewMfa
• SSLCSRGenerateRequest
• SSLCertificateInstallRequest
• SSLCertificatesProvisionResponse
• SSLCertificatesProvisionResponseRequests
• SSLStatus
• SSLStatusResponse
• SSLStatusType
• StatusEntry
• StatusEntryExtra
• StatusEntryType
• SystemBackupConfigResponse
• SystemBackupConfigUpdateRequest
• SystemBackupStatus
• SystemBackupStatusResponse
• SystemPrivacyStatus
• SystemPrivacyUpdateRequest
• SystemStatusResponse
• WebDomain

Documentation For Authorization

basicAuth

• Type: HTTP basic authentication