{"id":16293597,"url":"https://github.com/badsyntax/mailinabox-api-php","last_synced_at":"2026-04-18T14:03:34.189Z","repository":{"id":52451189,"uuid":"284928584","full_name":"badsyntax/mailinabox-api-php","owner":"badsyntax","description":"PHP client SDK for the Mail-in-a-Box API.","archived":false,"fork":false,"pushed_at":"2021-04-28T22:27:24.000Z","size":206,"stargazers_count":0,"open_issues_count":2,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-18T21:57:18.562Z","etag":null,"topics":["mail-in-a-box","mailinabox","openapi"],"latest_commit_sha":null,"homepage":"https://packagist.org/packages/mailinabox/mailinabox-api","language":"PHP","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-04T08:58:18.000Z","updated_at":"2020-12-20T12:41:54.000Z","dependencies_parsed_at":"2022-08-19T11:35:02.912Z","dependency_job_id":null,"html_url":"https://github.com/badsyntax/mailinabox-api-php","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/badsyntax/mailinabox-api-php","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/badsyntax%2Fmailinabox-api-php","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/badsyntax%2Fmailinabox-api-php/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/badsyntax%2Fmailinabox-api-php/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/badsyntax%2Fmailinabox-api-php/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/badsyntax","download_url":"https://codeload.github.com/badsyntax/mailinabox-api-php/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/badsyntax%2Fmailinabox-api-php/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31971491,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-18T00:39:45.007Z","status":"online","status_checked_at":"2026-04-18T02:00:07.018Z","response_time":103,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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:50.530Z","updated_at":"2026-04-18T14:03:34.156Z","avatar_url":"https://github.com/badsyntax.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MailInABoxAPI\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\nPHP client SDK for the Mail-in-a-Box API.\n\n- API version: 0.51.0\n- Package version: 0.51.1\n\nhttps://packagist.org/packages/mailinabox/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\nPHP 5.5 and later\n\n## Installation \u0026 Usage\n\n### Composer\n\nTo install the bindings via [Composer](http://getcomposer.org/), add the following to `composer.json`:\n\n```json\n{\n  \"require\": {\n    \"mailinabox/mailinabox-api\": \"0.51.1\"\n  }\n}\n```\n\nThen run `composer install`\n\n### Manual Installation\n\nDownload the files and include `autoload.php`:\n\n```php\n    require_once('/path/to/mailinabox-api-php/vendor/autoload.php');\n```\n\n## Tests\n\nTo run the unit tests:\n\n```bash\ncomposer install\n./vendor/bin/phpunit\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```php\n\u003c?php\nrequire_once(__DIR__ . '/vendor/autoload.php');\n\n\n\n// Configure HTTP basic authorization: basicAuth\n$config = MailInABoxAPI\\Client\\Configuration::getDefaultConfiguration()\n              -\u003esetUsername('YOUR_USERNAME')\n              -\u003esetPassword('YOUR_PASSWORD');\n\n\n$apiInstance = new MailInABoxAPI\\Client\\Api\\DNSApi(\n    // If you want use custom http client, pass your client which implements `GuzzleHttp\\ClientInterface`.\n    // This is optional, `GuzzleHttp\\Client` will be used as default.\n    new GuzzleHttp\\Client(),\n    $config\n);\n$qname = 'qname_example'; // string | DNS query name.\n$body = 1.2.3.4; // string | \n\ntry {\n    $result = $apiInstance-\u003eaddDnsCustomARecord($qname, $body);\n    print_r($result);\n} catch (Exception $e) {\n    echo 'Exception when calling DNSApi-\u003eaddDnsCustomARecord: ', $e-\u003egetMessage(), PHP_EOL;\n}\n\n?\u003e\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* | [**addDnsCustomARecord**](docs/Api/DNSApi.md#adddnscustomarecord) | **POST** /dns/custom/{qname} | Add DNS custom A record\n*DNSApi* | [**addDnsCustomRecord**](docs/Api/DNSApi.md#adddnscustomrecord) | **POST** /dns/custom/{qname}/{rtype} | Add DNS custom record\n*DNSApi* | [**addDnsSecondaryNameserver**](docs/Api/DNSApi.md#adddnssecondarynameserver) | **POST** /dns/secondary-nameserver | Add DNS secondary nameserver\n*DNSApi* | [**getDnsCustomARecordsForQName**](docs/Api/DNSApi.md#getdnscustomarecordsforqname) | **GET** /dns/custom/{qname} | Get DNS custom A records\n*DNSApi* | [**getDnsCustomRecords**](docs/Api/DNSApi.md#getdnscustomrecords) | **GET** /dns/custom | Get DNS custom records\n*DNSApi* | [**getDnsCustomRecordsForQNameAndType**](docs/Api/DNSApi.md#getdnscustomrecordsforqnameandtype) | **GET** /dns/custom/{qname}/{rtype} | Get DNS custom records\n*DNSApi* | [**getDnsDump**](docs/Api/DNSApi.md#getdnsdump) | **GET** /dns/dump | Get DNS dump\n*DNSApi* | [**getDnsSecondaryNameserver**](docs/Api/DNSApi.md#getdnssecondarynameserver) | **GET** /dns/secondary-nameserver | Get DNS secondary nameserver\n*DNSApi* | [**getDnsZonefile**](docs/Api/DNSApi.md#getdnszonefile) | **GET** /dns/zonefile/{zone} | Get DNS zonefile\n*DNSApi* | [**getDnsZones**](docs/Api/DNSApi.md#getdnszones) | **GET** /dns/zones | Get DNS zones\n*DNSApi* | [**removeDnsCustomARecord**](docs/Api/DNSApi.md#removednscustomarecord) | **DELETE** /dns/custom/{qname} | Remove DNS custom A record\n*DNSApi* | [**removeDnsCustomRecord**](docs/Api/DNSApi.md#removednscustomrecord) | **DELETE** /dns/custom/{qname}/{rtype} | Remove DNS custom record\n*DNSApi* | [**updateDns**](docs/Api/DNSApi.md#updatedns) | **POST** /dns/update | Update DNS\n*DNSApi* | [**updateDnsCustomARecord**](docs/Api/DNSApi.md#updatednscustomarecord) | **PUT** /dns/custom/{qname} | Update DNS custom A record\n*DNSApi* | [**updateDnsCustomRecord**](docs/Api/DNSApi.md#updatednscustomrecord) | **PUT** /dns/custom/{qname}/{rtype} | Update DNS custom record\n*MFAApi* | [**mfaStatus**](docs/Api/MFAApi.md#mfastatus) | **POST** /mfa/status | Retrieve MFA status for you or another user\n*MFAApi* | [**mfaTotpDisable**](docs/Api/MFAApi.md#mfatotpdisable) | **POST** /mfa/disable | Disable multi-factor authentication for you or another user\n*MFAApi* | [**mfaTotpEnable**](docs/Api/MFAApi.md#mfatotpenable) | **POST** /mfa/totp/enable | Enable TOTP authentication\n*MailApi* | [**addMailUser**](docs/Api/MailApi.md#addmailuser) | **POST** /mail/users/add | Add mail user\n*MailApi* | [**addMailUserPrivilege**](docs/Api/MailApi.md#addmailuserprivilege) | **POST** /mail/users/privileges/add | Add mail user privilege\n*MailApi* | [**getMailAliases**](docs/Api/MailApi.md#getmailaliases) | **GET** /mail/aliases | Get mail aliases\n*MailApi* | [**getMailDomains**](docs/Api/MailApi.md#getmaildomains) | **GET** /mail/domains | Get mail domains\n*MailApi* | [**getMailUserPrivileges**](docs/Api/MailApi.md#getmailuserprivileges) | **GET** /mail/users/privileges | Get mail user privileges\n*MailApi* | [**getMailUsers**](docs/Api/MailApi.md#getmailusers) | **GET** /mail/users | Get mail users\n*MailApi* | [**removeMailAlias**](docs/Api/MailApi.md#removemailalias) | **POST** /mail/aliases/remove | Remove mail alias\n*MailApi* | [**removeMailUser**](docs/Api/MailApi.md#removemailuser) | **POST** /mail/users/remove | Remove mail user\n*MailApi* | [**removeMailUserPrivilege**](docs/Api/MailApi.md#removemailuserprivilege) | **POST** /mail/users/privileges/remove | Remove mail user privilege\n*MailApi* | [**setMailUserPassword**](docs/Api/MailApi.md#setmailuserpassword) | **POST** /mail/users/password | Set mail user password\n*MailApi* | [**upsertMailAlias**](docs/Api/MailApi.md#upsertmailalias) | **POST** /mail/aliases/add | Upsert mail alias\n*SSLApi* | [**generateSSLCSR**](docs/Api/SSLApi.md#generatesslcsr) | **POST** /ssl/csr/{domain} | Generate SSL CSR\n*SSLApi* | [**getSSLStatus**](docs/Api/SSLApi.md#getsslstatus) | **GET** /ssl/status | Get SSL status\n*SSLApi* | [**installSSLCertificate**](docs/Api/SSLApi.md#installsslcertificate) | **POST** /ssl/install | Install SSL certificate\n*SSLApi* | [**provisionSSLCertificates**](docs/Api/SSLApi.md#provisionsslcertificates) | **POST** /ssl/provision | Provision SSL certificates\n*SystemApi* | [**getSystemBackupConfig**](docs/Api/SystemApi.md#getsystembackupconfig) | **GET** /system/backup/config | Get system backup config\n*SystemApi* | [**getSystemBackupStatus**](docs/Api/SystemApi.md#getsystembackupstatus) | **GET** /system/backup/status | Get system backup status\n*SystemApi* | [**getSystemPrivacyStatus**](docs/Api/SystemApi.md#getsystemprivacystatus) | **GET** /system/privacy | Get system privacy status\n*SystemApi* | [**getSystemRebootStatus**](docs/Api/SystemApi.md#getsystemrebootstatus) | **GET** /system/reboot | Get system reboot status\n*SystemApi* | [**getSystemStatus**](docs/Api/SystemApi.md#getsystemstatus) | **POST** /system/status | Get system status\n*SystemApi* | [**getSystemUpdates**](docs/Api/SystemApi.md#getsystemupdates) | **GET** /system/updates | Get system updates\n*SystemApi* | [**getSystemUpstreamVersion**](docs/Api/SystemApi.md#getsystemupstreamversion) | **POST** /system/latest-upstream-version | Get system upstream version\n*SystemApi* | [**getSystemVersion**](docs/Api/SystemApi.md#getsystemversion) | **GET** /system/version | Get system version\n*SystemApi* | [**rebootSystem**](docs/Api/SystemApi.md#rebootsystem) | **POST** /system/reboot | Reboot system\n*SystemApi* | [**updateSystemBackupConfig**](docs/Api/SystemApi.md#updatesystembackupconfig) | **POST** /system/backup/config | Update system backup config\n*SystemApi* | [**updateSystemPackages**](docs/Api/SystemApi.md#updatesystempackages) | **POST** /system/update-packages | Update system packages\n*SystemApi* | [**updateSystemPrivacy**](docs/Api/SystemApi.md#updatesystemprivacy) | **POST** /system/privacy | Update system privacy\n*UserApi* | [**getMe**](docs/Api/UserApi.md#getme) | **GET** /me | Get user information\n*WebApi* | [**getWebDomains**](docs/Api/WebApi.md#getwebdomains) | **GET** /web/domains | Get web domains\n*WebApi* | [**updateWeb**](docs/Api/WebApi.md#updateweb) | **POST** /web/update | Update web\n\n\n## Documentation For Models\n\n - [DNSCustomRecord](docs/Model/DNSCustomRecord.md)\n - [DNSCustomRecordsResponse](docs/Model/DNSCustomRecordsResponse.md)\n - [DNSDumpDomainRecord](docs/Model/DNSDumpDomainRecord.md)\n - [DNSDumpDomainRecords](docs/Model/DNSDumpDomainRecords.md)\n - [DNSDumpDomains](docs/Model/DNSDumpDomains.md)\n - [DNSDumpResponse](docs/Model/DNSDumpResponse.md)\n - [DNSRecordType](docs/Model/DNSRecordType.md)\n - [DNSSecondaryNameserverAddRequest](docs/Model/DNSSecondaryNameserverAddRequest.md)\n - [DNSSecondaryNameserverResponse](docs/Model/DNSSecondaryNameserverResponse.md)\n - [DNSUpdateRequest](docs/Model/DNSUpdateRequest.md)\n - [DNSZonesResponse](docs/Model/DNSZonesResponse.md)\n - [MailAlias](docs/Model/MailAlias.md)\n - [MailAliasByDomain](docs/Model/MailAliasByDomain.md)\n - [MailAliasRemoveRequest](docs/Model/MailAliasRemoveRequest.md)\n - [MailAliasUpsertRequest](docs/Model/MailAliasUpsertRequest.md)\n - [MailAliasesResponseFormat](docs/Model/MailAliasesResponseFormat.md)\n - [MailUser](docs/Model/MailUser.md)\n - [MailUserAddPrivilegeRequest](docs/Model/MailUserAddPrivilegeRequest.md)\n - [MailUserAddRequest](docs/Model/MailUserAddRequest.md)\n - [MailUserByDomain](docs/Model/MailUserByDomain.md)\n - [MailUserPrivilege](docs/Model/MailUserPrivilege.md)\n - [MailUserRemovePrivilegeRequest](docs/Model/MailUserRemovePrivilegeRequest.md)\n - [MailUserRemoveRequest](docs/Model/MailUserRemoveRequest.md)\n - [MailUserSetPasswordRequest](docs/Model/MailUserSetPasswordRequest.md)\n - [MailUserStatus](docs/Model/MailUserStatus.md)\n - [MailUsersResponse](docs/Model/MailUsersResponse.md)\n - [MailUsersResponseFormat](docs/Model/MailUsersResponseFormat.md)\n - [MeAuthStatus](docs/Model/MeAuthStatus.md)\n - [MeResponse](docs/Model/MeResponse.md)\n - [MfaDisableRequest](docs/Model/MfaDisableRequest.md)\n - [MfaEnableRequest](docs/Model/MfaEnableRequest.md)\n - [MfaStatusResponse](docs/Model/MfaStatusResponse.md)\n - [MfaStatusResponseEnabledMfa](docs/Model/MfaStatusResponseEnabledMfa.md)\n - [MfaStatusResponseNewMfa](docs/Model/MfaStatusResponseNewMfa.md)\n - [SSLCSRGenerateRequest](docs/Model/SSLCSRGenerateRequest.md)\n - [SSLCertificateInstallRequest](docs/Model/SSLCertificateInstallRequest.md)\n - [SSLCertificatesProvisionResponse](docs/Model/SSLCertificatesProvisionResponse.md)\n - [SSLCertificatesProvisionResponseRequests](docs/Model/SSLCertificatesProvisionResponseRequests.md)\n - [SSLStatus](docs/Model/SSLStatus.md)\n - [SSLStatusResponse](docs/Model/SSLStatusResponse.md)\n - [SSLStatusType](docs/Model/SSLStatusType.md)\n - [StatusEntry](docs/Model/StatusEntry.md)\n - [StatusEntryExtra](docs/Model/StatusEntryExtra.md)\n - [StatusEntryType](docs/Model/StatusEntryType.md)\n - [SystemBackupConfigResponse](docs/Model/SystemBackupConfigResponse.md)\n - [SystemBackupConfigUpdateRequest](docs/Model/SystemBackupConfigUpdateRequest.md)\n - [SystemBackupStatus](docs/Model/SystemBackupStatus.md)\n - [SystemBackupStatusResponse](docs/Model/SystemBackupStatusResponse.md)\n - [SystemPrivacyStatus](docs/Model/SystemPrivacyStatus.md)\n - [SystemPrivacyUpdateRequest](docs/Model/SystemPrivacyUpdateRequest.md)\n - [SystemStatusResponse](docs/Model/SystemStatusResponse.md)\n - [WebDomain](docs/Model/WebDomain.md)\n\n\n## Documentation For Authorization\n\n\n\n## basicAuth\n\n\n- **Type**: HTTP basic authentication\n\n\n## License\n\nMIT License\n\nCopyright (c) 2020 Richard Willis\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbadsyntax%2Fmailinabox-api-php","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbadsyntax%2Fmailinabox-api-php","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbadsyntax%2Fmailinabox-api-php/lists"}