Download the PHP package mailinabox/mailinabox-api without Composer

On this page you can find all versions of the php package mailinabox/mailinabox-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of mailinabox/mailinabox-api

Informations about the package mailinabox-api

MailInABoxAPI

Build & Publish

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

https://packagist.org/packages/mailinabox/mailinabox-api

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

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

Then run composer install

Manual Installation

Download the files and include autoload.php:

Tests

To run the unit tests:

Getting Started

Please follow the installation procedure and then run the following:

Documentation for API Endpoints

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

Class Method HTTP request Description
DNSApi addDnsCustomARecord POST /dns/custom/{qname} Add DNS custom A record
DNSApi addDnsCustomRecord POST /dns/custom/{qname}/{rtype} Add DNS custom record
DNSApi addDnsSecondaryNameserver POST /dns/secondary-nameserver Add DNS secondary nameserver
DNSApi getDnsCustomARecordsForQName GET /dns/custom/{qname} Get DNS custom A records
DNSApi getDnsCustomRecords GET /dns/custom Get DNS custom records
DNSApi getDnsCustomRecordsForQNameAndType GET /dns/custom/{qname}/{rtype} Get DNS custom records
DNSApi getDnsDump GET /dns/dump Get DNS dump
DNSApi getDnsSecondaryNameserver GET /dns/secondary-nameserver Get DNS secondary nameserver
DNSApi getDnsZonefile GET /dns/zonefile/{zone} Get DNS zonefile
DNSApi getDnsZones GET /dns/zones Get DNS zones
DNSApi removeDnsCustomARecord DELETE /dns/custom/{qname} Remove DNS custom A record
DNSApi removeDnsCustomRecord DELETE /dns/custom/{qname}/{rtype} Remove DNS custom record
DNSApi updateDns POST /dns/update Update DNS
DNSApi updateDnsCustomARecord PUT /dns/custom/{qname} Update DNS custom A record
DNSApi updateDnsCustomRecord PUT /dns/custom/{qname}/{rtype} Update DNS custom record
MFAApi mfaStatus POST /mfa/status Retrieve MFA status for you or another user
MFAApi mfaTotpDisable POST /mfa/disable Disable multi-factor authentication for you or another user
MFAApi mfaTotpEnable POST /mfa/totp/enable Enable TOTP authentication
MailApi addMailUser POST /mail/users/add Add mail user
MailApi addMailUserPrivilege POST /mail/users/privileges/add Add mail user privilege
MailApi getMailAliases GET /mail/aliases Get mail aliases
MailApi getMailDomains GET /mail/domains Get mail domains
MailApi getMailUserPrivileges GET /mail/users/privileges Get mail user privileges
MailApi getMailUsers GET /mail/users Get mail users
MailApi removeMailAlias POST /mail/aliases/remove Remove mail alias
MailApi removeMailUser POST /mail/users/remove Remove mail user
MailApi removeMailUserPrivilege POST /mail/users/privileges/remove Remove mail user privilege
MailApi setMailUserPassword POST /mail/users/password Set mail user password
MailApi upsertMailAlias POST /mail/aliases/add Upsert mail alias
SSLApi generateSSLCSR POST /ssl/csr/{domain} Generate SSL CSR
SSLApi getSSLStatus GET /ssl/status Get SSL status
SSLApi installSSLCertificate POST /ssl/install Install SSL certificate
SSLApi provisionSSLCertificates POST /ssl/provision Provision SSL certificates
SystemApi getSystemBackupConfig GET /system/backup/config Get system backup config
SystemApi getSystemBackupStatus GET /system/backup/status Get system backup status
SystemApi getSystemPrivacyStatus GET /system/privacy Get system privacy status
SystemApi getSystemRebootStatus GET /system/reboot Get system reboot status
SystemApi getSystemStatus POST /system/status Get system status
SystemApi getSystemUpdates GET /system/updates Get system updates
SystemApi getSystemUpstreamVersion POST /system/latest-upstream-version Get system upstream version
SystemApi getSystemVersion GET /system/version Get system version
SystemApi rebootSystem POST /system/reboot Reboot system
SystemApi updateSystemBackupConfig POST /system/backup/config Update system backup config
SystemApi updateSystemPackages POST /system/update-packages Update system packages
SystemApi updateSystemPrivacy POST /system/privacy Update system privacy
UserApi getMe GET /me Get user information
WebApi getWebDomains GET /web/domains Get web domains
WebApi updateWeb POST /web/update Update web

Documentation For Models

Documentation For Authorization

basicAuth

License

MIT License

Copyright (c) 2020 Richard Willis

All versions of mailinabox-api with dependencies

PHP Build Version
Package Version
Requires php Version >=7.1
ext-curl Version *
ext-json Version *
ext-mbstring Version *
guzzlehttp/guzzle Version ^6.2
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package mailinabox/mailinabox-api contains the following files

Loading the files please wait ....