{"id":16293555,"url":"https://github.com/badsyntax/mailinabox-api-py","last_synced_at":"2025-03-20T03:31:06.723Z","repository":{"id":51585314,"uuid":"285043672","full_name":"badsyntax/mailinabox-api-py","owner":"badsyntax","description":"Python client SDK for the Mail-in-a-Box API.","archived":false,"fork":false,"pushed_at":"2021-05-11T06:10:57.000Z","size":333,"stargazers_count":4,"open_issues_count":3,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-28T22:55:06.274Z","etag":null,"topics":["mail-in-a-box","mailinabox","openapi"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/mailinabox-api","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/badsyntax.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-08-04T16:55:58.000Z","updated_at":"2024-07-11T19:21:03.000Z","dependencies_parsed_at":"2022-08-21T19:50:06.798Z","dependency_job_id":null,"html_url":"https://github.com/badsyntax/mailinabox-api-py","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/badsyntax%2Fmailinabox-api-py","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/badsyntax%2Fmailinabox-api-py/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/badsyntax%2Fmailinabox-api-py/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/badsyntax%2Fmailinabox-api-py/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/badsyntax","download_url":"https://codeload.github.com/badsyntax/mailinabox-api-py/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244047647,"owners_count":20389206,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["mail-in-a-box","mailinabox","openapi"],"created_at":"2024-10-10T20:11:43.460Z","updated_at":"2025-03-20T03:31:06.086Z","avatar_url":"https://github.com/badsyntax.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mailinabox-api\n\n[![Build \u0026 Publish](https://github.com/badsyntax/mailinabox-api/workflows/Build%20\u0026%20Publish/badge.svg)](https://github.com/badsyntax/mailinabox-api/actions?query=workflow%3A%22Build+%26+Publish%22)\n\nPython client SDK for the Mail-in-a-Box API.\n\n- API version: 0.51.0\n- Package version: 0.51.1\n\nhttps://pypi.org/project/mailinabox-api\n\n**NOTE:** This package is [auto-generated](https://github.com/badsyntax/mailinabox-api) from the Mail-In-A-Box OpenAPI spec.\n\n## Requirements\n\nPython 2.7 and 3.4+\n\n## Installation \u0026 Usage\n\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/badsyntax/mailinabox-api-py.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/badsyntax/mailinabox-api-py.git`)\n\nThen import the package:\n```python\nimport mailinabox_api\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport mailinabox_api\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\nfrom __future__ import print_function\n\nimport time\nimport mailinabox_api\nfrom mailinabox_api.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://box.example.com/admin\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = mailinabox_api.Configuration(\n    host = \"https://box.example.com/admin\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = mailinabox_api.Configuration(\n    username = 'YOUR_USERNAME',\n    password = 'YOUR_PASSWORD'\n)\n\n\n# Enter a context with an instance of the API client\nwith mailinabox_api.ApiClient(configuration) as api_client:\n    # Create an instance of the API class\n    api_instance = mailinabox_api.DNSApi(api_client)\n    qname = 'qname_example' # str | DNS query name.\n    body = 1.2.3.4 # str | \n\n    try:\n        # Add DNS custom A record\n        api_response = api_instance.add_dns_custom_a_record(qname, body)\n        pprint(api_response)\n    except ApiException as e:\n        print(\"Exception when calling DNSApi-\u003eadd_dns_custom_a_record: %s\\n\" % e)\n    \n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://box.example.com/admin*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*DNSApi* | [**add_dns_custom_a_record**](docs/DNSApi.md#add_dns_custom_a_record) | **POST** /dns/custom/{qname} | Add DNS custom A record\n*DNSApi* | [**add_dns_custom_record**](docs/DNSApi.md#add_dns_custom_record) | **POST** /dns/custom/{qname}/{rtype} | Add DNS custom record\n*DNSApi* | [**add_dns_secondary_nameserver**](docs/DNSApi.md#add_dns_secondary_nameserver) | **POST** /dns/secondary-nameserver | Add DNS secondary nameserver\n*DNSApi* | [**get_dns_custom_a_records_for_q_name**](docs/DNSApi.md#get_dns_custom_a_records_for_q_name) | **GET** /dns/custom/{qname} | Get DNS custom A records\n*DNSApi* | [**get_dns_custom_records**](docs/DNSApi.md#get_dns_custom_records) | **GET** /dns/custom | Get DNS custom records\n*DNSApi* | [**get_dns_custom_records_for_q_name_and_type**](docs/DNSApi.md#get_dns_custom_records_for_q_name_and_type) | **GET** /dns/custom/{qname}/{rtype} | Get DNS custom records\n*DNSApi* | [**get_dns_dump**](docs/DNSApi.md#get_dns_dump) | **GET** /dns/dump | Get DNS dump\n*DNSApi* | [**get_dns_secondary_nameserver**](docs/DNSApi.md#get_dns_secondary_nameserver) | **GET** /dns/secondary-nameserver | Get DNS secondary nameserver\n*DNSApi* | [**get_dns_zonefile**](docs/DNSApi.md#get_dns_zonefile) | **GET** /dns/zonefile/{zone} | Get DNS zonefile\n*DNSApi* | [**get_dns_zones**](docs/DNSApi.md#get_dns_zones) | **GET** /dns/zones | Get DNS zones\n*DNSApi* | [**remove_dns_custom_a_record**](docs/DNSApi.md#remove_dns_custom_a_record) | **DELETE** /dns/custom/{qname} | Remove DNS custom A record\n*DNSApi* | [**remove_dns_custom_record**](docs/DNSApi.md#remove_dns_custom_record) | **DELETE** /dns/custom/{qname}/{rtype} | Remove DNS custom record\n*DNSApi* | [**update_dns**](docs/DNSApi.md#update_dns) | **POST** /dns/update | Update DNS\n*DNSApi* | [**update_dns_custom_a_record**](docs/DNSApi.md#update_dns_custom_a_record) | **PUT** /dns/custom/{qname} | Update DNS custom A record\n*DNSApi* | [**update_dns_custom_record**](docs/DNSApi.md#update_dns_custom_record) | **PUT** /dns/custom/{qname}/{rtype} | Update DNS custom record\n*MFAApi* | [**mfa_status**](docs/MFAApi.md#mfa_status) | **POST** /mfa/status | Retrieve MFA status for you or another user\n*MFAApi* | [**mfa_totp_disable**](docs/MFAApi.md#mfa_totp_disable) | **POST** /mfa/disable | Disable multi-factor authentication for you or another user\n*MFAApi* | [**mfa_totp_enable**](docs/MFAApi.md#mfa_totp_enable) | **POST** /mfa/totp/enable | Enable TOTP authentication\n*MailApi* | [**add_mail_user**](docs/MailApi.md#add_mail_user) | **POST** /mail/users/add | Add mail user\n*MailApi* | [**add_mail_user_privilege**](docs/MailApi.md#add_mail_user_privilege) | **POST** /mail/users/privileges/add | Add mail user privilege\n*MailApi* | [**get_mail_aliases**](docs/MailApi.md#get_mail_aliases) | **GET** /mail/aliases | Get mail aliases\n*MailApi* | [**get_mail_domains**](docs/MailApi.md#get_mail_domains) | **GET** /mail/domains | Get mail domains\n*MailApi* | [**get_mail_user_privileges**](docs/MailApi.md#get_mail_user_privileges) | **GET** /mail/users/privileges | Get mail user privileges\n*MailApi* | [**get_mail_users**](docs/MailApi.md#get_mail_users) | **GET** /mail/users | Get mail users\n*MailApi* | [**remove_mail_alias**](docs/MailApi.md#remove_mail_alias) | **POST** /mail/aliases/remove | Remove mail alias\n*MailApi* | [**remove_mail_user**](docs/MailApi.md#remove_mail_user) | **POST** /mail/users/remove | Remove mail user\n*MailApi* | [**remove_mail_user_privilege**](docs/MailApi.md#remove_mail_user_privilege) | **POST** /mail/users/privileges/remove | Remove mail user privilege\n*MailApi* | [**set_mail_user_password**](docs/MailApi.md#set_mail_user_password) | **POST** /mail/users/password | Set mail user password\n*MailApi* | [**upsert_mail_alias**](docs/MailApi.md#upsert_mail_alias) | **POST** /mail/aliases/add | Upsert mail alias\n*SSLApi* | [**generate_sslcsr**](docs/SSLApi.md#generate_sslcsr) | **POST** /ssl/csr/{domain} | Generate SSL CSR\n*SSLApi* | [**get_ssl_status**](docs/SSLApi.md#get_ssl_status) | **GET** /ssl/status | Get SSL status\n*SSLApi* | [**install_ssl_certificate**](docs/SSLApi.md#install_ssl_certificate) | **POST** /ssl/install | Install SSL certificate\n*SSLApi* | [**provision_ssl_certificates**](docs/SSLApi.md#provision_ssl_certificates) | **POST** /ssl/provision | Provision SSL certificates\n*SystemApi* | [**get_system_backup_config**](docs/SystemApi.md#get_system_backup_config) | **GET** /system/backup/config | Get system backup config\n*SystemApi* | [**get_system_backup_status**](docs/SystemApi.md#get_system_backup_status) | **GET** /system/backup/status | Get system backup status\n*SystemApi* | [**get_system_privacy_status**](docs/SystemApi.md#get_system_privacy_status) | **GET** /system/privacy | Get system privacy status\n*SystemApi* | [**get_system_reboot_status**](docs/SystemApi.md#get_system_reboot_status) | **GET** /system/reboot | Get system reboot status\n*SystemApi* | [**get_system_status**](docs/SystemApi.md#get_system_status) | **POST** /system/status | Get system status\n*SystemApi* | [**get_system_updates**](docs/SystemApi.md#get_system_updates) | **GET** /system/updates | Get system updates\n*SystemApi* | [**get_system_upstream_version**](docs/SystemApi.md#get_system_upstream_version) | **POST** /system/latest-upstream-version | Get system upstream version\n*SystemApi* | [**get_system_version**](docs/SystemApi.md#get_system_version) | **GET** /system/version | Get system version\n*SystemApi* | [**reboot_system**](docs/SystemApi.md#reboot_system) | **POST** /system/reboot | Reboot system\n*SystemApi* | [**update_system_backup_config**](docs/SystemApi.md#update_system_backup_config) | **POST** /system/backup/config | Update system backup config\n*SystemApi* | [**update_system_packages**](docs/SystemApi.md#update_system_packages) | **POST** /system/update-packages | Update system packages\n*SystemApi* | [**update_system_privacy**](docs/SystemApi.md#update_system_privacy) | **POST** /system/privacy | Update system privacy\n*UserApi* | [**get_me**](docs/UserApi.md#get_me) | **GET** /me | Get user information\n*WebApi* | [**get_web_domains**](docs/WebApi.md#get_web_domains) | **GET** /web/domains | Get web domains\n*WebApi* | [**update_web**](docs/WebApi.md#update_web) | **POST** /web/update | Update web\n\n\n## Documentation For Models\n\n - [DNSCustomRecord](docs/DNSCustomRecord.md)\n - [DNSCustomRecordsResponse](docs/DNSCustomRecordsResponse.md)\n - [DNSDumpDomainRecord](docs/DNSDumpDomainRecord.md)\n - [DNSDumpDomainRecords](docs/DNSDumpDomainRecords.md)\n - [DNSDumpDomains](docs/DNSDumpDomains.md)\n - [DNSDumpResponse](docs/DNSDumpResponse.md)\n - [DNSRecordType](docs/DNSRecordType.md)\n - [DNSSecondaryNameserverAddRequest](docs/DNSSecondaryNameserverAddRequest.md)\n - [DNSSecondaryNameserverResponse](docs/DNSSecondaryNameserverResponse.md)\n - [DNSUpdateRequest](docs/DNSUpdateRequest.md)\n - [DNSZonesResponse](docs/DNSZonesResponse.md)\n - [MailAlias](docs/MailAlias.md)\n - [MailAliasByDomain](docs/MailAliasByDomain.md)\n - [MailAliasRemoveRequest](docs/MailAliasRemoveRequest.md)\n - [MailAliasUpsertRequest](docs/MailAliasUpsertRequest.md)\n - [MailAliasesResponseFormat](docs/MailAliasesResponseFormat.md)\n - [MailUser](docs/MailUser.md)\n - [MailUserAddPrivilegeRequest](docs/MailUserAddPrivilegeRequest.md)\n - [MailUserAddRequest](docs/MailUserAddRequest.md)\n - [MailUserByDomain](docs/MailUserByDomain.md)\n - [MailUserPrivilege](docs/MailUserPrivilege.md)\n - [MailUserRemovePrivilegeRequest](docs/MailUserRemovePrivilegeRequest.md)\n - [MailUserRemoveRequest](docs/MailUserRemoveRequest.md)\n - [MailUserSetPasswordRequest](docs/MailUserSetPasswordRequest.md)\n - [MailUserStatus](docs/MailUserStatus.md)\n - [MailUsersResponse](docs/MailUsersResponse.md)\n - [MailUsersResponseFormat](docs/MailUsersResponseFormat.md)\n - [MeAuthStatus](docs/MeAuthStatus.md)\n - [MeResponse](docs/MeResponse.md)\n - [MfaDisableRequest](docs/MfaDisableRequest.md)\n - [MfaEnableRequest](docs/MfaEnableRequest.md)\n - [MfaStatusResponse](docs/MfaStatusResponse.md)\n - [MfaStatusResponseEnabledMfa](docs/MfaStatusResponseEnabledMfa.md)\n - [MfaStatusResponseNewMfa](docs/MfaStatusResponseNewMfa.md)\n - [SSLCSRGenerateRequest](docs/SSLCSRGenerateRequest.md)\n - [SSLCertificateInstallRequest](docs/SSLCertificateInstallRequest.md)\n - [SSLCertificatesProvisionResponse](docs/SSLCertificatesProvisionResponse.md)\n - [SSLCertificatesProvisionResponseRequests](docs/SSLCertificatesProvisionResponseRequests.md)\n - [SSLStatus](docs/SSLStatus.md)\n - [SSLStatusResponse](docs/SSLStatusResponse.md)\n - [SSLStatusType](docs/SSLStatusType.md)\n - [StatusEntry](docs/StatusEntry.md)\n - [StatusEntryExtra](docs/StatusEntryExtra.md)\n - [StatusEntryType](docs/StatusEntryType.md)\n - [SystemBackupConfigResponse](docs/SystemBackupConfigResponse.md)\n - [SystemBackupConfigUpdateRequest](docs/SystemBackupConfigUpdateRequest.md)\n - [SystemBackupStatus](docs/SystemBackupStatus.md)\n - [SystemBackupStatusResponse](docs/SystemBackupStatusResponse.md)\n - [SystemPrivacyStatus](docs/SystemPrivacyStatus.md)\n - [SystemPrivacyUpdateRequest](docs/SystemPrivacyUpdateRequest.md)\n - [SystemStatusResponse](docs/SystemStatusResponse.md)\n - [WebDomain](docs/WebDomain.md)\n\n\n## Documentation For Authorization\n\n\n## basicAuth\n\n- **Type**: HTTP basic authentication\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbadsyntax%2Fmailinabox-api-py","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbadsyntax%2Fmailinabox-api-py","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbadsyntax%2Fmailinabox-api-py/lists"}