Download the PHP package mhasnainjafri/cpanel without Composer
On this page you can find all versions of the php package mhasnainjafri/cpanel. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download mhasnainjafri/cpanel
More information about mhasnainjafri/cpanel
Files in mhasnainjafri/cpanel
Package cpanel
Short Description Laravel CPanel API Library for Managing cPanel Functionalities
License MIT
Homepage https://github.com/mhasnainjafri
Informations about the package cpanel
Library Name: Laravel CPanel API
This library provides a convenient way to interact with the cPanel API using Laravel. It allows you to perform various cPanel functions such as creating subdomains, managing databases, handling email accounts, and managing disk usage.
Installation
To use this library in your Laravel project, you can install it via Composer. Run the following command in your terminal:
Usage
To get started, you need to create a new instance of the Cpanel class. There are two ways to initialize the class:
-
Without any parameters:
- With parameters (if not defined in
.env
file):
Alternatively, you can set the cPanel credentials in the .env
file:
-
Steps to get Cpanel Api
- search api in cpanel search bar
- click on
- Give token a name and click on create
- Copy the token you get
Subdomain Functions
To create a subdomain, use the createSubDomain()
method:
Database Functions
To list all databases, use the listDatabases()
method:
To create a new database, use the createDatabase()
method:
To delete a database, use the deleteDatabase()
method:
To create a database user, use the createDatabaseUser()
method:
To delete a database user, use the deleteDatabaseUser()
method:
To set all privileges on a database for a user, use the setAllPrivilegesOnDatabase()
method:
Mail Functions
To create a POP email account, use the createPopEmailAccount()
method:
To delete a POP email account, use the deletePopEmailAccount()
method:
To edit the mailbox quota for an email account, use the editMailboxQuota()
method:
To dispatch client settings for an email account, use the dispatchClientSettings()
method:
To get the POP email count, use the getPopEmailCount()
method:
cPanel Disk Management
To get cPanel statistics bar stats for bandwidth usage or disk usage, use the getCpanelStatsBarStats()
method:
To get cPanel disk quota information, use the getCpanelDiskQuotaInfo()
method:
Other API Functions
To call any other cPanel API function, use the callUAPI()
method:
Replace $Module
with the desired module, $function
with the function name, and $parameters_array
with any additional parameters required by the API function.
That's it! You can now leverage the power of the Laravel CPanel API library to interact with the cPanel API seamlessly in your Laravel applications.
Testing
Changelog
Please see CHANGELOG for more information what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.
Laravel Package Boilerplate
This package was generated using the Laravel Package Boilerplate.