Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
naifalshaye authored Oct 21, 2018
1 parent 18ada2f commit f094699
Showing 1 changed file with 29 additions and 1 deletion.
30 changes: 29 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
# PHP Laravel cPanel
A php laravel package to manage cPanel email accounts

- Get a list of all email accounts.
- Create a new email account.
- Delete an email account.
- Change an email account's password.
- Change an email account's disk quota.

## Installation
```
composer require naif/php-cpanel-email
Expand Down Expand Up @@ -63,7 +69,7 @@ Response:
]
```

Delete an new email account
Delete an email account
```php
$cpanel->delete('email_address')

Expand All @@ -74,6 +80,28 @@ Response:
]
```

Change an email account's password
```php
$cpanel->changePassword('username','password')

Response:
[
"status" => "success"
"message" => "Password has been changed successfully"
]
```

Change an email account's disk quota
```php
$cpanel->changeQuota('username',500)//quota as a number or 0 to set it as unlimited

Response:
[
"status" => "success"
"message" => "Email disk quota has been changed successfully"
]
```

## Support:
naif@naif.io

Expand Down

0 comments on commit f094699

Please # to comment.